Documents

ফাইল সার্চ এপিআই আপনার কাঁচা উৎস ফাইল বা নথিগুলিকে অস্থায়ী ফাইল অবজেক্ট হিসেবে উল্লেখ করে।

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

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

শেষবিন্দু

https মুছে ফেলুন 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

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

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

অনুরোধের মূল অংশ

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

প্রতিক্রিয়া মূল অংশ

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

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

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

শেষবিন্দু

https পান 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 তালিকাভুক্ত করে।

শেষবিন্দু

https পান https: / /generativelanguage.googleapis.com /v1beta /{parent=fileSearchStores /*} /documents

পথের পরামিতি

parent string

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

displayName string

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

customMetadata[] object ( CustomMetadata )

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

updateTime string ( Timestamp format)

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

RFC 3339 ব্যবহার করে, যেখানে উৎপন্ন আউটপুট সর্বদা Z-স্বাভাবিক হবে এবং 0, 3, 6 অথবা 9 ভগ্নাংশ সংখ্যা ব্যবহার করবে। "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-স্বাভাবিক হবে এবং 0, 3, 6 অথবা 9 ভগ্নাংশ সংখ্যা ব্যবহার করবে। "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
value নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
stringValue string

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

stringListValue object ( StringList )

সংরক্ষণের জন্য মেটাডেটার 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 প্রক্রিয়াকরণে ব্যর্থ হয়েছে।