REST Resource: documents

উৎস: নথি

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

JSON উপস্থাপনা
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
ক্ষেত্র
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

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

dataSource

string

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

title

string

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

updateTime

string ( Timestamp format)

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

RFC 3339 ব্যবহার করা হয়, যেখানে তৈরি হওয়া আউটপুট সর্বদা Z-নরম্যালাইজড হবে এবং এতে ০, ৩, ৬ বা ৯টি ভগ্নাংশীয় অঙ্ক ব্যবহৃত হবে। "Z" ছাড়াও অন্যান্য অফসেটও গ্রহণ করা হয়। উদাহরণ: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" অথবা "2014-10-02T15:01:23+05:30"

view

enum ( DocumentView )

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

ডকুমেন্টভিউ

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

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

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

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

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

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

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

পদ্ধতি

batchGet

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

get

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

searchDocumentChunks

গুগলের ডেভেলপার ডকুমেন্টেশন থেকে ডেভেলপার জ্ঞান অনুসন্ধান করা হয়।