SearchSpec

Especificação de pesquisa.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of mutually exclusive fields.
}
Campos
Parâmetros de pesquisa para controlar o comportamento de pesquisa. Ou forneça uma lista de resultados da pesquisa para gerar uma resposta. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
searchParams

object (SearchParams)

Parâmetros de pesquisa.
searchResultList

object (SearchResultList)

Lista de resultados da pesquisa.
Fim dos campos mutuamente exclusivos.

SearchParams

Parâmetros de pesquisa.

Representação JSON 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
Campos
maxReturnResults

integer

Número de resultados da pesquisa a serem retornados. O valor padrão é 10.
filter

string

A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas. Isso será usado para filtrar os resultados da pesquisa, o que pode afetar a resposta.

Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.

A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")'

Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.
boostSpec

object (BoostSpec)

A especificação Boost visa dar mais destaque a determinados documentos nos resultados de pesquisa, o que pode afetar a resposta à consulta. Para mais informações sobre o aumento, consulte Aumento.
orderBy

string

A ordem em que os documentos são retornados. Os documentos podem ser ordenados por um campo em um objeto Document. Deixe em branco se a ordenação for por relevância. A expressão orderBy diferencia maiúsculas de minúsculas. Para mais informações sobre como fazer pedidos, consulte Pedidos.

Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.
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. Consulte analisar e dividir documentos
customFineTuningSpec

object (CustomFineTuningSpec)

Opcional. Configurações de ajuste refinado personalizadas.
dataStoreSpecs[]

object (DataStoreSpec)

Especificações que definem dataStores para filtrar em uma chamada de pesquisa e configurações para esses dataStores. Isso só é considerado para mecanismos com caso de uso de vários dataStores. Para um único dataStore em um mecanismo, use as especificações no nível superior.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Opcional. Especificação para ativar recursos de compreensão de linguagem natural para solicitações de pesquisa.

SearchResultList

Lista de resultados da pesquisa.

Representação JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
searchResults[]

object (SearchResult)

Resultados da pesquisa.

SearchResult

Resultado da pesquisa.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of mutually exclusive fields.
}
Campos
Conteúdo dos resultados da pesquisa. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informações de documentos não estruturados.
chunkInfo

object (ChunkInfo)

Informações do bloco.
Fim dos campos mutuamente exclusivos.

UnstructuredDocumentInfo

Informações de documentos não estruturados.

Representação JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
Campos
document

string

Nome do recurso do documento.
uri

string

URI do documento.
title

string

Título.
documentContexts[]

object (DocumentContext)

Lista de contextos de documentos. O conteúdo será usado para geração de respostas. Esse é o conteúdo principal do documento, que pode ser longo e abrangente.
extractiveSegments[]

object (ExtractiveSegment)

Lista de segmentos extrativos.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Descontinuado: esse campo está descontinuado e não vai afetar a geração de respostas. Use os campos "documentContexts" e "extractiveSegments". Lista de respostas extrativas.

DocumentContext

Contexto do documento.

Representação JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador da página.
content

string

Conteúdo do documento a ser usado para gerar respostas.

ExtractiveSegment

Segmento extrativo. Guide A geração de respostas só o utilizará se documentContexts estiver vazio. Supostamente, trata-se de trechos mais curtos.

Representação JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador da página.
content

string

Conteúdo do segmento extrativo.

ExtractiveAnswer

Resposta extrativa. Guia

Representação JSON 
{
  "pageIdentifier": string,
  "content": string
}
Campos
pageIdentifier

string

Identificador da página.
content

string

Conteúdo da resposta extrativa.

ChunkInfo

Informações do bloco.

Representação JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Campos
chunk

string

Nome do recurso de bloco.
content

string

Divida o conteúdo textual em partes.
documentMetadata

object (DocumentMetadata)

Metadados do documento do bloco atual.

DocumentMetadata

Os metadados do documento contêm as informações do documento do bloco atual.

Representação JSON 
{
  "uri": string,
  "title": string
}
Campos
uri

string

URI do documento.
title

string

Título do documento.