REST সম্পদ: corpora.documents
সম্পদ: নথি
একটি Document
হল Chunk
একটি সংগ্রহ। একটি Corpus
সর্বাধিক 10,000টি Document
থাকতে পারে৷
JSON প্রতিনিধিত্ব |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
name
string
অপরিবর্তনীয়। শনাক্তকারী। Document
সম্পদ নাম. আইডি ("কর্পোরা/*/ডকুমেন্টস/" উপসর্গ ব্যতীত নাম) 40টি পর্যন্ত অক্ষর থাকতে পারে যা ছোট হাতের বর্ণমালা বা ড্যাশ (-)। আইডি ড্যাশ দিয়ে শুরু বা শেষ হতে পারে না। নামটি তৈরিতে খালি থাকলে, 12 অক্ষরের র্যান্ডম প্রত্যয় সহ displayName
থেকে একটি অনন্য নাম নেওয়া হবে। উদাহরণ: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
ঐচ্ছিক। Document
জন্য মানব-পাঠযোগ্য প্রদর্শন নাম। প্রদর্শনের নামটি স্পেস সহ দৈর্ঘ্যে 512 অক্ষরের বেশি হওয়া উচিত নয়। উদাহরণ: "সিমান্টিক রিট্রিভার ডকুমেন্টেশন"
customMetadata[]
object ( CustomMetadata
)
ঐচ্ছিক। ব্যবহারকারী প্রদত্ত কাস্টম মেটাডেটা প্রশ্ন করার জন্য ব্যবহৃত কী-মান জোড়া হিসাবে সংরক্ষণ করা হয়েছে। একটি Document
সর্বাধিক 20টি CustomMetadata
থাকতে পারে৷
updateTime
string ( Timestamp
format)
শুধুমাত্র আউটপুট। Document
শেষবার কখন আপডেট করা হয়েছিল তার টাইমস্ট্যাম্প৷
RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: "2014-10-02T15:01:23Z"
এবং "2014-10-02T15:01:23.045123456Z"
।
createTime
string ( Timestamp
format)
শুধুমাত্র আউটপুট। Document
কখন তৈরি করা হয়েছিল তার টাইমস্ট্যাম্প৷
RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: "2014-10-02T15:01:23Z"
এবং "2014-10-02T15:01:23.045123456Z"
।
পদ্ধতি: corpora.documents.create
একটি খালি Document
তৈরি করে।
শেষপ্রান্ত
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
পোস্ট করুনপাথ প্যারামিটার
parent
string
প্রয়োজন। Corpus
নাম যেখানে এই Document
তৈরি করা হবে। উদাহরণ: corpora/my-corpus-123
এটি corpora/{corpora}
রূপ নেয়।
শরীরের অনুরোধ
অনুরোধের অংশে Document
একটি উদাহরণ রয়েছে।
প্রতিক্রিয়া শরীর
সফল হলে, রেসপন্স বডিতে Document
একটি নতুন তৈরি ইনস্ট্যান্স থাকে।
পদ্ধতি: corpora.documents.list
একটি Corpus
সমস্ত Document
তালিকা করে।
শেষপ্রান্ত
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
পানপাথ প্যারামিটার
parent
string
প্রয়োজন। Document
s সম্বলিত Corpus
নাম। উদাহরণ: corpora/my-corpus-123
এটি corpora/{corpora}
রূপ নেয়।
ক্যোয়ারী প্যারামিটার
pageSize
integer
ঐচ্ছিক। Document
সর্বোচ্চ সংখ্যক ফেরত দিতে হবে (প্রতি পৃষ্ঠায়)। পরিষেবাটি কম Document
ফেরত দিতে পারে৷
অনির্দিষ্ট থাকলে, সর্বাধিক 10টি Document
ফেরত দেওয়া হবে৷ সর্বোচ্চ আকারের সীমা প্রতি পৃষ্ঠায় 20টি Document
।
pageToken
string
ঐচ্ছিক। একটি পৃষ্ঠা টোকেন, একটি পূর্ববর্তী documents.list
কল থেকে প্রাপ্ত।
পরবর্তী পৃষ্ঠাটি পুনরুদ্ধার করার জন্য পরবর্তী অনুরোধের যুক্তি হিসাবে প্রতিক্রিয়াতে ফেরত দেওয়া nextPageToken
প্রদান করুন।
পেজিনেট করার সময়, documents.list
এ প্রদত্ত অন্যান্য সমস্ত প্যারামিটার অবশ্যই পেজ টোকেন প্রদানকারী কলের সাথে মেলে।
শরীরের অনুরোধ
অনুরোধের বডি খালি হতে হবে।
প্রতিক্রিয়া শরীর
Document
একটি পৃষ্ঠাযুক্ত তালিকা ধারণকারী documents.list
থেকে প্রতিক্রিয়া। Document
ক্রমবর্ধমান document.create_time
দ্বারা সাজানো হয়েছে।
সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:
documents[]
object ( Document
)
ফিরে আসা Document
গুলি.
nextPageToken
string
একটি টোকেন, যা পরবর্তী পৃষ্ঠা পুনরুদ্ধার করতে pageToken
হিসাবে পাঠানো যেতে পারে। যদি এই ক্ষেত্রটি বাদ দেওয়া হয়, তাহলে আর কোনো পৃষ্ঠা নেই।
JSON প্রতিনিধিত্ব |
---|
{
"documents": [
{
object ( |
পদ্ধতি: corpora.documents.query
একটি Document
শব্দার্থিক অনুসন্ধান সম্পাদন করে।
শেষপ্রান্ত
পোস্টhttps://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
পাথ প্যারামিটার
name
string
প্রয়োজন। প্রশ্ন করার জন্য Document
নাম। উদাহরণ: corpora/my-corpus-123/documents/the-doc-abc
এটি corpora/{corpora}/documents/{document}
ফর্ম নেয়।
শরীরের অনুরোধ
অনুরোধের অংশে নিম্নলিখিত কাঠামো সহ ডেটা রয়েছে:
query
string
প্রয়োজন। শব্দার্থিক অনুসন্ধান সঞ্চালনের জন্য ক্যোয়ারী স্ট্রিং।
resultsCount
integer
ঐচ্ছিক। সর্বোচ্চ সংখ্যক Chunk
s ফেরত দিতে হবে। পরিষেবা কম Chunk
s ফেরত দিতে পারে.
অনির্দিষ্ট থাকলে, সর্বাধিক 10টি Chunk
ফেরত দেওয়া হবে। সর্বাধিক নির্দিষ্ট ফলাফলের সংখ্যা 100।
metadataFilters[]
object ( MetadataFilter
)
ঐচ্ছিক। Chunk
মেটাডেটার জন্য ফিল্টার. প্রতিটি MetadataFilter
অবজেক্ট একটি অনন্য কী এর সাথে সঙ্গতিপূর্ণ হওয়া উচিত। একাধিক MetadataFilter
বস্তু যৌক্তিক "AND" দ্বারা যুক্ত হয়।
দ্রষ্টব্য: Document
-স্তরের ফিল্টারিং এই অনুরোধের জন্য সমর্থিত নয় কারণ একটি Document
নাম ইতিমধ্যেই নির্দিষ্ট করা আছে৷
উদাহরণ কোয়েরি: (বছর >= 2020 বা বছর <2010) এবং (জেনার = নাটক বা জেনার = অ্যাকশন)
MetadataFilter
অবজেক্ট তালিকা: মেটাডেটা ফিল্টার = [ {key = "chunk.custom_metadata.year" শর্ত = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata. " শর্ত = [{stringValue = "ড্রামা", অপারেশন = EQUAL}, {stringValue = "Action", অপারেশন = EQUAL}}]
মানগুলির একটি সংখ্যাসূচক পরিসরের জন্য উদাহরণ কোয়েরি: (বছর > 2015 এবং বছর <= 2020)
MetadataFilter
অবজেক্ট তালিকা: মেটাডেটা ফিল্টার = [ {key = "chunk.custom_metadata.year" শর্ত = [{int_value = 2015, অপারেশন = GREATER}]}, {key = "chunk.custom_metadata.year" শর্ত = [{int_value = 2020, অপারেশন = LESS_EQUAL}]}]
দ্রষ্টব্য: একই কী-এর জন্য "AND" শুধুমাত্র সাংখ্যিক মানের জন্য সমর্থিত। স্ট্রিং মান শুধুমাত্র একই কী-এর জন্য "OR" সমর্থন করে।
প্রতিক্রিয়া শরীর
প্রাসঙ্গিক খণ্ডগুলির একটি তালিকা ধারণকারী documents.query
থেকে প্রতিক্রিয়া।
সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:
relevantChunks[]
object ( RelevantChunk
)
প্রাসঙ্গিক অংশ ফিরে.
JSON প্রতিনিধিত্ব |
---|
{
"relevantChunks": [
{
object ( |
পদ্ধতি: corpora.documents.get
একটি নির্দিষ্ট Document
সম্পর্কে তথ্য পায়।
শেষপ্রান্ত
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
পানপাথ প্যারামিটার
name
string
প্রয়োজন। পুনরুদ্ধার করার জন্য Document
নাম। উদাহরণ: corpora/my-corpus-123/documents/the-doc-abc
এটি corpora/{corpora}/documents/{document}
ফর্ম নেয়।
শরীরের অনুরোধ
অনুরোধের বডি খালি হতে হবে।
প্রতিক্রিয়া শর���র
সফল হলে, প্রতিক্রিয়া বডিতে Document
একটি উদাহরণ থাকে।
পদ্ধতি: corpora.documents.patch
একটি Document
আপডেট করে।
শেষপ্রান্ত
প্যাচhttps://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
পাথ প্যারামিটার
document.name
string
অপরিবর্তনীয়। শনাক্তকারী। Document
সম্পদ নাম. আইডি ("কর্পোরা/*/ডকুমেন্টস/" উপসর্গ ব্যতীত নাম) 40টি পর্যন্ত অক্ষর থাকতে পারে যা ছোট হাতের বর্ণমালা বা ড্যাশ (-)। আইডি ড্যাশ দিয়ে শুরু বা শেষ হতে পারে না। নামটি তৈরিতে খালি থাকলে, 12 অক্ষরের র্যান্ডম প্রত্যয় সহ displayName
থেকে একটি অনন্য নাম নেওয়া হবে। উদাহরণ: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
এটি corpora/{corpora}/documents/{document}
ফর্ম নেয়।
ক্যোয়ারী প্যারামিটার
updateMask
string ( FieldMask
format)
প্রয়োজন। আপডেট করার জন্য ক্ষেত্রগুলির তালিকা৷ বর্তমানে, ����ি শুধুমাত্র displayName
এবং customMetadata
আপডেট করা সমর্থন করে।
এটি ক্ষেত্রগুলির সম্পূর্ণরূপে যোগ্য নামের একটি কমা দ্বারা পৃথক করা তালিকা৷ উদাহরণ: "user.displayName,photo"
।
শরীরের অনুরোধ
অনুরোধের অংশে Document
একটি উদাহরণ রয়েছে।
প্রতিক্রিয়া শরীর
সফল হলে, প্রতিক্রিয়া বডিতে Document
একটি উদাহরণ থাকে।
পদ্ধতি: corpora.documents.delete
একটি Document
মুছে দেয়।
শেষপ্রান্ত
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
মুছুনপাথ প্যারামিটার
name
string
প্রয়োজন। মুছে ফেলার জন্য Document
সম্পদের নাম। উদাহরণ: corpora/my-corpus-123/documents/the-doc-abc
এটি corpora/{corpora}/documents/{document}
ফর্ম নেয়।
ক্যোয়ারী প্যারামিটার
force
boolean
ঐচ্ছিক। সত্য হিসাবে সেট করা হলে, এই Document
সাথে সম্পর্কিত যেকোন Chunk
এবং বস্তুগুলিও মুছে ফেলা হবে।
যদি মিথ্যা হয় (ডিফল্ট), Document
কোনো Chunk
থাকলে একটি FAILED_PRECONDITION
ত্রুটি ফেরত দেওয়া হবে।
শরীরের অনুরোধ
অনুরোধের বডি খালি হতে হবে।
প্রতিক্রিয়া শরীর
সফল হলে, প্রতিক্রিয়া বডি খালি।
কাস্টম মেটাডেটা
ব্যবহারকারীর প্রদত্ত মেটাডেটা কী-মান জোড়া হিসাবে সংরক্ষিত।
JSON প্রতিনিধিত্ব |
---|
{ "key": string, // Union field |
key
string
প্রয়োজন। মেটাডেটা সংরক্ষণের চাবিকাঠি।
ইউনিয়ন ক্ষে��্রের value
।
value
নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
stringValue
string
সঞ্চয় করার জন্য মেটাডেটার স্ট্রিং মান।
stringListValue
object ( StringList
)
সঞ্চয় করার জন্য মেটাডেটার স্ট্রিংলিস্ট মান।
numericValue
number
সঞ্চয় করার জন্য মেটাডেটার সাংখ্যিক মান।
স্ট্রিংলিস্ট
ব্যবহারকারী প্রদত্ত স্ট্রিং মান একটি একক মেটাডেটা কীতে বরাদ্দ করা হয়েছে।
JSON প্রতিনিধিত্ব |
---|
{ "values": [ string ] } |
values[]
string
সংরক্ষণ ���রার জন্য মেটাডেটার স্ট্রিং মান।