Кэширование контекста позволяет сохранять и повторно использовать предварительно вычисленные входные токены, которые вы хотите использовать повторно, например, при постановке разных вопросов об одном и том же медиафайле. Это может привести к экономии средств и повышению скорости, в зависимости от использования. Подробное введение см. в руководстве по кэшированию контекста .
Метод: cachedContents.create
Создает ресурс CachedContent.
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Текст запроса
Тело запроса содержит экземпляр CachedContent
.
contents[]
object ( Content
)
Необязательно. Только ввод. Неизменяемо. Содержимое для кэширования.
tools[]
object ( Tool
)
Необязательный. Только входные данные. Неизменяемый. Список Tools
модель может использовать для генерации следующего ответа.
expiration
Union type
expiration
может быть только одним из следующих: expireTime
string ( Timestamp
format)
Временная метка в формате UTC, когда ресурс считается истёкшим. Она всегда указывается на выходе, независимо от того, что было отправлено на входе.
Использует 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"
.
ttl
string ( Duration
format)
Только ввод. Новый TTL для этого ресурса, только ввод.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s
». Пример: "3.5s"
.
string
displayName
Необязательно. Неизменяемо. Созданное пользователем осмысленное отображаемое имя кэшированного контента. Максимум 128 символов Unicode.
string
model
Обязательно. Неизменяемо. Имя Model
, используемой для кэшированного контента. Формат: models/{model}
object ( Content )
systemInstruction
Необязательно. Только ввод. Неизменяемо. Системная инструкция, заданная разработчиком. В настоящее время только текст.
toolConfig
object ( ToolConfig
)
Необязательно. Только ввод. Неизменяемо. Конфигурация инструмента. Эта конфигурация общая для всех инструментов.
Пример запроса
Базовый
Питон
Node.js
Идти
Оболочка
От имени
Питон
Node.js
Идти
Из чата
Питон
Node.js
Идти
Тело ответа
В случае успеха тело ответа содержит вновь созданный экземпляр CachedContent
.
Метод: cachedContents.list
Списки кэшированного содержимого.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Параметры запроса
pageSize
integer
Необязательно. Максимальное количество возвращаемых кэшированных элементов. Служба может вернуть меньше этого значения. Если не указано, будет возвращено некоторое количество элементов по умолчанию (меньше максимального). Максимальное значение — 1000; значения выше 1000 будут приведены к 1000.
string
pageToken
Необязательно. Токен страницы, полученный из предыдущего вызова cachedContents.list
. Укажите его для получения следующей страницы.
При пагинации все остальные параметры, предоставленные cachedContents.list
, должны соответствовать вызову, который предоставил токен страницы.
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ со списком CachedContents.
В случае успеха тело ответа содержит данные со следующей структурой:
cachedContents[]
object ( CachedContent
)
Список кэшированного содержимого.
string
nextPageToken
Токен, который можно отправить как pageToken
для получения следующей страницы. Если это поле пропущено, последующих страниц не будет.
JSON-представление |
---|
{
"cachedContents": [
{
object ( |
Метод: cachedContents.get
Читает ресурс CachedContent.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Параметры пути
string
name
Обязательно. Имя ресурса, ссылающегося на запись кэша контента. Формат: cachedContents/{id}
Имеет вид cachedContents/{cachedcontent}
.
Текст запроса
Тело запроса должно быть пустым.
Пример запроса
Питон
Node.js
Идти
Оболочка
Тело ответа
В случае успеха тело ответа содержит экземпляр CachedContent
.
Метод: cachedContents.patch
Обновляет ресурс CachedContent (обновляется только срок действия).
Конечная точка
патчhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Параметры пути
string
cachedContent.name
Только вывод. Идентификатор. Имя ресурса, относящегося к кэшированному содержимому. Формат: cachedContents/{id}
Имеет вид cachedContents/{cachedcontent}
.
Параметры запроса
string ( FieldMask format)
updateMask
Список полей для обновления.
Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo"
.
Текст запроса
Тело запроса содержит экземпляр CachedContent
.
expiration
Union type
expiration
может быть только одним из следующих: expireTime
string ( Timestamp
format)
Временная метка в формате UTC, когда ресурс считается истёкшим. Она всегда указывается на выходе, независимо от того, что было отправлено на входе.
Использует 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"
.
ttl
string ( Duration
format)
Только ввод. Новый TTL для этого ресурса, только ввод.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s
». Пример: "3.5s"
.
Пример запроса
Питон
Node.js
Идти
Оболочка
Тело ответа
В случае успеха тело ответа содержит экземпляр CachedContent
.
Метод: cachedContents.delete
Удаляет ресурс CachedContent.
Конечная точка
удалитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Параметры пути
string
name
Обязательно. Имя ресурса, ссылающегося на запись кэша контента. Формат: cachedContents/{id}
Имеет вид cachedContents/{cachedcontent}
.
Текст запроса
Тело запроса должно быть пустым.
Пример запроса
Питон
Node.js
Идти
Оболочка
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
Ресурс REST: cachedContents
- Ресурс: CachedContent
- Содержание
- Часть
- Клякса
- FunctionCall
- ФункцияОтвет
- Планирование
- FileData
- ИсполняемыйКод
- Язык
- CodeExecutionResult
- Исход
- ВидеоМетаданные
- Инструмент
- Объявление функции
- Схема
- Тип
- Поведение
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Режим
- CodeExecution
- GoogleSearch
- Интервал
- UrlContext
- ToolConfig
- Конфигурация вызова функции
- Режим
- ИспользованиеМетаданных
- Методы
Ресурс: CachedContent
Контент, который был предварительно обработан и может быть использован в последующем запросе к GenerativeService.
Кэшированный контент можно использовать только с той моделью, для которой он был создан.
contents[]
object ( Content
)
Необязательно. Только ввод. Неизменяемо. Содержимое для кэширования.
tools[]
object ( Tool
)
Необязательный. Только входные данные. Неизменяемый. Список Tools
модель может использовать для генерации следующего ответа.
createTime
string ( Timestamp
format)
Только вывод. Время создания записи в кэше.
Использует 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"
.
updateTime
string ( Timestamp
format)
Только вывод. Время последнего обновления записи в кэше (по UTC).
Использует 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"
.
usageMetadata
object ( UsageMetadata
)
Только вывод. Метаданные об использовании кэшированного контента.
expiration
Union type
expiration
может быть только одним из следующих: expireTime
string ( Timestamp
format)
Временная метка в формате UTC, когда ресурс считается истёкшим. Она всегда указывается на выходе, независимо от того, что было отправлено на входе.
Использует 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"
.
ttl
string ( Duration
format)
Только ввод. Новый TTL для этого ресурса, только ввод.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s
». Пример: "3.5s"
.
string
name
Только вывод. Идентификатор. Имя ресурса, относящегося к кэшированному содержимому. Формат: cachedContents/{id}
string
displayName
Необязательно. Неизменяемо. Созданное пользователем осмысленное отображаемое имя кэшированного контента. Максимум 128 символов Unicode.
string
model
Обязательно. Неизменяемо. Имя Model
, используемой для кэшированного контента. Формат: models/{model}
object ( Content )
systemInstruction
Необязательно. Только ввод. Неизменяемо. Системная инструкция, заданная разработчиком. В настоящее время только текст.
toolConfig
object ( ToolConfig
)
Необязательно. Только ввод. Неизменяемо. Конфигурация инструмента. Эта конфигурация общая для всех инструментов.
JSON-представление |
---|
{ "contents": [ { object ( |
Содержание
Базовый структурированный тип данных, содержащий многочастное содержимое сообщения.
Content
включает поле role
, обозначающее производителя Content
, и поле parts
, содержащее многокомпонентные данные, включающие содержимое поворота сообщения.
parts[]
object ( Part
)
Упорядоченные Parts
, составляющие единое сообщение. Части могут иметь разные типы MIME.
string
role
Необязательно. Производитель контента. Должен быть либо «пользователь», либо «модель».
Полезно устанавливать для многооборотных разговоров, в противном случае можно оставить пустым или не устанавливать.
JSON-представление |
---|
{
"parts": [
{
object ( |
Часть
Тип данных, содержащий медиа-данные, являющиеся частью многокомпонентного сообщения Content
.
Part
состоит из данных, имеющих связанный тип данных. Part
может содержать только один из допустимых типов в Part.data
.
Part
должна иметь фиксированный тип IANA MIME, определяющий тип и подтип носителя, если поле inlineData
заполнено необработанными байтами.
thought
boolean
Необязательно. Указывает, была ли деталь разработана на основе модели.
string ( bytes format)
thoughtSignature
Необязательно. Непрозрачная подпись для мысли, чтобы её можно было использовать повторно в последующих запросах.
Строка в кодировке base64.
Union type
data
data
могут быть только одним из следующих:text
string
Встроенный текст.
inlineData
object ( Blob
)
Встроенные медиа-байты.
object ( FunctionCall )
functionCall
Предсказанный FunctionCall
возвращаемый из модели, содержащий строку, представляющую FunctionDeclaration.name
с аргументами и их значениями.
object ( FunctionResponse )
functionResponse
Результат вывода FunctionCall
, содержащий строку, представляющую FunctionDeclaration.name
, и структурированный объект JSON, содержащий любые выходные данные функции, используется в качестве контекста для модели.
fileData
object ( FileData
)
Данные на основе URI.
object ( ExecutableCode )
executableCode
Код, сгенерированный моделью и предназначенный для выполнения.
object ( CodeExecutionResult )
codeExecutionResult
Результат выполнения ExecutableCode
.
metadata
Union type
metadata
могут быть только одними из следующих:object ( VideoMetadata )
videoMetadata
Необязательно. Метаданные видео. Метаданные следует указывать только в том случае, если видеоданные представлены в inlineData или fileData.
JSON-представление |
---|
{ "thought": boolean, "thoughtSignature": string, // data "text": string, "inlineData": { object ( |
Клякса
Необработанные медиа-байты.
Текст не следует отправлять в виде необработанных байтов, используйте поле «текст».
string
mimeType
Стандартный тип MIME IANA для исходных данных. Примеры: - image/png - image/jpeg. Если указан неподдерживаемый тип MIME, будет возвращена ошибка. Полный список поддерживаемых типов см. в разделе «Поддерживаемые форматы файлов» .
string ( bytes format)
data
Необработанные байты для медиаформатов.
Строка в кодировке base64.
JSON-представление |
---|
{ "mimeType": string, "data": string } |
FunctionCall
Предсказанный FunctionCall
возвращаемый из модели, содержащий строку, представляющую FunctionDeclaration.name
с аргументами и их значениями.
string
id
Необязательно. Уникальный идентификатор вызова функции. Если он заполнен, клиент выполнит functionCall
и вернет ответ с соответствующим id
.
string
name
Обязательно. Имя вызываемой функции. Имя должно содержать символы az, AZ, 0-9 или символы подчеркивания и тире. Максимальная длина — 63 символа.
args
object ( Struct
format)
Необязательно. Параметры и значения функции в формате JSON-объекта.
JSON-представление |
---|
{ "id": string, "name": string, "args": { object } } |
ФункцияОтвет
Результат вызова FunctionCall
, содержащий строку, представляющую FunctionDeclaration.name
, и структурированный JSON-объект, содержащий все выходные данные функции, используется в качестве контекста для модели. Он должен содержать результат вызова FunctionCall
, выполненного на основе прогноза модели.
string
id
Необязательно. Идентификатор вызова функции, для которой предназначен этот ответ. Заполняется клиентом в соответствии с id
вызова функции.
string
name
Обязательно. Имя вызываемой функции. Имя должно содержать символы az, AZ, 0-9 или символы подчеркивания и тире. Максимальная длина — 63 символа.
object ( Struct format)
response
Обязательно. Ответ функции в формате JSON-объекта.
willContinue
boolean
Необязательно. Сигнализирует о продолжении вызова функции и о том, что будут возвращены дополнительные ответы, превращая вызов функции в генератор. Применимо только к вызовам функций NON_BLOCKING, в противном случае игнорируется. Если установлено значение false, последующие ответы не будут учитываться. Разрешается возвращать пустой response
с willContinue=False
чтобы сигнализировать о завершении вызова функции. Это может привести к запуску генерации модели. Чтобы избежать запуска генерации и завершить вызов функции, дополнительно установите scheduling
значение SILENT
.
scheduling
enum ( Scheduling
)
Необязательно. Указывает, как следует планировать ответ в диалоге. Применимо только к вызовам функций NON_BLOCKING, в противном случае игнорируется. По умолчанию WHEN_IDLE.
JSON-представление |
---|
{
"id": string,
"name": string,
"response": {
object
},
"willContinue": boolean,
"scheduling": enum ( |
Планирование
Указывает, как следует планировать ответ в разговоре.
Перечисления | |
---|---|
SCHEDULING_UNSPECIFIED | Это значение не используется. |
SILENT | Только добавляйте результат в контекст беседы, не прерывайте и не запускайте генерацию. |
WHEN_IDLE | Добавьте результат в контекст беседы и подсказывайте, как сгенерировать вывод, не прерывая текущую генерацию. |
INTERRUPT | Добавить результат в контекст разговора, прервать текущую генерацию и предложить сгенерировать вывод. |
FileData
Данные на основе URI.
string
mimeType
Необязательно. Стандартный тип MIME IANA для исходных данных.
string
fileUri
Обязательно. URI.
JSON-представление |
---|
{ "mimeType": string, "fileUri": string } |
ИсполняемыйКод
Код, сгенерированный моделью, предназначенный для выполнения, и результат, возвращаемый модели.
Генерируется только при использовании инструмента CodeExecution
, в котором код будет автоматически выполнен, а также будет сгенерирован соответствующий CodeExecutionResult
.
language
enum ( Language
)
Обязательно. Язык программирования code
.
code
string
Обязательно. Код для выполнения.
JSON-представление |
---|
{
"language": enum ( |
Язык
Поддерживаемые языки программирования для сгенерированного кода.
Перечисления | |
---|---|
LANGUAGE_UNSPECIFIED | Язык не указан. Это значение не следует использовать. |
PYTHON | Python >= 3.10, с доступными numpy и simpy. |
CodeExecutionResult
Результат выполнения ExecutableCode
.
Генерируется только при использовании CodeExecution
и всегда следует за part
содержащей ExecutableCode
.
outcome
enum ( Outcome
)
Обязательно. Результат выполнения кода.
output
string
Необязательно. Содержит stdout при успешном выполнении кода, stderr или другое описание в противном случае.
JSON-представление |
---|
{
"outcome": enum ( |
Исход
Перечисление возможных результатов выполнения кода.
Перечисления | |
---|---|
OUTCOME_UNSPECIFIED | Статус не указан. Это значение не следует использовать. |
OUTCOME_OK | Выполнение кода завершено успешно. |
OUTCOME_FAILED | Выполнение кода завершено, но с ошибкой. stderr должен содержать причину. |
OUTCOME_DEADLINE_EXCEEDED | Выполнение кода заняло слишком много времени и было отменено. Возможно, присутствует частичный вывод, а возможно, и нет. |
ВидеоМетаданные
Метаданные описывают входной видеоконтент.
startOffset
string ( Duration
format)
Необязательно. Начальное смещение видео.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s
». Пример: "3.5s"
.
endOffset
string ( Duration
format)
Необязательно. Смещение конца видео.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « s
». Пример: "3.5s"
.
number
fps
Необязательно. Частота кадров видео, отправляемого модели. Если не указано, по умолчанию будет использоваться значение 1,0. Диапазон кадров в секунду: (0,0, 24,0).
JSON-представление |
---|
{ "startOffset": string, "endOffset": string, "fps": number } |
Инструмент
Подробная информация об инструментах, которые модель может использовать для генерации ответа.
Tool
— это фрагмент кода, который позволяет системе взаимодействовать с внешними системами для выполнения действия или набора действий, выходящих за рамки знаний и области действия модели.
functionDeclarations[]
object ( FunctionDeclaration
)
Необязательно. Список доступных модели FunctionDeclarations
, которые можно использовать для вызова функций.
Модель или система не выполняет функцию. Вместо этого определённая функция может быть возвращена как FunctionCall
с аргументами на клиентскую сторону для выполнения. Модель может принять решение о вызове подмножества этих функций, заполнив FunctionCall
в ответе. Следующий этап диалога может содержать FunctionResponse
с контекстом генерации Content.role
«function» для следующего этапа модели.
object ( GoogleSearchRetrieval )
googleSearchRetrieval
Необязательно. Инструмент поиска, работающий на основе поиска Google.
object ( CodeExecution )
codeExecution
Необязательно. Позволяет модели выполнять код в процессе генерации.
object ( GoogleSearch )
googleSearch
Необязательно. Тип инструмента GoogleSearch. Инструмент для поддержки поиска Google в модели. Работает на базе Google.
object ( UrlContext )
urlContext
Необязательно. Инструмент для поддержки поиска контекста URL.
JSON-представление |
---|
{ "functionDeclarations": [ { object ( |
Объявление функции
Структурированное представление объявления функции, как определено в спецификации OpenAPI 3.03 . В это объявление включены имя функции и параметры. Это объявление FunctionDeclaration представляет собой блок кода, который может использоваться моделью в качестве Tool
и выполняться клиентом.
string
name
Обязательно. Имя функции. Должно содержать символы az, AZ, 0-9 или символы подчеркивания и тире. Максимальная длина — 63 символа.
string
description
Обязательно. Краткое описание функции.
behavior
enum ( Behavior
)
Необязательно. Задаёт поведение функции. В настоящее время поддерживается только методом BidiGenerateContent.
parameters
object ( Schema
)
Необязательно. Описывает параметры этой функции. Соответствует строке объекта параметра Open API 3.03. Ключ: имя параметра. Имена параметров чувствительны к регистру. Значение схемы: схема, определяющая тип, используемый для параметра.
parametersJsonSchema
value ( Value
format)
Необязательно. Описывает параметры функции в формате JSON-схемы. Схема должна описывать объект, свойства которого являются параметрами функции. Например:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Это поле является взаимоисключающим с parameters
.
response
object ( Schema
)
Необязательно. Описывает выходные данные этой функции в формате схемы JSON. Соответствует объекту ответа Open API 3.03. Схема определяет тип, используемый для значения ответа функции.
responseJsonSchema
value ( Value
format)
Необязательно. Описывает выходные данные этой функции в формате схемы JSON. Значение, указанное в схеме, является значением ответа функции.
Это поле является взаимоисключающим с response
.
Схема
Объект Schema
позволяет определять типы входных и выходных данных. Эти типы могут быть объектами, а также примитивами и массивами. Представляет собой выбранное подмножество объекта схемы OpenAPI 3.0 .
type
enum ( Type
)
Обязательно. Тип данных.
string
format
Необязательный параметр. Формат данных. Используется только для примитивных типов данных. Поддерживаемые форматы: для типа NUMBER: float, double; для типа INTEGER: int32, int64; для типа STRING: enum, date-time.
string
title
Необязательно. Название схемы.
string
description
Необязательно. Краткое описание параметра. Может содержать примеры использования. Описание параметра можно отформатировать в формате Markdown.
boolean
nullable
Необязательно. Указывает, может ли значение быть нулевым.
enum[]
string
Необязательно. Возможные значения элемента Type.STRING в формате enum. Например, мы можем определить Enum Direction следующим образом: {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
string ( int64 format)
maxItems
Необязательно. Максимальное количество элементов для Type.ARRAY.
string ( int64 format)
minItems
Необязательно. Минимальное количество элементов для Type.ARRAY.
properties
map (key: string, value: object ( Schema
))
Необязательно. Свойства типа.OBJECT.
Объект, содержащий список пар "key": value
. Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
required[]
string
Необязательно. Обязательные свойства Type.OBJECT.
string ( int64 format)
minProperties
Необязательно. Минимальное количество свойств для Type.OBJECT.
string ( int64 format)
maxProperties
Необязательно. Максимальное количество свойств для Type.OBJECT.
minLength
string ( int64 format)
Необязательно. ПОЛЯ СХЕМЫ ДЛЯ ТИПА STRING Минимальная длина Type.STRING
maxLength
string ( int64 format)
Необязательно. Максимальная длина Type.STRING
string
pattern
Необязательно. Шаблон Type.STRING для ограничения строки регулярным выражением.
example
value ( Value
format)
Необязательно. Пример объекта. Заполняется только в том случае, если объект является корневым.
anyOf[]
object ( Schema
)
Необязательно. Значение должно быть проверено по любой (одной или нескольким) подсхемам в списке.
propertyOrdering[]
string
Необязательно. Порядок свойств. Нестандартное поле в спецификации Open API. Используется для определения порядка свойств в ответе.
default
value ( Value
format)
Необязательное. Значение поля по умолчанию. Согласно схеме JSON, это поле предназначено для генераторов документации и не влияет на валидацию. Поэтому оно включено сюда и игнорируется, чтобы разработчики, отправляющие схемы с полем default
не получали ошибок неизвестного поля.
items
object ( Schema
)
Необязательно. Схема элементов Type.ARRAY.
minimum
number
Необязательно. ПОЛЯ СХЕМЫ ДЛЯ ТИПА INTEGER и NUMBER Минимальное значение Type.INTEGER и Type.NUMBER
maximum
number
Необязательно. Максимальное значение Type.INTEGER и Type.NUMBER.
JSON-представление |
---|
{ "type": enum ( |
Тип
Тип содержит список типов данных OpenAPI, как определено в https://spec.openapis.org/oas/v3.0.3#data-types
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Не указано, не следует использовать. |
STRING | Тип строки. |
NUMBER | Тип числа. |
INTEGER | Целочисленный тип. |
BOOLEAN | Булевский тип. |
ARRAY | Тип массива. |
OBJECT | Тип объекта. |
NULL | Нулевой тип. |
Поведение
Определяет поведение функции. По умолчанию — BLOCKING
.
Перечисления | |
---|---|
UNSPECIFIED | Это значение не используется. |
BLOCKING | Если установлено, система будет ждать ответа функции, прежде чем продолжить разговор. |
NON_BLOCKING | Если установлено, система не будет дожидаться ответа функции. Вместо этого она будет пытаться обрабатывать ответы функций по мере их поступления, поддерживая при этом диалог между пользователем и моделью. |
GoogleSearchRetrieval
Инструмент для извлечения общедоступных веб-данных для заземления, работающий на базе Google.
object ( DynamicRetrievalConfig )
dynamicRetrievalConfig
Задает конфигурацию динамического извлечения для заданного источника.
JSON-представление |
---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Описывает возможности настройки динамического поиска.
mode
enum ( Mode
)
Режим предиктора, который будет использоваться при динамическом поиске.
dynamicThreshold
number
Пороговое значение, используемое при динамическом поиске. Если не задано, используется системное значение по умолчанию.
JSON-представление |
---|
{
"mode": enum ( |
Режим
Режим предиктора, который будет использоваться при динамическом поиске.
Перечисления | |
---|---|
MODE_UNSPECIFIED | Всегда запускайте извлечение. |
MODE_DYNAMIC | Запускайте извлечение только тогда, когда система решит, что это необходимо. |
CodeExecution
Этот тип не имеет полей.
Инструмент, который выполняет код, сгенерированный моделью, и автоматически возвращает результат модели.
См. также ExecutableCode
и CodeExecutionResult
, которые генерируются только при использовании этого инструмента.
GoogleSearch
Тип инструмента GoogleSearch. Инструмент для поддержки поиска Google в модели. Работает на базе Google.
object ( Interval )
timeRangeFilter
Необязательно. Фильтрация результатов поиска по определённому временному диапазону. Если клиенты указали время начала, им необходимо указать время окончания (и наоборот).
JSON-представление |
---|
{
"timeRangeFilter": {
object ( |
Интервал
Представляет временной интервал, закодированный как начальная метка времени (включительно) и конечная метка времени (исключая).
Начало должно быть меньше или равно концу. Если начало равно концу, интервал пустой (не соответствует ни одному времени). Если ни начало, ни конец не указаны, интервал соответствует любому времени.
startTime
string ( Timestamp
format)
Необязательно. Начало интервала включено.
Если указано, то соответствующая этому интервалу временная метка должна быть такой же или более поздней.
Использует 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"
.
endTime
string ( Timestamp
format)
Необязательно. Исключительный конец интервала.
Если указано, то соответствующая этому интервалу временная метка должна быть до конца.
Использует 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-представление |
---|
{ "startTime": string, "endTime": string } |
UrlContext
Этот тип не имеет полей.
Инструмент для поддержки поиска контекста URL.
ToolConfig
Конфигурация инструмента, содержащая параметры для указания использования Tool
в запросе.
object ( FunctionCallingConfig )
functionCallingConfig
Необязательно. Функция, вызывающая конфигурацию.
JSON-представление |
---|
{
"functionCallingConfig": {
object ( |
Конфигурация вызова функции
Конфигурация для указания поведения вызова функций.
mode
enum ( Mode
)
Необязательный параметр. Указывает режим, в котором должен выполняться вызов функции. Если параметр не указан, по умолчанию будет установлено значение AUTO.
string
allowedFunctionNames[]
Необязательный. Набор имён функций, который, если указан, ограничивает функции, вызываемые моделью.
Этот параметр следует устанавливать только в том случае, если для параметра Mode установлено значение ANY. Имена функций должны соответствовать [FunctionDeclaration.name]. Если для параметра Mode установлено значение ANY, модель будет предсказывать вызов функции из предоставленного набора имён функций.
JSON-представление |
---|
{
"mode": enum ( |
Режим
Определяет поведение выполнения для вызова функции путем определения режима выполнения.
Перечисления | |
---|---|
MODE_UNSPECIFIED | Не указан режим вызова функции. Это значение не следует использовать. |
AUTO | Поведение модели по умолчанию: модель решает предсказать либо вызов функции, либо ответ на естественном языке. |
ANY | Модель ограничена тем, что всегда предсказывает только вызов функции. Если задано "allowedFunctionNames", то предсказанным вызовом функции будет любое из "allowedFunctionNames", в противном случае предсказанным вызовом функции будет любое из предоставленных "functionDeclarations". |
NONE | Модель не предскажет ни одного вызова функции. Поведение модели такое же, как и без объявления функций. |
VALIDATED | Модель решает предсказать либо вызов функции, либо ответ на естественном языке, но будет проверять вызовы функций с помощью ограниченного декодирования. |
ИспользованиеМетаданных
Метаданные об использовании кэшированного контента.
totalTokenCount
integer
Общее количество токенов, потребляемых кэшированным контентом.
JSON-представление |
---|
{ "totalTokenCount": integer } |