เมธอด: corpora.documents.create
สร้าง Document
ว่าง
ปลายทาง
โพสต์https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
parent
string
ต้องระบุ ชื่อของ Corpus
ที่ระบบจะสร้าง Document
นี้ ตัวอย่าง: corpora/my-corpus-123
อยู่ในรูปแบบ corpora/{corpora}
เนื้อหาของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ Document
name
string
เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Document
รหัส (ชื่อที่ไม่รวมส่วนนำหน้า "corpora/*/documents/") ประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 อักขระ โดยรหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ระบบจะสร้างชื่อที่ไม่ซ้ำกันจาก displayName
พร้อมกับคำต่อแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Document
ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ ซึ่งรวมถึงการเว้นวรรค ตัวอย่าง: "เอกสารประกอบเกี่ยวกับเครื่องมือดึงข้อมูลเชิงความหมาย"
customMetadata[]
object (CustomMetadata
)
ไม่บังคับ ข้อมูลเมตาที่กําหนดเองซึ่งได้จากผู้ใช้ที่จัดเก็บเป็นคู่คีย์-ค่าสําหรับใช้ค้นหา Document
มี CustomMetadata
ได้สูงสุด 20 รายการ
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document
ที่สร้างขึ้นใหม่
เมธอด: corpora.documents.query
ทำการค้นหาเชิงความหมายใน Document
ปลายทาง
โพสต์https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}:query
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
name
string
ต้องระบุ ชื่อของ Document
ที่จะค้นหา ตัวอย่าง: corpora/my-corpus-123/documents/the-doc-abc
อยู่ในรูปแบบ corpora/{corpora}/documents/{document}
เนื้อหาของคำขอ
เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
query
string
ต้องระบุ สตริงการค้นหาเพื่อทำการค้นหาเชิงความหมาย
resultsCount
integer
ไม่บังคับ จำนวน Chunk
สูงสุดที่จะแสดง บริการอาจแสดง Chunk
น้อยกว่า
หากไม่ระบุ ระบบจะแสดงผล Chunk
ไม่เกิน 10 รายการ จํานวนผลลัพธ์สูงสุดที่ระบุได้คือ 100 รายการ
metadataFilters[]
object (MetadataFilter
)
ไม่บังคับ กรองข้อมูลเมตา Chunk
ออบเจ็กต์ MetadataFilter
แต่ละรายการควรสอดคล้องกับคีย์ที่ไม่ซ้ำกัน ออบเจ็กต์ MetadataFilter
หลายรายการจะรวมกันด้วยตรรกะ "AND"
หมายเหตุ: คำขอนี้ไม่รองรับการกรองระดับ Document
เนื่องจากมีการระบุชื่อ Document
ไว้แล้ว
ตัวอย่างข้อความค้นหา: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
MetadataFilter
รายการออบเจ็กต์: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]
ตัวอย่างการค้นหาสำหรับช่วงตัวเลขของค่า: (year > 2015 AND year <= 2020)
MetadataFilter
รายการออบเจ็กต์: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
หมายเหตุ: ระบบรองรับ "AND" สำหรับคีย์เดียวกันสำหรับค่าตัวเลขเท่านั้น ค่าสตริงรองรับเฉพาะ "OR" สำหรับคีย์เดียวกันเท่านั้น
เนื้อหาการตอบกลับ
การตอบกลับจาก documents.query
ที่มีรายการข้อมูลที่เกี่ยวข้อง
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
relevantChunks[]
object (RelevantChunk
)
ข้อมูลที่เกี่ยวข้องที่แสดงผล
การแสดง JSON |
---|
{
"relevantChunks": [
{
object ( |
เมธอด: corpora.documents.list
แสดงรายการ Document
ทั้งหมดใน Corpus
ปลายทาง
gethttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
parent
string
ต้องระบุ ชื่อของ Corpus
ที่มี Document
ตัวอย่าง: corpora/my-corpus-123
อยู่ในรูปแบบ corpora/{corpora}
พารามิเตอร์การค้นหา
pageSize
integer
ไม่บังคับ จำนวน Document
สูงสุดที่จะแสดง (ต่อหน้า) บริการอาจแสดง Document
น้อยกว่า
หากไม่ระบุ ระบบจะแสดงผล Document
ไม่เกิน 10 รายการ ขนาดสูงสุดคือ Document
20 รายการต่อหน้า
pageToken
string
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ documents.list
ก่อนหน้านี้
ระบุ nextPageToken
ที่แสดงในการตอบกลับเป็นอาร์กิวเมนต์ในคำขอถัดไปเพื่อดึงข้อมูลหน้าถัดไป
เมื่อแบ่งหน้าเว็บ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้กับ documents.list
ต้องตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบกลับจาก documents.list
ที่มีรายการ Document
แบบแบ่งหน้า Document
จะจัดเรียงตาม document.create_time
จากน้อยไปมาก
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
documents[]
object (Document
)
Document
ที่แสดงผล
nextPageToken
string
โทเค็น ซึ่งสามารถส่งเป็น pageToken
เพื่อเรียกข้อมูลหน้าถัดไป หากไม่ระบุฟิลด์นี้ ระบบจะไม่แสดงหน้าเว็บอีก
การแสดง JSON |
---|
{
"documents": [
{
object ( |
เมธอด: corpora.documents.get
รับข้อมูลเกี่ยวกับ Document
ที่เฉพาะเจาะจง
ปลายทาง
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
name
string
ต้องระบุ ชื่อของ Document
ที่จะดึงข้อมูล ตัวอย่าง: corpora/my-corpus-123/documents/the-doc-abc
อยู่ในรูปแบบ corpora/{corpora}/documents/{document}
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document
เมธอด: corpora.documents.patch
อัปเดต Document
ปลายทาง
patchhttps: / /generativelanguage.googleapis.com /v1beta /{document.name=corpora /* /documents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
document.name
string
เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Document
รหัส (ชื่อที่ไม่รวมส่วนนำหน้า "corpora/*/documents/") ประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 อักขระ โดยรหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ระบบจะสร้างชื่อที่ไม่ซ้ำกันจาก displayName
พร้อมกับคำต่อแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
อยู่ในรูปแบบ corpora/{corpora}/documents/{document}
พารามิเตอร์การค้นหา
updateMask
string (FieldMask
format)
ต้องระบุ รายการช่องที่จะอัปเดต ปัจจุบันการอัปเดตนี้รองรับเฉพาะ displayName
และ customMetadata
ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"
เนื้อหาของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ Document
displayName
string
ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Document
ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ ซึ่งรวมถึงการเว้นวรรค ตัวอย่าง: "เอกสารประกอบเกี่ยวกับเครื่องมือดึงข้อมูลเชิงความหมาย"
customMetadata[]
object (CustomMetadata
)
ไม่บังคับ ข้อมูลเมตาที่กําหนดเองซึ่งได้จากผู้ใช้ที่จัดเก็บเป็นคู่คีย์-ค่าสําหรับใช้ค้นหา Document
มี CustomMetadata
ได้สูงสุด 20 รายการ
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document
วิธีการ: corpora.documents.delete
ลบ Document
ปลายทาง
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
name
string
ต้องระบุ ชื่อทรัพยากรของ Document
ที่จะลบ ตัวอย่าง: corpora/my-corpus-123/documents/the-doc-abc
อยู่ในรูปแบบ corpora/{corpora}/documents/{document}
พารามิเตอร์การค้นหา
force
boolean
ไม่บังคับ หากตั้งค่าเป็น "จริง" ระบบจะลบ Chunk
และออบเจ็กต์ที่เกี่ยวข้องกับ Document
นี้ด้วย
หากเป็นเท็จ (ค่าเริ่มต้น) ระบบจะแสดงข้อผิดพลาด FAILED_PRECONDITION
หาก Document
มี Chunk
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นออบเจ็กต์ JSON ว่าง
ทรัพยากร REST: corpora.documents
ทรัพยากร: เอกสาร
Document
คือคอลเล็กชันของ Chunk
Corpus
มีDocument
ได้สูงสุด 10,000 รายการ
name
string
เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Document
รหัส (ชื่อที่ไม่รวมส่วนนำหน้า "corpora/*/documents/") ประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 อักขระ โดยรหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ระบบจะสร้างชื่อที่ไม่ซ้ำกันจาก displayName
พร้อมกับคำต่อแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Document
ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ ซึ่งรวมถึงการเว้นวรรค ตัวอย่าง: "เอกสารประกอบเกี่ยวกับเครื่องมือดึงข้อมูลเชิงความหมาย"
customMetadata[]
object (CustomMetadata
)
ไม่บังคับ ข้อมูลเมตาที่กําหนดเองซึ่งได้จากผู้ใช้ที่จัดเก็บเป็นคู่คีย์-ค่าสําหรับใช้ค้นหา Document
มี CustomMetadata
ได้สูงสุด 20 รายการ
updateTime
string (Timestamp
format)
เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดต Document
ครั้งล่าสุด
ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
หรือ "2014-10-02T15:01:23+05:30"
createTime
string (Timestamp
format)
เอาต์พุตเท่านั้น การประทับเวลาที่สร้าง Document
ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
หรือ "2014-10-02T15:01:23+05:30"
การแสดง JSON |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
CustomMetadata
ข้อมูลเมตาที่ได้จากผู้ใช้ซึ่งจัดเก็บเป็นคู่คีย์-ค่า
key
string
ต้องระบุ คีย์ของข้อมูลเมตาที่จะจัดเก็บ
value
Union type
value
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้นstringValue
string
ค่าสตริงของข้อมูลเมตาที่จะจัดเก็บ
stringListValue
object (StringList
)
ค่า StringList ของข้อมูลเมตาที่จะจัดเก็บ
numericValue
number
ค่าตัวเลขของข้อมูลเมตาที่จะจัดเก็บ
การแสดง JSON |
---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
ค่าสตริงที่ผู้ใช้ระบุซึ่งกำหนดให้กับคีย์ข้อมูลเมตารายการเดียว
values[]
string
ค่าสตริงของข้อมูลเมตาที่จะจัดเก็บ
การแสดง JSON |
---|
{ "values": [ string ] } |