- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- GroundingPassages
- GroundingPassage
- SemanticRetrieverConfig
- AnswerStyle
- InputFeedback
- BlockReason
Gera uma resposta embasada a partir do modelo, dada uma entrada GenerateAnswerRequest
.
Solicitação HTTP
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
model |
Obrigatório. O nome do Formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "contents": [ { object ( |
Campos | |
---|---|
contents[] |
Obrigatório. O conteúdo da conversa atual com o modelo. Para consultas de turno único, esta é uma pergunta a ser respondida. Para consultas de várias interações, esse é um campo repetido que contém o histórico da conversa e o último Observação: no momento, models.generateAnswer é compatível apenas com consultas em inglês. |
answerStyle |
Obrigatório. Estilo em que as respostas devem ser retornadas. |
safetySettings[] |
Opcional. Uma lista de instâncias Isso será aplicado ao |
Campo de união grounding_source . As fontes em que a resposta será embasada. grounding_source pode ser apenas de um dos tipos a seguir: |
|
inlinePassages |
Passagens fornecidas inline com a solicitação. |
semanticRetriever |
Conteúdo recuperado de recursos criados pela API Semantic Retriever. |
temperature |
Opcional. Controla a aleatoriedade da saída. Os valores podem variar de [0,0,1,0], inclusive. Um valor próximo de 1,0 produz respostas mais variadas e criativas, enquanto um valor mais próximo de 0,0 normalmente resulta em respostas mais diretas do modelo. Uma temperatura baixa (~0,2) geralmente é recomendada para casos de uso de respostas a perguntas atribuídas. |
Corpo da resposta
Resposta do modelo para uma resposta fundamentada.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "answer": { object ( |
Campos | |
---|---|
answer |
Resposta candidata a partir do modelo. Observação: o modelo sempre tenta fornecer uma resposta fundamentada, mesmo quando é improvável que ela seja respondida nos trechos fornecidos. Nesse caso, uma resposta de baixa qualidade ou não fundamentada pode ser fornecida, além de uma |
answerableProbability |
Apenas saída. A estimativa do modelo da probabilidade de a resposta estar correta e fundamentada nas passagens de entrada. Uma baixa answerableProbability indica que a resposta pode não estar fundamentada nas fontes. Quando
|
inputFeedback |
Apenas saída. Feedback relacionado aos dados de entrada usados para responder à pergunta, em vez da resposta gerada pelo modelo. Os "dados de entrada" podem ser um ou mais dos seguintes valores:
|
Escopos de autorização
Requer um dos seguintes escopos 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 saber mais, consulte a Visão geral da autenticação.
GroundingPassages
Uma lista repetida de trechos.
Representação JSON |
---|
{
"passages": [
{
object ( |
Campos | |
---|---|
passages[] |
Lista de trechos. |
GroundingPassage
Passagem incluída inline com uma configuração de embasamento.
Representação JSON |
---|
{
"id": string,
"content": {
object ( |
Campos | |
---|---|
id |
Identificador do trecho que atribui esse trecho em respostas embasadas. |
content |
Conteúdo do trecho. |
SemanticRetrieverConfig
Configuração para recuperar conteúdo de embasamento de um Corpus
ou Document
criada usando a API Semantic Retriever.
Representação JSON |
---|
{ "source": string, "query": { object ( |
Campos | |
---|---|
source |
Obrigatório. Nome do recurso a ser recuperado, por exemplo, corpora/123 ou corpora/123/documents/abc. |
query |
Obrigatório. Consulta a ser usada para correspondência de similaridade |
metadataFilters[] |
Opcional. Filtros para selecionar |
maxChunksCount |
Opcional. Número máximo de |
minimumRelevanceScore |
Opcional. Pontuação de relevância mínima para |
AnswerStyle
Estilo para respostas fundamentadas.
Enums | |
---|---|
ANSWER_STYLE_UNSPECIFIED |
Estilo de resposta não especificado. |
ABSTRACTIVE |
Estilo sucinto, mas abstrato. |
EXTRACTIVE |
Estilo muito breve e extrativo. |
VERBOSE |
Estilo detalhado, incluindo detalhes extras. A resposta pode ser formatada como uma frase, um parágrafo, vários parágrafos, marcadores etc. |
InputFeedback
Feedback relacionado aos dados de entrada usados para responder à pergunta, em vez da resposta gerada pelo modelo.
Representação JSON |
---|
{ "safetyRatings": [ { object ( |
Campos | |
---|---|
safetyRatings[] |
Classificações de segurança da entrada. Há no máximo uma classificação por categoria. |
blockReason |
Opcional. Se definido, a entrada será bloqueada e nenhum candidato será retornado. Reformule sua entrada. |
BlockReason
Especifica o motivo pelo qual a entrada foi bloqueada.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
SAFETY |
A entrada foi bloqueada por motivos de segurança. Você pode inspecionar safetyRatings para entender qual categoria de segurança a bloqueou. |
OTHER |
A entrada foi bloqueada por outros motivos. |