Docuents

ทรัพยากร REST: corpora.documents

แหล่งข้อมูล: เอกสาร

Document คือคอลเล็กชันของ Chunk Corpus มี Document ได้สูงสุด 10,000 รายการ

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
ช่อง
name string

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Document รหัส (ชื่อที่ไม่รวมคำนำหน้า "corpora/*/documents/") มีอักขระได้สูงสุด 40 ตัว ซึ่งเป็นอักขระที่เป็นตัวอักษรพิมพ์เล็กและตัวเลขคละกันหรือขีดกลาง (-) รหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ชื่อที่ไม่ซ้ำกันจะได้มาจาก displayName พร้อมด้วยคำต่อท้ายแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Document ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ รวมเว้นวรรค ตัวอย่าง: "เอกสารประกอบของ Semantic Retriever"

customMetadata[] object (CustomMetadata)

ไม่บังคับ ผู้ใช้ระบุข้อมูลเมตาที่กำหนดเองซึ่งจัดเก็บเป็นคู่คีย์-ค่าที่ใช้ในการค้นหา Document มี CustomMetadata ได้สูงสุด 20 รายการ

updateTime string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดต Document ครั้งล่าสุด

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

createTime string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่สร้าง Document

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

เมธอด: corpora.documents.create

สร้าง Document ที่ว่างเปล่า

ปลายทาง

โพสต์ https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

พารามิเตอร์เส้นทาง

parent string

ต้องระบุ ชื่อของ Corpus ที่ระบบจะสร้าง Document นี้ ตัวอย่างเช่น corpora/my-corpus-123 ใช้รูปแบบ corpora/{corpora}

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Document

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ที่สร้างขึ้นใหม่ Document

เมธอด: corpora.documents.list

แสดง Document ทั้งหมดใน Corpus

ปลายทาง

ซื้อ https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

พารามิเตอร์เส้นทาง

parent string

ต้องระบุ ชื่อของ Corpus ที่มี Document ตัวอย่างเช่น corpora/my-corpus-123 ใช้รูปแบบ corpora/{corpora}

พารามิเตอร์การค้นหา

pageSize integer

ไม่บังคับ จำนวนสูงสุด Document วินาทีที่จะแสดงผล (ต่อหน้า) บริการอาจแสดงผล Document น้อยลง

หากไม่ระบุ ระบบจะแสดงผล Document สูงสุด 10 รายการ ขนาดสูงสุดคือ 20 Document วินาทีต่อหน้า

pageToken string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร documents.list ก่อนหน้า

ระบุ nextPageToken ที่แสดงผลในการตอบกลับเป็นอาร์กิวเมนต์ของคำขอถัดไปเพื่อดึงหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ documents.list ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

คำตอบจาก documents.list ที่มีรายการ Document ที่ใส่เลขหน้า Document จะจัดเรียงตาม document.create_time จากน้อยไปมาก

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ช่อง
documents[] object (Document)

Document ที่แสดงผล

nextPageToken string

โทเค็นซึ่งสามารถส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไป หากเว้นช่องนี้ไว้ จะไม่มีหน้าเพิ่มเติม

การแสดง JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

เมธอด: corpora.documents.query

ทำการค้นหาเชิงความหมายในช่วง Document

ปลายทาง

โพสต์ https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

พารามิเตอร์เส้นทาง

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 ไว้แล้ว

ตัวอย่างคำค้นหา: (ปี >= 2020 หรือ ปี < 2010) AND (ประเภท = ละคร OR ประเภท = แอ็กชัน)

รายการออบเจ็กต์ MetadataFilter: ตัวกรองข้อมูลเมตา = [ {key = "chunk.custom_metadata.year" เงื่อนไข = [{int_value = 2020, การดำเนินการ = GREATER_EQUAL}, {int_value = 2010, การดำเนินการ = LESS}}, {key = "chunk.custom_metadata.genre" เงื่อนไข = [{stringValue = "ละคร", การดำเนินการ = EQUAL}, {stringValue = "การกระทำ", การดำเนินการ = EQUAL}}]

ตัวอย่างคำค้นหาสำหรับช่วงของค่าที่เป็นตัวเลข: (ปี > 2015 และ ปี <= 2020)

รายการออบเจ็กต์ MetadataFilter: ตัวกรองข้อมูลเมตา = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; เงื่อนไข = [{int_value = 2020, การดำเนินการ = LESS_EQUAL}]}]

หมายเหตุ: "AND" สำหรับคีย์เดียวกันรองรับเฉพาะค่าตัวเลข ค่าสตริงรองรับเฉพาะ "OR" สำหรับคีย์เดียวกัน

เนื้อหาการตอบกลับ

คำตอบจาก documents.query ที่มีรายชื่อส่วนที่เกี่ยวข้อง

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ช่อง
relevantChunks[] object (RelevantChunk)

ส่วนที่เกี่ยวข้องที่ส่งกลับ

การแสดง JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

เมธอด: corpora.documents.get

รับข้อมูลเกี่ยวกับ Document ที่เจาะจง

ปลายทาง

ซื้อ https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

พารามิเตอร์เส้นทาง

name string

ต้องระบุ ชื่อของ Document ที่จะดึงข้อมูล ตัวอย่างเช่น corpora/my-corpus-123/documents/the-doc-abc ใช้รูปแบบ corpora/{corpora}/documents/{document}

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

เมธอด: corpora.documents.patch

อัปเดต Document

ปลายทาง

แพตช์ https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

พารามิเตอร์เส้นทาง

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

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

เมธอด: corpora.documents.delete

ลบ Document

ปลายทาง

ลบ https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

พารามิเตอร์เส้นทาง

name string

ต้องระบุ ชื่อทรัพยากรของ Document ที่จะลบ ตัวอย่างเช่น corpora/my-corpus-123/documents/the-doc-abc ใช้รูปแบบ corpora/{corpora}/documents/{document}

พารามิเตอร์การค้นหา

force boolean

ไม่บังคับ หากตั้งค่าเป็น "จริง" ระบบจะลบ Chunk และออบเจ็กต์ทั้งหมดที่เกี่ยวข้องกับ Document นี้ด้วย

หากเป็น "เท็จ" (ค่าเริ่มต้น) ระบบจะแสดงข้อผิดพลาด FAILED_PRECONDITION หาก Document มี Chunk

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากสำเร็จ เนื้อหาการตอบกลับจะว่างเปล่า

CustomMetadata

ข้อมูลเมตาที่ผู้ใช้ระบุซึ่งเก็บไว้เป็นคู่คีย์-ค่า

การแสดง JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
ช่อง
key string

ต้องระบุ คีย์ของข้อมูลเมตาที่จะจัดเก็บ

ช่องการรวม value

value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้

stringValue string

ค่าสตริงของข้อมูลเมตาที่จะจัดเก็บ

stringListValue object (StringList)

ค่า StringList ของข้อมูลเมตาที่จะจัดเก็บ

numericValue number

ค่าที่เป็นตัวเลขของข้อมูลเมตาที่จะจัดเก็บ

StringList

ค่าสตริงที่ผู้ใช้ระบุซึ่งกำหนดให้กับคีย์ข้อมูลเมตาเดียว

การแสดง JSON 
{
  "values": [
    string
  ]
}
ช่อง
values[] string

ค่าสตริงของข้อมูลเมตาที่จะจัดเก็บ