Documents - Index

Serviço:: Search Service

Versão da API:: 2026-04-01

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitaçã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 das operações para todos os documentos na solicitação de indexação.
Other Status Codes	IndexDocumentsResult	Resposta que contém o status das operações para todos os documentos na solicitação de indexação.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchIndexIndexDocuments

Solicitação de exemplo

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.index?api-version=2026-04-01


{
  "value": [
    {
      "@search.action": "mergeOrUpload",
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "vector1": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector1b": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector2": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector3": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector22": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29
      ],
      "ownerId": "benny",
      "category": "purple",
      "price": 0
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "1",
      "name": "test",
      "description": "test1 hello",
      "vector1": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector1b": [
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector2": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector3": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector22": [
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 1
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "vector1": [
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector1b": [
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector2": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector3": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector22": [
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 2
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Código de status:: 207

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
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 que contém 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.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexAction

Objeto

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

Enumeração

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

Valor	Description
upload	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.
merge	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	Comporta-se como mesclar 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.
delete	Remove o documento especificado do índice. Qualquer campo especificado em uma operação de exclusão diferente do campo-chave será ignorado. Se você desejar remover um campo individual de um documento, use a mesclagem e defina o campo explicitamente como nulo.

IndexBatch

Objeto

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

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

IndexDocumentsResult

Objeto

Resposta que contém o status das 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

Objeto

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 (int32)	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 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.