Documents - Index

Referência

Serviço:: Search Service

Versão da API:: 2024-07-01

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

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

Parâmetros do URI

Name	Em	Necessá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 do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de rastreamento enviado com a solicitação para ajudar com a 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 contendo o status das operações para todas as ações no lote.
Other Status Codes	IndexDocumentsResult	Resposta contendo o status das operações para todas as ações no lote.
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchIndexIndexDocuments

Pedido de amostra

HTTP

POST https://exampleservice.search.windows.net/indexes('indexdocumentsexample')/docs/search.index?api-version=2024-07-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"
    }
  ]
}

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "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 estado:: 207

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
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 para enviar ao índice.
IndexDocumentsResult	Resposta contendo o status das 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.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexAction

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

Name	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.

Name	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 mesclar em vez disso 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 especificado 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 mesclagem se um documento com a chave fornecida já existir no índice. Se o documento não existir, ele se comporta 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 gravação de documento para enviar ao índice.

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

IndexDocumentsResult

Resposta contendo o status das operações para todos os documentos na solicitação de indexação.

Name	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.

Name	Tipo	Description
errorMessage	string	A mensagem de erro explicando por que a operação de indexação falhou para o documento identificado pela chave; null se a indexação for 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 de status da operação de indexação. Os valores possíveis incluem: 200 para uma atualização ou exclusão bem-sucedida, 201 para a criação bem-sucedida de documentos, 400 para um documento de entrada malformado, 404 para um 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.

Partilhar via