Chunks

เมธอด: 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

ฟิลด์
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 รายการ

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

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

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

แสดงรายการ Chunk ทั้งหมดใน Document

ปลายทาง

get 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 รายการ ขนาดสูงสุดคือ Chunk 100 รายการต่อหน้า

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 ที่เฉพาะเจาะจง

ปลายทาง

get 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

ปลายทาง

patch 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

ฟิลด์
data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ 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}

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

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

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

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

เมธอด: 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

ฟิลด์
parent string

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

chunk object (Chunk)

ต้องระบุ Chunk เพื่อสร้าง

การแสดง JSON 
{
  "parent": string,
  "chunk": {
    object (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

ฟิลด์
chunk object (Chunk)

ต้องระบุ Chunk เพื่ออัปเดต

updateMask string (FieldMask format)

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

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

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

เมธอด: 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 ที่จะลบ

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

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

DeleteChunkRequest

คำขอให้ลบ Chunk

ฟิลด์
name string

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

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

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

ทรัพยากร: ข้อมูล

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

ฟิลด์
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

ใช้ 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"

updateTime string (Timestamp format)

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

ใช้ 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"

state enum (State)

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

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

ChunkData

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

ช่อง
data Union type
data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
stringValue string

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

การแสดง JSON 
{

  // data
  "stringValue": string
  // Union type
}

รัฐ

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

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