Corpora

الطريقة: corpora.create

لإنشاء Corpus فارغ

نقطة نهاية

post https://generativelanguage.googleapis.com/v1beta/corpora

نص الطلب

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

الحقول
name string

غير قابل للتغيير المعرّف اسم المورد Corpus يمكن أن يحتوي المعرّف (الاسم باستثناء البادئة "corpora/") على ما يصل إلى 40 حرفًا أبجديًا رقميًا صغيرًا أو شرطات (-). ولا يمكن أن يبدأ المعرّف بشرطة أو ينتهي بها. إذا كان الاسم فارغًا عند الإنشاء، سيتم إنشاء اسم فريد من displayName مع إضافة لاحقة عشوائية من 12 حرفًا. مثال: corpora/my-awesome-corpora-123a456b789c

displayName string

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثيل تم إنشاؤه حديثًا من Corpus.

الطريقة: corpora.query

تُجري عملية بحث دلالي على Corpus.

نقطة نهاية

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

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

name string

مطلوب. اسم Corpus المطلوب إجراء طلب بحث عنه. مثال: corpora/my-corpus-123 يكون بالشكل corpora/{corpora}.

نص الطلب

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

الحقول
query string

مطلوب. سلسلة طلب البحث لإجراء البحث الدلالي

metadataFilters[] object (MetadataFilter)

اختيارية: فلتِر البيانات الوصفية Chunk وDocument. يجب أن يكون كل عنصر MetadataFilter متوافقًا مع مفتاح فريد. يتمّ دمج عناصر MetadataFilter متعدّدة باستخدام عوامل التشغيل المنطقية "و".

مثال على طلب بحث على مستوى المستند: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter قائمة العناصر: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

مثال على طلب بحث على مستوى الجزء لنطاق رقمي من القيم: (year > 2015 AND year <= 2020)

MetadataFilter قائمة العناصر: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

ملاحظة: لا يمكن استخدام "و" للمفتاح نفسه إلا مع القيم الرقمية. لا تتيح قيم السلاسل استخدام "أو" إلا للمفتاح نفسه.

resultsCount integer

اختيارية: الحد الأقصى لعدد Chunk المطلوب عرضها قد تعرض الخدمة عددًا أقل من Chunk.

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

نص الاستجابة

استجابة من corpora.query تحتوي على قائمة بالمقاطع ذات الصلة

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

الحقول
relevantChunks[] object (RelevantChunk)

الأجزاء ذات الصلة

تمثيل JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

الطريقة: corpora.list

يسرد كل Corpora التي يملكها المستخدم.

نقطة نهاية

الحصول على https://generativelanguage.googleapis.com/v1beta/corpora

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

pageSize integer

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

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

pageToken string

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

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

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

نص الطلب

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

نص الاستجابة

استجابة من corpora.list تتضمّن قائمة مُقسّمة إلى صفحات من Corpora يتم ترتيب النتائج حسب corpus.create_time تصاعديًا.

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

الحقول
corpora[] object (Corpus)

مجموعات النصوص التي تمّ إرجاعها

nextPageToken string

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

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

الطريقة: corpora.get

الحصول على معلومات عن Corpus معيّن

نقطة نهاية

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

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

name string

مطلوب. اسم Corpus. مثال: corpora/my-corpus-123 يكون على الشكل corpora/{corpora}.

نص الطلب

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

نص الاستجابة

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

الطريقة: corpora.patch

تعديلات على Corpus

نقطة نهاية

تصحيح https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

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

corpus.name string

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

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

updateMask string (FieldMask format)

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

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

نص الطلب

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

الحقول
displayName string

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

نص الاستجابة

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

الطريقة: corpora.delete

لحذف Corpus

نقطة نهاية

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

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

name string

مطلوب. اسم المورد الخاص بالCorpus. مثال: corpora/my-corpus-123 يكون على الشكل corpora/{corpora}.

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

force boolean

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

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

نص الطلب

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

نص الاستجابة

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

مورد REST: corpora.permissions

المرجع: الإذن

يمنح مورد الأذونات المستخدم أو المجموعة أو بقية المستخدمين في العالم إذن الوصول إلى مورد PaLM API (مثل نموذج معدّل أو قاعدة بيانات).

الدور هو مجموعة من العمليات المسموح بها التي تسمح للمستخدمين بتنفيذ إجراءات معيّنة على موارد PaLM API. لإتاحتها للمستخدمين أو المجموعات أو حسابات الخدمة، عليك إسناد الأدوار. عند منح دور، يتم منح الأذونات التي يحتوي عليها هذا الدور.

هناك ثلاثة أدوار متداخلة. كل دور هو مجموعة شاملة من العمليات المسموح بها للدور السابق:

  • يمكن للقارئ استخدام المورد (مثل النموذج المحسَّن أو مجموعة النصوص) للاستنتاج
  • يمتلك الكاتب أذونات القارئ، ويمكنه أيضًا التعديل والمشاركة.
  • يمتلك المالك أذونات الكاتب، ويمكنه أيضًا حذف المحتوى.
