REST Resource: corpora.documents

منبع: سند

A Document مجموعه ای از Chunk s است. یک Corpus می تواند حداکثر 10000 Document داشته باشد.

نمایندگی JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
زمینه های
name

string

تغییرناپذیر. مشخص کننده. نام منبع Document . شناسه (نام بدون پیشوند "corpora/*/documents/") می‌تواند حداکثر دارای 40 کاراکتر باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد از displayName به همراه یک پسوند تصادفی 12 کاراکتری مشتق می شود. مثال: 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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

createTime

string ( Timestamp format)

فقط خروجی مهر زمانی از زمان ایجاد Document .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

مواد و روش ها

create

 یک Document خالی ایجاد می کند.

delete

 یک Document را حذف می کند.

get

 اطلاعات مربوط به یک Document خاص را دریافت می کند.

list

 تمام Document موجود در یک Corpus را فهرست می کند.

patch

 یک Document را به روز می کند.

query

 جستجوی معنایی را روی یک Document انجام می دهد.