REST Resource: corpora.documents

المرجع: مستند

Document هي مجموعة من Chunk. يمكن أن يتضمّن Corpus 10,000 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.