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 حرفًا، بما في ذلك المسافات. مثال: "مستندات حول Semantic Retriever"

نص الاستجابة

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

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

resultsCount integer

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

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

نص الاستجابة

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

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

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

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

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

الطريقة: corpora.list

تعرض هذه السمة جميع Corpora التي يملكها المستخدم.

نقطة نهاية

get 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

نقطة نهاية

patch 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 حرفًا، بما في ذلك المسافات. مثال: "مستندات حول Semantic Retriever"

نص الاستجابة

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

الطريقة: corpora.delete

يحذف Corpus.

نقطة نهاية

delete 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

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

role enum (Role)

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

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

GranteeType

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

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

الدور

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

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

MetadataFilter

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

الحقول
key string

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

conditions[] object (Condition)

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

تمثيل 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 المرتبطة بطلب البحث

document object (Document)

تمثّل هذه السمة Document المرتبطة بالجزء.

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

مورد REST: corpora

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

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

الحقول
name string

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

displayName string

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

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
}