Chunks

مورد REST: corpora.documents.chunks

المرجع: مقطع

Chunk هو جزء فرعي من Document يتم التعامل معه كوحدة مستقلة لأغراض تمثيل المتجه وتخزينه. ويمكن أن يصل الحد الأقصى لطول السمة Corpus إلى مليون Chunk.

تمثيل JSON 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
الحقول
name string

غير قابل للتغيير. المُعرّف. اسم المورد "Chunk". يمكن أن يحتوي رقم التعريف (الاسم باستثناء البادئة "corpora/*/documents/*/chunks/") على ما يصل إلى 40 حرفًا أبجديًا رقميًا أو شرطات (-). لا يمكن أن يبدأ المعرّف أو ينتهي بشرطة. إذا كان الاسم فارغًا عند الإنشاء، سيتم إنشاء معرّف فريد عشوائي مكوّن من 12 حرفًا. مثلاً: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

مطلوب. محتوى Chunk، مثل السلسلة النصية. الحدّ الأقصى لعدد الرموز المميّزة لكلّ مجموعة هو 2043.

customMetadata[] object (CustomMetadata)

اختياريّ. البيانات الوصفية المخصّصة التي قدّمها المستخدم والمخزّنة كأزواج من المفاتيح والقيم الحد الأقصى لعدد CustomMetadata لكل مجموعة هو 20.

createTime string (Timestamp format)

النتائج فقط. الطابع الزمني لوقت إنشاء Chunk

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

النتائج فقط. الطابع الزمني لآخر تعديل لـ "Chunk"

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

state enum (State)

النتائج فقط. حالة Chunk الحالية

ChunkData

البيانات المستخرجة التي تمثّل محتوى Chunk.

تمثيل JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
الحقول

حقل الاتحاد data.

يمكن أن يكون data واحدًا فقط مما يلي:

stringValue string

محتوى Chunk كسلسلة. الحدّ الأقصى لعدد الرموز المميّزة لكلّ مجموعة هو 2043.

الحالة

الحالات التي تنطبق فيها السمة Chunk

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية. يتم استخدام هذه القيمة إذا تم حذف الحالة.
STATE_PENDING_PROCESSING تتم معالجة Chunk (التضمين وتخزين المتجه).
STATE_ACTIVE تمت معالجة Chunk وأصبح متاحًا لطلب البحث.
STATE_FAILED تعذّرت معالجة "Chunk".

الطريقة: corpora.documents.chunks.create

ينشئ Chunk.

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

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

parent string

مطلوب. اسم Document الذي سيتم إنشاء Chunk فيه مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

يحتوي نص الطلب على مثال Chunk.

نص الاستجابة

في حال نجاح الإجراء، يحتوي نص الاستجابة على مثيل Chunk تم إنشاؤه حديثًا.

الطريقة: corpora.documents.chunks.list

يسرد جميع Chunk في Document.

نقطة نهاية

الحصول على https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

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

parent string

مطلوب. اسم Document الذي يحتوي على Chunk مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

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

pageSize integer

اختياريّ. الحد الأقصى لعدد Chunk ثانية المطلوب عرضها (لكل صفحة). قد تعرض الخدمة عددًا أقل من Chunk.

وفي حال عدم تحديد قيمة السمة، سيتم إرجاع 10 Chunk كحدّ أقصى. الحدّ الأقصى للحجم هو 100 Chunk ثانية لكل صفحة.

pageToken string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من استدعاء سابق لتطبيق "chunks.list".

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

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

نص الطلب

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

نص الاستجابة

رد من chunks.list يحتوي على قائمة مقسّمة على صفحات تضم Chunk. يتم فرز Chunk تصاعديًا chunk.create_time.

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

الحقول
chunks[] object (Chunk)

قيمتا Chunk التي تم إرجاعها

nextPageToken string

رمز مميز يمكن إرساله على شكل pageToken لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، يعني هذا أنّه لا يتوفّر المزيد من الصفحات.

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

الطريقة: corpora.documents.chunks.get

يتيح هذا الخيار الحصول على معلومات عن Chunk محدّد.

نقطة نهاية

الحصول على https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

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

name string

مطلوب. اسم Chunk المطلوب استرداده. مثال: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk تأخذ الشكل corpora/{corpora}/documents/{document}/chunks/{chunk}.

نص الطلب

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Chunk.

