Package google.developers.knowledge.v1alpha

সূচি

DeveloperKnowledge

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

Google-এর ডেভেলপার ডকুমেন্টেশনে মেশিনের ক্ষেত্রে গ্রহণযোগ্য অ্যাক্সেসের জন্য ক্যানোনিকাল সোর্স হিসেবে API ডিজাইন করা হয়েছে।

সাধারণত, প্রথমে DeveloperKnowledge.SearchDocumentChunks ব্যবহার করে কোনও কোয়েরির ভিত্তিতে প্রাসঙ্গিক ডকুমেন্টের অংশ খুঁজে নেওয়া হয় এবং তারপর ডকুমেন্ট রিসোর্সের নাম (যেমন DocumentChunk.parent বা documents/{uri_without_scheme}) সহ DeveloperKnowledge.GetDocument বা DeveloperKnowledge.BatchGetDocuments ব্যবহার করে সেরা ফলাফলের সম্পূর্ণ কন্টেন্ট নিয়ে আসা হয়।

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

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

গ্রাউন্ডেড জেনারেশন ব্যবহার করে কোয়েরির উত্তর দেয়।

অনুমোদনের স্কোপ

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

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

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

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

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

অনুমোদনের স্কোপ

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

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

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

rpc GetDocument(GetDocumentRequest) returns (Document)

সম্পূর্ণ Markdown কন্টেন্ট সহ একটি ডকুমেন্ট ফিরিয়ে আনে।

অনুমোদনের স্কোপ

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

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

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

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

অনুমোদনের স্কোপ

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

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

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

উত্তর

কোনও কোয়েরির উত্তর।

ফিল্ড
answer_text

string

উত্তরের টেক্সট থাকে।
citations[]

AnswerCitation

শুধু আউটপুট। উত্তরের জন্য সাইটেশন রয়েছে।
references[]

AnswerReference

শুধু আউটপুট। উত্তরের জন্য রেফারেন্স রয়েছে।

AnswerCitation

কোনও সেগমেন্টের জন্য উদ্ধৃতি সংক্রান্ত তথ্য।

ফিল্ড
start_index

int32

শুধু আউটপুট। সেগমেন্টের শুরু নির্দেশ করে, বাইটে (UTF-8 ইউনিকোড) পরিমাপ করা হয়, অন্তর্ভুক্ত। মাল্টি-বাইট অক্ষর, যেমন ASCII নয় এমন অক্ষর থাকলে, ইন্ডেক্স পরিমাপ স্ট্রিংয়ের দৈর্ঘ্যের চেয়ে বেশি হয়।
end_index

int32

শুধু আউটপুট। সেগমেন্টের শেষ নির্দেশ করে, বাইটে (UTF-8 ইউনিকোড) পরিমাপ করা হয়, এক্সক্লুসিভ। মাল্টি-বাইট অক্ষর, যেমন ASCII নয় এমন অক্ষর থাকলে, ইন্ডেক্স পরিমাপ স্ট্রিংয়ের দৈর্ঘ্যের চেয়ে বেশি হয়।
sources[]

CitationSource

শুধু আউটপুট। অ্যাট্রিবিউট করা সেগমেন্টের জন্য সাইটেশন সোর্স আছে।

AnswerReference

কোনও সোর্সের রেফারেন্স দেখায়।

ফিল্ড
ইউনিয়ন ফিল্ড content। রেফারেন্সের কন্টেন্ট থাকে। content শুধুমাত্র নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
document_reference

DocumentReference

শুধু আউটপুট। রেফারেন্স ডকুমেন্ট।

CitationSource

সাইটেশন সোর্স।

ফিল্ড
reference_index

int32

শুধু আউটপুট। references রিপিট করা ফিল্ডে Answer.AnswerReference-এর ইন্ডেক্স থাকে।

DocumentReference

ডকুমেন্টের রেফারেন্স দেখায়।

ফিল্ড
document_chunk

DocumentChunk

শুধু আউটপুট। ডকুমেন্টের চাঙ্ক রয়েছে। document_chunk.id ফিল্ড সেট করা হয়নি এবং খালি থাকবে।

AnswerQueryRequest

