Method: corpora.documents.query

جستجوی معنایی را روی یک Document انجام می دهد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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 یا سال < 2010) و (ژانر = درام یا ژانر = اکشن)

فهرست شیء MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2020، عملیات = GREATER_EQUAL}، {int_value = 2010، عملیات = LESS}}، {key = "chunk.custom_metadatagenre. "condition = [{stringValue = "drama"، عملیات = EQUAL}، {stringValue = "Action"، عملیات = EQUAL}}]

پرس و جوی مثال برای محدوده عددی مقادیر: (سال > 2015 و سال <= 2020)

فهرست شیء MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2015، عملیات = GREATER}]}، {key = "chunk.custom_metadata.year" شرایط = [{int_value = 2020، عملیات = LESS_EQUAL}]}]

توجه: "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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.