- Ресурс: CachedContent
- Содержание
- Часть
- Блоб
- Вызов функции
- ФункцияОтвет
- ФайлДанные
- Инструмент
- Объявление функции
- Схема
- Тип
- ИнструментКонфигурация
- ФункцияCallingConfig
- Режим
- Использованиеметаданные
- Методы
Ресурс: CachedContent
Содержимое, которое было предварительно обработано и может использоваться в последующем запросе к GenerativeService.
Кэшированный контент можно использовать только с моделью, для которой он был создан.
JSON-представление |
---|
{ "contents": [ { object ( |
Поля | |
---|---|
contents[] | Необязательный. Только ввод. Неизменный. Содержимое для кэширования. |
tools[] | Необязательный. Только ввод. Неизменный. Список |
createTime | Только вывод. Время создания записи кэша. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
updateTime | Только вывод. Когда запись кэша была последний раз обновлена по времени UTC. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
usageMetadata | Только вывод. Метаданные об использовании кэшированного контента. |
expiration поля объединения . Указывает, когда истечет срок действия этого ресурса. expiration может быть только одним из следующих: | |
expireTime | Временная метка в формате UTC, когда срок действия этого ресурса считается истекшим. Это всегда предоставляется на выходе, независимо от того, что было отправлено на вход. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
ttl | Только ввод. Новый срок жизни для этого ресурса, только входные данные. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
name | Необязательный. Идентификатор. Имя ресурса, относящееся к кэшированному содержимому. Формат: |
displayName | Необязательный. Неизменный. Созданное пользователем значимое отображаемое имя кэшированного содержимого. Максимум 128 символов Юникода. |
model | Необходимый. Неизменный. Имя |
systemInstruction | Необязательный. Только ввод. Неизменный. Разработчик установил системную инструкцию. Пока только текст. |
toolConfig | Необязательный. Только ввод. Неизменный. Конфигурация инструмента. Эта конфигурация является общей для всех инструментов. |
Содержание
Базовый структурированный тип данных, содержащий содержимое сообщения, состоящее из нескольких частей.
Content
включает в себя поле role
, обозначающее производителя Content
и поле parts
, содержащее данные, состоящие из нескольких частей, которые содержат содержимое очереди сообщения.
JSON-представление |
---|
{
"parts": [
{
object ( |
Поля | |
---|---|
parts[] | Заказанные |
role | Необязательный. Производитель контента. Должно быть либо «пользователь», либо «модель». Полезно для многоходовых разговоров, в противном случае его можно оставить пустым или не установить. |
Часть
Тип данных, содержащий медиафайлы, которые являются частью сообщения Content
состоящего из нескольких частей.
Part
состоит из данных, имеющих связанный тип данных. Part
может содержать только один из типов, принятых в Part.data
.
Part
должна иметь фиксированный тип IANA MIME, определяющий тип и подтип носителя, если поле inlineData
заполнено необработанными байтами.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
text | Встроенный текст. |
inlineData | Встроенные медиабайты. |
functionCall | Прогнозируемый |
functionResponse | Результат вызова |
fileData | Данные на основе URI. |
Блоб
Необработанные медиабайты.
Текст не следует отправлять в виде необработанных байтов, используйте поле «текст».
JSON-представление |
---|
{ "mimeType": string, "data": string } |
Поля | |
---|---|
mimeType | Стандартный MIME-тип IANA исходных данных. Примеры: - image/png - image/jpeg Если указан неподдерживаемый тип MIME, будет возвращена ошибка. Полный список поддерживаемых типов см. в разделе Поддерживаемые форматы файлов . |
data | Необработанные байты для медиаформатов. Строка в кодировке Base64. |
Вызов функции
Прогнозируемый вызов FunctionCall
, возвращенный из модели, содержит строку, представляющую FunctionDeclaration.name
с аргументами и их значениями.
JSON-представление |
---|
{ "name": string, "args": { object } } |
Поля | |
---|---|
name | Необходимый. Имя функции, которую нужно вызвать. Должен быть az, AZ, 0–9 или содержать символы подчеркивания и тире, максимальная длина — 63. |
args | Необязательный. Параметры и значения функции в формате объекта JSON. |
ФункцияОтвет
Выходные данные FunctionCall
, содержащие строку, представляющую FunctionDeclaration.name
, и структурированный объект JSON, содержащий любые выходные данные функции, используются в качестве контекста для модели. Он должен содержать результат вызова FunctionCall
, созданного на основе предсказания модели.
JSON-представление |
---|
{ "name": string, "response": { object } } |
Поля | |
---|---|
name | Необходимый. Имя функции, которую нужно вызвать. Должен быть az, AZ, 0–9 или содержать символы подчеркивания и тире, максимальная длина — 63. |
response | Необходимый. Ответ функции в формате объекта JSON. |
ФайлДанные
Данные на основе URI.
JSON-представление |
---|
{ "mimeType": string, "fileUri": string } |
Поля | |
---|---|
mimeType | Необязательный. Стандартный MIME-тип IANA исходных данных. |
fileUri | Необходимый. УРИ. |
Инструмент
Сведения об инструменте, которые модель может использовать для генерации ответа.
Tool
— это фрагмент кода, который позволяет системе взаимодействовать с внешними системами для выполнения действия или набора действий за пределами знаний и области действия модели.
JSON-представление |
---|
{
"functionDeclarations": [
{
object ( |
Поля | |
---|---|
functionDeclarations[] | Необязательный. Список Модель или система не выполняет функцию. Вместо этого определенная функция может быть возвращена как [FunctionCall][content.part.function_call] с аргументами на стороне клиента для выполнения. Модель может решить вызвать подмножество этих функций, заполнив [FunctionCall][content.part.function_call] в ответе. Следующий ход диалога может содержать [FunctionResponse][content.part.function_response] с контекстом генерации «функции» [content.role] для следующего хода модели. |
Объявление функции
Структурированное представление объявления функции, определенное спецификацией OpenAPI 3.03 . В это объявление включены имя функции и параметры. Это объявление функции является представлением блока кода, который может использоваться моделью в качестве Tool
и выполняться клиентом.
JSON-представление |
---|
{
"name": string,
"description": string,
"parameters": {
object ( |
Поля | |
---|---|
name | Необходимый. Имя функции. Должен быть az, AZ, 0–9 или содержать символы подчеркивания и тире, максимальная длина — 63. |
description | Необходимый. Краткое описание функции. |
parameters | Необязательный. Описывает параметры этой функции. Отражает строку объекта параметра Open API 3.03. Ключ: имя параметра. Имена параметров чувствительны к регистру. Значение схемы: схема, определяющая тип, используемый для параметра. |
Схема
Объект Schema
позволяет определять типы входных и выходных данных. Эти типы могут быть объектами, а также примитивами и массивами. Представляет выбранное подмножество объекта схемы OpenAPI 3.0 .
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Необходимый. Тип данных. |
format | Необязательный. Формат данных. Это используется только для примитивных типов данных. Поддерживаемые форматы: для типа NUMBER: float, double для типа INTEGER: int32, int64. |
description | Необязательный. Краткое описание параметра. Это может содержать примеры использования. Описание параметра может быть отформатировано как Markdown. |
nullable | Необязательный. Указывает, может ли значение быть нулевым. |
enum[] | Необязательный. Возможные значения элемента Type.STRING в формате перечисления. Например, мы можем определить направление перечисления как: {type:STRING, format:enum, enum:["ВОСТОК", СЕВЕР", "ЮГ", "ЗАПАД"]} |
properties | Необязательный. Свойства Type.OBJECT. Объект, содержащий список пар |
required[] | Необязательный. Обязательные свойства Type.OBJECT. |
items | Необязательный. Схема элементов Type.ARRAY. |
Тип
Тип содержит список типов данных OpenAPI, как определено https://spec.openapis.org/oas/v3.0.3#data-types.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Не указано, не следует использовать. |
STRING | Тип строки. |
NUMBER | Тип номера. |
INTEGER | Целочисленный тип. |
BOOLEAN | Булев тип. |
ARRAY | Тип массива. |
OBJECT | Тип объекта. |
ИнструментКонфигурация
Конфигурация инструмента, содержащая параметры для указания использования Tool
в запросе.
JSON-представление |
---|
{
"functionCallingConfig": {
object ( |
Поля | |
---|---|
functionCallingConfig | Необязательный. Конфигурация вызова функции. |
ФункцияВызовConfig
Конфигурация для указания поведения вызова функций.
JSON-представление |
---|
{
"mode": enum ( |
Поля | |
---|---|
mode | Необязательный. Указывает режим, в котором должен выполняться вызов функции. Если не указано, значение по умолчанию будет установлено на АВТО. |
allowedFunctionNames[] | Необязательный. Набор имен функций, который, если он указан, ограничивает функции, которые будет вызывать модель. Это значение следует устанавливать только в том случае, если выбран режим ЛЮБОЙ. Имена функций должны соответствовать [FunctionDeclaration.name]. Если для режима установлено значение ЛЮБОЙ, модель будет прогнозировать вызов функции на основе предоставленного набора имен функций. |
Режим
Определяет поведение выполнения для вызова функции путем определения режима выполнения.
Перечисления | |
---|---|
MODE_UNSPECIFIED | Неуказанный режим вызова функции. Это значение не следует использовать. |
AUTO | Поведение модели по умолчанию: модель решает предсказать либо вызов функции, либо ответ на естественном языке. |
ANY | Модель ограничена всегда прогнозированием только вызова функции. Если установлены «allowedFunctionNames», прогнозируемый вызов функции будет ограничен любым из «allowedFunctionNames», в противном случае прогнозируемый вызов функции будет любым из предоставленных «объявлений функций». |
NONE | Модель не будет предсказывать какой-либо вызов функции. Поведение модели такое же, как и при отсутствии каких-либо объявлений функций. |
Использованиеметаданные
Метаданные об использовании кэшированного контента.
JSON-представление |
---|
{ "totalTokenCount": integer } |
Поля | |
---|---|
totalTokenCount | Общее количество токенов, которые потребляет кэшированный контент. |
Методы | |
---|---|
| Создает ресурс CachedContent. |
| Удаляет ресурс CachedContent. |
| Читает ресурс CachedContent. |
| Перечисляет кэшированное содержимое. |
| Обновляет ресурс CachedContent (обновляется только срок действия). |