Documents - Index

Service:

Search Service

API Version:

2023-11-01

Wysyła partię akcji zapisu dokumentu do indeksu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Identyfikator śledzenia wysłany za pomocą żądania ułatwiającego debugowanie.

Treść żądania

Nazwa	Wymagane	Typ	Opis
value	True	IndexAction[]	Akcje w partii.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IndexDocumentsResult	Odpowiedź zawierająca stan operacji dla wszystkich akcji w partii.
Other Status Codes	IndexDocumentsResult	Odpowiedź zawierająca stan operacji dla wszystkich akcji w partii.
Other Status Codes	SearchError	Odpowiedź na błąd.

Przykłady

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

Definicje

Nazwa	Opis
IndexAction	Reprezentuje akcję indeksu, która działa w dokumencie.
IndexActionType	Operacja do wykonania w dokumencie w partii indeksowania.
IndexBatch	Zawiera partię akcji zapisu dokumentu do wysłania do indeksu.
IndexDocumentsResult	Odpowiedź zawierająca stan operacji dla wszystkich dokumentów w żądaniu indeksowania.
IndexingResult	Stan operacji indeksowania dla pojedynczego dokumentu.
SearchError	Opisuje warunek błędu interfejsu API.

IndexAction

Reprezentuje akcję indeksu, która działa w dokumencie.

Nazwa	Typ	Opis
@search.action	IndexActionType	Operacja do wykonania w dokumencie w partii indeksowania.

IndexActionType

Operacja do wykonania w dokumencie w partii indeksowania.

Nazwa	Typ	Opis
delete	string	Usuwa określony dokument z indeksu. Każde pole określone w operacji usuwania innej niż pole klucza zostanie zignorowane. Jeśli chcesz usunąć pojedyncze pole z dokumentu, użyj scalania i ustaw pole jawnie na wartość null.
merge	string	Scala określone wartości pól z istniejącym dokumentem. Jeśli dokument nie istnieje, scalanie zakończy się niepowodzeniem. Wszystkie pola, które określisz w żądaniu scalania, zastąpią istniejące pola w dokumencie. Dotyczy to również kolekcji typów pierwotnych i złożonych.
mergeOrUpload	string	Zachowuje się jak scalanie, jeśli dokument z danym kluczem już istnieje w indeksie. Jeśli dokument nie istnieje, zachowuje się jak przekazywanie przy użyciu nowego dokumentu.
upload	string	Wstawia dokument do indeksu, jeśli jest nowy i aktualizuje go, jeśli istnieje. Wszystkie pola są zastępowane w przypadku aktualizacji.

IndexBatch

Zawiera partię akcji zapisu dokumentu do wysłania do indeksu.

Nazwa	Typ	Opis
value	IndexAction[]	Akcje w partii.

IndexDocumentsResult

Odpowiedź zawierająca stan operacji dla wszystkich dokumentów w żądaniu indeksowania.

Nazwa	Typ	Opis
value	IndexingResult[]	Lista informacji o stanie dla każdego dokumentu w żądaniu indeksowania.

IndexingResult

Stan operacji indeksowania dla pojedynczego dokumentu.

Nazwa	Typ	Opis
errorMessage	string	Komunikat o błędzie wyjaśniający, dlaczego operacja indeksowania nie powiodła się dla dokumentu zidentyfikowanego przez klucz; null, jeśli indeksowanie zakończyło się pomyślnie.
key	string	Klucz dokumentu, który był w żądaniu indeksowania.
status	boolean	Wartość wskazująca, czy operacja indeksowania zakończyła się pomyślnie dla dokumentu zidentyfikowanego przez klucz.
statusCode	integer	Kod stanu operacji indeksowania. Możliwe wartości obejmują: 200 dla pomyślnej aktualizacji lub usunięcia, 201 w celu pomyślnego utworzenia dokumentu, 400 dla źle sformułowanego dokumentu wejściowego, 404 dla nie odnalezionego dokumentu, 409 dla konfliktu wersji, 422, gdy indeks jest tymczasowo niedostępny lub 503, gdy usługa jest zbyt zajęta.

SearchError

Opisuje warunek błędu interfejsu API.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	SearchError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.