Documents - Index

Referência

Service:: Search Service

API Version:: 2023-11-01

Envia um lote de ações de escrita de documentos para o índice.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Corpo do Pedido

Name	Necessário	Tipo	Description
value	True	IndexAction[]	As ações no lote.

Respostas

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

Exemplos

SearchIndexIndexDocuments

Sample Request

HTTP

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

{
  "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"
    }
  ]
}

Sample Response

Status code:: 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
    }
  ]
}

Status code:: 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

Name	Description
IndexAction	Representa uma ação de índice que funciona num documento.
IndexActionType	A operação a executar num documento num lote de indexação.
IndexBatch	Contém um lote de ações de escrita de documentos para enviar para o índice.
IndexDocumentsResult	Resposta que contém o estado das operações para todos os documentos no pedido de indexação.
IndexingResult	Estado 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 funciona num documento.

Name	Tipo	Description
@search.action	IndexActionType	A operação a executar num documento num lote de indexação.

IndexActionType

A operação a executar num documento num lote de indexação.

Name	Tipo	Description
delete	string	Remove o documento especificado do índice. Qualquer campo que especificar numa operação de eliminação que não seja o campo de chave será ignorado. Se quiser remover um campo individual de um documento, utilize intercalar e defina explicitamente o campo como nulo.
merge	string	Intercala os valores de campo especificados com um documento existente. Se o documento não existir, a intercalação falhará. Qualquer campo que especifique numa intercalação irá substituir o campo existente no documento. Isto também se aplica a coleções de tipos primitivos e complexos.
mergeOrUpload	string	Comporta-se como uma intercalação se já existir um documento com a chave especificada no índice. Se o documento não existir, comporta-se como carregar com um novo documento.
upload	string	Insere o documento no índice se for novo e atualiza-o se existir. Todos os campos são substituídos no caso de atualização.

IndexBatch

Contém um lote de ações de escrita de documentos para enviar para o índice.

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

IndexDocumentsResult

Resposta que contém o estado das operações para todos os documentos no pedido de indexação.

Name	Tipo	Description
value	IndexingResult[]	A lista de informações de estado para cada documento no pedido de indexação.

IndexingResult

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

Name	Tipo	Description
errorMessage	string	A mensagem de erro que explica a razão pela qual 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 no pedido de indexação.
status	boolean	Um valor que indica se a operação de indexação foi efetuada com êxito para o documento identificado pela chave.
statusCode	integer	O código de estado da operação de indexação. Os valores possíveis incluem: 200 para uma atualização ou eliminação bem-sucedida, 201 para criação de documentos com êxito, 400 para um documento de entrada mal formado, 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á demasiado ocupado.

SearchError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message	string	Uma representação legível por humanos do erro.

Partilhar via