Documents

تشير File Search API إلى ملفات المصدر الأولية أو المستندات كعناصر File مؤقتة.

الطريقة: fileSearchStores.documents.delete

يحذف Document.

نقطة نهاية

delete 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

اختيارية: في حال ضبطها على "صحيح"، سيتم أيضًا حذف أي Chunk وعناصر مرتبطة بهذا Document.

إذا كانت القيمة خطأ (القيمة التلقائية)، سيتم عرض الخطأ FAILED_PRECONDITION إذا كان Document يحتوي على أي Chunk.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيكون نص الاستجابة عبارة عن كائن 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

تعرض هذه السمة جميع Document في Corpus.

نقطة نهاية

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

مَعلمات المسار

parent string

الحقل مطلوب. اسم FileSearchStore الذي يحتوي على Document مثال: fileSearchStores/my-file-search-store-123 ويكون بالتنسيق التالي: fileSearchStores/{filesearchstore}.

مَعلمات طلب البحث

pageSize integer

اختيارية: الحد الأقصى لعدد Documents التي سيتم عرضها (في كل صفحة) قد تعرض الخدمة عددًا أقل من Document.

إذا لم يتم تحديد عدد، سيتم عرض 10 Document على الأكثر. الحدّ الأقصى للحجم هو 20 Document لكل صفحة.

pageToken string

اختيارية: رمز مميز للصفحة تم تلقّيه من طلب documents.list سابق.

قدِّم nextPageToken الذي تم عرضه في الرد كمعلَمة للطلب التالي لاسترداد الصفحة التالية.

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى documents.list مع الطلب الذي قدَّم الرمز المميّز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

استجابة من documents.list تحتوي على قائمة مقسّمة إلى صفحات من Document. يتم ترتيب Document حسب document.create_time تصاعديًا.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

الحقول
documents[] object (Document)

تمثّل هذه السمة Documents التي تم إرجاعها.

nextPageToken string

رمز مميز يمكن إرساله كـ pageToken لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، لن يكون هناك المزيد من الصفحات.

تمثيل JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

مورد REST: ‏ fileSearchStores.documents

المورد: مستند

Document هي مجموعة من Chunk.

الحقول
name string

غير قابل للتغيير المعرّف تمثّل هذه السمة Document اسم المورد. يمكن أن يحتوي المعرّف (الاسم باستثناء البادئة "fileSearchStores/*/documents/") على ما يصل إلى 40 حرفًا أبجديًا رقميًا صغيرًا أو شرطة (-)، ولا يمكن أن يبدأ المعرّف أو ينتهي بشرطة. إذا كان الاسم فارغًا عند الإنشاء، سيتم استخلاص اسم فريد من displayName مع لاحقة عشوائية مكوّنة من 12 حرفًا. مثال: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

displayName string

اختيارية: تمثّل هذه السمة الاسم المعروض Document الذي يمكن للمستخدم قراءته. يجب ألا يزيد طول الاسم المعروض عن 512 حرفًا، بما في ذلك المسافات. مثال: "مستندات Semantic Retriever"

customMetadata[] object (CustomMetadata)

اختيارية: البيانات الوصفية المخصّصة المقدَّمة من المستخدِم والمخزَّنة كأزواج من المفاتيح والقيم والمستخدَمة في طلبات البحث يمكن أن يحتوي Document على 20 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

النتائج فقط. نوع MIME الخاص بالمستند.

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

CustomMetadata

البيانات الوصفية المقدَّمة من المستخدِم والمخزَّنة في صورة أزواج المفتاح/القيمة

الحقول
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
}

StringList

قيم السلسلة المقدَّمة من المستخدِم والمخصّصة لمفتاح بيانات وصفية واحد

الحقول
values[] string

قيم السلسلة للبيانات الوصفية التي سيتم تخزينها.

تمثيل JSON 
{
  "values": [
    string
  ]
}

ولاية

حالات مراحل نشاط Document

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية يتم استخدام هذه القيمة في حال حذف الولاية.
STATE_PENDING تتم معالجة بعض Chunks من Document (التضمين وتخزين المتجهات).
STATE_ACTIVE تتم معالجة كل Chunks في Document وتصبح متاحة للاستعلام.
STATE_FAILED تعذّر معالجة بعض Chunks في Document.