Documents

ফাইল সার্চ এপিআই আপনার মূল সোর্স ফাইল বা ডকুমেন্টগুলোকে অস্থায়ী ফাইল অবজেক্ট হিসেবে রেফারেন্স করে।

পদ্ধতি: fileSearchStores.documents.delete

একটি Document মুছে ফেলে।

এন্ডপয়েন্ট

https: / /generativelanguage.googleapis.com /v1beta /{name=fileSearchStores /* /documents /*} মুছে ফেলুন

পথের পরামিতি

name string

আবশ্যক। যে Document মুছে ফেলতে হবে তার রিসোর্স নেম। উদাহরণ: fileSearchStores/my-file-search-store-123/documents/the-doc-abc এর গঠনটি হলো fileSearchStores/{filesearchstore}/documents/{document} ।

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

force boolean

ঐচ্ছিক। যদি এটি 'true' সেট করা হয়, তাহলে এই Document সাথে সম্পর্কিত যেকোনো Chunk এবং অবজেক্টও মুছে ফেলা হবে।

যদি false (ডিফল্ট) হয়, এবং Document কোনো Chunk থাকে, তাহলে একটি FAILED_PRECONDITION error ফেরত দেওয়া হবে।

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

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

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

সফল হলে, রেসপন্স বডিটি একটি খালি JSON অবজেক্ট হয়।

পদ্ধতি: fileSearchStores.documents.get

একটি নির্দিষ্ট Document সম্পর্কে তথ্য পায়।

এন্ডপয়েন্ট

get https: / /generativelanguage.googleapis.com /v1beta /{name=fileSearchStores /* /documents /*}

পথের পরামিতি

name string

আবশ্যক। যে Document পুনরুদ্ধার করতে হবে তার নাম। উদাহরণ: fileSearchStores/my-file-search-store-123/documents/the-doc-abc এর গঠনটি হলো fileSearchStores/{filesearchstore}/documents/{document} ।

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

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

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

সফল হলে, রেসপন্স বডিতে Document এর একটি ইনস্ট্যান্স থাকে।

পদ্ধতি: fileSearchStores.documents.list

একটি Corpus অন্তর্গত সমস্ত Document তালিকা দেখায়।

এন্ডপয়েন্ট

get https: / /generativelanguage.googleapis.com /v1beta /{parent=fileSearchStores /*} /documents

পথের পরামিতি

parent string

আবশ্যক। যে FileSearchStore Document রয়েছে তার নাম। উদাহরণ: fileSearchStores/my-file-search-store-123 এর গঠনটি হলো fileSearchStores/{filesearchstore} ।

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

pageSize integer

ঐচ্ছিক। ফেরত দেওয়া হবে এমন Document সর্বোচ্চ সংখ্যা (প্রতি পৃষ্ঠায়)। পরিষেবাটি এর চেয়ে কম Document ফেরত দিতে পারে।

অনির্দিষ্ট থাকলে, সর্বাধিক ১০টি Document ফেরত দেওয়া হবে। প্রতি পৃষ্ঠায় সর্বোচ্চ আকারের সীমা হলো ২০টি Document ।

pageToken string

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

পরবর্তী পৃষ্ঠাটি পাওয়ার জন্য, রেসপন্সে প্রাপ্ত nextPageToken টি পরবর্তী রিকোয়েস্টের আর্গুমেন্ট হিসেবে প্রদান করুন।

পেজিনেশন করার সময়, documents.list এ প্রদত্ত অন্য সকল প্যারামিটার অবশ্যই সেই কলের সাথে মিলতে হবে যা পেজ টোকেনটি প্রদান করেছে।

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

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

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

documents.list থেকে প্রাপ্ত প্রতিক্রিয়া, যাতে Document গুলোর একটি পৃষ্ঠাযুক্ত তালিকা রয়েছে। Document গুলো document.create_time অনুসারে আরোহী ক্রমে সাজানো আছে।

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

ক্ষেত্র
documents[] object ( Document )

ফেরত দেওয়া Document ।

nextPageToken string

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

JSON উপস্থাপনা 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

REST রিসোর্স: fileSearchStores.documents

উৎস: নথি

একটি Document হলো একাধিক Chunk সমষ্টি।

ক্ষেত্র
name string

অপরিবর্তনীয়। শনাক্তকারী। Document রিসোর্সের নাম। আইডি (নাম থেকে "fileSearchStores/*/documents/" প্রিফিক্স বাদে) ৪০টি পর্যন্ত ছোট হাতের অক্ষর, সংখ্যা বা ড্যাশ (-) দিয়ে গঠিত হতে পারে। আইডি ড্যাশ দিয়ে শুরু বা শেষ হতে পারবে না। তৈরির সময় নামটি খালি থাকলে, displayName সাথে একটি ১২ অক্ষরের র‍্যান্ডম সাফিক্স যোগ করে একটি অনন্য নাম তৈরি করা হবে। উদাহরণ: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

displayName string

ঐচ্ছিক। Document জন্য মানুষের পাঠযোগ্য প্রদর্শিত নাম। স্পেস সহ প্রদর্শিত নামটি অবশ্যই ৫১২ অক্ষরের বেশি হবে না। উদাহরণ: "Semantic Retriever Documentation"

customMetadata[] object ( CustomMetadata )

ঐচ্ছিক। ব্যবহারকারীর দেওয়া কাস্টম মেটাডেটা কী-ভ্যালু পেয়ার হিসেবে সংরক্ষিত থাকে, যা কোয়েরি করার জন্য ব্যবহৃত হয়। একটি Document সর্বোচ্চ ২০টি CustomMetadata থাকতে পারে।

updateTime string ( Timestamp format)

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

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

createTime string ( Timestamp format)

শুধুমাত্র আউটপুট। Document তৈরি হওয়ার টাইমস্ট্যাম্প।

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

state enum ( State )

শুধুমাত্র আউটপুট। Document বর্তমান অবস্থা।

sizeBytes string ( int64 format)

শুধুমাত্র আউটপুট। ডকুমেন্টে অন্তর্ভুক্ত করা মূল বাইটের আকার।

mimeType string

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

JSON উপস্থাপনা 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

কাস্টম মেটাডেটা

ব্যবহারকারীর দেওয়া মেটাডেটা কী-ভ্যালু পেয়ার হিসেবে সংরক্ষিত থাকে।

ক্ষেত্র
key string

প্রয়োজনীয়। সংরক্ষণ করার জন্য মেটাডেটার কী।

value Union type
নিম্নলিখিতটি হলো পারস্পরিকভাবে বর্জনীয় ফিল্ডগুলির একটি তালিকা। একটি উত্তরে এই ফিল্ডগুলির মধ্যে সর্বাধিক একটি সেট করা হবে:
stringValue string

সংরক্ষণ করার জন্য মেটাডেটার স্ট্রিং মান।

stringListValue object ( StringList )

সংরক্ষণ করার জন্য মেটাডেটার স্ট্রিংলিস্ট মান।

numericValue number

সংরক্ষণ করার জন্য মেটাডেটার সাংখ্যিক মান।

পারস্পরিকভাবে বর্জনশীল ক্ষেত্রসমূহের সমাপ্তি।
JSON উপস্থাপনা 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

স্ট্রিংলিস্ট

ব্যবহারকারী কর্তৃক প্রদত্ত স্ট্রিং মানগুলো একটিমাত্র মেটাডেটা কী-তে বরাদ্দ করা হয়েছে।

ক্ষেত্র
values[] string

সংরক্ষণ করার জন্য মেটাডেটার স্ট্রিং মানগুলো।

JSON উপস্থাপনা 
{
  "values": [
    string
  ]
}

রাজ্য

একটি Document জীবনচক্রের অবস্থাসমূহ।

এনাম
STATE_UNSPECIFIED ডিফল্ট মান। স্টেটটি উল্লেখ না করা হলে এই মানটি ব্যবহৃত হয়।
STATE_PENDING Document কিছু Chunks প্রক্রিয়াজাত করা হচ্ছে (এম্বেডিং এবং ভেক্টর স্টোরেজ)।
STATE_ACTIVE Document সমস্ত Chunks প্রক্রিয়াজাত করা হয়েছে এবং অনুসন্ধানের জন্য উপলব্ধ আছে।
STATE_FAILED Document কিছু Chunks প্রক্রিয়াকরণে ব্যর্থ হয়েছে।