Pesquisa os documentos de um único DataStore.
Retorna segmentos de subdocumentos classificados, cada um se referindo ao documento de origem e com a procedência necessária para citá-lo.
Solicitação HTTP
POST https://vectorsearch.googleapis.com/v1beta/{parent}/documents:search
Parâmetros de caminho
| Parâmetros | |
|---|---|
parent |
Obrigatório. O DataStore a ser pesquisado. Formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
| Representação JSON |
|---|
{ "topK": integer, "documentIds": [ string ], "rankingSpec": { object ( |
| Campos | |
|---|---|
topK |
Opcional. Número de resultados que serão retornados. O valor padrão é 10. Valores acima de 100 são convertidos para 100. |
documentIds[] |
Opcional. Restrinja a pesquisa a esses IDs de documento. Máximo de 100. Se estiver vazio, todo o DataStore será pesquisado. |
rankingSpec |
Opcional. Controla como os resultados são classificados. |
filter |
Opcional. Restringe a pesquisa a segmentos que correspondem a esse filtro, um objeto JSON nos caminhos de campo de um
Comparações: {"$and": [{"metadata.year": {"$gte": 2025}}, {"unstructured_details.page_range.start_page": {"$lte": 20}}]} |
outputFields |
Opcional. Campos a serem retornados em cada resultado. |
| Obrigatório. A consulta a ser pesquisada. É necessário definir exatamente um tipo de consulta. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
textQuery |
Uma consulta de texto. |
| Fim dos campos mutuamente exclusivos. | |
Corpo da resposta
Mensagem de resposta para DocumentSearchService.SearchDocuments.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
|---|
{ "results": [ { object ( |
| Campos | |
|---|---|
results[] |
Apenas saída. Os segmentos de documentos que correspondem aos critérios de pesquisa, ordenados por relevância. |
warnings[] |
Apenas saída. Avisos ou erros não fatais que ocorreram durante a execução. |
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/vectorsearchhttps://www.googleapis.com/auth/vectorsearch.readonly
Para mais informações, consulte Authentication Overview.
TextQuery
Uma consulta de texto.
| Representação JSON |
|---|
{ "text": string } |
| Campos | |
|---|---|
text |
Obrigatório. O texto a ser pesquisado. |
RankingSpec
Controla como os resultados são classificados.
| Representação JSON |
|---|
{
"rerankingSpec": {
object ( |
| Campos | |
|---|---|
rerankingSpec |
Opcional. Controla o estágio de reclassificação. |
RerankingSpec
Configuração para reclassificação semântica aplicada aos resultados candidatos após a recuperação híbrida e a Reciprocal Rank Fusion (RRF).
| Representação JSON |
|---|
{ "enabled": boolean, "rankOversamplingFactor": integer } |
| Campos | |
|---|---|
enabled |
Opcional. Se os resultados combinados devem ser reclassificados. O padrão é falso: os resultados são retornados na ordem de fusão da RRF, a menos que o autor da chamada opte por não fazer isso. Quando ativada, a reclassificação usa Não há suporte para um DataStore |
rankOversamplingFactor |
Opcional. O fator pelo qual os candidatos são superamostrados antes de serem reclassificados. O número total de candidatos recuperados para reclassificação é Ignorado, a menos que Para reclassificar sem oversampling, defina esse campo como 1. |
OutputFields
Campos a serem retornados em cada DocumentSearchResult, além daqueles que todos os resultados carregam.
| Representação JSON |
|---|
{ "metadata": [ string ] } |
| Campos | |
|---|---|
metadata[] |
Opcional. Propriedades de metadados a serem retornadas em |
DocumentSearchResult
Um único segmento correspondente de um documento.
| Representação JSON |
|---|
{ "document": { object ( |
| Campos | |
|---|---|
document |
Apenas saída. O documento de origem desse segmento, incluindo o nome do recurso e o local do Cloud Storage de onde ele foi ingerido. Nem todos os campos do documento são preenchidos. Para o documento completo, chame documents.get no nome do documento retornado. |
Detalhes de onde o segmento está no documento. O campo definido segue o document_type do DataStore pai. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: |
|
videoDetails |
Definido quando o |
unstructuredDetails |
Definido quando o |
| Fim dos campos mutuamente exclusivos. | |
VideoSegmentDetails
Localiza um segmento em um documento de vídeo.
| Representação JSON |
|---|
{ "startOffset": string, "endOffset": string } |
| Campos | |
|---|---|
startOffset |
Apenas saída. Onde esse segmento começa, em relação ao início do vídeo de origem. Duração em segundos com até nove dígitos fracionários, terminando em " |
endOffset |
Apenas saída. Onde esse segmento termina, em relação ao início do vídeo de origem. Duração em segundos com até nove dígitos fracionários, terminando em " |
UnstructuredSegmentDetails
Localiza um segmento em um documento não estruturado e carrega o texto dele.
| Representação JSON |
|---|
{
"contentSnippet": string,
"pageRange": {
object ( |
| Campos | |
|---|---|
contentSnippet |
Apenas saída. Conteúdo de texto do segmento. |
pageRange |
Apenas saída. Onde o segmento está no documento de origem. Defina para arquivos PDF, PowerPoint e Excel, em que uma página é uma página PDF, um slide ou uma planilha. Para arquivos HTML, de texto simples, Markdown, JSON, XML e Word, defina apenas quando o arquivo for dividido em páginas ( |
PageRange
Um intervalo de páginas no documento de origem. As páginas são baseadas em 1, e o intervalo é inclusivo. Uma única página é representada como startPage == endPage.
| Representação JSON |
|---|
{ "startPage": string, "endPage": string } |
| Campos | |
|---|---|
startPage |
Apenas saída. Primeira página do intervalo. |
endPage |
Apenas saída. Última página do intervalo. |