- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- ЗаземлениеПроходы
- ЗаземлениеПроход
- SemanticRetrieverConfig
- ОтветСтиль
- ВводОбратная связь
- БлокПричина
Генерирует обоснованный ответ из модели с учетом входных данных GenerateAnswerRequest
.
HTTP-запрос
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
model | Необходимый. Имя Формат: |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "contents": [ { object ( |
Поля | |
---|---|
contents[] | Необходимый. Содержание текущего разговора с моделью. Для одноходовых запросов это один вопрос, на который нужно ответить. Для многоходовых запросов это повторяющееся поле, содержащее историю разговоров и последнее Примечание. models.generateAnswer в настоящее время поддерживает запросы только на английском языке. |
answerStyle | Необходимый. Стиль, в котором должны быть возвращены ответы. |
safetySettings[] | Необязательный. Список уникальных экземпляров Это будет применено к |
Поле объединения grounding_source . Источники, в которых можно обосновать ответ. grounding_source может быть только одним из следующих: | |
inlinePassages | Отрывки предоставлены вместе с запросом. |
semanticRetriever | Контент, полученный из ресурсов, созданных с помощью API Semantic Retriever. |
temperature | Необязательный. Управляет случайностью вывода. Значения могут находиться в диапазоне от [0,0,1,0] включительно. Значение ближе к 1,0 приведет к более разнообразным и творческим ответам, тогда как значение ближе к 0,0 обычно приводит к более прямым ответам модели. Низкая температура (~0,2) обычно рекомендуется для случаев использования «Вопрос с указанием атрибутов» и «Ответ». |
Тело ответа
Ответ модели на обоснованный ответ.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "answer": { object ( |
Поля | |
---|---|
answer | Ответ кандидата от модели. Примечание. Модель всегда пытается дать обоснованный ответ, даже если маловероятно, что на него можно ответить из данных отрывков. В этом случае может быть предоставлен некачественный или необоснованный ответ, а также низкая |
answerableProbability | Только вывод. Оценка модели вероятности того, что ее ответ правильный и основана на входных данных. Низкая вероятность ответа указывает на то, что ответ может не основываться на источниках. Когда
|
inputFeedback | Только вывод. Обратная связь связана с входными данными, используемыми для ответа на вопрос, в отличие от ответа на вопрос, сгенерированного моделью. «Входные данные» могут быть одним или несколькими из следующих:
|
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/generative-language
-
https://www.googleapis.com/auth/generative-language.retriever
-
https://www.googleapis.com/auth/generative-language.retriever.readonly
-
https://www.googleapis.com/auth/generative-language.tuning
-
https://www.googleapis.com/auth/generative-language.tuning.readonly
Для получения дополнительной информации см. Обзор аутентификации .
ЗаземлениеПроходы
Повторяющийся список отрывков.
JSON-представление |
---|
{
"passages": [
{
object ( |
Поля | |
---|---|
passages[] | Список отрывков. |
ЗаземлениеПроход
Проход включен в линию с заземляющей конфигурацией.
JSON-представление |
---|
{
"id": string,
"content": {
object ( |
Поля | |
---|---|
id | Идентификатор отрывка для приписывания этого отрывка в обоснованных ответах. |
content | Содержание отрывка. |
SemanticRetrieverConfig
Конфигурация для получения основного контента из Corpus
или Document
, созданного с помощью API Semantic Retriever.
JSON-представление |
---|
{ "source": string, "query": { object ( |
Поля | |
---|---|
source | Необходимый. Имя ресурса для поиска, например corpora/123 или corpora/123/documents/abc. |
query | Необходимый. Запрос, который будет использоваться для сопоставления |
metadataFilters[] | Необязательный. Фильтры для выбора |
maxChunksCount | Необязательный. Максимальное количество соответствующих |
minimumRelevanceScore | Необязательный. Минимальная оценка релевантности для извлеченных соответствующих |
ОтветСтиль
Стиль обоснованных ответов.
Перечисления | |
---|---|
ANSWER_STYLE_UNSPECIFIED | Неуказанный стиль ответа. |
ABSTRACTIVE | Краткий, но абстрактный стиль. |
EXTRACTIVE | Очень краткий и экстрактивный стиль. |
VERBOSE | Многословный стиль, включающий дополнительные детали. Ответ может быть отформатирован как предложение, абзац, несколько абзацев или маркеры и т. д. |
ВводОбратная связь
Обратная связь связана с входными данными, используемыми для ответа на вопрос, в отличие от ответа на вопрос, сгенерированного моделью.
JSON-представление |
---|
{ "safetyRatings": [ { object ( |
Поля | |
---|---|
safetyRatings[] | Оценки безопасности ввода. В каждой категории может быть не более одного рейтинга. |
blockReason | Необязательный. Если установлено, ввод был заблокирован и кандидаты не возвращались. Перефразируйте свой ввод. |
БлокПричина
Указывает причину блокировки ввода.
Перечисления | |
---|---|
BLOCK_REASON_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
SAFETY | Вход заблокирован по соображениям безопасности. Вы можете проверить safetyRatings , чтобы понять, какая категория безопасности заблокировала его. |
OTHER | Ввод заблокирован по другим причинам. |