Method: corpora.documents.chunks.list

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

คำขอ HTTP

GET https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

URL ใช้ไวยากรณ์การแปลง gRPC

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

พารามิเตอร์
parent

string

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

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

พารามิเตอร์
pageSize

integer

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

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

string

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

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

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

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

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

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

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

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

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

object (Chunk)

Chunk ที่แสดงผล
nextPageToken

string

โทเค็นที่ส่งเป็น pageToken เพื่อเรียกดูหน้าถัดไป หากเว้นช่องนี้ไว้ แสดงว่าไม่มีหน้าอื่นอีก

ขอบเขตการให้สิทธิ์

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์