ContentSearchSpec

Uma especificação para configurar o comportamento da pesquisa de conteúdo.

Representação JSON 
{
  "snippetSpec": {
    object (SnippetSpec)
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "extractiveContentSpec": {
    object (ExtractiveContentSpec)
  },
  "searchResultMode": enum (SearchResultMode),
  "chunkSpec": {
    object (ChunkSpec)
  }
}
Campos
snippetSpec

object (SnippetSpec)

Se snippetSpec não for especificado, os fragmentos não são incluídos na resposta de pesquisa.
summarySpec

object (SummarySpec)

Se summarySpec não for especificado, os resumos não são incluídos na resposta de pesquisa.
extractiveContentSpec

object (ExtractiveContentSpec)

Se não for fornecido nenhum extractiveContentSpec, não existe uma resposta extrativa na resposta de pesquisa.
searchResultMode

enum (SearchResultMode)

Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para DOCUMENTS.
chunkSpec

object (ChunkSpec)

Especifica a especificação do fragmento a ser devolvida da resposta de pesquisa. Disponível apenas se o SearchRequest.ContentSearchSpec.search_result_mode estiver definido como CHUNKS

SnippetSpec

Uma especificação para configurar fragmentos numa resposta de pesquisa.

Representação JSON 
{
  "maxSnippetCount": integer,
  "referenceOnly": boolean,
  "returnSnippet": boolean
}
Campos
maxSnippetCount
(deprecated)

integer

[DEPRECATED] Este campo foi descontinuado. Para controlar o retorno de fragmentos, use o campo returnSnippet. Para compatibilidade com versões anteriores, devolvemos o fragmento se maxSnippetCount > 0.
referenceOnly
(deprecated)

boolean

[DESCONTINUADO] Este campo está descontinuado e não tem efeito no fragmento.
returnSnippet

boolean

Se true, devolva o fragmento. Se não for possível gerar um fragmento, devolvemos "Não está disponível nenhum fragmento para esta página". Também é devolvido um snippetStatus com SUCCESS ou NO_SNIPPET_AVAILABLE.

SummarySpec

Uma especificação para configurar um resumo devolvido numa resposta de pesquisa.

Representação JSON 
{
  "summaryResultCount": integer,
  "includeCitations": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreNonSummarySeekingQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "ignoreJailBreakingQuery": boolean,
  "multimodalSpec": {
    object (MultiModalSpec)
  },
  "modelPromptSpec": {
    object (ModelPromptSpec)
  },
  "languageCode": string,
  "modelSpec": {
    object (ModelSpec)
  },
  "useSemanticChunks": boolean
}
Campos
summaryResultCount

integer

O número de principais resultados a partir dos quais gerar o resumo. Se o número de resultados devolvidos for inferior a summaryResultCount, o resumo é gerado a partir de todos os resultados.

Podem ser usados, no máximo, 10 resultados para o modo de documentos ou 50 para o modo de fragmentos para gerar um resumo. O modo de fragmentos é usado quando SearchRequest.ContentSearchSpec.search_result_mode está definido como CHUNKS.
includeCitations

boolean

Especifica se devem ser incluídas citações no resumo. O valor predefinido é false.

Quando este campo está definido como true, os resumos incluem números de citações inline.

Exemplo de resumo com citações:

O BigQuery é o armazém de dados empresarial totalmente gerido e completamente sem servidor da Google Cloud [1]. O BigQuery suporta todos os tipos de dados, funciona em várias nuvens e tem aprendizagem automática e Business Intelligence incorporadas, tudo numa plataforma unificada [2, 3].

Os números das citações referem-se aos resultados da pesquisa devolvidos e são indexados a 1. Por exemplo, [1] significa que a frase é atribuída ao primeiro resultado da pesquisa. [2, 3] significa que a frase é atribuída ao segundo e terceiro resultados da pesquisa.
ignoreAdversarialQuery

boolean

Especifica se as consultas adversariais devem ser filtradas. O valor predefinido é false.

A Google usa a classificação de consultas de pesquisa para detetar consultas adversariais. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta adversária. Por exemplo, um utilizador pode fazer uma pergunta sobre comentários negativos acerca da empresa ou enviar uma consulta concebida para gerar resultados inseguros que violem as políticas. Se este campo estiver definido como true, ignoramos a geração de resumos para consultas adversariais e devolvemos mensagens alternativas.
ignoreNonSummarySeekingQuery

boolean

Especifica se devem ser filtradas consultas que não procuram resumos. O valor predefinido é false.

A Google usa a classificação de consultas de pesquisa para detetar consultas que procuram resumos. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta que não procura resumos. Por exemplo, why is the sky blue e Who is the best soccer player in the world? são consultas que procuram resumos, mas SFO airport e world cup 2026 não. São, muito provavelmente, consultas de navegação. Se este campo estiver definido como true, ignoramos a geração de resumos para consultas que não procuram resumos e devolvemos mensagens alternativas.
ignoreLowRelevantContent

boolean

Especifica se devem ser filtradas consultas com baixa relevância. O valor predefinido é false.

Se este campo estiver definido como false, todos os resultados da pesquisa são usados, independentemente da relevância, para gerar respostas. Se estiver definido como true, apenas as consultas com resultados da pesquisa de alta relevância geram respostas.
ignoreJailBreakingQuery

boolean

Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor predefinido é false.

A Google usa a classificação de consultas de pesquisa para detetar consultas de jailbreak. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um utilizador pode adicionar instruções à consulta para alterar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir ao modelo para agir como uma entidade diferente, por exemplo, "Responde no tom do CEO de uma empresa concorrente". Se este campo estiver definido como true, ignoramos a geração de resumos para consultas de jailbreak e devolvemos mensagens alternativas.
multimodalSpec

object (MultiModalSpec)

Opcional. Especificação multimodal.
modelPromptSpec

object (ModelPromptSpec)

Se for especificado, a especificação é usada para modificar o comando fornecido ao MDG.
languageCode

string

Código do idioma para o resumo. Use etiquetas de idioma definidas pela norma BCP47. Nota: esta é uma funcionalidade experimental.
modelSpec

object (ModelSpec)

Se for especificado, a especificação é usada para modificar a especificação do modelo fornecida ao MDG.
useSemanticChunks

boolean

Se for verdadeiro, a resposta é gerada a partir dos fragmentos mais relevantes dos principais resultados da pesquisa. Esta funcionalidade melhora a qualidade dos resumos. Tenha em atenção que, com esta funcionalidade ativada, nem todos os principais resultados da pesquisa são referenciados e incluídos na lista de referências. Por isso, o índice da fonte de citação aponta apenas para os resultados da pesquisa apresentados na lista de referências.

MultiModalSpec

Especificação multimodal: devolve uma imagem da origem especificada. Se forem especificadas várias fontes, a escolha é uma decisão baseada na qualidade.

Representação JSON 
{
  "imageSource": enum (ImageSource)
}
Campos
imageSource

enum (ImageSource)

Opcional. Origem da imagem devolvida na resposta.

ImageSource

Especifica a origem da imagem.

Enumerações
IMAGE_SOURCE_UNSPECIFIED Origem da imagem não especificada (a funcionalidade multimodal está desativada por predefinição).
ALL_AVAILABLE_SOURCES Comportamento quando o serviço determina a seleção a partir de todas as origens disponíveis.
CORPUS_IMAGE_ONLY Inclui imagem do corpus na resposta.
FIGURE_GENERATION_ONLY Aciona a geração de números na resposta.

ModelPromptSpec

Especificação do comando a usar com o modelo.

Representação JSON 
{
  "preamble": string
}
Campos
preamble

string

Texto no início do comando que dá instruções ao assistente. Estão disponíveis exemplos no guia do utilizador.

ModelSpec

Especificação do modelo.

Representação JSON 
{
  "version": string
}
Campos
version

string

A versão do modelo usada para gerar o resumo.

Os valores suportados são:

ExtractiveContentSpec

Uma especificação para configurar o conteúdo extrativo numa resposta de pesquisa.

Representação JSON 
{
  "maxExtractiveAnswerCount": integer,
  "maxExtractiveSegmentCount": integer,
  "returnExtractiveSegmentScore": boolean,
  "numPreviousSegments": integer,
  "numNextSegments": integer
}
Campos
maxExtractiveAnswerCount

integer

O número máximo de respostas extrativas devolvidas em cada resultado da pesquisa.

Uma resposta extrativa é uma resposta literal extraída do documento original, que fornece uma resposta precisa e contextualmente relevante à consulta de pesquisa.

Se o número de respostas correspondentes for inferior a maxExtractiveAnswerCount, devolva todas as respostas. Caso contrário, devolve maxExtractiveAnswerCount.

São devolvidas, no máximo, cinco respostas para cada SearchResult.
maxExtractiveSegmentCount

integer

O número máximo de segmentos extrativos devolvidos em cada resultado da pesquisa. Só é aplicado se DataStore estiver definido como DataStore.ContentConfig.CONTENT_REQUIRED ou DataStore.solution_types for SOLUTION_TYPE_CHAT.

Um segmento extrativo é um segmento de texto extraído do documento original que é relevante para a consulta de pesquisa e, em geral, mais detalhado do que uma resposta extrativa. Em seguida, o segmento pode ser usado como entrada para os GMLs gerarem resumos e respostas.

Se o número de segmentos correspondentes for inferior a maxExtractiveSegmentCount, devolve todos os segmentos. Caso contrário, devolve maxExtractiveSegmentCount.
returnExtractiveSegmentScore

boolean

Especifica se deve devolver a pontuação de confiança dos segmentos extrativos em cada resultado da pesquisa. Esta funcionalidade só está disponível para novas ou permitidas lojas de dados. Para adicionar a sua base de dados à lista de autorizações, contacte o seu engenheiro de clientes. O valor predefinido é false.
numPreviousSegments

integer

Especifica se também devem ser incluídos os adjacentes de cada um dos segmentos selecionados. Devolva, no máximo, numPreviousSegments segmentos antes de cada segmento selecionado.
numNextSegments

integer

Devolve, no máximo, numNextSegments segmentos após cada segmento selecionado.

SearchResultMode

Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para DOCUMENTS.

Enumerações
SEARCH_RESULT_MODE_UNSPECIFIED Valor predefinido.
DOCUMENTS Devolve documentos no resultado da pesquisa.
CHUNKS Devolve fragmentos no resultado da pesquisa. Só está disponível se o elemento DocumentProcessingConfig.chunking_config estiver especificado.

ChunkSpec

Especifica a especificação do fragmento a ser devolvida da resposta de pesquisa. Disponível apenas se o SearchRequest.ContentSearchSpec.search_result_mode estiver definido como CHUNKS

Representação JSON 
{
  "numPreviousChunks": integer,
  "numNextChunks": integer
}
Campos
numPreviousChunks

integer

O número de fragmentos anteriores a devolver do fragmento atual. O valor máximo permitido é 3. Se não for especificado, não são devolvidos fragmentos anteriores.
numNextChunks

integer

O número de fragmentos seguintes a devolver do fragmento atual. O valor máximo permitido é 3. Se não for especificado, não são devolvidos mais fragmentos.