Method: corpora.query

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

คำขอ HTTP

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

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

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

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

string

ต้องระบุ ชื่อของ Corpus ที่จะค้นหา ตัวอย่าง: corpora/my-corpus-123

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

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

การแสดง JSON
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
ช่อง
query

string

ต้องระบุ สตริงคำค้นหาเพื่อดำเนินการค้นหาเชิงความหมาย

metadataFilters[]

object (MetadataFilter)

ไม่บังคับ กรองข้อมูลเมตา Chunk และ Document ออบเจ็กต์ MetadataFilter แต่ละรายการควรสอดคล้องกับคีย์ที่ไม่ซ้ำกัน ออบเจ็กต์ MetadataFilter หลายรายการจะมีการผนวกกันด้วยตรรกะ "AND"

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

MetadataFilter รายการออบเจ็กต์: ตัวกรองข้อมูลเมตา = [ {คีย์ = "document.custom_metadata.year" เงื่อนไข = [{int_value = 2020, actions = GREATER_EQUAL}, {int_value = 2010, actions = LESS}]}, {key = "document.custom_metadata.year" actions = [{int_value} เงื่อนไข = GREATER_EQUAL}

ตัวอย่างคำค้นหาที่ระดับกลุ่มสำหรับช่วงตัวเลขของค่า: (year > 2015 AND year <= 2020)

รายการออบเจ็กต์ MetadataFilter: ตัวกรองข้อมูลเมตา = [ {คีย์ = "chunk.custom_metadata.year" เงื่อนไข = [{int_value = 2015, actions = GREATER}]}, {คีย์ = "chunk.custom_metadata.year" เงื่อนไข = [{int_value = 2020, actions = LESS]EQUAL}]

หมายเหตุ: "และ" สำหรับคีย์เดียวกันจะใช้ได้เฉพาะค่าตัวเลขเท่านั้น ค่าสตริงรองรับเฉพาะ "OR" สำหรับคีย์เดียวกัน

resultsCount

integer

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

หากไม่ระบุ ระบบจะส่งคืน Chunk ไม่เกิน 10 รายการ จำนวนผลลัพธ์ที่ระบุสูงสุดคือ 100

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

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

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

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

object (RelevantChunk)

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

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

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

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

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