API Gemini поддерживает генерацию контента с использованием изображений, аудио, кода, инструментов и многого другого. Для получения подробной информации о каждой из этих функций читайте дальше и ознакомьтесь с примерами кода, ориентированными на решение конкретных задач, или прочитайте подробные руководства.
- Генерация текста
- Зрение
- Аудио
- Эмбеддинги
- Длинный контекст
- Выполнение кода
- Режим JSON
- Вызов функции
- Системные инструкции
Метод: models.generateContent
Генерирует ответ модели на входной запрос GenerateContentRequest . Подробную информацию об использовании см. в руководстве по генерации текста . Возможности ввода различаются для разных моделей, включая оптимизированные модели. Для получения более подробной информации см. руководство по моделям и руководство по оптимизации .
Конечная точка
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContentПараметры пути
string model Обязательно. Название Model , которая будет использоваться для генерации автозавершения.
Формат: models/{model} . Он принимает вид models/{model} .
Текст запроса
Тело запроса содержит данные следующей структуры:
tools[]object ( Tool ) Необязательно. Список Tools Model может использовать для генерации следующего ответа.
Tool — это фрагмент кода, позволяющий системе взаимодействовать с внешними системами для выполнения действия или набора действий, выходящих за рамки знаний и области действия Model . Поддерживаемые Tool — это Function и codeExecution . Для получения дополнительной информации обратитесь к руководствам по вызову функций и выполнению кода .
toolConfigobject ( ToolConfig ) Необязательно. Конфигурация инструмента для любого Tool указанного в запросе. Пример использования см. в руководстве по вызову функций .
safetySettings[]object ( SafetySetting ) Необязательно. Список уникальных экземпляров SafetySetting для блокировки небезопасного контента.
Это будет применяться к GenerateContentRequest.contents и GenerateContentResponse.candidates . Для каждого типа SafetyCategory не должно быть более одной настройки. API будет блокировать любой контент и ответы, которые не соответствуют пороговым значениям, установленным этими настройками. Этот список переопределяет настройки по умолчанию для каждой SafetyCategory , указанной в safetySettings. Если для данной SafetyCategory в списке не указана SafetySetting SafetyCategory , API будет использовать настройку безопасности по умолчанию для этой категории. Поддерживаются категории вреда HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Подробную информацию о доступных настройках безопасности см. в руководстве . Также обратитесь к руководству по безопасности , чтобы узнать, как учитывать соображения безопасности в ваших приложениях ИИ.
systemInstructionobject ( Content )Необязательно. Разработчик задает системные инструкции . В настоящее время только текст.
generationConfigobject ( GenerationConfig )Необязательно. Параметры конфигурации для генерации модели и выходных данных.
cachedContentstring Необязательно. Название кэшированного контента, используемого в качестве контекста для выполнения прогнозирования. Формат: cachedContents/{cachedContent}
storebooleanНеобязательный параметр. Задает поведение логирования для данного запроса. Если задан, он имеет приоритет над конфигурацией логирования на уровне проекта.
Пример запроса
Текст
Python
Node.js
Идти
Оболочка
Java
Изображение
Python
Node.js
Идти
Оболочка
Java
Аудио
Python
Node.js
Идти
Оболочка
Видео
Python
Node.js
Идти
Оболочка
Python
Идти
Оболочка
Чат
Python
Node.js
Идти
Оболочка
Java
Кэш
Python
Node.js
Идти
Тюнингованная модель
Python
Режим JSON
Python
Node.js
Идти
Оболочка
Java
Выполнение кода
Python
Идти
Java
Вызов функции
Python
Идти
Node.js
Оболочка
Java
Конфигурация генерации
Python
Node.js
Идти
Оболочка
Java
Настройки безопасности
Python
Node.js
Идти
Оболочка
Java
Системная инструкция
Python
Node.js
Идти
Оболочка
Java
Ответный текст
В случае успеха тело ответа будет содержать экземпляр GenerateContentResponse .
Метод: models.streamGenerateContent
Генерирует потоковый ответ от модели на основе входных данных GenerateContentRequest .
Конечная точка
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContentПараметры пути
string model Обязательно. Название Model , которая будет использоваться для генерации автозавершения.
Формат: models/{model} . Он принимает вид models/{model} .
Текст запроса
Тело запроса содержит данные следующей структуры:
tools[]object ( Tool ) Необязательно. Список Tools Model может использовать для генерации следующего ответа.
Tool — это фрагмент кода, позволяющий системе взаимодействовать с внешними системами для выполнения действия или набора действий, выходящих за рамки знаний и области действия Model . Поддерживаемые Tool — это Function и codeExecution . Для получения дополнительной информации обратитесь к руководствам по вызову функций и выполнению кода .
toolConfigobject ( ToolConfig ) Необязательно. Конфигурация инструмента для любого Tool указанного в запросе. Пример использования см. в руководстве по вызову функций .
safetySettings[]object ( SafetySetting ) Необязательно. Список уникальных экземпляров SafetySetting для блокировки небезопасного контента.
Это будет применяться к GenerateContentRequest.contents и GenerateContentResponse.candidates . Для каждого типа SafetyCategory не должно быть более одной настройки. API будет блокировать любой контент и ответы, которые не соответствуют пороговым значениям, установленным этими настройками. Этот список переопределяет настройки по умолчанию для каждой SafetyCategory , указанной в safetySettings. Если для данной SafetyCategory в списке не указана SafetySetting SafetyCategory , API будет использовать настройку безопасности по умолчанию для этой категории. Поддерживаются категории вреда HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Подробную информацию о доступных настройках безопасности см. в руководстве . Также обратитесь к руководству по безопасности , чтобы узнать, как учитывать соображения безопасности в ваших приложениях ИИ.
systemInstructionobject ( Content )Необязательно. Разработчик задает системные инструкции . В настоящее время только текст.
generationConfigobject ( GenerationConfig )Необязательно. Параметры конфигурации для генерации модели и выходных данных.
cachedContentstring Необязательно. Название кэшированного контента, используемого в качестве контекста для выполнения прогнозирования. Формат: cachedContents/{cachedContent}
storebooleanНеобязательный параметр. Задает поведение логирования для данного запроса. Если задан, он имеет приоритет над конфигурацией логирования на уровне проекта.
Пример запроса
Текст
Python
Node.js
Идти
Оболочка
Java
Изображение
Python
Node.js
Идти
Оболочка
Java
Аудио
Python
Идти
Оболочка
Видео
Python
Node.js
Идти
Оболочка
Python
Идти
Оболочка
Чат
Python
Node.js
Идти
Оболочка
Ответный текст
В случае успеха тело ответа содержит поток экземпляров GenerateContentResponse .
GenerateContentResponse
Ответ модели, подтверждающий наличие нескольких вариантов ответа.
Рейтинги безопасности и фильтрация контента отображаются для обоих запросов в GenerateContentResponse.prompt_feedback , а для каждого кандидата — в finishReason и safetyRatings . API: - Возвращает либо все запрошенные кандидаты, либо ни одного из них; - Не возвращает ни одного кандидата, только если с запросом что-то было не так (см. promptFeedback ); - Отображает отзывы по каждому кандидату в finishReason и safetyRatings .
candidates[]object ( Candidate )Варианты ответов, полученные от модели.
promptFeedbackobject ( PromptFeedback )Возвращает обратную связь от запроса, относящуюся к фильтрам содержимого.
usageMetadataobject ( UsageMetadata )Только вывод. Метаданные об использовании токенов в запросах на генерацию.
string modelVersionТолько выходные данные. Версия модели, использованная для генерации ответа.
responseIdstringТолько вывод. responseId используется для идентификации каждого ответа.
modelStatusobject ( ModelStatus )Только вывод. Текущее состояние данной модели.
| JSON-представление |
|---|
{ "candidates": [ { object ( |
PromptFeedback
Набор метаданных обратной связи, указанных в запросе GenerateContentRequest.content .
blockReasonenum ( BlockReason )Необязательно. Если задано, запрос был заблокирован, и варианты не возвращаются. Переформулируйте запрос.
safetyRatings[]object ( SafetyRating )Оценки безопасности подсказки. В каждой категории может быть не более одной оценки.
| JSON-представление |
|---|
{ "blockReason": enum ( |
BlockReason
Указывает причину блокировки запроса.
| Перечисления | |
|---|---|
BLOCK_REASON_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
SAFETY | Запрос был заблокирован по соображениям безопасности. Проверьте safetyRatings , чтобы узнать, какая категория безопасности привела к блокировке. |
OTHER | Запрос был заблокирован по неизвестным причинам. |
BLOCKLIST | Запрос был заблокирован из-за терминов, включенных в список заблокированных терминов. |
PROHIBITED_CONTENT | Запрос был заблокирован из-за запрещенного контента. |
IMAGE_SAFETY | Кандидаты заблокированы из-за небезопасного контента, созданного с помощью фотошопа. |
UsageMetadata
Метаданные об использовании токена в запросе на генерацию.
promptTokenCountinteger Количество токенов в запросе. Если задан параметр cachedContent , это по-прежнему общий эффективный размер запроса, то есть он включает количество токенов в кэшированном содержимом.
cachedContentTokenCountintegerКоличество токенов в кэшированной части запроса (кэшированное содержимое)
candidatesTokenCountintegerОбщее количество токенов по всем сгенерированным вариантам ответа.
toolUsePromptTokenCountintegerТолько вывод. Количество токенов, присутствующих в подсказках использования инструмента.
thoughtsTokenCountintegerТолько вывод. Количество токенов мыслей для моделей мышления.
totalTokenCountintegerОбщее количество токенов для запроса на генерацию (кандидаты запроса + ответа).
promptTokensDetails[]object ( ModalityTokenCount )Только выходные данные. Список модальностей, которые были обработаны во входном запросе.
cacheTokensDetails[]object ( ModalityTokenCount )Только вывод. Список вариантов содержимого, кэшированного в запросе.
candidatesTokensDetails[]object ( ModalityTokenCount )Только вывод. Список модальностей, которые были возвращены в ответе.
toolUsePromptTokensDetails[]object ( ModalityTokenCount )Только выходные данные. Список модальностей, обработанных для обработки запросов на использование инструмента.
| JSON-представление |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
Статус базовой модели. Используется для обозначения стадии развития базовой модели и времени вывода из эксплуатации, если таковое имеется.
modelStageenum ( ModelStage )Этап базовой модели.
retirementTimestring ( 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" .
string messageСообщение с пояснением статуса модели.
| JSON-представление |
|---|
{
"modelStage": enum ( |
ModelStage
Определяет стадию развития базовой модели.
| Перечисления | |
|---|---|
MODEL_STAGE_UNSPECIFIED | Неуказанная стадия модели. |
UNSTABLE_EXPERIMENTAL | Базовая модель подвергается множеству настроек. |
EXPERIMENTAL | Модели на данном этапе предназначены исключительно для экспериментальных целей. |
PREVIEW | Модели на этом этапе более зрелые, чем экспериментальные модели. |
STABLE | Модели на этом этапе считаются стабильными и готовыми к использованию в производственных целях. |
LEGACY | Если модель находится на этой стадии, это означает, что в ближайшем будущем она будет снята с поддержки. Использовать эту модель смогут только существующие клиенты. |
DEPRECATED | Модели на этом этапе устарели. Использовать эти модели нельзя. |
RETIRED | Модели на этом этапе сняты с производства. Эти модели использовать нельзя. |
Кандидат
- JSON-представление
- FinishReason
- Атрибуция заземления
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- Метаданные заземления
- SearchEntryPoint
- GroundingChunk
- Веб
- Изображение
- Полученный контекст
- Пользовательские метаданные
- StringList
- Карты
- PlaceAnswerSources
- ReviewSnippet
- Поддержка заземления
- Сегмент
- RetrievalMetadata
- LogprobsResult
- Лучшие кандидаты
- Кандидат
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Вариант ответа, сгенерированный на основе модели.
contentobject ( Content )Только выходные данные. Сгенерированный контент, возвращаемый моделью.
finishReasonenum ( FinishReason )Необязательно. Только для вывода. Причина, по которой модель перестала генерировать токены.
Если поле пустое, модель не прекращает генерацию токенов.
safetyRatings[]object ( SafetyRating )Список оценок безопасности кандидатов на должность в оперативно-розыскной группе.
В каждой категории может быть не более одной оценки.
citationMetadataobject ( CitationMetadata )Только выходные данные. Информация об источнике информации для кандидата, сгенерированного моделью.
Это поле может быть заполнено информацией о декламации любого текста, включенного в content . Речь идет о отрывках, которые «декламируются» из материалов, защищенных авторским правом, в обучающих данных базовой магистерской программы.
tokenCountintegerТолько вывод. Количество токенов для этого кандидата.
groundingAttributions[]object ( GroundingAttribution )Только выходные данные. Информация об источниках, которые способствовали получению обоснованного ответа.
Это поле заполняется для звонков, GenerateAnswer .
groundingMetadataobject ( GroundingMetadata )Только выходные данные. Метаданные для подтверждения данных кандидата.
Это поле заполняется для вызовов GenerateContent .
avgLogprobsnumberТолько выходные данные. Средний логарифмический показатель вероятности кандидата.
logprobsResultobject ( LogprobsResult )Только вывод. Значения логарифмической функции правдоподобия для токенов ответа и лучших токенов.
object ( UrlContextMetadata ) urlContextMetadataТолько выходные данные. Метаданные, относящиеся к инструменту получения контекста URL.
indexintegerТолько вывод. Индекс кандидата в списке кандидатов на ответ.
string finishMessage Необязательно. Только для вывода. Подробно описывает причину, по которой модель перестала генерировать токены. Заполняется только при установке finishReason .
| JSON-представление |
|---|
{ "content": { object ( |
FinishReason
Указывает причину, по которой модель перестала генерировать токены.
| Перечисления | |
|---|---|
FINISH_REASON_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
STOP | Естественная точка остановки модели или заданная последовательность остановок. |
MAX_TOKENS | Достигнуто максимальное количество токенов, указанное в запросе. |
SAFETY | Содержимое предложенного варианта ответа было помечено как потенциально опасное по соображениям безопасности. |
RECITATION | Содержание предложенного варианта ответа было помечено как требующее заучивания наизусть. |
LANGUAGE | В предложенном варианте ответа было обнаружено использование неподдерживаемого языка. |
OTHER | Причина неизвестна. |
BLOCKLIST | Генерация токенов прекращена, поскольку контент содержит запрещенные термины. |
PROHIBITED_CONTENT | Выпуск токенов приостановлен из-за потенциального наличия запрещенного контента. |
SPII | Генерация токенов прекращена, поскольку содержимое потенциально содержит конфиденциальную личную информацию (SPII). |
MALFORMED_FUNCTION_CALL | Вызов функции, сгенерированный моделью, является недопустимым. |
IMAGE_SAFETY | Генерация токенов прекращена, поскольку сгенерированные изображения содержат нарушения правил безопасности. |
IMAGE_PROHIBITED_CONTENT | Генерация изображений была остановлена, поскольку сгенерированные изображения содержали запрещенный контент. |
IMAGE_OTHER | Генерация изображений прекратилась из-за других различных проблем. |
NO_IMAGE | Предполагалось, что модель сгенерирует изображение, но изображение не было сгенерировано. |
IMAGE_RECITATION | Генерация изображений прекратилась из-за чтения вслух. |
UNEXPECTED_TOOL_CALL | Модель сгенерировала вызов инструмента, но ни один инструмент не был включен в запрос. |
TOO_MANY_TOOL_CALLS | Модель вызвала слишком много инструментов подряд, в результате чего система завершила выполнение. |
MISSING_THOUGHT_SIGNATURE | В запросе отсутствует как минимум одна подпись, выражающая мысль. |
MALFORMED_RESPONSE | Завершено из-за неправильной реакции. |
Атрибуция заземления
Укажите источник, который послужил основой для ответа.
sourceIdobject ( AttributionSourceId )Только вывод. Идентификатор источника, обеспечившего данное указание.
contentobject ( Content )Исходный контент, на основе которого составлена эта атрибуция.
| JSON-представление |
|---|
{ "sourceId": { object ( |
AttributionSourceId
Идентификатор источника, предоставившего эти данные.
sourceUnion typesource может быть только один из следующих вариантов: groundingPassageobject ( GroundingPassageId )Идентификатор для встроенного фрагмента текста.
object ( SemanticRetrieverChunk ) semanticRetrieverChunk Идентификатор Chunk , полученного с помощью семантического ретривера.
| JSON-представление |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Идентификатор части внутри объекта GroundingPassage .
string passageId Только вывод. Идентификатор фрагмента текста, соответствующего свойству GroundingPassage.id из GenerateAnswerRequest .
partIndexinteger Только вывод. Индекс части внутри GroundingPassage.content объекта GenerateAnswerRequest .
| JSON-представление |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Идентификатор Chunk , полученного с помощью семантического ретривера, указанный в GenerateAnswerRequest с использованием SemanticRetrieverConfig .
sourcestring Только вывод. Имя источника, соответствующее файлу SemanticRetrieverConfig.source запроса. Пример: corpora/123 или corpora/123/documents/abc
chunkstring Только вывод. Название Chunk , содержащего атрибутированный текст. Пример: corpora/123/documents/abc/chunks/xyz
| JSON-представление |
|---|
{ "source": string, "chunk": string } |
Метаданные заземления
Метаданные возвращаются клиенту при включении заземления.
groundingChunks[]object ( GroundingChunk )Список подтверждающих ссылок, полученных из указанного источника данных. При потоковой передаче он содержит только те фрагменты данных, которые не были включены в метаданные предыдущих ответов.
groundingSupports[]object ( GroundingSupport )Список средств заземления.
webSearchQueries[]stringПоисковые запросы в интернете для последующего поиска.
imageSearchQueries[]stringПоисковые запросы по изображениям, используемые для приведения в соответствие с реальностью.
searchEntryPointobject ( SearchEntryPoint )Необязательно. Запись в поисковой выдаче Google для последующих веб-поисков.
retrievalMetadataobject ( RetrievalMetadata )Метаданные, связанные с извлечением данных в процессе заземления.
string googleMapsWidgetContextTokenНеобязательно. Имя ресурса контекстного токена виджета Google Maps, который можно использовать с виджетом PlacesContextElement для отображения контекстных данных. Заполняется только в том случае, если включена привязка к карте с помощью Google Maps.
| JSON-представление |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Точка входа в поисковую выдачу Google.
renderedContentstringНеобязательный элемент. Фрагмент веб-контента, который можно встроить в веб-страницу или веб-представление приложения.
sdkBlobstring ( bytes format)Необязательно. JSON-данные в кодировке Base64, представляющие собой массив кортежей <поисковый запрос, URL поиска>.
Строка, закодированная в формате Base64.
| JSON-представление |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
GroundingChunk представляет собой сегмент подтверждающих данных, который служит основой для ответа модели. Это может быть фрагмент из интернета, контекст, полученный из файла, или информация из Google Maps.
chunk_typeUnion typechunk_type может быть только одним из следующих:webobject ( Web )Фрагмент веб-страницы, предназначенный для закрепления на месте.
imageobject ( Image )Необязательно. Фрагмент для определения местоположения из результатов поиска изображений.
retrievedContextobject ( RetrievedContext )Необязательно. Фрагмент контекста, полученный с помощью инструмента поиска файлов.
mapsobject ( Maps )Необязательно. Фрагмент карты местности из Google Maps.
| JSON-представление |
|---|
{ // chunk_type "web": { object ( |
Веб
Фрагмент из интернета.
string uriТолько вывод. URI-ссылка на фрагмент.
string titleТолько вывод. Заголовок фрагмента.
| JSON-представление |
|---|
{ "uri": string, "title": string } |
Изображение
Фрагмент из поиска изображений.
string sourceUriURI веб-страницы для указания источника.
string imageUriURL-адрес графического ресурса.
string titleЗаголовок веб-страницы, с которой взято изображение.
string domainКорневой домен веб-страницы, с которой взято изображение, например, "example.com".
| JSON-представление |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
Полученный контекст
Фрагмент из контекста, полученный с помощью инструмента поиска по файлу.
customMetadata[]object ( CustomMetadata )Необязательно. Предоставляемые пользователем метаданные о полученном контексте.
string uriНеобязательно. URI-ссылка на документ для семантического поиска.
string titleНеобязательно. Заголовок документа.
textstringНеобязательно. Текст фрагмента.
fileSearchStorestring Необязательно. Название FileSearchStore содержащего документ. Пример: fileSearchStores/123
| JSON-представление |
|---|
{
"customMetadata": [
{
object ( |
Пользовательские метаданные
Пользователь предоставил метаданные о GroundingFact.
keystringКлюч метаданных.
valueUnion typevalue может принимать только одно из следующих значений: stringValuestringНеобязательный параметр. Строковое значение метаданных.
stringListValueobject ( StringList )Необязательно. Список строковых значений для метаданных.
numericValuenumber Необязательно. Числовое значение метаданных. Ожидаемый диапазон значений зависит от используемого key .
| JSON-представление |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
Список строковых значений.
values[]stringСтроковые значения списка.
| JSON-представление |
|---|
{ "values": [ string ] } |
Карты
Фрагмент карты Google Maps, соответствующий одному месту.
string uriURI-ссылка на это место.
string titleНазвание места.
textstringТекстовое описание места, дающего ответ.
placeIdstring Идентификатор места в формате places/{placeId} . Пользователь может использовать этот идентификатор для поиска данного места.
placeAnswerSourcesobject ( PlaceAnswerSources )Источники, предоставляющие ответы на вопросы об особенностях того или иного места на Google Maps.
| JSON-представление |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
Коллекция источников, предоставляющих ответы на вопросы об особенностях конкретного места на Google Maps. Каждое сообщение PlaceAnswerSources соответствует определенному месту на Google Maps. Инструмент Google Maps использовал эти источники для ответа на вопросы об особенностях места (например: «Есть ли Wi-Fi в Bar Foo?» или «Доступен ли бар Foo для инвалидов-колясочников?»). В настоящее время мы поддерживаем в качестве источников только фрагменты отзывов.
reviewSnippets[]object ( ReviewSnippet )Фрагменты отзывов, используемые для генерации ответов об особенностях того или иного места в Google Maps.
| JSON-представление |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
Представляет собой фрагмент отзыва пользователя, отвечающего на вопрос об особенностях конкретного места на Google Maps.
reviewIdstringИдентификатор фрагмента отзыва.
string googleMapsUriСсылка, соответствующая отзыву пользователя на Google Maps.
string titleЗаголовок рецензии.
| JSON-представление |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
Поддержка заземления
Поддержка заземления.
groundingChunkIndices[]integer Необязательно. Список индексов (в 'grounding_chunk' в response.candidate.grounding_metadata ), указывающий на цитаты, связанные с утверждением. Например, [1,3,4] означает, что grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] — это полученный контент, относящийся к утверждению. Если ответ потоковый, groundingChunkIndices ссылаются на индексы во всех ответах. Клиент несет ответственность за накопление фрагментов данных из всех ответов (с сохранением того же порядка).
confidenceScores[]numberНеобязательно. Показатель достоверности ссылок на источники поддержки. Диапазон от 0 до 1. 1 означает наивысший уровень достоверности. Этот список должен иметь тот же размер, что и groundingChunkIndices.
renderedParts[]integer Только для вывода. Индексы в поле parts содержимого кандидата. Эти индексы указывают, какие отрендеренные части связаны с данным источником поддержки.
segmentobject ( Segment )Данный раздел контента относится к данной поддержке.
| JSON-представление |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
Сегмент
Фрагмент контента.
partIndexintegerИндекс объекта Part внутри родительского объекта Content.
startIndexintegerНачальный индекс в заданной части, измеряемый в байтах. Смещение от начала части включительно, начиная с нуля.
endIndexintegerКонечный индекс в заданной части, измеряемый в байтах. Смещение от начала части, исключая его, начиная с нуля.
textstringТекст, соответствующий фрагменту ответа.
| JSON-представление |
|---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Метаданные, связанные с извлечением данных в процессе заземления.
googleSearchDynamicRetrievalScorenumberНеобязательный параметр. Оценка, указывающая на вероятность того, что информация из поиска Google поможет ответить на вопрос. Оценка находится в диапазоне [0, 1], где 0 — наименее вероятный ответ, а 1 — наиболее вероятный. Эта оценка заполняется только при включенной функции сопоставления с поиском Google и динамического поиска. Она будет сравниваться с пороговым значением для определения необходимости запуска поиска Google.
| JSON-представление |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Результат Logprobs
topCandidates[]object ( TopCandidates )Длина = общее количество шагов декодирования.
chosenCandidates[]object ( Candidate )Длина = общее количество шагов декодирования. Выбранные кандидаты могут входить или не в число лучших кандидатов.
logProbabilitySumnumberСумма логарифмических вероятностей для всех токенов.
| JSON-представление |
|---|
{ "topCandidates": [ { object ( |
Лучшие кандидаты
Кандидаты с наивысшими логарифмическими вероятностями на каждом этапе декодирования.
candidates[]object ( Candidate )Отсортировано по логарифмической вероятности в порядке убывания.
| JSON-представление |
|---|
{
"candidates": [
{
object ( |
Кандидат
Кандидат на получение токена и оценки logprobs.
string tokenСтроковое значение токена кандидата.
tokenIdintegerИдентификатор токена кандидата.
logProbabilitynumberЛогарифмическая вероятность кандидата.
| JSON-представление |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Метаданные, относящиеся к инструменту получения контекста URL-адреса.
urlMetadata[]object ( UrlMetadata )Список контекста URL-адреса.
| JSON-представление |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Контекст получения одной и той же URL-ссылки.
retrievedUrlstringRetrieved url by the tool.
urlRetrievalStatusenum ( UrlRetrievalStatus )Status of the url retrieval.
| JSON representation |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Status of the url retrieval.
| Перечисления | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED | Default value. This value is unused. |
URL_RETRIEVAL_STATUS_SUCCESS | Url retrieval is successful. |
URL_RETRIEVAL_STATUS_ERROR | Url retrieval is failed due to error. |
URL_RETRIEVAL_STATUS_PAYWALL | Url retrieval is failed because the content is behind paywall. |
URL_RETRIEVAL_STATUS_UNSAFE | Url retrieval is failed because the content is unsafe. |
CitationMetadata
A collection of source attributions for a piece of content.
citationSources[]object ( CitationSource )Citations to sources for a specific response.
| JSON representation |
|---|
{
"citationSources": [
{
object ( |
CitationSource
A citation to a source for a portion of a specific response.
startIndexintegerOptional. Start of segment of the response that is attributed to this source.
Index indicates the start of the segment, measured in bytes.
endIndexintegerOptional. End of the attributed segment, exclusive.
uristringOptional. URI that is attributed as a source for a portion of the text.
licensestringOptional. License for the GitHub project that is attributed as a source for segment.
License info is required for code citations.
| JSON representation |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- JSON representation
- Модальность
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
Configuration options for model generation and outputs. Not all parameters are configurable for every model.
stopSequences[]string Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop_sequence . The stop sequence will not be included as part of the response.
responseMimeTypestring Optional. MIME type of the generated candidate text. Supported MIME types are: text/plain : (default) Text output. application/json : JSON response in the response candidates. text/x.enum : ENUM as a string response in the response candidates. Refer to the docs for a list of all supported text MIME types.
responseSchemaobject ( Schema )Optional. Output schema of the generated candidate text. Schemas must be a subset of the OpenAPI schema and can be objects, primitives or arrays.
If set, a compatible responseMimeType must also be set. Compatible MIME types: application/json : Schema for JSON response. Refer to the JSON text generation guide for more details.
_responseJsonSchemavalue ( Value format) Optional. Output schema of the generated response. This is an alternative to responseSchema that accepts JSON Schema .
If set, responseSchema must be omitted, but responseMimeType is required.
While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:
-
$id -
$defs -
$ref -
$anchor -
type -
format -
title -
description -
enum(for strings and numbers) -
items -
prefixItems -
minItems -
maxItems -
minimum -
maximum -
anyOf -
oneOf(interpreted the same asanyOf) -
properties -
additionalProperties -
required
The non-standard propertyOrdering property may also be set.
Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $ , may be set.
responseJsonSchemavalue ( Value format) Optional. An internal detail. Use responseJsonSchema rather than this field.
responseModalities[]enum ( Modality )Optional. The requested modalities of the response. Represents the set of modalities that the model can return, and should be expected in the response. This is an exact match to the modalities of the response.
A model may have multiple combinations of supported modalities. If the requested modalities do not match any of the supported combinations, an error will be returned.
An empty list is equivalent to requesting only text.
candidateCountintegerOptional. Number of generated responses to return. If unset, this will default to 1. Please note that this doesn't work for previous generation models (Gemini 1.0 family)
maxOutputTokensintegerOptional. The maximum number of tokens to include in a response candidate.
Note: The default value varies by model, see the Model.output_token_limit attribute of the Model returned from the getModel function.
temperaturenumberOptional. Controls the randomness of the output.
Note: The default value varies by model, see the Model.temperature attribute of the Model returned from the getModel function.
Values can range from [0.0, 2.0].
topPnumberOptional. The maximum cumulative probability of tokens to consider when sampling.
The model uses combined Top-k and Top-p (nucleus) sampling.
Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits the number of tokens based on the cumulative probability.
Note: The default value varies by Model and is specified by the Model.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.
topKintegerOptional. The maximum number of tokens to consider when sampling.
Gemini models use Top-p (nucleus) sampling or a combination of Top-k and nucleus sampling. Top-k sampling considers the set of topK most probable tokens. Models running with nucleus sampling don't allow topK setting.
Note: The default value varies by Model and is specified by the Model.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.
seedintegerOptional. Seed used in decoding. If not set, the request uses a randomly generated seed.
presencePenaltynumberOptional. Presence penalty applied to the next token's logprobs if the token has already been seen in the response.
This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequencyPenalty for a penalty that increases with each use.
A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary.
A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary.
frequencyPenaltynumberOptional. Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far.
A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more difficult it is for the model to use that token again increasing the vocabulary of responses.
Caution: A negative penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the maxOutputTokens limit.
responseLogprobsbooleanOptional. If true, export the logprobs results in response.
logprobsinteger Optional. Only valid if responseLogprobs=True . This sets the number of top logprobs, including the chosen candidate, to return at each decoding step in the Candidate.logprobs_result . The number must be in the range of [0, 20].
enableEnhancedCivicAnswersbooleanOptional. Enables enhanced civic answers. It may not be available for all models.
speechConfigobject ( SpeechConfig )Optional. The speech generation config.
thinkingConfigobject ( ThinkingConfig )Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
imageConfigobject ( ImageConfig )Optional. Config for image generation. An error will be returned if this field is set for models that don't support these config options.
mediaResolutionenum ( MediaResolution )Optional. If specified, the media resolution specified will be used.
| JSON representation |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Модальность
Supported modalities of the response.
| Перечисления | |
|---|---|
MODALITY_UNSPECIFIED | Default value. |
TEXT | Indicates the model should return text. |
IMAGE | Indicates the model should return images. |
AUDIO | Indicates the model should return audio. |
SpeechConfig
Config for speech generation and transcription.
voiceConfigobject ( VoiceConfig )The configuration in case of single-voice output.
multiSpeakerVoiceConfigobject ( MultiSpeakerVoiceConfig )Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voiceConfig field.
languageCodestringOptional. The IETF BCP-47 language code that the user configured the app to use. Used for speech recognition and synthesis.
Valid values are: de-DE , en-AU , en-GB , en-IN , en-US , es-US , fr-FR , hi-IN , pt-BR , ar-XA , es-ES , fr-CA , id-ID , it-IT , ja-JP , tr-TR , vi-VN , bn-IN , gu-IN , kn-IN , ml-IN , mr-IN , ta-IN , te-IN , nl-NL , ko-KR , cmn-CN , pl-PL , ru-RU , and th-TH .
| JSON representation |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
The configuration for the voice to use.
voice_configUnion typevoice_config can be only one of the following: prebuiltVoiceConfigobject ( PrebuiltVoiceConfig )The configuration for the prebuilt voice to use.
| JSON representation |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
The configuration for the prebuilt speaker to use.
voiceNamestringThe name of the preset voice to use.
| JSON representation |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
The configuration for the multi-speaker setup.
speakerVoiceConfigs[]object ( SpeakerVoiceConfig )Required. All the enabled speaker voices.
| JSON representation |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
The configuration for a single speaker in a multi speaker setup.
speakerstringRequired. The name of the speaker to use. Should be the same as in the prompt.
voiceConfigobject ( VoiceConfig )Required. The configuration for the voice to use.
| JSON representation |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Config for thinking features.
includeThoughtsbooleanIndicates whether to include thoughts in the response. If true, thoughts are returned only when available.
thinkingBudgetintegerThe number of thoughts tokens that the model should generate.
thinkingLevelenum ( ThinkingLevel )Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. If not specified, the default is HIGH. Recommended for Gemini 3 or later models. Use with earlier models results in an error.
| JSON representation |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
Allow user to specify how much to think using enum instead of integer budget.
| Перечисления | |
|---|---|
THINKING_LEVEL_UNSPECIFIED | Default value. |
MINIMAL | Little to no thinking. |
LOW | Low thinking level. |
MEDIUM | Medium thinking level. |
HIGH | High thinking level. |
ImageConfig
Config for image generation features.
aspectRatiostring Optional. The aspect ratio of the image to generate. Supported aspect ratios: 1:1 , 1:4 , 4:1 , 1:8 , 8:1 , 2:3 , 3:2 , 3:4 , 4:3 , 4:5 , 5:4 , 9:16 , 16:9 , or 21:9 .
If not specified, the model will choose a default aspect ratio based on any reference images provided.
imageSizestring Optional. Specifies the size of generated images. Supported values are 512 , 1K , 2K , 4K . If not specified, the model will use default value 1K .
| JSON representation |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
Media resolution for the input media.
| Перечисления | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED | Media resolution has not been set. |
MEDIA_RESOLUTION_LOW | Media resolution set to low (64 tokens). |
MEDIA_RESOLUTION_MEDIUM | Media resolution set to medium (256 tokens). |
MEDIA_RESOLUTION_HIGH | Media resolution set to high (zoomed reframing with 256 tokens). |
HarmCategory
The category of a rating.
These categories cover various kinds of harms that developers may wish to adjust.
| Перечисления | |
|---|---|
HARM_CATEGORY_UNSPECIFIED | Category is unspecified. |
HARM_CATEGORY_DEROGATORY | PaLM - Negative or harmful comments targeting identity and/or protected attribute. |
HARM_CATEGORY_TOXICITY | PaLM - Content that is rude, disrespectful, or profane. |
HARM_CATEGORY_VIOLENCE | PaLM - Describes scenarios depicting violence against an individual or group, or general descriptions of gore. |
HARM_CATEGORY_SEXUAL | PaLM - Contains references to sexual acts or other lewd content. |
HARM_CATEGORY_MEDICAL | PaLM - Promotes unchecked medical advice. |
HARM_CATEGORY_DANGEROUS | PaLM - Dangerous content that promotes, facilitates, or encourages harmful acts. |
HARM_CATEGORY_HARASSMENT | Gemini - Harassment content. |
HARM_CATEGORY_HATE_SPEECH | Gemini - Hate speech and content. |
HARM_CATEGORY_SEXUALLY_EXPLICIT | Gemini - Sexually explicit content. |
HARM_CATEGORY_DANGEROUS_CONTENT | Gemini - Dangerous content. |
HARM_CATEGORY_CIVIC_INTEGRITY | Gemini - Content that may be used to harm civic integrity. DEPRECATED: use enableEnhancedCivicAnswers instead. |
ModalityTokenCount
Represents token counting info for a single modality.
modalityenum ( Modality )The modality associated with this token count.
tokenCountintegerNumber of tokens.
| JSON representation |
|---|
{
"modality": enum ( |
Модальность
Content Part modality
| Перечисления | |
|---|---|
MODALITY_UNSPECIFIED | Unspecified modality. |
TEXT | Простой текст. |
IMAGE | Изображение. |
VIDEO | Видео. |
AUDIO | Аудио. |
DOCUMENT | Document, eg PDF. |
SafetyRating
Safety rating for a piece of content.
The safety rating contains the category of harm and the harm probability level in that category for a piece of content. Content is classified for safety across a number of harm categories and the probability of the harm classification is included here.
categoryenum ( HarmCategory )Required. The category for this rating.
probabilityenum ( HarmProbability )Required. The probability of harm for this content.
blockedbooleanWas this content blocked because of this rating?
| JSON representation |
|---|
{ "category": enum ( |
HarmProbability
The probability that a piece of content is harmful.
The classification system gives the probability of the content being unsafe. This does not indicate the severity of harm for a piece of content.
| Перечисления | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED | Probability is unspecified. |
NEGLIGIBLE | Content has a negligible chance of being unsafe. |
LOW | Content has a low chance of being unsafe. |
MEDIUM | Content has a medium chance of being unsafe. |
HIGH | Content has a high chance of being unsafe. |
SafetySetting
Safety setting, affecting the safety-blocking behavior.
Passing a safety setting for a category changes the allowed probability that content is blocked.
categoryenum ( HarmCategory )Required. The category for this setting.
thresholdenum ( HarmBlockThreshold )Required. Controls the probability threshold at which harm is blocked.
| JSON representation |
|---|
{ "category": enum ( |
HarmBlockThreshold
Block at and beyond a specified harm probability.
| Перечисления | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | Threshold is unspecified. |
BLOCK_LOW_AND_ABOVE | Content with NEGLIGIBLE will be allowed. |
BLOCK_MEDIUM_AND_ABOVE | Content with NEGLIGIBLE and LOW will be allowed. |
BLOCK_ONLY_HIGH | Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed. |
BLOCK_NONE | All content will be allowed. |
OFF | Turn off the safety filter. |