Documents - Index

Служба:: Search Service

Версия API:: 2026-04-01

Отправляет пакет действий записи документов в индекс.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Текст запроса

Имя	Обязательно	Тип	Описание
value	True	IndexAction[]	Действия в пакете.

Ответы

Имя	Тип	Описание
200 OK	IndexDocumentsResult	Ответ, содержащий состояние операций для всех документов в запросе индексирования.
Other Status Codes	IndexDocumentsResult	Ответ, содержащий состояние операций для всех документов в запросе индексирования.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchIndexIndexDocuments

Образец запроса

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

Пример ответа

Код состояния:: 200

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

Код состояния:: 207

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

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
IndexAction	Представляет действие индекса, которое работает с документом.
IndexActionType	Операция, выполняемая с документом в пакете индексирования.
IndexBatch	Содержит пакет действий записи документа для отправки в индекс.
IndexDocumentsResult	Ответ, содержащий состояние операций для всех документов в запросе индексирования.
IndexingResult	Состояние операции индексирования для одного документа.

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=none

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IndexAction

Объект

Представляет действие индекса, которое работает с документом.

Имя	Тип	Описание
@search.action	IndexActionType	Операция, выполняемая с документом в пакете индексирования.

IndexActionType

Перечисление

Операция, выполняемая с документом в пакете индексирования.

Значение	Описание
upload	Вставляет документ в индекс, если он новый, и обновляет его, если он существует. В случае обновления все поля заменяются.
merge	Объединяет указанные значения полей с существующим документом. Если документ не существует, объединение завершится ошибкой. Любое поле, указанное при слиянии, заменит существующее поле в документе. Это относится и к коллекциям примитивных и сложных типов.
mergeOrUpload	Ведет себя как слияние, если документ с заданным ключом уже существует в индексе. Если документ не существует, он ведет себя как при загрузке с новым документом.
delete	Удаляет указанный документ из индекса. Любое поле, указанное в операции удаления, отличное от ключевого поля, будет проигнорировано. Если вы хотите удалить отдельное поле из документа, используйте слияние и явно установите для поля значение null.

IndexBatch

Объект

Содержит пакет действий записи документа для отправки в индекс.

Имя	Тип	Описание
value	IndexAction[]	Действия в пакете.

IndexDocumentsResult

Объект

Ответ, содержащий состояние операций для всех документов в запросе индексирования.

Имя	Тип	Описание
value	IndexingResult[]	Список сведений о состоянии каждого документа в запросе индексирования.

IndexingResult

Объект

Состояние операции индексирования для одного документа.

Имя	Тип	Описание
errorMessage	string	Сообщение об ошибке, объясняющее, почему операция индексирования завершилась ошибкой для документа, определенного ключом; Значение NULL, если индексирование выполнено успешно.
key	string	Ключ документа, который был в запросе индексирования.
status	boolean	Значение, указывающее, выполнена ли операция индексирования для документа, определяемого ключом.
statusCode	integer (int32)	Код состояния операции индексирования. Возможные значения включают: 200 для успешного обновления или удаления, 201 для успешного создания документа, 400 для неправильно сформированного входного документа, 404 для документа не найден, 409 для конфликта версии, 422, когда индекс временно недоступен, или 503, если служба слишком занята.