Package google.developers.knowledge.v1

সূচী

ডেভেলপার নলেজ

ডেভেলপার নলেজ এপিআই গুগলের পাবলিক ডেভেলপার ডকুমেন্টেশনে প্রোগ্রাম্যাটিক অ্যাক্সেস প্রদান করে, যা আপনাকে এই নলেজ বেসটি আপনার নিজস্ব অ্যাপ্লিকেশন এবং ওয়ার্কফ্লোতে একীভূত করতে সক্ষম করে।

এই এপিআইটি গুগলের ডেভেলপার ডকুমেন্টেশনে মেশিন-পাঠযোগ্য অ্যাক্সেসের জন্য প্রামাণ্য উৎস হিসেবে ডিজাইন করা হয়েছে।

এর একটি সাধারণ ব্যবহার হলো, প্রথমে একটি কোয়েরির উপর ভিত্তি করে প্রাসঙ্গিক পেজ URI খুঁজে বের করার জন্য DeveloperKnowledge.SearchDocumentChunks ব্যবহার করা, এবং তারপর শীর্ষ ফলাফলগুলোর সম্পূর্ণ কন্টেন্ট ফেচ করার জন্য DeveloperKnowledge.GetDocument অথবা DeveloperKnowledge.BatchGetDocuments ব্যবহার করা।

ডকুমেন্টের সমস্ত বিষয়বস্তু মার্কডাউন ফরম্যাটে প্রদান করা হয়েছে।

ব্যাচগেটডকুমেন্টস

rpc BatchGetDocuments( BatchGetDocumentsRequest ) returns ( BatchGetDocumentsResponse )

একাধিক ডকুমেন্ট পুনরুদ্ধার করে, যার প্রতিটিতে তার সম্পূর্ণ মার্কডাউন কন্টেন্ট থাকে।

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

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

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

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

ডকুমেন্ট পান

rpc GetDocument( GetDocumentRequest ) returns ( Document )

একটিমাত্র ডকুমেন্ট তার সম্পূর্ণ মার্কডাউন বিষয়বস্তুসহ পুনরুদ্ধার করে।

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

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

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

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

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

rpc SearchDocumentChunks( SearchDocumentChunksRequest ) returns ( SearchDocumentChunksResponse )

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

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

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

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

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

ব্যাচগেটডকুমেন্টসরিকোয়েস্ট

DeveloperKnowledge.BatchGetDocuments এর জন্য অনুরোধ বার্তা।

ক্ষেত্র
names[]

string

আবশ্যক। যে নথিগুলো পুনরুদ্ধার করতে হবে, সেগুলোর নাম নির্দিষ্ট করে। একবারে সর্বোচ্চ ২০টি নথি পুনরুদ্ধার করা যাবে। অনুরোধে names যে ক্রমে রয়েছে, নথিগুলো সেই একই ক্রমে ফেরত দেওয়া হয়।

ফর্ম্যাট: documents/{uri_without_scheme} উদাহরণ: documents/docs.cloud.google.com/storage/docs/creating-buckets

view

DocumentView

ঐচ্ছিক। এটি ডকুমেন্টের DocumentView নির্দিষ্ট করে। যদি নির্দিষ্ট করা না থাকে, তাহলে DeveloperKnowledge.BatchGetDocuments ডিফল্টরূপে DOCUMENT_VIEW_CONTENT ব্যবহার করে।

ব্যাচগেটডকুমেন্টসরেসপন্স

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

ক্ষেত্র
documents[]

Document

অনুরোধ করা নথিগুলো রয়েছে।

নথি

একটি ডকুমেন্ট হলো ডেভেলপার নলেজ কর্পাস থেকে নেওয়া একটি বিষয়বস্তু।

ক্ষেত্র
name

string

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

uri

string

শুধুমাত্র আউটপুট। এটি কন্টেন্টের URI প্রদান করে, যেমন docs.cloud.google.com/storage/docs/creating-buckets ।

content

string

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

description

string

শুধুমাত্র আউটপুট। ডকুমেন্টটির একটি বিবরণ প্রদান করে।

data_source

string

শুধুমাত্র আউটপুট। ডকুমেন্টের ডেটা সোর্স নির্দিষ্ট করে। ডেটা সোর্সের উদাহরণ: firebase.google.com

title

string

শুধুমাত্র আউটপুট। ডকুমেন্টের শিরোনাম প্রদান করে।

update_time

Timestamp

শুধুমাত্র আউটপুট। এটি সেই সময়কে নির্দেশ করে, যখন ডকুমেন্টের বিষয়বস্তু বা মেটাডেটা সর্বশেষ আপডেট করা হয়েছিল।

view

DocumentView

শুধুমাত্র আউটপুট। ডকুমেন্টটির DocumentView নির্দিষ্ট করে।

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

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

ক্ষেত্র
parent

string

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

id

string

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

content

string

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

document

Document

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

ডকুমেন্টভিউ

Document কোন কোন ফিল্ড অন্তর্ভুক্ত থাকবে তা নির্দিষ্ট করে।

এনাম
DOCUMENT_VIEW_UNSPECIFIED ডিফল্ট / অনির্ধারিত মান। DocumentView নির্দিষ্ট করা না থাকলে, প্রতিটি API পদ্ধতির ডিফল্ট মান জানতে সেটি দেখুন।
DOCUMENT_VIEW_BASIC

শুধুমাত্র মৌলিক মেটাডেটা ফিল্ডগুলো অন্তর্ভুক্ত: - name - uri - data_source - title - description - update_time - view

এটি DeveloperKnowledge.SearchDocumentChunks এর ডিফল্ট ভিউ।

DOCUMENT_VIEW_FULL Document সমস্ত ফিল্ড অন্তর্ভুক্ত।
DOCUMENT_VIEW_CONTENT

এর মধ্যে DOCUMENT_VIEW_BASIC ফিল্ড এবং content ফিল্ড অন্তর্ভুক্ত রয়েছে।

এটি DeveloperKnowledge.GetDocument এবং DeveloperKnowledge.BatchGetDocuments এর ডিফল্ট ভিউ।

ডকুমেন্ট অনুরোধ পান

DeveloperKnowledge.GetDocument এর জন্য অনুরোধ বার্তা।

ক্ষেত্র
name

string

আবশ্যক। যে ডকুমেন্টটি পুনরুদ্ধার করতে হবে তার নাম উল্লেখ করুন। ফরম্যাট: documents/{uri_without_scheme} উদাহরণ: documents/docs.cloud.google.com/storage/docs/creating-buckets

view

DocumentView

ঐচ্ছিক। এটি ডকুমেন্টের DocumentView নির্দিষ্ট করে। যদি নির্দিষ্ট করা না থাকে, তাহলে DeveloperKnowledge.GetDocument ডিফল্টভাবে DOCUMENT_VIEW_CONTENT হিসেবে ব্যবহৃত হয়।

SearchDocumentChunks Request

DeveloperKnowledge.SearchDocumentChunks এর জন্য অনুরোধ বার্তা।

ক্ষেত্র
query

string

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

page_size

int32

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

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

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

page_token

string

ঐচ্ছিক। এতে একটি পেজ টোকেন থাকে, যা পূর্ববর্তী SearchDocumentChunks কল থেকে প্রাপ্ত। পরবর্তী পেজটি পুনরুদ্ধার করতে এটি প্রদান করুন।

filter

string

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

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

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

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

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

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

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

উদাহরণ:

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

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

SearchDocumentChunksResponse

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

ক্ষেত্র
results[]

DocumentChunk

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

next_page_token

string

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