Documents - Index

Referência

Serviço:: Search Service

Versão da API:: 2023-10-01-Preview

Envia um lote de ações de gravação de documento para o índice.

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2023-10-01-Preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
value	True	IndexAction[]	As ações no lote.

Respostas

Nome	Tipo	Description
200 OK	IndexDocumentsResult	Resposta que contém o status de operações para todas as ações no lote.
Other Status Codes	IndexDocumentsResult	Resposta que contém o status de operações para todas as ações no lote.
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchIndexIndexDocuments

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-10-01-Preview

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Código de status:: 207

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Definições

Nome	Description
IndexAction	Representa uma ação de índice que opera em um documento.
IndexActionType	A operação a ser executada em um documento em um lote de indexação.
IndexBatch	Contém um lote de ações de gravação de documento a serem enviadas para o índice.
IndexDocumentsResult	Resposta que contém o status de operações para todos os documentos na solicitação de indexação.
IndexingResult	Status de uma operação de indexação para um único documento.
SearchError	Descreve uma condição de erro para a API.

IndexAction

Representa uma ação de índice que opera em um documento.

Nome	Tipo	Description
@search.action	IndexActionType	A operação a ser executada em um documento em um lote de indexação.

IndexActionType

A operação a ser executada em um documento em um lote de indexação.

Nome	Tipo	Description
delete	string	Remove o documento especificado do índice. Qualquer campo especificado em uma operação de exclusão diferente do campo de chave será ignorado. Se você quiser remover um campo individual de um documento, use merge e defina o campo explicitamente como nulo.
merge	string	Mescla os valores de campo especificados com um documento existente. Se o documento não existir, a mesclagem falhará. Qualquer campo que você especificar em uma mesclagem substituirá o campo existente no documento. Isso também se aplica a coleções de tipos primitivos e complexos.
mergeOrUpload	string	Comporta-se como mesclar se um documento com a chave fornecida já existir no índice. Se o documento não existir, ele se comportará como carregar com um novo documento.
upload	string	Insere o documento no índice se ele for novo e o atualiza se ele existir. Todos os campos são substituídos no caso de atualização.

IndexBatch

Contém um lote de ações de gravação de documento a serem enviadas para o índice.

Nome	Tipo	Description
value	IndexAction[]	As ações no lote.

IndexDocumentsResult

Resposta que contém o status de operações para todos os documentos na solicitação de indexação.

Nome	Tipo	Description
value	IndexingResult[]	A lista de informações de status para cada documento na solicitação de indexação.

IndexingResult

Status de uma operação de indexação para um único documento.

Nome	Tipo	Description
errorMessage	string	A mensagem de erro explicando por que a operação de indexação falhou para o documento identificado pela chave; nulo se a indexação tiver sido bem-sucedida.
key	string	A chave de um documento que estava na solicitação de indexação.
status	boolean	Um valor que indica se a operação de indexação foi bem-sucedida para o documento identificado pela chave.
statusCode	integer	O código status da operação de indexação. Os valores possíveis incluem: 200 para uma atualização ou exclusão bem-sucedida, 201 para criação bem-sucedida de documentos, 400 para um documento de entrada malformado, 404 para documento não encontrado, 409 para um conflito de versão, 422 quando o índice está temporariamente indisponível ou 503 para quando o serviço está muito ocupado.

SearchError

Descreve uma condição de erro para a API.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível do erro.

Compartilhar via