Chunks

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

لإنشاء Chunk.

نقطة نهاية

post 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.

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثيل تم إنشاؤه حديثًا من 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.

الحقول
data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال 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}.

نص الطلب

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

نص الاستجابة

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

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

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

نقطة نهاية

post 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.

الحقول
parent string

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

chunk object (Chunk)

مطلوب. Chunk لإنشاء

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

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

تعديل Chunk بشكل مجمّع

نقطة نهاية

post 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

الحقول
chunk object (Chunk)

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

updateMask string (FieldMask format)

مطلوب. قائمة الحقول المطلوب تعديلها لا يتيح هذا الخيار حاليًا تعديل سوى customMetadata وdata.

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

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

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

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

نقطة نهاية

post 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 المطلوب حذفها

نص الاستجابة

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

DeleteChunkRequest

طلب حذف Chunk

الحقول
name string

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

تمثيل JSON 
{
  "name": string
}

مورد REST: corpora.documents.chunks

المرجع: قطعة

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

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

يستخدم معيار 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"

updateTime string (Timestamp format)

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

يستخدم معيار 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)

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

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

ChunkData

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

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

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

تمثيل JSON 
{

  // data
  "stringValue": string
  // Union type
}

الحالة

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

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