Chunks

الطريقة: 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.

الحقول
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 معيّن

نقطة نهاية

get 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}.

نص الطلب

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

نص الاستجابة

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

الطريقة: 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.

الحقول
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 ثانية

نقطة نهاية

منشور 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 بشكل مجمّع

نقطة نهاية

منشور 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

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

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

updateTime string (Timestamp format)

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

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

state enum (State)

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

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

ChunkData

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

الحقول

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

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

stringValue string

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

تمثيل JSON 
{

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

الحالة

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

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