DeveloperKnowledge.AnswerQuery-এর জন্য অনুরোধের মেসেজ।

ফিল্ড
query

string

প্রয়োজনীয়। কোয়েরির উত্তর দিতে হবে।
filter

string

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

ফিল্টার করার জন্য কাজ করে এমন ফিল্ড:

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

INTEGER ফিল্ডে =, <, <=, > এবং >= অপারেটর কাজ করে।

STRING ফিল্ডে সম্পূর্ণ স্ট্রিংয়ের সম্পূর্ণ মিল-এর জন্য = (সমান) এবং != (সমান নয়) অপারেটর কাজ করে। আংশিক ম্যাচ, প্রিফিক্স ম্যাচ ও regexp ম্যাচ কাজ করে না।

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

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

উদাহরণ:

  • Document.content_length_bytes অনুযায়ী ফিল্টার করুন: content_length_bytes < 50000
  • 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 সমস্যা দেখা দেবে।

AnswerQueryResponse

DeveloperKnowledge.AnswerQuery-এর জন্য উত্তর মেসেজ।

ফিল্ড
answer

Answer

কোয়েরির উত্তর।

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments-এর জন্য অনুরোধের মেসেজ।

ফিল্ড
names[]

string

প্রয়োজনীয়। যেসব ডকুমেন্ট ফিরিয়ে আনতে হবে সেগুলির নাম উল্লেখ করে। একটি ব্যাচে সর্বাধিক ২০টি ডকুমেন্ট রিট্রিভ করা যাবে। অনুরোধে names-এর মতো একই ক্রমে ডকুমেন্টগুলি ফেরত দেওয়া হয়।

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

প্রতিটি নাম ৫০০ অক্ষরের বেশি হওয়া চলবে না; ৫০০ অক্ষরের বেশি হলে INVALID_ARGUMENT সমস্যা হবে।
view

DocumentView

ঐচ্ছিক। ডকুমেন্টের DocumentView নির্দিষ্ট করে। উল্লেখ করা না থাকলে, DeveloperKnowledge.BatchGetDocuments ডিফল্ট হিসেবে DOCUMENT_VIEW_CONTENT-এ সেট করা থাকে।

BatchGetDocumentsResponse

DeveloperKnowledge.BatchGetDocuments-এর জন্য উত্তর মেসেজ।

ফিল্ড
documents[]

Document

অনুরোধ করা ডকুমেন্ট রয়েছে।

দস্তাবেজ

ডকুমেন্ট বলতে ডেভেলপার নলেজ কর্পাসে ডকুমেন্টেশনের একটি পৃষ্ঠাকে বোঝায়, যেমন https://docs.cloud.google.com/storage/docs/creating-buckets লিঙ্কের পৃষ্ঠা।

ফিল্ড
name

string

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

string

শুধু আউটপুট। কন্টেন্টের URI প্রদান করে, যেমন https://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 নির্দিষ্ট করে।
content_length_bytes

int32

শুধু আউটপুট। content ফিল্ডের দৈর্ঘ্য, বাইটের হিসেবে।

DocumentChunk

DocumentChunk, DeveloperKnowledge কর্পাসে Document থেকে কন্টেন্টের একটি অংশকে দেখায়। সম্পূর্ণ ডকুমেন্টের কন্টেন্ট ফেচ করতে, parent-কে DeveloperKnowledge.GetDocument বা DeveloperKnowledge.BatchGetDocuments-এ পাস করুন।

ফিল্ড
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 ব্যবহার করা উচিত।
relevance_score

double

শুধু আউটপুট। সার্চ কোয়েরির সাথে চাঙ্কের প্রাসঙ্গিকতা স্কোর দেখায়। বেশি স্কোর বেশি চাঙ্ক প্রাসঙ্গিকতা নির্দেশ করে। স্কোর [০.০, ১.০] রেঞ্জের মধ্যে আছে।

DocumentView

Document-এর কোন কোন ফিল্ড অন্তর্ভুক্ত করা হয়েছে তা নির্দিষ্ট করে।

