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 snippets não serão incluídos na resposta da pesquisa.
summarySpec

object (SummarySpec)

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

object (ExtractiveContentSpec)

Se não houver um extractiveContentSpec, não haverá uma resposta extraída na resposta da pesquisa.
searchResultMode

enum (SearchResultMode)

Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa será DOCUMENTS por padrão.
chunkSpec

object (ChunkSpec)

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

SnippetSpec

Uma especificação para configurar snippets em uma resposta de pesquisa.

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

integer

[DESCONTINUADO] O uso deste campo foi descontinuado. Para controlar o retorno de snippets, use o campo returnSnippet. Para compatibilidade com versões anteriores, vamos retornar o snippet se maxSnippetCount > 0.
referenceOnly
(deprecated)

boolean

[DESCONTINUADO] Este campo está descontinuado e não vai afetar o snippet.
returnSnippet

boolean

Se true, retorne o snippet. Se não for possível gerar um trecho, vamos retornar "Nenhum trecho disponível para esta página". Um snippetStatus com SUCCESS ou NO_SNIPPET_AVAILABLE também será retornado.

SummarySpec

Uma especificação para configurar um resumo retornado em uma 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 dos principais resultados para gerar o resumo. Se o número de resultados retornados for menor que summaryResultCount, o resumo será gerado com base em todos os resultados.

É possível usar no máximo 10 resultados no modo de documentos ou 50 no modo de partes para gerar um resumo. O modo de partes é usado quando SearchRequest.ContentSearchSpec.search_result_mode é definido como CHUNKS.
includeCitations

boolean

Especifica se as citações devem ser incluídas no resumo. O valor padrão é false.

Quando esse campo é definido como true, os resumos incluem números de citação inline.

Exemplo de resumo com citações:

O BigQuery é o data warehouse corporativo totalmente gerenciado e sem servidor do Google Cloud [1]. O BigQuery oferece suporte a todos os tipos de dados, funciona em diferentes nuvens e tem machine learning e Business Intelligence integrados, tudo em uma plataforma unificada [2, 3].

Os números de citação se referem aos resultados da pesquisa retornados e são indexados de 1 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 ao terceiro resultados da pesquisa.
ignoreAdversarialQuery

boolean

Especifica se as consultas adversárias devem ser filtradas. O valor padrão é false.

O Google usa a classificação de consultas de pesquisa para detectar consultas adversárias. Nenhum resumo é retornado se a consulta de pesquisa for classificada como adversária. Por exemplo, um usuário pode fazer uma pergunta sobre comentários negativos sobre a empresa ou enviar uma consulta projetada para gerar uma saída não segura que viola a política. Se esse campo for definido como true, vamos pular a geração de resumos para consultas adversárias e retornar mensagens alternativas.
ignoreNonSummarySeekingQuery

boolean

Especifica se é necessário filtrar consultas que não buscam um resumo. O valor padrão é false.

O Google usa a classificação de consultas de pesquisa para detectar consultas que buscam resumos. Nenhum resumo é retornado se a consulta de pesquisa for classificada como uma consulta que não busca resumos. Por exemplo, why is the sky blue e Who is the best soccer player in the world? são consultas que buscam um resumo, mas SFO airport e world cup 2026 não são. Provavelmente são consultas de navegação. Se este campo estiver definido como true, vamos pular a geração de resumos para consultas que não buscam resumos e retornar mensagens alternativas.
ignoreLowRelevantContent

boolean

Especifica se as consultas de baixa relevância devem ser filtradas. O valor padrão é false.

Se esse campo for definido como false, todos os resultados da pesquisa serão usados, independente da relevância, para gerar respostas. Se definido como true, apenas consultas com resultados de pesquisa de alta relevância vão gerar respostas.
ignoreJailBreakingQuery

boolean

Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor padrão é false.

O Google usa a classificação de consultas de pesquisa para detectar consultas de jailbreak. Nenhum resumo é retornado se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um usuário pode adicionar instruções à consulta para mudar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir que o modelo aja como uma entidade diferente, por exemplo, "Responda no tom de um CEO de uma empresa concorrente". Se esse campo for definido como true, vamos pular a geração de resumos para consultas de jailbreak e retornar mensagens alternativas.
multimodalSpec

object (MultiModalSpec)

Opcional. Especificação multimodal.
modelPromptSpec

object (ModelPromptSpec)

Se especificado, a especificação será usada para modificar o comando fornecido ao LLM.
languageCode

string

Código do idioma do resumo. Use tags de idioma definidas pelo BCP47 (em inglês). Observação: este é um recurso experimental.
modelSpec

object (ModelSpec)

Se especificado, ele será usado para modificar a especificação do modelo fornecida ao LLM.
useSemanticChunks

boolean

Se for "true", a resposta será gerada com base nos trechos mais relevantes dos principais resultados da pesquisa. Esse recurso vai melhorar a qualidade do resumo. Com esse recurso ativado, nem todos os principais resultados da pesquisa serão referenciados e incluídos na lista de referências. Portanto, o índice de origem da citação aponta apenas para os resultados da pesquisa listados na lista de referências.

MultiModalSpec

Especificação multimodal: retorna uma imagem da fonte especificada. Se várias fontes forem especificadas, a escolha será baseada na qualidade.

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

enum (ImageSource)

Opcional. Origem da imagem retornada na resposta.

ImageSource

Especifica a origem da imagem.

Tipos enumerados
IMAGE_SOURCE_UNSPECIFIED Origem da imagem não especificada (o recurso multimodal fica desativado por padrão).
ALL_AVAILABLE_SOURCES Comportamento quando o serviço determina a escolha entre todas as fontes disponíveis.
CORPUS_IMAGE_ONLY Inclui imagem do corpus na resposta.
FIGURE_GENERATION_ONLY Aciona a geração de figuras na resposta.

ModelPromptSpec

Especificação do comando a ser usado com o modelo.

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

string

Texto no início do comando que instrui o assistente. Exemplos estão disponíveis no guia do usuário.

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 aceitos são:

ExtractiveContentSpec

Uma especificação para configurar o conteúdo extrativo em uma 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 extraídas retornadas em cada resultado da pesquisa.

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

Se o número de respostas correspondentes for menor que maxExtractiveAnswerCount, retorne todas as respostas. Caso contrário, retorne o maxExtractiveAnswerCount.

No máximo, cinco respostas são retornadas para cada SearchResult.
maxExtractiveSegmentCount

integer

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

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

Se o número de segmentos correspondentes for menor que maxExtractiveSegmentCount, retorne todos os segmentos. Caso contrário, retorne o maxExtractiveSegmentCount.
returnExtractiveSegmentScore

boolean

Especifica se é necessário retornar a pontuação de confiança dos segmentos extrativos em cada resultado da pesquisa. Esse recurso está disponível apenas para repositórios de dados novos ou na lista de permissões. Para autorizar seu repositório de dados, entre em contato com seu engenheiro de clientes. O valor padrão é false.
numPreviousSegments

integer

Especifica se também é necessário incluir o adjacente de cada segmento selecionado. Retorne no máximo numPreviousSegments segmentos antes de cada segmento selecionado.
numNextSegments

integer

Retorne 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 será DOCUMENTS por padrão.

Tipos enumerados
SEARCH_RESULT_MODE_UNSPECIFIED Valor padrão.
DOCUMENTS Retorna documentos no resultado da pesquisa.
CHUNKS Retorna partes no resultado da pesquisa. Disponível apenas se o DocumentProcessingConfig.chunking_config for especificado.

ChunkSpec

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

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

integer

O número de partes anteriores a serem retornadas da parte atual. O valor máximo permitido é 3. Se não for especificado, nenhum trecho anterior será retornado.
numNextChunks

integer

O número de próximos trechos a serem retornados do trecho atual. O valor máximo permitido é 3. Se não for especificado, nenhum próximo bloco será retornado.