SearchSpec

Especificação de pesquisa.

Representação JSON 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
Campos
Campo de união input. Parâmetros de pesquisa para controlar o comportamento da pesquisa. Em alternativa, forneça uma lista de resultados da pesquisa para gerar uma resposta. input só pode ser uma das seguintes opções:
searchParams

object (SearchParams)

Parâmetros de pesquisa.
searchResultList

object (SearchResultList)

Lista de resultados da pesquisa.

SearchParams

Parâmetros de pesquisa.

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

integer

Número de resultados de pesquisa a devolver. O valor predefinido é 10.
filter

string

A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas. Isto é usado para filtrar os resultados da pesquisa, o que pode afetar a resposta da resposta.

Se este campo não for reconhecível, é devolvido um INVALID_ARGUMENT.

A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "nome" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")'

Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar
boostSpec

object (BoostSpec)

Especificação de reforço para reforçar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta à consulta de resposta. Para mais informações sobre o aumento, consulte o artigo Aumentar
orderBy

string

A ordem pela qual os documentos são devolvidos. Os documentos podem ser ordenados por um campo num objeto Document. Deixe-o não definido se a ordenação for por relevância. A expressão orderBy é sensível a maiúsculas e minúsculas. Para mais informações sobre como fazer encomendas, consulte o artigo Fazer encomendas

Se este campo não for reconhecível, é devolvido um INVALID_ARGUMENT.
searchResultMode

enum (SearchResultMode)

Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para DOCUMENTS. Consulte o artigo Analise e divida documentos em partes
dataStoreSpecs[]

object (DataStoreSpec)

Especificações que definem os dataStores a filtrar numa chamada de pesquisa e as configurações desses dataStores. Isto só é considerado para motores com o exemplo de utilização de várias lojas de dados. Para um único dataStore num motor, devem usar as especificações ao nível superior.

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 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de união content. Conteúdo dos resultados da pesquisa. content só pode ser uma das seguintes opções:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

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

object (ChunkInfo)

Informações de blocos.

UnstructuredDocumentInfo

Informações de documentos não estruturadas.

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 vai ser usado para a geração de respostas. Este deve ser o conteúdo principal do documento, que pode ser longo e abrangente.
extractiveSegments[]

object (ExtractiveSegment)

Lista de segmentos extrativos.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Obsoleto: este campo está obsoleto e não tem efeito na 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 usar para a geração de respostas.

ExtractiveSegment

Segmento extrativo. A geração de respostas da Guide só a usa se documentContexts estiver vazio. Estes devem ser fragmentos mais curtos.

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

string

Identificador da página.
content

string

Conteúdo de segmentos extrativos.

ExtractiveAnswer

Resposta extrativa. Guia

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

string

Identificador da página.
content

string

Conteúdo de resposta extrativo.

ChunkInfo

Informações de blocos.

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

string

Nome do recurso do fragmento.
content

string

Dividir o conteúdo textual em partes.
documentMetadata

object (DocumentMetadata)

Metadados do documento do fragmento atual.

DocumentMetadata

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

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

string

URI do documento.
title

string

Título do documento.