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 s ফেরত দিতে হবে। পরিষেবা কম Chunk s ফেরত দিতে পারে.

অনির্দিষ্ট থাকলে, সর্বাধিক 10 Chunk ফেরত দেওয়া হবে। সর্বাধিক নির্দিষ্ট ফলাফলের সংখ্যা 100।

metadataFilters[]

object ( MetadataFilter )

ঐচ্ছিক। Chunk মেটাডেটার জন্য ফিল্টার. প্রতিটি MetadataFilter অবজেক্ট একটি অনন্য কী এর সাথে সঙ্গতিপূর্ণ হওয়া উচিত। একাধিক MetadataFilter বস্তু যৌক্তিক "AND" দ্বারা যুক্ত হয়।

দ্রষ্টব্য: Document -স্তরের ফিল্টারিং এই অনুরোধের জন্য সমর্থিত নয় কারণ একটি Document নাম ইতিমধ্যেই নির্দিষ্ট করা আছে৷

উদাহরণ কোয়েরি: (বছর >= 2020 বা বছর <2010) এবং (জেনার = নাটক বা জেনার = অ্যাকশন)

MetadataFilter অবজেক্ট তালিকা: মেটাডেটা ফিল্টার = [ {key = "chunk.custom_metadata.year" শর্ত = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata. " শর্ত = [{stringValue = "ড্রামা", অপারেশন = EQUAL}, {stringValue = "Action", অপারেশন = EQUAL}}]

মানগুলির একটি সংখ্যাসূচক পরিসরের জন্য উদাহরণ কোয়েরি: (বছর > 2015 এবং বছর <= 2020)

MetadataFilter অবজেক্ট লিস্ট: মেটাডেটা ফিল্টার = [ {key = "chunk.custom_metadata.year" শর্ত = [{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

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।