Documents - Index

Ссылка

Служба:: Search Service

Версия API:: 2024-05-01-preview

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

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Идентификатор отслеживания, отправленный с запросом для помощи в отладке.

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

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

Ответы

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

Примеры

SearchIndexIndexDocuments

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

HTTP

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

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

Код состояния:: 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
    }
  ]
}

Код состояния:: 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
    }
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IndexAction	Представляет действие индекса, которое работает с документом.
IndexActionType	Операция, выполняемая с документом в пакете индексирования.
IndexBatch	Содержит пакет действий записи документов для отправки в индекс.
IndexDocumentsResult	Ответ, содержащий состояние операций для всех документов в запросе на индексирование.
IndexingResult	Состояние операции индексирования для одного документа.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Сообщение об ошибке

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

IndexAction

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

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

IndexActionType

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

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

IndexBatch

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

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

IndexDocumentsResult

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

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

IndexingResult

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

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

Поделиться через