API Gemini поддерживает генерацию контента с изображениями, аудио, кодом, инструментами и т. д. Для получения подробной информации о каждой из этих функций читайте дальше и ознакомьтесь с примером кода, ориентированным на задачу, или прочитайте подробные руководства.
- Генерация текста
- Зрение
- Аудио
- Длинный контекст
- Выполнение кода
- Режим JSON
- Вызов функции
- Системные инструкции
Метод: models.generateContent
Генерирует ответ модели, учитывая входные данные GenerateContentRequest
. Подробную информацию об использовании см. в руководстве по генерации текста . Возможности ввода различаются в зависимости от модели, включая настроенные модели. Подробности см. в руководстве по моделям и руководстве по настройке .
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Параметры пути
model
string
Обязательно. Имя Model
, используемой для генерации завершения.
Формат: models/{model}
. Принимает вид models/{model}
.
Текст запроса
Тело запроса содержит данные со следующей структурой:
tools[]
object ( Tool
)
Необязательно. Список Tools
Model
может использовать для генерации следующего ответа.
Tool
— это фрагмент кода, который позволяет системе взаимодействовать с внешними системами для выполнения действия или набора действий за пределами знаний и области действия Model
. Поддерживаемые Tool
— это Function
и codeExecution
. Подробнее см. в руководствах по вызову функций и выполнению кода .
toolConfig
object ( ToolConfig
)
Необязательно. Конфигурация инструмента для любого Tool
, указанного в запросе. Пример использования см. в руководстве по вызову функций .
safetySettings[]
object ( SafetySetting
)
Необязательно. Список уникальных экземпляров SafetySetting
для блокировки небезопасного контента.
Это будет применяться к GenerateContentRequest.contents
и GenerateContentResponse.candidates
. Для каждого типа SafetyCategory
не должно быть более одной настройки. API будет блокировать любой контент и ответы, которые не соответствуют пороговым значениям, установленным этими настройками. Этот список переопределяет настройки по умолчанию для каждой SafetyCategory
, указанной в safetySettings. Если в списке нет SafetySetting
для заданной SafetyCategory
, API будет использовать настройку безопасности по умолчанию для этой категории. Поддерживаются категории вреда HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Подробную информацию о доступных настройках безопасности см. в руководстве . Также см. руководство по безопасности , чтобы узнать, как включить соображения безопасности в ваши приложения ИИ.
object ( Content )
systemInstruction
Необязательно. Разработчик устанавливает системные инструкции . В настоящее время только текст.
object ( GenerationConfig )
generationConfig
Необязательно. Параметры конфигурации для генерации модели и выходных данных.
string
cachedContent
Необязательно. Имя кэшированного контента для использования в качестве контекста для обслуживания прогноза. Формат: cachedContents/{cachedContent}
Пример запроса
Текст
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Изображение
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Аудио
Питон
Node.js
Оболочка
Видео
Питон
Node.js
Идти
Оболочка
Питон
Оболочка
Чат
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Кэш
Питон
Node.js
Настроенная модель
Питон
Режим JSON
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Выполнение кода
Питон
Котлин
Ява
Вызов функции
Питон
Node.js
Оболочка
Котлин
Быстрый
Дарт
Ява
Конфигурация генерации
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Настройки безопасности
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Системная инструкция
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Тело ответа
В случае успеха тело ответа содержит экземпляр GenerateContentResponse
.
Метод: models.streamGenerateContent
Генерирует потоковый ответ из модели, принимая во внимание входные данные GenerateContentRequest
.
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Параметры пути
model
string
Обязательно. Имя Model
, используемой для генерации завершения.
Формат: models/{model}
. Принимает вид models/{model}
.
Текст запроса
Тело запроса содержит данные со следующей структурой:
tools[]
object ( Tool
)
Необязательно. Список Tools
Model
может использовать для генерации следующего ответа.
Tool
— это фрагмент кода, который позволяет системе взаимодействовать с внешними системами для выполнения действия или набора действий за пределами знаний и области действия Model
. Поддерживаемые Tool
— это Function
и codeExecution
. Подробнее см. в руководствах по вызову функций и выполнению кода .
toolConfig
object ( ToolConfig
)
Необязательно. Конфигурация инструмента для любого Tool
, указанного в запросе. Пример использования см. в руководстве по вызову функций .
safetySettings[]
object ( SafetySetting
)
Необязательно. Список уникальных экземпляров SafetySetting
для блокировки небезопасного контента.
Это будет применяться к GenerateContentRequest.contents
и GenerateContentResponse.candidates
. Для каждого типа SafetyCategory
не должно быть более одной настройки. API будет блокировать любой контент и ответы, которые не соответствуют пороговым значениям, установленным этими настройками. Этот список переопределяет настройки по умолчанию для каждой SafetyCategory
, указанной в safetySettings. Если в списке нет SafetySetting
для заданной SafetyCategory
, API будет использовать настройку безопасности по умолчанию для этой категории. Поддерживаются категории вреда HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Подробную информацию о доступных настройках безопасности см. в руководстве . Также см. руководство по безопасности , чтобы узнать, как включить соображения безопасности в ваши приложения ИИ.
object ( Content )
systemInstruction
Необязательно. Разработчик устанавливает системные инструкции . В настоящее время только текст.
object ( GenerationConfig )
generationConfig
Необязательно. Параметры конфигурации для генерации модели и выходных данных.
string
cachedContent
Необязательно. Имя кэшированного контента для использования в качестве контекста для обслуживания прогноза. Формат: cachedContents/{cachedContent}
Пример запроса
Текст
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Изображение
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Аудио
Питон
Оболочка
Видео
Питон
Node.js
Идти
Оболочка
Питон
Оболочка
Чат
Питон
Node.js
Идти
Оболочка
Котлин
Быстрый
Дарт
Ява
Тело ответа
В случае успеха тело ответа содержит поток экземпляров GenerateContentResponse
.
ГенерироватьКонтентОтвет
Ответ модели, поддерживающей несколько возможных ответов.
Рейтинги безопасности и фильтрация контента сообщаются как для подсказки в GenerateContentResponse.prompt_feedback
, так и для каждого кандидата в finishReason
и safetyRatings
. API: - Возвращает либо всех запрошенных кандидатов, либо ни одного из них - Не возвращает ни одного кандидата, только если с подсказкой что-то не так (проверьте promptFeedback
) - Сообщает отзывы по каждому кандидату в finishReason
и safetyRatings
.
candidates[]
object ( Candidate
)
Ответы кандидатов от модели.
object ( PromptFeedback )
promptFeedback
Возвращает ответ подсказки, связанный с фильтрами контента.
usageMetadata
object ( UsageMetadata
)
Только вывод. Метаданные об использовании токенов запросов на генерацию.
string
modelVersion
Только вывод. Версия модели, используемая для генерации ответа.
string
responseId
Только вывод. responseId используется для идентификации каждого ответа.
JSON-представление |
---|
{ "candidates": [ { object ( |
PromptFeedback
Набор метаданных обратной связи, указанный в запросе GenerateContentRequest.content
.
blockReason
enum ( BlockReason
)
Необязательно. Если установлено, подсказка была заблокирована и кандидаты не возвращаются. Перефразируйте подсказку.
safetyRatings[]
object ( SafetyRating
)
Рейтинги безопасности подсказки. Максимально возможна одна оценка на категорию.
JSON-представление |
---|
{ "blockReason": enum ( |
BlockReason
Указывает причину, по которой запрос был заблокирован.
Перечисления | |
---|---|
BLOCK_REASON_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
SAFETY | Запрос был заблокирован из соображений безопасности. Проверьте safetyRatings , чтобы понять, какая категория безопасности его заблокировала. |
OTHER | Запрос был заблокирован по неизвестным причинам. |
BLOCKLIST | Запрос был заблокирован из-за терминов, включенных в список заблокированных терминов. |
PROHIBITED_CONTENT | Запрос был заблокирован из-за запрещенного контента. |
IMAGE_SAFETY | Кандидаты заблокированы из-за небезопасного контента, создающего изображения. |
ИспользованиеМетаданных
Метаданные об использовании токена запроса на генерацию.
promptTokenCount
integer
Количество токенов в подсказке. Если задано cachedContent
, это все еще общий эффективный размер подсказки, то есть сюда входит количество токенов в кэшированном контенте.
cachedContentTokenCount
integer
Количество токенов в кэшированной части подсказки (кэшированное содержимое)
candidatesTokenCount
integer
Общее количество токенов среди всех сгенерированных кандидатов на ответы.
toolUsePromptTokenCount
integer
Только вывод. Количество токенов, присутствующих в подсказке(ах) использования инструмента.
thoughtsTokenCount
integer
Только вывод. Количество токенов мыслей для моделей мышления.
totalTokenCount
integer
Общее количество токенов для запроса на генерацию (запрос + кандидаты на ответ).
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 ( |
Кандидат
- JSON-представление
- FinishReason
- ЗаземлениеАтрибуция
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingМетаданные
- SearchEntryPoint
- ЗаземлениеChunk
- Веб
- ЗаземлениеПоддержка
- Сегмент
- ИзвлечениеМетаданных
- LogprobsResult
- ЛучшиеКандидаты
- Кандидат
- UrlRetrievalMetadata
- UrlRetrievalContext
- UrlContextMetadata
- UrlМетаданные
- UrlRetrievalStatus
Кандидат на ответ, сгенерированный на основе модели.
content
object ( Content
)
Только вывод. Сгенерированный контент, возвращаемый из модели.
finishReason
enum ( FinishReason
)
Необязательно. Только вывод. Причина, по которой модель перестала генерировать токены.
Если пусто, модель не прекратила генерацию токенов.
safetyRatings[]
object ( SafetyRating
)
Список оценок безопасности кандидата на ответ.
В каждой категории может быть максимум один рейтинг.
object ( CitationMetadata )
citationMetadata
Только вывод. Информация о цитировании для кандидата, сгенерированного моделью.
Это поле может быть заполнено информацией о декламации для любого текста, включенного в content
. Это отрывки, которые «декламируются» из защищенного авторским правом материала в базовых учебных данных LLM.
tokenCount
integer
Только вывод. Количество токенов для этого кандидата.
groundingAttributions[]
object ( GroundingAttribution
)
Только вывод. Информация об источниках, которые способствовали обоснованному ответу.
Это поле заполняется для вызовов GenerateAnswer
.
object ( GroundingMetadata )
groundingMetadata
Только вывод. Заземляющие метаданные для кандидата.
Это поле заполняется для вызовов GenerateContent
.
avgLogprobs
number
Только вывод. Средний логарифм вероятности кандидата.
object ( LogprobsResult )
logprobsResult
Только вывод. Оценки логарифмического правдоподобия для токенов ответа и верхних токенов
object ( UrlRetrievalMetadata )
urlRetrievalMetadata
Только вывод. Метаданные, относящиеся к инструменту извлечения контекста URL.
object ( UrlContextMetadata )
urlContextMetadata
Только вывод. Метаданные, относящиеся к инструменту извлечения контекста URL.
index
integer
Только вывод. Индекс кандидата в списке кандидатов на ответ.
JSON-представление |
---|
{ "content": { object ( |
FinishReason
Определяет причину, по которой модель перестала генерировать токены.
Перечисления | |
---|---|
FINISH_REASON_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
STOP | Естественная точка остановки модели или предусмотренная последовательность остановок. |
MAX_TOKENS | Достигнуто максимальное количество токенов, указанное в запросе. |
SAFETY | Содержание кандидата на ответ было помечено в целях безопасности. |
RECITATION | Содержание кандидата на ответ было помечено как некорректное. |
LANGUAGE | Контент кандидата на ответ был помечен как использующий неподдерживаемый язык. |
OTHER | Причина неизвестна. |
BLOCKLIST | Генерация токенов остановлена, поскольку контент содержит запрещённые термины. |
PROHIBITED_CONTENT | Генерация токенов остановлена из-за потенциального содержания запрещенного контента. |
SPII | Генерация токенов остановлена, поскольку контент потенциально содержит конфиденциальную персональную информацию (SPII). |
MALFORMED_FUNCTION_CALL | Вызов функции, сгенерированный моделью, недействителен. |
IMAGE_SAFETY | Генерация токенов остановлена, поскольку сгенерированные изображения содержат нарушения безопасности. |
ЗаземлениеАтрибуция
Укажите источник, который способствовал ответу.
sourceId
object ( AttributionSourceId
)
Только вывод. Идентификатор источника, способствующего этой атрибуции.
content
object ( Content
)
Обоснование исходного контента, составляющего эту атрибуцию.
JSON-представление |
---|
{ "sourceId": { object ( |
AttributionSourceId
Идентификатор источника, способствующего данной атрибуции.
source
Union type
source
может быть только одно из следующего: object ( GroundingPassageId )
groundingPassage
Идентификатор встроенного отрывка.
semanticRetrieverChunk
object ( SemanticRetrieverChunk
)
Идентификатор Chunk
, полученного с помощью семантического ретривера.
JSON-представление |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Идентификатор детали внутри GroundingPassage
.
string
passageId
Только вывод. Идентификатор прохода, соответствующий GroundingPassage.id
GenerateAnswerRequest
.
partIndex
integer
Только вывод. Индекс части в GroundingPassage.content
GenerateAnswerRequest
.
JSON-представление |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Идентификатор Chunk
, полученного с помощью Semantic Retriever, указанный в GenerateAnswerRequest
с помощью SemanticRetrieverConfig
.
source
string
Только вывод. Имя источника, соответствующее SemanticRetrieverConfig.source
запроса. Пример: corpora/123
или corpora/123/documents/abc
chunk
string
Только вывод. Имя Chunk
содержащего атрибутированный текст. Пример: corpora/123/documents/abc/chunks/xyz
JSON-представление |
---|
{ "source": string, "chunk": string } |
GroundingМетаданные
Метаданные возвращаются клиенту при включении заземления.
groundingChunks[]
object ( GroundingChunk
)
Список подтверждающих ссылок, полученных из указанного источника заземления.
groundingSupports[]
object ( GroundingSupport
)
Перечень заземляющих опор.
webSearchQueries[]
string
Запросы веб-поиска для последующего веб-поиска.
object ( SearchEntryPoint )
searchEntryPoint
Необязательно. Запись в поиске Google для последующих веб-поисков.
object ( RetrievalMetadata )
retrievalMetadata
Метаданные, связанные с поиском в потоке заземления.
JSON-представление |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Точка входа в поиск Google.
string
renderedContent
Необязательно. Фрагмент веб-контента, который можно встроить в веб-страницу или веб-представление приложения.
sdkBlob
string ( bytes format)
Необязательно. JSON в кодировке Base64, представляющий собой массив кортежей <search term, search url>.
Строка в кодировке base64.
JSON-представление |
---|
{ "renderedContent": string, "sdkBlob": string } |
ЗаземлениеChunk
Заземляющий кусок.
chunk_type
Union type
chunk_type
может быть только одним из следующих:web
object ( Web
)
Заземляющий кусок из сети.
JSON-представление |
---|
{
// chunk_type
"web": {
object ( |
Веб
Фрагмент из Интернета.
string
uri
URI-ссылка на фрагмент.
string
title
Название фрагмента.
JSON-представление |
---|
{ "uri": string, "title": string } |
ЗаземлениеПоддержка
Поддержка заземления.
groundingChunkIndices[]
integer
Список индексов (в 'grounding_chunk'), указывающих цитаты, связанные с утверждением. Например, [1,3,4] означает, что grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] — это извлеченный контент, приписываемый утверждению.
number
confidenceScores[]
Оценка достоверности опорных ссылок. Диапазон от 0 до 1. 1 — максимальная достоверность. Этот список должен иметь тот же размер, что и groundingChunkIndices.
segment
object ( Segment
)
Сегмент контента, к которому относится данная поддержка.
JSON-представление |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Сегмент
Сегмент контента.
partIndex
integer
Только вывод. Индекс объекта Part внутри его родительского объекта Content.
startIndex
integer
Только вывод. Начальный индекс в данной Части, измеряемый в байтах. Смещение от начала Части, включительно, начиная с нуля.
endIndex
integer
Только вывод. Конечный индекс в данной Части, измеряемый в байтах. Смещение от начала Части, не включающее, начиная с нуля.
text
string
Только вывод. Текст, соответствующий сегменту из ответа.
JSON-представление |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
ИзвлечениеМетаданных
Метаданные, связанные с поиском в потоке заземления.
googleSearchDynamicRetrievalScore
number
Необязательно. Оценка, указывающая, насколько вероятно, что информация из поиска Google может помочь ответить на подсказку. Оценка находится в диапазоне [0, 1], где 0 — наименее вероятная, а 1 — наиболее вероятная. Эта оценка заполняется только при включении заземления поиска Google и динамического поиска. Она будет сравниваться с пороговым значением, чтобы определить, следует ли запускать поиск Google.
JSON-представление |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Результат логпроб
topCandidates[]
object ( TopCandidates
)
Длина = общее количество шагов декодирования.
chosenCandidates[]
object ( Candidate
)
Длина = общее количество шагов декодирования. Выбранные кандидаты могут быть или не быть в topCandidates.
JSON-представление |
---|
{ "topCandidates": [ { object ( |
ЛучшиеКандидаты
Кандидаты с наивысшими логарифмическими вероятностями на каждом этапе декодирования.
candidates[]
object ( Candidate
)
Сортировано по логарифмической вероятности в порядке убывания.
JSON-представление |
---|
{
"candidates": [
{
object ( |
Кандидат
Кандидат на получение токена и оценки logprobs.
string
token
Значение строки токена кандидата.
tokenId
integer
Значение идентификатора токена кандидата.
number
logProbability
Логарифм вероятности кандидата.
JSON-представление |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlRetrievalMetadata
Метаданные, связанные с инструментом извлечения контекста URL.
urlRetrievalContexts[]
object ( UrlRetrievalContext
)
Список контекстов поиска URL.
JSON-представление |
---|
{
"urlRetrievalContexts": [
{
object ( |
UrlRetrievalContext
Контекст поиска по одному URL-адресу.
retrievedUrl
string
Полученный инструментом URL.
JSON-представление |
---|
{ "retrievedUrl": string } |
UrlContextMetadata
Метаданные, связанные с инструментом извлечения контекста URL.
urlMetadata[]
object ( UrlMetadata
)
Список контекста URL.
JSON-представление |
---|
{
"urlMetadata": [
{
object ( |
UrlМетаданные
Контекст поиска по одному URL-адресу.
retrievedUrl
string
Полученный инструментом URL.
urlRetrievalStatus
enum ( UrlRetrievalStatus
)
Статус извлечения URL.
JSON-представление |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Статус извлечения URL.
Перечисления | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
URL_RETRIEVAL_STATUS_SUCCESS | Получение URL прошло успешно. |
URL_RETRIEVAL_STATUS_ERROR | Не удалось получить URL из-за ошибки. |
CitationMetadata
Коллекция ссылок на источники фрагмента контента.
citationSources[]
object ( CitationSource
)
Ссылки на источники для конкретного ответа.
JSON-представление |
---|
{
"citationSources": [
{
object ( |
Источник цитаты
Ссылка на источник части конкретного ответа.
startIndex
integer
Необязательно. Начало сегмента ответа, который приписывается этому источнику.
Индекс указывает начало сегмента, измеряемое в байтах.
endIndex
integer
Необязательно. Конец атрибутированного сегмента, эксклюзивный.
string
uri
Необязательно. URI, который указывается как источник части текста.
string
license
Необязательно. Лицензия для проекта GitHub, который указан как источник для сегмента.
Для цитирования кода необходима информация о лицензии.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
ГенерацияКонфигурация
- JSON-представление
- Модальность
- SpeechConfig
- VoiceConfig
- Предварительно созданная конфигурация голоса
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
Параметры конфигурации для генерации модели и выходов. Не все параметры можно настроить для каждой модели.
stopSequences[]
string
Необязательно. Набор последовательностей символов (до 5), которые остановят генерацию вывода. Если указано, API остановится при первом появлении stop_sequence
. Последовательность остановки не будет включена в ответ.
responseMimeType
string
Необязательно. Тип MIME сгенерированного текста-кандидата. Поддерживаемые типы MIME: text/plain
: (по умолчанию) текстовый вывод. application/json
: ответ JSON в кандидатах на ответ. text/x.enum
: ENUM как строковый ответ в кандидатах на ответ. Список всех поддерживаемых типов MIME текста см. в документации .
object ( Schema )
responseSchema
Необязательно. Выходная схема сгенерированного текста-кандидата. Схемы должны быть подмножеством схемы OpenAPI и могут быть объектами, примитивами или массивами.
Если установлено, необходимо также установить совместимый responseMimeType
. Совместимые типы MIME: application/json
: Схема для ответа JSON. Более подробную информацию см. в руководстве по генерации текста JSON .
responseModalities[]
enum ( Modality
)
Необязательно. Запрошенные модальности ответа. Представляет набор модальностей, которые может вернуть модель и которые следует ожидать в ответе. Это точное совпадение с модальностями ответа.
Модель может иметь несколько комбинаций поддерживаемых модальностей. Если запрошенные модальности не соответствуют ни одной из поддерживаемых комбинаций, будет возвращена ошибка.
Пустой список эквивалентен запросу только текста.
candidateCount
integer
Необязательно. Количество сгенерированных ответов для возврата. Если не установлено, по умолчанию будет 1. Обратите внимание, что это не работает для моделей предыдущего поколения (семейство Gemini 1.0)
maxOutputTokens
integer
Необязательно. Максимальное количество токенов для включения в кандидат ответа.
Примечание: значение по умолчанию зависит от модели, см. атрибут Model.output_token_limit
Model
, возвращаемый функцией getModel
.
number
temperature
Необязательно. Управляет случайностью вывода.
Примечание: значение по умолчанию зависит от модели, см. атрибут Model.temperature
Model
, возвращаемый функцией getModel
.
Значения могут находиться в диапазоне [0,0, 2,0].
number
topP
Необязательно. Максимальная кумулятивная вероятность токенов, которую следует учитывать при выборке.
Модель использует комбинированную выборку Top-K и Top-P (ядро).
Токены отсортируются на основе их назначенных вероятностей, так что рассматриваются только наиболее вероятные токены. Отбор выборки Top-K непосредственно ограничивает максимальное количество токенов, которые следует учитывать, в то время как выборка ядра ограничивает количество токенов на основе кумулятивной вероятности.
ПРИМЕЧАНИЕ. Значение по умолчанию варьируется в зависимости от Model
и указывается атрибутом Model.top_p
, возвращаемого из функции getModel
. Пустой атрибут topK
указывает, что модель не применяет выборку TOP-K и не позволяет устанавливать topK
на запросы.
topK
integer
Необязательный. Максимальное количество токенов, которые следует учитывать при отборе выборки.
Модели Близнецов используют выборку в верхнюю P (ядро) или комбинацию отбора проб и ядра. Выборка топ-K рассматривает набор наиболее вероятных токенов topK
. Модели, работающие с выборкой ядра, не позволяют настройку Topk.
ПРИМЕЧАНИЕ. Значение по умолчанию варьируется в зависимости от Model
и указывается атрибутом Model.top_p
, возвращаемого из функции getModel
. Пустой атрибут topK
указывает, что модель не применяет выборку TOP-K и не позволяет устанавливать topK
на запросы.
seed
integer
Необязательный. Семена используются в декодировании. Если не установлен, в запросе используется случайно сгенерированное семя.
presencePenalty
number
Необязательный. Наказание о присутствии применяется к Logprobs следующего Token, если токен уже был замечен в ответе.
Этот штраф является бинарным включением/выключением и не зависит от количества раз, когда токен используется (после первого). Используйте frequencyPenalty
на штраф, который увеличивается с каждым использованием.
Положительный штраф отговаривает использование токенов, которые уже использовались в ответе, увеличивая словарный запас.
Негативное наказание поощряет использование токенов, которые уже использовались в ответе, уменьшая словарный запас.
number
frequencyPenalty
Необязательный. Частотный штраф, применяемый к Logprobs следующего Token, умноженные на количество раз каждый токен, который до сих пор наблюдался в Respponse.
Положительный штраф отговаривает использование токенов, которые уже использовались, пропорционально количеству токена использовался: чем больше токен используется, тем сложнее модель использует этот токен, снова увеличивая словарь ответов.
Внимание: Негативное наказание побудит модель повторно использовать токены, пропорциональные количеством раз, когда токен использовался. Небольшие отрицательные значения уменьшат словарный запас ответа. Большие отрицательные значения приведут к тому, что модель начинает повторять общий токен, пока не достигнет предела maxOutputTokens
.
responseLogprobs
boolean
Необязательный. Если TRUE, экспорт LogProbs приводит к ответу.
logprobs
integer
Необязательный. Только действительный, если responseLogprobs=True
. Это устанавливает количество лучших logprobs для возврата на каждом этапе декодирования в Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
Необязательный. Позволяет улучшить гражданские ответы. Это может быть недоступно для всех моделей.
object ( SpeechConfig )
speechConfig
Необязательный. Конфигурация генерации речи.
object ( ThinkingConfig )
thinkingConfig
Необязательный. Конфигурация для мышления функций. Ошибка будет возвращена, если это поле будет установлено для моделей, которые не поддерживают мышление.
mediaResolution
enum ( MediaResolution
)
Необязательный. Если указано, будет использоваться указанное разрешение носителя.
Представление JSON |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Модальность
Поддерживаемые методы ответа.
Перечисления | |
---|---|
MODALITY_UNSPECIFIED | Значение по умолчанию. |
TEXT | Указывает, что модель должна возвращать текст. |
IMAGE | Указывает, что модель должна возвращать изображения. |
AUDIO | Указывает, что модель должна вернуть аудио. |
SpeechConfig
Конфигурация генерации речи.
voiceConfig
object ( VoiceConfig
)
Конфигурация в случае выхода из одного голоса.
multiSpeakerVoiceConfig
object ( MultiSpeakerVoiceConfig
)
Необязательный. Конфигурация для настройки с несколькими динамиками. Это взаимно эксклюзив с полем VoiceConfig.
string
languageCode
Необязательный. Языковой код (в формате BCP 47, например, «En-US») для синтеза речи.
Допустимые значения: 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-k-in, ml-in, mr-in, ta-in, nl-nl, ko-kn-pl, ru-in, pl-pl, ru-in, pl-pl, pl-r и th-й.
Представление JSON |
---|
{ "voiceConfig": { object ( |
VoiceConfig
Конфигурация для использования голоса.
voice_config
Union type
voice_config
может быть только одним из следующих: prebuiltVoiceConfig
object ( PrebuiltVoiceConfig
)
Конфигурация для предварительного голоса для использования.
Представление JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
Prebuiltvoiceconfig
Конфигурация для предварительного динамика для использования.
voiceName
string
Название предустановленного голоса для использования.
Представление JSON |
---|
{ "voiceName": string } |
MultipeakervoiceConfig
Конфигурация для настройки с несколькими динамиками.
speakerVoiceConfigs[]
object ( SpeakerVoiceConfig
)
Требуется Все включенные голоса динамиков.
Представление JSON |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakervoiceConfig
Конфигурация для одного динамика в настройке нескольких динамиков.
speaker
string
Требуется Название динамика для использования. Должен быть таким же, как в подсказке.
voiceConfig
object ( VoiceConfig
)
Требуется Конфигурация для использования голоса.
Представление JSON |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
Мышление Конфиг
Конфигурация для мышления функций.
includeThoughts
boolean
Указывает, включать ли мысли в ответ. Если это правда, мысли возвращаются только тогда, когда они доступны.
thinkingBudget
integer
Количество токенов мыслей, которые должна генерировать модель.
Представление JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
Медиарезолюция
Разрешение медиа для входных носителей.
Перечисления | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED | Резолюция СМИ не была установлена. |
MEDIA_RESOLUTION_LOW | Разрешение медиа установлена на низкий (64 токена). |
MEDIA_RESOLUTION_MEDIUM | Разрешение медиа, установленное на среднее (256 токенов). |
MEDIA_RESOLUTION_HIGH | Разрешение средств массовой информации установлено на высокое (масштабированное переосмысление с 256 токенами). |
Harmcategory
Категория рейтинга.
Эти категории охватывают различные виды вреда, которые разработчики могут пожелать приспособиться.
Перечисления | |
---|---|
HARM_CATEGORY_UNSPECIFIED | Категория не определена. |
HARM_CATEGORY_DEROGATORY | Palm - отрицательные или вредные комментарии, нацеленные на личность и/или защищенный атрибут. |
HARM_CATEGORY_TOXICITY | Palm - Содержание, которое является грубым, неуважительным или мягким. |
HARM_CATEGORY_VIOLENCE | PALM - описывает сценарии, изображающие насилие в отношении отдельного человека или группы, или общие описания крови. |
HARM_CATEGORY_SEXUAL | PALM - содержит ссылки на сексуальные действия или другое непристойное содержание. |
HARM_CATEGORY_MEDICAL | Palm - продвигает неконтролируемые медицинские советы. |
HARM_CATEGORY_DANGEROUS | PALM - Опасное содержание, которое продвигает, облегчает или поощряет вредные действия. |
HARM_CATEGORY_HARASSMENT | Близнецы - содержание домогательств. |
HARM_CATEGORY_HATE_SPEECH | Близнецы - ненавистная речь и содержание. |
HARM_CATEGORY_SEXUALLY_EXPLICIT | Близнецы - Откровенно откровенное содержание. |
HARM_CATEGORY_DANGEROUS_CONTENT | Близнецы - опасное содержание. |
HARM_CATEGORY_CIVIC_INTEGRITY | Близнецы - содержание, которое может использоваться для нанесения вреда гражданской целостности. |
MODITYTOKENCUNT
Представляет информацию о подсчете токена для единой модальности.
modality
enum ( Modality
)
Модальность, связанная с этим токеном.
tokenCount
integer
Количество токенов.
Представление JSON |
---|
{
"modality": enum ( |
Модальность
Контент Части модальности
Перечисления | |
---|---|
MODALITY_UNSPECIFIED | Неопределенная модальность. |
TEXT | Простой текст. |
IMAGE | Изображение. |
VIDEO | Видео. |
AUDIO | Аудио. |
DOCUMENT | Документ, например, PDF. |
Безопасность
Рейтинг безопасности для части контента.
Рейтинг безопасности содержит категорию вреда и уровень вероятности вреда в этой категории для части содержания. Содержание классифицируется по безопасности по ряду категорий вреда, и здесь включена вероятность классификации вреда.
category
enum ( HarmCategory
)
Требуется Категория для этого рейтинга.
probability
enum ( HarmProbability
)
Требуется Вероятность вреда для этого контента.
blocked
boolean
Был ли этот контент заблокирован из -за этого рейтинга?
Представление JSON |
---|
{ "category": enum ( |
Harmprobobility
Вероятность того, что часть контента вредна.
Система классификации дает вероятность того, что содержание небезопасно. Это не указывает на серьезность вреда для части содержания.
Перечисления | |
---|---|
HARM_PROBABILITY_UNSPECIFIED | Вероятность не указана. |
NEGLIGIBLE | Контент имеет незначительный шанс быть небезопасным. |
LOW | Контент имеет низкий шанс быть небезопасным. |
MEDIUM | Контент имеет средний шанс быть небезопасным. |
HIGH | Контент имеет высокий шанс быть небезопасным. |
SafetySetting
Установка безопасности, влияя на поведение блокировки безопасности.
Передача настройки безопасности для категории изменяет разрешенную вероятность того, что содержание блокируется.
category
enum ( HarmCategory
)
Требуется Категория для этой настройки.
threshold
enum ( HarmBlockThreshold
)
Требуется Управляет порогом вероятности, при котором вред заблокирован.
Представление JSON |
---|
{ "category": enum ( |
HARMBLOCKTHRESHOLD
Блок на за пределами определенной вероятности вреда.
Перечисления | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | Порог не указан. |
BLOCK_LOW_AND_ABOVE | Содержание с незначительным будет разрешено. |
BLOCK_MEDIUM_AND_ABOVE | Содержание с незначительным и низким будет разрешено. |
BLOCK_ONLY_HIGH | Содержание с незначительным, низким и средним будет разрешено. |
BLOCK_NONE | Весь контент будет разрешен. |
OFF | Выключите фильтр безопасности. |