Method: documents.searchDocumentChunks

গুগলের ডেভেলপার ডকুমেন্টেশন জুড়ে ডেভেলপার জ্ঞান অনুসন্ধান করে। ব্যবহারকারীর কোয়েরির উপর ভিত্তি করে DocumentChunk রিটার্ন করে। একই Document থেকে একাধিক চাঙ্ক থাকতে পারে। সম্পূর্ণ ডকুমেন্ট পুনরুদ্ধার করতে, SearchDocumentChunksResponse.results এ রিটার্ন করা DocumentChunk.parent সহ DeveloperKnowledge.GetDocument অথবা DeveloperKnowledge.BatchGetDocuments ব্যবহার করুন।

HTTP অনুরোধ

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

URL-টিতে gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়েছে।

কোয়েরি প্যারামিটার

প্যারামিটার
query

string

আবশ্যক। ব্যবহারকারীর দেওয়া মূল কোয়েরি স্ট্রিংটি প্রদান করে, যেমন "How to create a Cloud Storage bucket?"।

pageSize

integer

ঐচ্ছিক। ফেরত দেওয়া ফলাফলের সর্বোচ্চ সংখ্যা নির্দিষ্ট করে। পরিষেবাটি এই মানের চেয়ে কম ফলাফলও ফেরত দিতে পারে।

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

সর্বোচ্চ মান হলো ২০; ২০-এর বেশি মান ব্যবহার করলে INVALID_ARGUMENT ত্রুটি দেখা দেবে।

pageToken

string

ঐচ্ছিক। এতে একটি পেজ টোকেন থাকে, যা পূর্ববর্তী documents.searchDocumentChunks কল থেকে প্রাপ্ত। পরবর্তী পৃষ্ঠাটি পুনরুদ্ধার করতে এটি প্রদান করুন।

filter

string

ঐচ্ছিক। অনুসন্ধানের ফলাফলের উপর একটি কঠোর ফিল্টার প্রয়োগ করে। এই এক্সপ্রেশনটি https://google.aip.dev/160 -এ বর্ণিত সিনট্যাক্সের একটি উপসেট সমর্থন করে।

যদিও documents.searchDocumentChunks DocumentChunk রিটার্ন করে, ফিল্টারটি DocumentChunk.document ফিল্ডগুলিতে প্রয়োগ করা হয়।

ফিল্টার করার জন্য সমর্থিত ক্ষেত্রসমূহ:

  • dataSource (স্ট্রিং): ডকুমেন্টটির উৎস, যেমন docs.cloud.google.com । কর্পাসের ডেটা উৎসগুলোর সম্পূর্ণ তালিকার জন্য https://developers.google.com/knowledge/reference/corpus-reference দেখুন।
  • updateTime (টাইমস্ট্যাম্প): ডকুমেন্টটি সর্বশেষ কখন অর্থপূর্ণভাবে আপডেট করা হয়েছিল তার টাইমস্ট্যাম্প। একটি অর্থপূর্ণ আপডেট হলো এমন একটি আপডেট যা ডকুমেন্টের মার্কডাউন কন্টেন্ট বা মেটাডেটা পরিবর্তন করে।
  • uri (স্ট্রিং): ডকুমেন্ট URI, যেমন https://docs.cloud.google.com/bigquery/docs/tables ।

STRING ফিল্ডগুলো সম্পূর্ণ স্ট্রিংয়ের সঠিক মিলের জন্য = (সমান) এবং != (অসমান) অপারেটর সমর্থন করে। আংশিক মিল, প্রিফিক্স মিল এবং রেজেক্সপ মিল সমর্থিত নয়।

TIMESTAMP ফিল্ডে = , < , <= , > , এবং >= অপারেটরগুলো সমর্থিত। টাইমস্ট্যাম্প অবশ্যই RFC-3339 ফরম্যাটে হতে হবে, যেমন, "2025-01-01T00:00:00Z" ।

আপনি AND , OR , এবং NOT (বা - ) লজিক্যাল অপারেটর ব্যবহার করে এক্সপ্রেশন একত্রিত করতে পারেন। AND এর চেয়ে OR অগ্রাধিকার বেশি। সুস্পষ্ট অগ্রাধিকার গ্রুপিংয়ের জন্য প্রথম বন্ধনী ব্যবহার করুন।

