Documents

API جستجوی فایل، فایل‌های منبع خام یا اسناد شما را به عنوان اشیاء موقت فایل ارجاع می‌دهد.

روش: fileSearchStores.documents.delete

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

نقطه پایانی

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

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

string name

الزامی. نام منبع Document که قرار است حذف شود. مثال: fileSearchStores/my-file-search-store-123/documents/the-doc-abc این پارامتر به شکل fileSearchStores/{filesearchstore}/documents/{document} است.

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

force boolean

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

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

درخواست بدنه

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

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ یک شیء JSON خالی خواهد بود.

روش: fileSearchStores.documents.get

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

نقطه پایانی

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

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

string name

الزامی. نام Document که قرار است بازیابی شود. مثال: fileSearchStores/my-file-search-store-123/documents/the-doc-abc این پارامتر به شکل fileSearchStores/{filesearchstore}/documents/{document} است.

درخواست بدنه

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

بدنه پاسخ

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

روش: fileSearchStores.documents.list

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

نقطه پایانی

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

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

string parent

الزامی. نام FileSearchStore که شامل Document s است. مثال: fileSearchStores/my-file-search-store-123 این مقدار به شکل fileSearchStores/{filesearchstore} است.

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

integer pageSize

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

اگر مشخص نشود، حداکثر ۱۰ Document برگردانده خواهد شد. حداکثر اندازه مجاز ۲۰ Document در هر صفحه است.

string pageToken

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

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

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

درخواست بدنه

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

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

Document بازگردانده شده.

string nextPageToken

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

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

روش: fileSearchStores.documents.query

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

نقطه پایانی

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

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

string name

الزامی. نام Document که قرار است جستجو شود. مثال: fileSearchStores/my-file-search-store-123/documents/the-doc-abc این پارامتر به شکل fileSearchStores/{filesearchstore}/documents/{document} است.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

فیلدها
string query

الزامی. رشته‌ی جستجو برای انجام جستجوی معنایی.

resultsCount integer

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

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

شیء metadataFilters[] object ( MetadataFilter )

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

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

مثال پرس‌وجو: (سال >= ۲۰۲۰ یا سال < ۲۰۱۰) و (ژانر = درام یا ژانر = اکشن)

لیست اشیاء 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}}]

مثال پرس و جو برای محدوده عددی از مقادیر: (سال > 2015 و سال <= 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" برای یک کلید فقط برای مقادیر عددی پشتیبانی می‌شوند. مقادیر رشته‌ای فقط از عبارات "OR" برای یک کلید پشتیبانی می‌کنند.

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

تکه‌های مربوطه بازگردانده شده.

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

منبع REST: fileSearchStores.documents

منبع: سند

یک Document مجموعه‌ای از Chunk ها است.

فیلدها
string name

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

string displayName

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

شیء customMetadata[] object ( CustomMetadata )

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

رشته updateTime string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

شمارشگر state enum ( State )

فقط خروجی. وضعیت فعلی Document .

رشته sizeBytes string ( int64 format)

فقط خروجی. اندازه بایت‌های خام وارد شده به سند.

string mimeType

فقط خروجی. نوع MIME سند.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

ایالت

حالت‌هایی برای چرخه حیات یک Document .

انوم‌ها
STATE_UNSPECIFIED مقدار پیش‌فرض. این مقدار در صورتی استفاده می‌شود که state حذف شده باشد.
STATE_PENDING برخی از Chunks Document در حال پردازش هستند (جاسازی و ذخیره‌سازی برداری).
STATE_ACTIVE تمام Chunks Document پردازش شده و برای جستجو در دسترس هستند.
STATE_FAILED پردازش برخی از Chunks Document با شکست مواجه شد.