Corpora

روش: corpora.create

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

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/corpora

درخواست بدن

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

فیلدها
string name

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

string displayName

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

بدن پاسخگو

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

روش: corpora.query

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

نقطه پایانی

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

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

string name

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

درخواست بدن

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

فیلدها
string query

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

شی metadataFilters[] object ( MetadataFilter )

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

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

فهرست شیء MetadataFilter : metadataFilters = [ {key = "document.custom_metadata.year" condition = [{int_value = 2020، عملیات = GREATER_EQUAL}، {int_value = 2010، عملیات = LESS}]}، {key = "document.custom_metata. سال" شرایط = [{int_value = 2020، عملیات = GREATER_EQUAL}، {int_value = 2010، عملیات = کمتر}]}، {key = "document.custom_metadata.genre" شرایط = [{stringValue = "درام"، عملیات = برابر }، {stringValue = "عمل"، عملیات = 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" برای همان کلید پشتیبانی می کند.

resultsCount integer

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

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

بدن پاسخگو

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

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

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

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

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

روش: corpora.list

تمام Corpora متعلق به کاربر را فهرست می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/corpora را دریافت کنید

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

pageSize integer

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

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

string pageToken

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

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

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

درخواست بدن

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

بدن پاسخگو

پاسخ از corpora.list حاوی فهرست صفحه بندی شده Corpora . نتایج بر اساس صعودی corpus.create_time مرتب شده اند.

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

فیلدها
corpora[] object ( Corpus )

مجموعه های برگشتی

string nextPageToken

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

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

روش: corpora.get

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

نقطه پایانی

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

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

string name

مورد نیاز. نام 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/*}

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

string corpus.name

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

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

رشته updateMask string ( FieldMask format)

مورد نیاز. لیست فیلدهایی که باید به روز شوند. در حال حاضر، این فقط از به‌روزرسانی displayName پشتیبانی می‌کند.

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

درخواست بدن

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

فیلدها
string displayName

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

بدن پاسخگو

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

روش: corpora.delete

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

نقطه پایانی

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

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

string name

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

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

force boolean

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

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

درخواست بدن

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

بدن پاسخگو

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

منبع REST: corpora.permissions

منبع: مجوز

منبع مجوز به کاربر، گروه یا سایر نقاط جهان دسترسی به منبع API PalM (به عنوان مثال یک مدل تنظیم شده، مجموعه) اعطا می کند.

نقش مجموعه ای از عملیات مجاز است که به کاربران اجازه می دهد تا اقدامات خاصی را بر روی منابع Palm API انجام دهند. برای در دسترس قرار دادن آنها برای کاربران، گروه‌ها یا حساب‌های سرویس، نقش‌هایی را اختصاص می‌دهید. وقتی نقشی را اختصاص می دهید، مجوزهایی را که آن نقش در بر دارد اعطا می کنید.

سه نقش متحدالمرکز وجود دارد. هر نقش ابرمجموعه ای از عملیات مجاز نقش قبلی است:

  • خواننده می تواند از منبع (مثلاً مدل تنظیم شده، پیکره) برای استنتاج استفاده کند
  • نویسنده دارای مجوزهای خواننده است و علاوه بر این می تواند ویرایش و به اشتراک بگذارد
  • مالک دارای مجوزهای نویسنده است و علاوه بر این می تواند حذف کند
فیلدها
string name

فقط خروجی شناسه. نام مجوز یک نام منحصر به فرد در ایجاد ایجاد می شود. مثال‌ها: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} فقط خروجی.

enum granteeType enum ( GranteeType )

اختیاری. تغییرناپذیر. نوع اعطا کننده.

string emailAddress

اختیاری. تغییرناپذیر. آدرس ایمیل کاربر گروهی که این مجوز به آن اشاره دارد. وقتی نوع دریافت‌کننده مجوز EVERYONE باشد، فیلد تنظیم نمی‌شود.

role enum ( Role )

مورد نیاز. نقش اعطا شده توسط این مجوز.

نمایندگی JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

انواع دارنده این مجوز را تعریف می کند.

Enums
GRANTEE_TYPE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
USER یک کاربر را نشان می دهد. پس از تنظیم، باید آدرس ایمیل را برای کاربر ارائه دهید.
GROUP نماینده یک گروه است. وقتی تنظیم شد، باید آدرس ایمیل را برای گروه ارائه دهید.
EVERYONE نشان دهنده دسترسی به همه است. هیچ اطلاعات اضافی مورد نیاز نیست.

نقش

نقش اعطا شده توسط این مجوز را تعریف می کند.

Enums
ROLE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
OWNER مالک می تواند از منبع استفاده، به روز رسانی، اشتراک گذاری و حذف کند.
WRITER Writer می تواند از منبع استفاده کند، به روز کند و به اشتراک بگذارد.
READER خواننده می تواند از منبع استفاده کند.

فیلتر فراداده

فیلتر ارائه شده توسط کاربر برای محدود کردن بازیابی بر اساس مقادیر فراداده سطح Chunk یا Document . مثال (ژانر = درام یا ژانر = اکشن): کلید = "document.custom_metadata.genre" شرایط = [{stringValue = "درام"، عملیات = برابر}، {stringValue = "اکشن"، عملیات = برابر}]

فیلدها
string key

مورد نیاز. کلید ابرداده برای فیلتر کردن.

conditions[] object ( Condition )

مورد نیاز. Condition برای کلید داده شده که این فیلتر را فعال می کند. چند Condition با ORهای منطقی به هم می پیوندند.

نمایندگی JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

وضعیت

شرایط فیلتر قابل اعمال برای یک کلید.

فیلدها
شماره operation enum ( Operator )

مورد نیاز. عملگر به جفت کلید-مقدار داده شده اعمال می شود تا شرایط را راه اندازی کند.

value فیلد اتحادیه نوع مقدار باید با نوع مقدار تعریف شده در فیلد برای کلید مربوطه مطابقت داشته باشد. اگر انواع مقادیر سازگار نباشند، نتیجه یک مجموعه خالی خواهد بود. هنگامی که CustomMetadata دارای یک نوع مقدار StringList است، شرط فیلتر باید string_value جفت شده با عملیات INCLUDES/EXCLUDES استفاده کند، در غیر این صورت نتیجه نیز یک مجموعه خالی خواهد بود. value فقط می تواند یکی از موارد زیر باشد:
stringValue string

مقدار رشته برای فیلتر کردن ابرداده.

numericValue number

مقدار عددی برای فیلتر کردن ابرداده.

نمایندگی JSON 
{
  "operation": enum (Operator),

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

اپراتور

عملگرهای معتبری را تعریف می کند که می توانند برای یک جفت کلید-مقدار اعمال شوند.

Enums
OPERATOR_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
LESS پشتیبانی شده توسط عدد
LESS_EQUAL پشتیبانی شده توسط عدد
EQUAL پشتیبانی شده توسط عدد و رشته.
GREATER_EQUAL پشتیبانی شده توسط عدد
GREATER پشتیبانی شده توسط عدد
NOT_EQUAL پشتیبانی شده توسط عدد و رشته.
INCLUDES تنها زمانی توسط رشته پشتیبانی می شود که نوع مقدار CustomMetadata برای کلید داده شده دارای stringListValue باشد.
EXCLUDES تنها زمانی توسط رشته پشتیبانی می شود که نوع مقدار CustomMetadata برای کلید داده شده دارای stringListValue باشد.

RelevantChunk

اطلاعات مربوط به یک پرس و جو.

فیلدها
number chunkRelevanceScore

ارتباط Chunk با پرس و جو.

chunk object ( Chunk )

Chunk مرتبط با پرس و جو.

نمایندگی JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

منبع REST: corpora

منبع: Corpus

Corpus مجموعه ای از Document s است. یک پروژه می تواند حداکثر 5 مجموعه ایجاد کند.

فیلدها
string name

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

string displayName

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

رشته 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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

نمایندگی JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}