- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- GroundingPassages
- GroundingPassage
- SemanticRetrieverConfig
- AnswerStyle
- InputFeedback
- BlockReason
Genera una respuesta basada en el modelo a partir de un GenerateAnswerRequest
de entrada.
Solicitud HTTP
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
model |
Obligatorio. El nombre de Formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "contents": [ { object ( |
Campos | |
---|---|
contents[] |
Obligatorio. El contenido de la conversación actual con el modelo. En el caso de las consultas de un solo turno, esta es una sola pregunta para responder. En el caso de las consultas de varios turnos, este es un campo repetido que contiene el historial de conversaciones y el último Nota: Por el momento, models.generateAnswer solo admite consultas en inglés. |
answerStyle |
Obligatorio. El estilo en el que se deben mostrar las respuestas. |
safetySettings[] |
Opcional. Una lista de instancias de Esto se aplicará de manera forzosa en |
Campo de unión grounding_source . Las fuentes en las que basar la respuesta. Las direcciones (grounding_source ) solo pueden ser una de las siguientes opciones: |
|
inlinePassages |
Los pasajes se proporcionan intercalados en la solicitud. |
semanticRetriever |
Contenido recuperado de recursos creados con la API de Semantic Retriever. |
temperature |
Opcional. Controla la aleatorización del resultado. Los valores pueden variar desde [0.0,1.0] inclusive. Un valor cercano a 1.0 producirá respuestas más variadas y creativas, mientras que un valor cercano a 0.0 generalmente dará como resultado respuestas más directas del modelo. Por lo general, se recomienda una temperatura baja (~0.2) para los casos de uso de respuestas a preguntas atribuidas. |
Cuerpo de la respuesta
Respuesta del modelo para una respuesta fundamentada.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "answer": { object ( |
Campos | |
---|---|
answer |
Respuesta del candidato del modelo. Nota: El modelo siempre intenta proporcionar una respuesta fundamentada, incluso cuando es poco probable que se pueda responder a partir de los fragmentos dados. En ese caso, es posible que se proporcione una respuesta de baja calidad o no fundamentada, junto con una |
answerableProbability |
Solo salida. Es la estimación del modelo de la probabilidad de que su respuesta sea correcta y se base en los pasajes de entrada. Una answerableProbability baja indica que la respuesta puede no estar basada en las fuentes. Cuando el valor de
|
inputFeedback |
Solo salida. Son comentarios relacionados con los datos de entrada usados para responder a la pregunta, en lugar de la respuesta generada por modelos a la pregunta. Los "Datos de entrada" pueden ser uno o más de los siguientes valores:
|
Permisos de autorización
Se necesita uno de los siguientes alcances de 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
Para obtener más información, consulta Descripción general de la autenticación.
GroundingPassages
Una lista repetida de pasajes.
Representación JSON |
---|
{
"passages": [
{
object ( |
Campos | |
---|---|
passages[] |
Lista de pasajes. |
GroundingPassage
El pasaje se incluye intercalado con una configuración de puesta a tierra.
Representación JSON |
---|
{
"id": string,
"content": {
object ( |
Campos | |
---|---|
id |
Identificador del pasaje para atribuirlo en respuestas fundadas. |
content |
Contenido del pasaje. |
SemanticRetrieverConfig
Configuración para recuperar contenido de fundamentos de un Corpus
o Document
creado con la API de Semantic Retriever.
Representación JSON |
---|
{ "source": string, "query": { object ( |
Campos | |
---|---|
source |
Obligatorio. Nombre del recurso para la recuperación, p.ej., corpora/123 o corpora/123/documents/abc. |
query |
Obligatorio. Consulta para usar para similitudes coincidentes |
metadataFilters[] |
Opcional. Filtros para seleccionar |
maxChunksCount |
Opcional. Cantidad máxima de |
minimumRelevanceScore |
Opcional. Puntuación de relevancia mínima para los |
AnswerStyle
Estilo para respuestas fundadas.
Enumeradores | |
---|---|
ANSWER_STYLE_UNSPECIFIED |
Estilo de respuesta sin especificar. |
ABSTRACTIVE |
Estilo conciso pero abstracto. |
EXTRACTIVE |
Estilo muy breve y extractivo. |
VERBOSE |
Estilo detallado que incluye detalles adicionales. La respuesta puede tener el formato de una oración, un párrafo, varios párrafos, viñetas, etcétera. |
InputFeedback
Son comentarios relacionados con los datos de entrada usados para responder a la pregunta, en lugar de la respuesta generada por modelos a la pregunta.
Representación JSON |
---|
{ "safetyRatings": [ { object ( |
Campos | |
---|---|
safetyRatings[] |
Clasificaciones de seguridad de la entrada Existe, como máximo, una calificación por categoría. |
blockReason |
Opcional. Si se establece, se bloqueó la entrada y no se muestran candidatos. Reformula la entrada. |
BlockReason
Especifica el motivo por el que se bloqueó la entrada.
Enumeradores | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Valor predeterminado Este valor no se usa. |
SAFETY |
Se bloqueó la entrada por razones de seguridad. Puedes inspeccionar safetyRatings para comprender qué categoría de seguridad lo bloqueó. |
OTHER |
Se bloqueó la entrada por otros motivos. |