Method: corpora.documents.query

لإجراء بحث دلالي على Document.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
name

string

مطلوبة. اسم Document المطلوب البحث عنه. مثال: corpora/my-corpus-123/documents/the-doc-abc

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "query": string,
  "resultsCount": integer,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ]
}
الحقول
query

string

مطلوبة. سلسلة طلب بحث لإجراء البحث الدلالي.
resultsCount

integer

اختياريّ. الحد الأقصى لعدد Chunk ثانية المطلوب عرضها. قد تعرِض الخدمة عدد أقل من Chunk ثوانٍ.

وفي حال عدم تحديد هذا الحقل، سيتم عرض 10 ثوانٍ على الأكثر من Chunk. الحد الأقصى لعدد النتائج المحددة هو 100 نتيجة.
metadataFilters[]

object (MetadataFilter)

اختياريّ. فلتر البيانات الوصفية لـ Chunk يجب أن يكون كل كائن MetadataFilter متوافقًا مع مفتاح فريد. يتم ربط كائنات MetadataFilter متعددة باستخدام رموز "AND" منطقية.

ملاحظة: لا تتوفّر الفلترة على مستوى Document لهذا الطلب لأنّه تم تحديد اسم Document من قبل.

مثال على طلب البحث: (السنة >= 2020 OR السنة < 2010) AND (النوع = الدراما OR النوع = الإجراء)

قائمة عناصر MetadataFilter: dataFilters = [ {key = "chunk.custom_metadata.year" terms = [{int_value = 2020, process = GREATER_EQUAL}, {int_value = 2010, process = LESS}}, {key = "chunk.custom_metadata.year" terms = [{int_value = 2020, process = GREATER_EQUAL}, {int_value = 2010, process = LESS}}, {key = "chunk.custom_metadata =process =ALQUALprocess =ALQUAL line }"

مثال على طلب بحث لنطاق رقمي من القيم: (year > 2015 AND year <= 2020)

قائمة عناصر MetadataFilter: dataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2015, process = GREATER}]}, {key = "chunk.custom_metadata.year" terms = [{int_value = 2020, process = AL}]LESS_E

ملاحظة: لا يمكن استخدام حرف "AND" للمفتاح نفسه إلا للقيم الرقمية. وتتوافق قيم السلسلة مع الأحرف "OR" فقط للمفتاح نفسه.

نص الاستجابة

ردّ من documents.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

لمزيد من المعلومات، راجع نظرة عامة على المصادقة.