Documents

الطريقة: corpora.documents.create

تنشئ هذه الدالة Document فارغًا.

نقطة نهاية

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

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

parent string

مطلوب. اسم Corpus الذي سيتم إنشاء Document فيه. مثال: corpora/my-corpus-123 تأخذ الشكل corpora/{corpora}.

نص الطلب

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

الحقول
name string

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

displayName string

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

customMetadata[] object (CustomMetadata)

اختياريّ. البيانات الوصفية المخصّصة المقدَّمة من المستخدِم والمخزَّنة كأزواج من المفاتيح والقيم والمستخدَمة في طلبات البحث يمكن أن يتضمّن Document ما يصل إلى 20 CustomMetadata.

نص الاستجابة

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

الطريقة: corpora.documents.query

تُجري هذه الدالة بحثًا دلاليًا في Document.

نقطة نهاية

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

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

name string

مطلوب. تمثّل هذه السمة اسم Document المطلوب البحث عنه. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

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

الحقول
query string

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

resultsCount integer

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

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

metadataFilters[] object (MetadataFilter)

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

ملاحظة: لا تتوفّر فلترة على مستوى Document لهذا الطلب لأنّه تم تحديد اسم Document من قبل.

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

MetadataFilter قائمة العناصر: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.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" للمفتاح نفسه إلا مع القيم الرقمية. لا تتوافق قيم السلسلة إلا مع "أو" للمفتاح نفسه.

نص الاستجابة

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

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

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

الفقرات ذات الصلة التي تم إرجاعها

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

الطريقة: corpora.documents.list

تعرض هذه السمة جميع Document في Corpus.

نقطة نهاية

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

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

parent string

مطلوب. اسم Corpus الذي يحتوي على Document مثال: corpora/my-corpus-123 تأخذ الشكل corpora/{corpora}.

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

pageSize integer

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

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

pageToken string

اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب documents.list سابق.

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

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

نص الطلب

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

نص الاستجابة

استجابة من documents.list تحتوي على قائمة مقسّمة إلى صفحات من Document. يتم ترتيب Document حسب document.create_time تصاعديًا.

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

الحقول
documents[] object (Document)

تم إرجاع Document.

nextPageToken string

رمز مميز يمكن إرساله كـ pageToken لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، لن يكون هناك المزيد من الصفحات.

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

الطريقة: corpora.documents.get

تعرض هذه السمة معلومات حول Document معيّن.

نقطة نهاية

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

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

name string

مطلوب. تمثّل هذه السمة اسم Document المطلوب استرداده. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

نص الطلب

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

نص الاستجابة

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

الطريقة: corpora.documents.patch

تعديل Document

نقطة نهاية

patch https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

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

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

document.name string

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

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

updateMask string (FieldMask format)

مطلوب. قائمة الحقول التي سيتم تعديلها في الوقت الحالي، لا يتيح ذلك سوى تعديل displayName وcustomMetadata.

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

نص الطلب

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

الحقول
displayName string

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

customMetadata[] object (CustomMetadata)

اختياريّ. البيانات الوصفية المخصّصة المقدَّمة من المستخدِم والمخزَّنة كأزواج من المفاتيح والقيم والمستخدَمة في طلبات البحث يمكن أن يتضمّن Document ما يصل إلى 20 CustomMetadata.

نص الاستجابة

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

الطريقة: corpora.documents.delete

يحذف Document.

نقطة نهاية

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

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

name string

مطلوب. اسم المورد الذي يمثّل Document المطلوب حذفه. مثال: corpora/my-corpus-123/documents/the-doc-abc تأخذ الشكل corpora/{corpora}/documents/{document}.

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

force boolean

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

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

نص الطلب

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

نص الاستجابة

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

مورد REST: ‏ corpora.documents

المورد: مستند

Document هي مجموعة من Chunk. يمكن أن يحتوي Corpus على 10,000 Document كحدّ أقصى.

الحقول
name string

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

displayName string

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

customMetadata[] object (CustomMetadata)

اختياريّ. البيانات الوصفية المخصّصة المقدَّمة من المستخدِم والمخزَّنة كأزواج من المفاتيح والقيم والمستخدَمة في طلبات البحث يمكن أن يتضمّن Document ما يصل إلى 20 CustomMetadata.

updateTime string (Timestamp format)

النتائج فقط. الطابع الزمني لآخر مرة تم فيها تعديل Document

يستخدم هذا النوع 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"

createTime string (Timestamp format)

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

يستخدم هذا النوع 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,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

البيانات الوصفية المقدَّمة من المستخدِم والمخزَّنة في صورة أزواج المفتاح/القيمة

الحقول
key string

مطلوب. مفتاح البيانات الوصفية المطلوب تخزينها

value Union type
يمكن أن تكون value إحدى القيم التالية فقط:
stringValue string

قيمة السلسلة للبيانات الوصفية التي سيتم تخزينها.

stringListValue object (StringList)

قيمة StringList للبيانات الوصفية التي سيتم تخزينها.

numericValue number

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

تمثيل JSON 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

قيم السلسلة المقدَّمة من المستخدِم والمخصّصة لمفتاح بيانات وصفية واحد

الحقول
values[] string

قيم السلسلة للبيانات الوصفية التي سيتم تخزينها.

تمثيل JSON 
{
  "values": [
    string
  ]
}