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 متعددة بواسطة أحرف "AND" منطقية.

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

MetadataFilter object list: metadataFilters = [ {key = &quot;document.custom_metadata.year&quot; الشروط = [{int_value = 2020, العملية = GREATER_EQUAL}، {int_value = 2010, العملية = LESS}]}, {key = "document.custom_metadata.year" الشروط = [{int_value = 2020, العملية = GREATER_EQUAL}، {int_value = 2010, process = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, 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}]}]

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

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 محدّد.

نقطة نهاية

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

نص الطلب

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

نص الاستجابة

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

مورد REST: corpora.permissions

المورد: الإذن

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

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

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

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

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

granteeType enum (GranteeType)

اختياريّ. غير قابل للتغيير نوع المستفيد.

emailAddress string

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

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 = وينطبق OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]

الحقول
key string

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

conditions[] object (Condition)

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

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

الشرط

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

الحقول
operation enum (Operator)

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

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

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

numericValue number

القيمة الرقمية المطلوب فلترة البيانات الوصفية وفقًا لها.

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

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

مُشغِّل

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

عمليات التعداد
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

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

updateTime string (Timestamp format)

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

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

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