الحقول
name string

النتائج فقط. المعرّف اسم الإذن سيتم إنشاء اسم فريد عند الإنشاء. أمثلة: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} النتائج فقط.

granteeType enum (GranteeType)

اختيارية: غير قابل للتغيير نوع الممنوح

emailAddress string

اختيارية: غير قابل للتغيير عنوان البريد الإلكتروني للمستخدم أو المجموعة التي يشير إليها هذا الإذن لا يتم ضبط الحقل عندما يكون نوع مانح الإذن هو "الجميع".

role enum (Role)

مطلوب. الدور الذي يمنحه هذا الإذن

تمثيل JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

تحدِّد أنواع مُمنوح هذا الإذن.

عمليات التعداد
GRANTEE_TYPE_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
USER يمثّل مستخدمًا. عند ضبطها، يجب تقديم emailAddress للمستخدم.
GROUP يمثّل مجموعة. عند ضبط القيمة، يجب تقديم عنوان البريد الإلكتروني للمجموعة.
EVERYONE يشير إلى إمكانية الوصول إلى الجميع. ولا يلزم تقديم أي معلومات إضافية.

الدور

يحدِّد الدور الذي يمنحه هذا الإذن.

عمليات التعداد
ROLE_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
OWNER يمكن للمالك استخدام المورد وتعديله ومشاركته وحذفه.
WRITER يمكن للكاتب استخدام المرجع وتعديله ومشاركته.
READER يمكن للقارئ استخدام المرجع.

MetadataFilter

فلتر يقدّمه المستخدم للحدّ من الاسترجاع استنادًا إلى قيم البيانات الوصفية على مستوى Chunk أو Document مثال (genre = دراما أو genre = إثارة): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

الحقول
key string

مطلوب. مفتاح البيانات الوصفية التي سيتم الفلترة حسبها.

conditions[] object (Condition)

مطلوب. Condition للمفتاح المحدّد الذي سيؤدي إلى تنشيط هذا الفلتر. يتمّ ربط عدّة Condition باستخدام عوامل التشغيل المنطقية "أو".

تمثيل JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

الشرط

شرط فلتر ينطبق على مفتاح واحد

الحقول
operation enum (Operator)

مطلوب. عامل يتم تطبيقه على زوج المفتاح/القيمة المحدَّد لتشغيل الشرط.

value Union type
يجب أن يكون نوع القيمة متوافقًا مع نوع القيمة المحدّد في الحقل للمفتاح المقابل. إذا لم تكن أنواع القيم متسقة، ستكون النتيجة مجموعة فارغة. عندما يكون CustomMetadata من نوع القيمة StringList، يجب أن يستخدم شرط الفلترة string_value مع عملية INCLUDES/EXCLUDES، وإلا ستكون النتيجة أيضًا مجموعة فارغة. يمكن أن يكون value واحدًا مما يلي فقط:
stringValue string

قيمة السلسلة لفلترة البيانات الوصفية

numericValue number

القيمة الرقمية لفلترة البيانات الوصفية

تمثيل JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

عامل التشغيل

تحدِّد عوامل التشغيل الصالحة التي يمكن تطبيقها على زوج مفتاح/قيمة.

عمليات التعداد
OPERATOR_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
LESS متاح للأرقام.
LESS_EQUAL متاح للأرقام.
EQUAL يمكن استخدام الأرقام والسلاسل.
GREATER_EQUAL متاح للأرقام.
GREATER متاح للأرقام.
NOT_EQUAL يمكن استخدام الأرقام والسلاسل.
INCLUDES لا يمكن استخدامها إلا مع السلسلة عندما يكون نوع القيمة CustomMetadata للمفتاح المحدّد يحتوي على stringListValue.
EXCLUDES لا يمكن استخدامها إلا مع السلسلة عندما يكون نوع القيمة CustomMetadata للمفتاح المحدّد يحتوي على stringListValue.

RelevantChunk

معلومات عن جزء ذي صلة باستعلام

الحقول
chunkRelevanceScore number

Chunk مدى الصلة بطلب البحث

chunk object (Chunk)

Chunk المرتبطة بالطلب

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

مورد REST: corpora

المرجع: مجموعة النصوص

Corpus هي مجموعة من Document. يمكن أن ينشئ المشروع ما يصل إلى 5 قواعد بيانات.

الحقول
name string

غير قابل للتغيير المعرّف اسم المورد Corpus يمكن أن يحتوي المعرّف (الاسم باستثناء البادئة "corpora/") على ما يصل إلى 40 حرفًا أبجديًا رقميًا صغيرًا أو شرطات (-). ولا يمكن أن يبدأ المعرّف بشرطة أو ينتهي بها. إذا كان الاسم فارغًا عند الإنشاء، سيتم إنشاء اسم فريد من displayName مع إضافة لاحقة عشوائية من 12 حرفًا. مثال: corpora/my-awesome-corpora-123a456b789c

displayName string

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

createTime string (Timestamp format)

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

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

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

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

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}