উদাহরণ:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter স্ট্রিং অবশ্যই ৫০০ অক্ষরের বেশি হবে না; ৫০০ অক্ষরের চেয়ে দীর্ঘ মানের ফলে INVALID_ARGUMENT ত্রুটি দেখা দেবে।

অনুরোধকারী শরীর

অনুরোধের মূল অংশ অবশ্যই খালি হতে হবে।

প্রতিক্রিয়া সংস্থা

DeveloperKnowledge.SearchDocumentChunks এর জন্য প্রতিক্রিয়া বার্তা।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
ক্ষেত্র
results[]

object ( DocumentChunk )

প্রদত্ত কোয়েরির জন্য অনুসন্ধানের ফলাফল এখানে রয়েছে। এই তালিকার প্রতিটি DocumentChunk এ অনুসন্ধান কোয়েরির সাথে প্রাসঙ্গিক বিষয়বস্তুর একটি অংশ থাকে। সম্পূর্ণ ডকুমেন্টের বিষয়বস্তু পেতে DeveloperKnowledge.GetDocument অথবা DeveloperKnowledge.BatchGetDocuments এর সাথে প্রতিটি ফলাফলের DocumentChunk.parent ফিল্ডটি ব্যবহার করুন।

nextPageToken

string

ঐচ্ছিক। এটি এমন একটি টোকেন প্রদান করে যা পরবর্তী পৃষ্ঠা আনার জন্য pageToken হিসেবে পাঠানো যেতে পারে। এই ক্ষেত্রটি পূরণ না করা হলে, পরবর্তী কোনো পৃষ্ঠা থাকবে না।

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, দেখুনOAuth 2.0 Overview .

ডকুমেন্টচাঙ্ক

একটি DocumentChunk হলো DeveloperKnowledge কর্পাসের কোনো একটি Document এর বিষয়বস্তুর অংশ। সম্পূর্ণ Document-এর বিষয়বস্তু পেতে, DeveloperKnowledge.GetDocument অথবা DeveloperKnowledge.BatchGetDocuments এ parent পাস করুন।

JSON উপস্থাপনা 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
ক্ষেত্র
parent

string

শুধুমাত্র আউটপুট। এতে সেই ডকুমেন্টের রিসোর্স নামটি থাকে যেখান থেকে এই অংশটি নেওয়া হয়েছে। ফরম্যাট: documents/{uri_without_scheme} উদাহরণ: documents/docs.cloud.google.com/storage/docs/creating-buckets

id

string

শুধুমাত্র আউটপুট। ডকুমেন্টের মধ্যে এই চাঙ্কের আইডি নির্দিষ্ট করে। চাঙ্ক আইডি একটি ডকুমেন্টের মধ্যে অনন্য, কিন্তু ডকুমেন্টগুলোর মধ্যে বিশ্বব্যাপী অনন্য নয়। চাঙ্ক আইডি স্থিতিশীল নয় এবং সময়ের সাথে সাথে পরিবর্তিত হতে পারে।

content

string

শুধুমাত্র আউটপুট। এতে ডকুমেন্ট চাঙ্কের বিষয়বস্তু থাকে।

document

object ( Document )

শুধুমাত্র আউটপুট। এটি যে ডকুমেন্ট থেকে নেওয়া হয়েছে, সেই Document মেটাডেটা উপস্থাপন করে। এই Document মেসেজের DocumentView DOCUMENT_VIEW_BASIC এ সেট করা হবে। এটি এখানে সুবিধার জন্য অন্তর্ভুক্ত করা হয়েছে, যাতে ক্লায়েন্টদের শুধুমাত্র মেটাডেটা ফিল্ডগুলির প্রয়োজন হলে DeveloperKnowledge.GetDocument বা DeveloperKnowledge.BatchGetDocuments কল করার প্রয়োজন না হয়। অন্যথায়, সম্পূর্ণ ডকুমেন্টের বিষয়বস্তু আনার জন্য ক্লায়েন্টদের DeveloperKnowledge.GetDocument বা DeveloperKnowledge.BatchGetDocuments ব্যবহার করা উচিত।