Enums
DOCUMENT_VIEW_UNSPECIFIED ডিফল্ট / সেট না করা ভ্যালু। DocumentView উল্লেখ করা না থাকলে, প্রতিটি API মেথডের ডিফল্ট ভ্যালু দেখুন।
DOCUMENT_VIEW_BASIC

শুধুমাত্র প্রাথমিক মেটাডেটা ফিল্ড অন্তর্ভুক্ত করে:

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

এটি DeveloperKnowledge.SearchDocumentChunks-এর ডিফল্ট ভিউ।
DOCUMENT_VIEW_FULL সব Documentটি ফিল্ড অন্তর্ভুক্ত করে।
DOCUMENT_VIEW_CONTENT

DOCUMENT_VIEW_BASIC ফিল্ড এবং content ফিল্ড অন্তর্ভুক্ত করে।

এটি DeveloperKnowledge.GetDocument ও DeveloperKnowledge.BatchGetDocuments-এর জন্য ডিফল্ট ভিউ।

GetDocumentRequest

DeveloperKnowledge.GetDocument-এর জন্য অনুরোধের মেসেজ।

ফিল্ড
name

string

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

নাম ৫০০ অক্ষরের বেশি হলে চলবে না; ৫০০ অক্ষরের বেশি হলে INVALID_ARGUMENT সমস্যা হবে।
view

DocumentView

ঐচ্ছিক। ডকুমেন্টের DocumentView নির্দিষ্ট করে। উল্লেখ করা না থাকলে, DeveloperKnowledge.GetDocument ডিফল্ট হিসেবে DOCUMENT_VIEW_CONTENT-এ সেট করা থাকে।

SearchDocumentChunksRequest

DeveloperKnowledge.SearchDocumentChunks-এর জন্য অনুরোধের মেসেজ।

ফিল্ড
query

string

প্রয়োজনীয়। ব্যবহারকারীর দেওয়া র' কোয়েরি স্ট্রিং প্রদান করে, যেমন "কীভাবে Cloud Storage বাকেট তৈরি করতে হয়?"। কোয়েরি ৫০০ অক্ষরের বেশি হলে চলবে না; ৫০০ অক্ষরের বেশি হলে INVALID_ARGUMENT সমস্যা হবে।
page_size

int32

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

অনির্দিষ্ট থাকলে, সর্বাধিক ৫টি ফলাফল দেখানো হবে।

সর্বাধিক মান হল ১০০; ১০০-এর বেশি মানকে ১০০-তে পরিবর্তন করা হবে।
page_token

string

ঐচ্ছিক। এতে একটি পৃষ্ঠা টোকেন রয়েছে, যা আগের SearchDocumentChunks কল থেকে পাওয়া গেছে। পরবর্তী পৃষ্ঠাটি ফিরিয়ে আনতে এটি প্রদান করুন।
filter

string

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

SearchDocumentChunks-এর মাধ্যমে DocumentChunk পাওয়া গেলেও, ফিল্টারটি DocumentChunk.document ফিল্ডে প্রয়োগ করা হয়।

ফিল্টার করার জন্য কাজ করে এমন ফিল্ড:

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

INTEGER ফিল্ডে =, <, <=, > এবং >= অপারেটর কাজ করে।

STRING ফিল্ডে সম্পূর্ণ স্ট্রিংয়ের সম্পূর্ণ মিল-এর জন্য = (সমান) এবং != (সমান নয়) অপারেটর কাজ করে। আংশিক ম্যাচ, প্রিফিক্স ম্যাচ ও regexp ম্যাচ কাজ করে না।

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

মনে রাখবেন: ফিল্ডের নাম অবশ্যই snake_case (যেমন, data_source) হতে হবে। ফিল্টারিং এক্সপ্রেশনের ডানদিকের মান অবশ্যই ডবল কোটে লেখা স্ট্রিং লিটারেল হতে হবে (যেমন, "docs.cloud.google.com")।

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

উদাহরণ:

  • Document.content_length_bytes অনুযায়ী ফিল্টার করুন: content_length_bytes < 50000
  • 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 হিসাবে পাঠানো যেতে পারে। এই ফিল্ড বাদ দেওয়া হলে, পরবর্তী কোনও পৃষ্ঠা থাকবে না।