Documents

روش: corpora.documents.create

یک Document خالی ایجاد می کند.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

پارامترهای مسیر

string parent

مورد نیاز. نام Corpus که این Document در آن ایجاد می شود. مثال: corpora/my-corpus-123 به شکل corpora/{corpora} است.

درخواست بدن

بدنه درخواست حاوی نمونه‌ای از Document است.

فیلدها
string name

تغییرناپذیر. شناسه. نام منبع Document . شناسه (نام بدون پیشوند "corpora/*/documents/") می‌تواند حداکثر دارای 40 کاراکتر باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد از displayName به همراه یک پسوند تصادفی 12 کاراکتری مشتق می شود. مثال: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

string displayName

اختیاری. نام نمایشی قابل خواندن توسط انسان برای Document . نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "مستندات بازیابی معنایی"

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را ارائه می کند که به عنوان جفت های کلید-مقدار ذخیره شده برای پرس و جو استفاده می شود. یک Document می تواند حداکثر 20 CustomMetadata داشته باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه جدید از Document است.

روش: corpora.documents.query

جستجوی معنایی را روی یک Document انجام می دهد.

نقطه پایانی

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

پارامترهای مسیر

string name

مورد نیاز. نام Document مورد نظر. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

فیلدها
string query

مورد نیاز. رشته پرس و جو برای انجام جستجوی معنایی.

resultsCount integer

اختیاری. حداکثر تعداد Chunk برای بازگشت. ممکن است این سرویس تعداد کمتری Chunk را برگرداند.

اگر مشخص نشده باشد، حداکثر 10 Chunk برگردانده می شود. حداکثر تعداد نتایج مشخص شده 100 است.

شی metadataFilters[] object ( MetadataFilter )

اختیاری. فیلتر برای فراداده های Chunk . هر شی MetadataFilter باید با یک کلید منحصر به فرد مطابقت داشته باشد. چندین شیء MetadataFilter توسط "AND"های منطقی به هم می پیوندند.

توجه: فیلتر در سطح Document برای این درخواست پشتیبانی نمی شود زیرا نام Document قبلاً مشخص شده است.

جستجوی مثال: (سال >= 2020 یا سال < 2010) و (ژانر = درام یا ژانر = اکشن)

فهرست شیء MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2020، عملیات = GREATER_EQUAL}، {int_value = 2010، عملیات = LESS}}، {key = "chunk.custom_metadatagenre. "condition = [{stringValue = "drama"، عملیات = EQUAL}، {stringValue = "Action"، عملیات = EQUAL}}]

پرس و جوی مثال برای محدوده عددی مقادیر: (سال > 2015 و سال <= 2020)

فهرست شیء MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2015، عملیات = GREATER}]}، {key = "chunk.custom_metadata.year" شرایط = [{int_value = 2020، عملیات = LESS_EQUAL}]}]

توجه: "AND" برای یک کلید فقط برای مقادیر عددی پشتیبانی می شود. مقادیر رشته فقط از "OR" برای همان کلید پشتیبانی می کند.

بدن پاسخگو

پاسخ از documents.query حاوی لیستی از تکه های مربوطه.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

فیلدها
شی relevantChunks[] object ( RelevantChunk )

تکه های مربوطه برگشتی

نمایندگی JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

روش: corpora.documents.list

تمام Document موجود در یک Corpus را فهرست می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents را دریافت کنید

پارامترهای مسیر

string parent

مورد نیاز. نام Corpus حاوی Document s. مثال: corpora/my-corpus-123 به شکل corpora/{corpora} است.

پارامترهای پرس و جو

pageSize integer

اختیاری. حداکثر تعداد Document برای بازگشت (در هر صفحه). این سرویس ممکن است تعداد کمتری Document برگرداند.

اگر نامشخص باشد، حداکثر 10 Document برگردانده می شود. حداکثر اندازه مجاز 20 Document در هر صفحه است.

string pageToken

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی documents.list .