الطريقة: corpora.documents.chunks.patch

يعدِّل Chunk.

نقطة نهاية

رمز تصحيح https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

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

chunk.name string

غير قابل للتغيير. المُعرّف. اسم المورد "Chunk". يمكن أن يحتوي رقم التعريف (الاسم باستثناء البادئة "corpora/*/documents/*/chunks/") على ما يصل إلى 40 حرفًا أبجديًا رقميًا أو شرطات (-). لا يمكن أن يبدأ المعرّف أو ينتهي بشرطة. إذا كان الاسم فارغًا عند الإنشاء، سيتم إنشاء معرّف فريد عشوائي مكوّن من 12 حرفًا. مثال: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c تأخذ الشكل corpora/{corpora}/documents/{document}/chunks/{chunk}.

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

updateMask string (FieldMask format)

مطلوب. قائمة الحقول المطلوب تعديلها. في الوقت الحالي، يتيح هذا التحديث تحديث customMetadata وdata فقط.

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال Chunk.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Chunk.

الطريقة: corpora.documents.chunks.delete

يؤدي هذا الإجراء إلى حذف Chunk.

نقطة نهاية

حذف https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

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

name string

مطلوب. اسم المورد Chunk المطلوب حذفه. مثال: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk تأخذ الشكل corpora/{corpora}/documents/{document}/chunks/{chunk}.

نص الطلب

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة فارغًا.

الطريقة: corpora.documents.chunks.batchCreate

يتم إنشاء Chunk بشكل مجمّع.

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

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

parent string

اختياريّ. اسم Document الذي سيتم إنشاء هذه المجموعة من Chunk فيه. يجب أن يتطابق الحقل الرئيسي في كل CreateChunkRequest مع هذه القيمة. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

الحقول
requests[] object (CreateChunkRequest)

مطلوب. رسائل الطلب التي تحدِّد Chunk المطلوب إنشاؤها. يمكن إنشاء 100 Chunk كحدّ أقصى في دُفعة واحدة.

نص الاستجابة

ردّ من "chunks.batchCreate" يتضمّن قائمة بـ "Chunk" التي تم إنشاؤها

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

الحقول
chunks[] object (Chunk)

تم إنشاء Chunk.

تمثيل JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

يمكنك طلب إنشاء Chunk.

تمثيل JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
الحقول
parent string

مطلوب. اسم Document الذي سيتم إنشاء Chunk فيه مثلاً: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

مطلوب. Chunk المطلوب إنشاؤها.

الطريقة: corpora.documents.chunks.batchUpdate

التحديثات المجمّعة Chunk ثانية

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

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

parent string

اختياريّ. اسم Document الذي يتضمّن Chunk المطلوب تعديلها. يجب أن يتطابق الحقل الرئيسي في كل UpdateChunkRequest مع هذه القيمة. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

الحقول
requests[] object (UpdateChunkRequest)

مطلوب. رسائل الطلب التي تحدّد Chunk لتعديلها. يمكن تعديل 100 Chunk كحدّ أقصى في دُفعة واحدة.

نص الاستجابة

ردّ من "chunks.batchUpdate" يتضمّن قائمة بـ "Chunk" معدَّلة.

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

الحقول
chunks[] object (Chunk)

تم تعديل Chunk ثانية.

تمثيل JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

طلب تحديث Chunk

تمثيل JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
الحقول
chunk object (Chunk)

مطلوب. Chunk المطلوب تعديله.

updateMask string (FieldMask format)

مطلوب. قائمة الحقول المطلوب تعديلها. في الوقت الحالي، يتيح هذا التحديث تحديث customMetadata وdata فقط.

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

الطريقة: corpora.documents.chunks.batchDelete

حذف Chunk بشكل مجمّع

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

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

parent string

اختياريّ. اسم Document الذي يتضمّن Chunk المطلوب حذفها. يجب أن يتطابق الحقل الرئيسي في كل DeleteChunkRequest مع هذه القيمة. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

الحقول
requests[] object (DeleteChunkRequest)

مطلوب. رسائل الطلب التي تحدد Chunk لحذفها.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة فارغًا.

DeleteChunkRequest

طلب حذف Chunk

تمثيل JSON 
{
  "name": string
}
الحقول
name string

مطلوب. اسم المورد Chunk المطلوب حذفه. مثلاً: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk