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.

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.

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.