nextPageToken بازگشتی در پاسخ را به عنوان آرگومان درخواست بعدی برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به documents.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ از documents.list حاوی فهرست صفحه بندی شده از Document s. Document بر اساس صعودی document.create_time مرتب شده اند.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

فیلدها
documents[] object ( Document )

Document برگشتی s.

string nextPageToken

یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، صفحه دیگری وجود ندارد.

نمایندگی JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

روش: corpora.documents.get

اطلاعات مربوط به یک Document خاص را دریافت می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*} را دریافت کنید

پارامترهای مسیر

string name

مورد نیاز. نام Document که باید بازیابی شود. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Document است.

روش: corpora.documents.patch

یک Document به روز می کند.

نقطه پایانی

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

پارامترهای مسیر

string document.name

تغییرناپذیر. شناسه. نام منبع 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 است.

فیلدها
string displayName

اختیاری. نام نمایشی قابل خواندن توسط انسان برای Document . نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "مستندات بازیابی معنایی"

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را ارائه می کند که به عنوان جفت های کلید-مقدار ذخیره شده برای پرس و جو استفاده می شود. یک Document می تواند حداکثر 20 CustomMetadata داشته باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Document است.

روش: corpora.documents.delete

یک Document حذف می کند.

نقطه پایانی

حذف https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

پارامترهای مسیر

string name

مورد نیاز. نام منبع Document که باید حذف شود. مثال: corpora/my-corpus-123/documents/the-doc-abc شکل corpora/{corpora}/documents/{document} را دارد.

پارامترهای پرس و جو

force boolean

اختیاری. اگر روی true تنظیم شود، هر Chunk و اشیاء مربوط به این Document نیز حذف خواهد شد.

اگر نادرست (پیش‌فرض)، خطای FAILED_PRECONDITION برگردانده می‌شود اگر Document حاوی هر Chunk باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

منبع REST: corpora.documents

منبع: سند

A Document مجموعه ای از Chunk s است. یک Corpus می تواند حداکثر 10000 Document داشته باشد.

فیلدها
string name

تغییرناپذیر. شناسه. نام منبع Document . شناسه (نام بدون پیشوند "corpora/*/documents/") می‌تواند حداکثر دارای 40 کاراکتر باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد از displayName به همراه یک پسوند تصادفی 12 کاراکتری مشتق می شود. مثال: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

string displayName

اختیاری. نام نمایشی قابل خواندن توسط انسان برای Document . نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "مستندات بازیابی معنایی"

شی customMetadata[] object ( CustomMetadata )

اختیاری. کاربر فوق داده های سفارشی را ارائه می کند که به عنوان جفت های کلید-مقدار ذخیره شده برای پرس و جو استفاده می شود. یک Document می تواند حداکثر 20 CustomMetadata داشته باشد.

رشته updateTime string ( Timestamp format)

فقط خروجی مهر زمانی آخرین به‌روزرسانی Document .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

رشته createTime string ( Timestamp format)

فقط خروجی مهر زمانی از زمان ایجاد Document .

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

نمایندگی JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

متادیتا سفارشی

ابرداده ارائه شده توسط کاربر به صورت جفت کلید-مقدار ذخیره می شود.

فیلدها
string key

مورد نیاز. کلید ابرداده برای ذخیره.

value فیلد اتحادیه

value فقط می تواند یکی از موارد زیر باشد:

stringValue string

مقدار رشته ای فراداده برای ذخیره.

شی stringListValue object ( StringList )

مقدار StringList ابرداده برای ذخیره.

numericValue number

مقدار عددی ابرداده برای ذخیره.

نمایندگی JSON 
{
  "key": string,

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

StringList

کاربر مقادیر رشته ای را که به یک کلید فراداده اختصاص داده شده است، ارائه کرده است.

فیلدها
values[] string

مقادیر رشته ای ابرداده برای ذخیره.

نمایندگی JSON 
{
  "values": [
    string
  ]
}