Chunks

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

แหล่งข้อมูล: กลุ่ม

Chunk เป็นส่วนย่อยของ Document ซึ่งถือว่าเป็นหน่วยอิสระเพื่อวัตถุประสงค์ในการแสดงเวกเตอร์และพื้นที่เก็บข้อมูล Corpus มีจำนวนได้สูงสุด 1 ล้านChunk วินาที

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

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

data object (ChunkData)

ต้องระบุ เนื้อหาของ Chunk เช่น สตริงข้อความ จำนวนโทเค็นสูงสุดต่อกลุ่มคือ 2043 โทเค็น

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

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

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

state enum (State)

เอาต์พุตเท่านั้น สถานะปัจจุบันของ Chunk

ChunkData

ข้อมูลที่แยกออกมาซึ่งแสดงเนื้อหาของ Chunk

การแสดง JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
ช่อง

ช่องการรวม data

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

stringValue string

เนื้อหา Chunk เป็นสตริง จำนวนโทเค็นสูงสุดต่อกลุ่มคือ 2043 โทเค็น

รัฐ

สถานะสำหรับวงจรของ Chunk

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากเว้นสถานะไว้
STATE_PENDING_PROCESSING กำลังประมวลผล Chunk (การฝังและพื้นที่เก็บข้อมูลเวกเตอร์)
STATE_ACTIVE Chunk ได้รับการประมวลผลและพร้อมสำหรับการค้นหา
STATE_FAILED ประมวลผล Chunk ไม่สำเร็จ

เมธอด: corpora.documents.chunks.create

สร้าง Chunk

ปลายทาง

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

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

parent string

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

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

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

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

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

เมธอด: corpora.documents.chunks.list

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

ปลายทาง

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

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

parent string

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

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

pageSize integer

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

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

pageToken string

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

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

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

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

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

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

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

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

ช่อง
chunks[] object (Chunk)

Chunk ที่แสดงผล

nextPageToken string

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

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

เมธอด: corpora.documents.chunks.get

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

ปลายทาง

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

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

name string

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

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

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

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

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

เมธอด: corpora.documents.chunks.patch

อัปเดต Chunk

ปลายทาง

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

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

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

chunk.name string

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

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

updateMask string (FieldMask format)

ต้องระบุ รายการช่องที่จะอัปเดต ปัจจุบันฟีเจอร์นี้รองรับเฉพาะการอัปเดตcustomMetadataและdataเท่านั้น

ซึ่งเป็นรายการชื่อของช่องที่มีคุณสมบัติครบถ้วนและคั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

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

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

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

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

เมธอด: corpora.documents.chunks.delete

ลบ Chunk

ปลายทาง

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

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

name string

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

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

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

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

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

เมธอด: corpora.documents.chunks.batchCreate

สร้าง Chunk เป็นกลุ่ม

ปลายทาง

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

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

parent string

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

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

ช่อง
requests[] object (CreateChunkRequest)

ต้องระบุ ข้อความคำขอที่ระบุ Chunk ที่จะสร้าง สร้าง Chunk เป็นกลุ่มได้สูงสุด 100 รายการ

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

คำตอบจาก chunks.batchCreate ที่มีรายการ Chunk ที่สร้างขึ้น

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

ช่อง
chunks[] object (Chunk)

สร้าง Chunk แล้ว

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

CreateChunkRequest

คำขอสร้าง Chunk

การแสดง JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
ช่อง
parent string

ต้องระบุ ชื่อของ Document ที่ระบบจะสร้าง Chunk นี้ ตัวอย่าง: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

ต้องระบุ Chunk ที่จะสร้าง

เมธอด: corpora.documents.chunks.batchUpdate

อัปเดตแบบกลุ่ม Chunk วินาที

ปลายทาง

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

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

parent string

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

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

ช่อง
requests[] object (UpdateChunkRequest)

ต้องระบุ ข้อความคำขอที่ระบุ Chunk ที่จะอัปเดต อัปเดต Chunk เป็นกลุ่มได้สูงสุด 100 รายการ

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

คำตอบจาก chunks.batchUpdate ที่มีรายการ Chunk ที่อัปเดตแล้ว

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

ช่อง
chunks[] object (Chunk)

อัปเดต Chunk แล้ว

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

UpdateChunkRequest

คำขออัปเดต Chunk

การแสดง JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
ช่อง
chunk object (Chunk)

ต้องระบุ Chunk ที่จะอัปเดต

updateMask string (FieldMask format)

ต้องระบุ รายการช่องที่จะอัปเดต ปัจจุบันฟีเจอร์นี้รองรับเฉพาะการอัปเดตcustomMetadataและdataเท่านั้น

ซึ่งเป็นรายการชื่อของช่องที่มีคุณสมบัติครบถ้วนและคั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เมธอด: corpora.documents.chunks.batchDelete

ลบ Chunk เป็นกลุ่ม

ปลายทาง

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

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

parent string

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

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

ช่อง
requests[] object (DeleteChunkRequest)

ต้องระบุ ข้อความในคำขอระบุ Chunk ที่จะลบ

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

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

DeleteChunkRequest

คำขอลบ Chunk

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

ต้องระบุ ชื่อทรัพยากรของ Chunk ที่จะลบ ตัวอย่าง: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk