Method: models.generateMessage

Генерирует ответ модели с учетом входного MessagePrompt .

HTTP-запрос

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
model

string

Необходимый. Имя модели, которую нужно использовать.

Формат: name=models/{model} .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
Поля
prompt

object ( MessagePrompt )

Необходимый. Структурированный текстовый ввод, подаваемый модели в качестве подсказки.

При наличии подсказки модель вернет то, что, по ее прогнозам, станет следующим сообщением в обсуждении.

temperature

number

Необязательный. Управляет случайностью вывода.

Значения могут находиться в диапазоне от [0.0,1.0] включительно. Значение ближе к 1.0 приведет к более разнообразным ответам, тогда как значение ближе к 0.0 обычно приводит к менее неожиданным ответам модели.

candidateCount

integer

Необязательный. Количество сгенерированных ответных сообщений, которые необходимо вернуть.

Это значение должно находиться в диапазоне [1, 8] включительно. Если не установлено, по умолчанию будет установлено значение 1 .

topP

number

Необязательный. Максимальная совокупная вероятность токенов, которую следует учитывать при выборке.

Модель использует комбинированную выборку Top-k и ядра.

Ядерная выборка рассматривает наименьший набор токенов, сумма вероятностей которых не меньше topP .

topK

integer

Необязательный. Максимальное количество токенов, которые следует учитывать при выборке.

Модель использует комбинированную выборку Top-k и ядра.

Выборка Top-k рассматривает набор наиболее вероятных токенов topK .

Тело ответа

Ответ модели.

Сюда входят сообщения кандидатов и история разговоров в виде сообщений в хронологическом порядке.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
Поля
candidates[]

object ( Message )

Ответные сообщения кандидата от модели.

messages[]

object ( Message )

История разговоров, используемая моделью.

filters[]

object ( ContentFilter )

Набор метаданных фильтрации контента для текста приглашения и ответа.

Здесь указывается, какая категория SafetyCategory заблокировала кандидата в этом ответе, наименьшая HarmProbability , вызвавшая блокировку, а также параметр HarmThreshold для этой категории.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Для получения дополнительной информации см. Обзор аутентификации .