الطريقة: corpora.create
تنشئ Corpus
فارغة.
نقطة نهاية
منشور
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
.
نقطة نهاية
منشور
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
قائمة العناصر: 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
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" الشروط = [{int_value = 2015, العملية = GREATER}]}, {key = "chunk.custom_metadata.year" الشروط = [{int_value = 2020, العملية = LESS_EQUAL}]}]
ملاحظة: تتوفر أحرف "و" للمفتاح نفسه للقيم الرقمية فقط. تتيح قيم السلسلة استخدام "OR" للمفتاح نفسه فقط.
resultsCount
integer
اختياريّ. الحد الأقصى لعدد Chunk
المطلوب عرضها قد تعرض الخدمة عددًا أقل من Chunk
.
إذا لم يتم تحديد عدد، سيتم عرض 10 Chunk
كحد أقصى. الحد الأقصى لعدد النتائج المحدّدة هو 100.
نص الاستجابة
ردّ من corpora.query
يحتوي على قائمة بالأجزاء ذات الصلة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
relevantChunks[]
object (RelevantChunk
)
الأجزاء ذات الصلة
تمثيل JSON |
---|
{
"relevantChunks": [
{
object ( |
الطريقة: 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 ( |
الطريقة: 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
.
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يكون نص الاستجابة فارغًا.
مورد 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
تحدِّد أنواع مُمنوح هذا الإذن.
عمليات التعداد | |
---|---|
GRANTEE_TYPE_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدَمة. |
USER |
يمثّل مستخدمًا. وعند ضبط هذه السياسة، يجب تقديم عنوان البريد الإلكتروني للمستخدم. |
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 ( |
الشرط
شرط الفلتر الذي ينطبق على مفتاح واحد
operation
enum (Operator
)
مطلوب. عامل يتم تطبيقه على زوج المفتاح/القيمة المحدَّد لتشغيل الشرط.
value
يجب أن يكون نوع القيمة متوافقًا مع نوع القيمة المحدّد في الحقل للمفتاح المقابل. إذا كانت أنواع القيم غير متسقة، ستكون النتيجة مجموعة فارغة. عندما تحتوي CustomMetadata
على نوع القيمة StringList
، يجب أن يستخدم شرط الفلترة string_value
مع عملية "تضمين" أو "استبعاد"، وإلا ستكون النتيجة مجموعة فارغة أيضًا. يمكن أن يكون value
واحدًا فقط مما يلي:
stringValue
string
قيمة السلسلة لفلترة البيانات الوصفية
numericValue
number
القيمة الرقمية لفلترة البيانات الوصفية
تمثيل JSON |
---|
{ "operation": enum ( |
مُشغِّل
لتحديد العوامل الصالحة التي يمكن تطبيقها على زوج المفتاح/القيمة.
عمليات التعداد | |
---|---|
OPERATOR_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدَمة. |
LESS |
متاح للأرقام. |
LESS_EQUAL |
متاح للأرقام. |
EQUAL |
متاح بواسطة السلسلة. |
GREATER_EQUAL |
متاح للأرقام. |
GREATER |
متاح للأرقام. |
NOT_EQUAL |
يمكن استخدام الأرقام والسلاسل. |
INCLUDES |
لا يمكن استخدامها إلا مع السلسلة عندما يكون نوع القيمة CustomMetadata للمفتاح المحدّد يحتوي على stringListValue . |
EXCLUDES |
هذا الخيار متاح من خلال السلسلة فقط عندما يحتوي نوع قيمة CustomMetadata للمفتاح المحدّد على stringListValue . |
مورد REST: Corpora
المورد: Corpus
السمة 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 "Zulu" وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "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"
.
تمثيل JSON |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string } |