Corpora

مورد REST: corpora

المورد: Corpus

السمة Corpus هي مجموعة من Document. يمكن للمشروع إنشاء ما يصل إلى 5 مجموعات.

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
الحقول
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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

الطريقة: corpora.create

تنشئ Corpus فارغة.

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/corpora

نص الطلب

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

نص الاستجابة

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

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

لإجراء بحث دلالي عبر Corpus.

نقطة نهاية

منشور 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 = للبيانات OR genre = action)

قائمة الكائنات MetadataFilter: dataFilters = [ {key = "document.custom_metadata.year" الشروط = [{int_value = 2020, العملية = GREATER_EQUAL}، {int_value = 2010, العملية = LESS}]}, {key = "document.custom_metadata.year" الشروط = [{int_value = 2020, الفريق = GREATER_EQUAL}، {int_value = 2010، العملية = LESS}]}، {key = "document.custom_metadata.genre" الشروط = [{stringValue = "drama", العملية = EQUAL}، {stringValue = "action"، العملية = EQUAL}]}]

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

قائمة عناصر MetadataFilter: البيانات الوصفية لفلاتر = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; الشروط = [{int_value = 2020, العملية = LESS_EQUAL}]}]

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

resultsCount integer

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

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

نص الاستجابة

ردّ من corpora.query يحتوي على قائمة بالأجزاء ذات الصلة

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

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

المقاطع ذات الصلة.

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

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

نص الاستجابة

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

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

  • يمكن للقارئ استخدام المورد (مثل النموذج المضبوط أو المجموعة) للاستنتاج.
  • الكاتب لديه أذونات القارئ ويمكنه بالإضافة إلى ذلك التعديل والمشاركة
  • لدى المالك أذونات الكاتب ويمكنه أيضًا حذف
تمثيل JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
الحقول
name string

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

granteeType enum (GranteeType)

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

emailAddress string

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

role enum (Role)

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

GranteeType

تحدّد هذه السمة أنواع المستفيدين من هذا الإذن.

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

الدور

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

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

MetadataFilter

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

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

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

conditions[] object (Condition)

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

الشرط

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

تمثيل 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.
}
الحقول
operation enum (Operator)

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

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

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

numericValue number

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

مُشغِّل

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

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

RelevantChunk

يشير ذلك المصطلح إلى معلومات المقطع ذي الصلة بطلب البحث.

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

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

chunk object (Chunk)

تم ربط Chunk بطلب البحث.