Documents - Index

Usługa:: Search Service

Wersja interfejsu API:: 2024-03-01-Preview

Wysyła partię akcji zapisu dokumentu do indeksu.

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

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 z żądaniem, aby ułatwić 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	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexIndexDocuments

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
    }
  ]
}

Kod stanu:: 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
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IndexAction	Reprezentuje akcję indeksu działającą w dokumencie.
IndexActionType	Operacja wykonywana na 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.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IndexAction

Objekt

Reprezentuje akcję indeksu działającą w dokumencie.

Nazwa	Typ	Opis
@search.action	IndexActionType	Operacja wykonywana na dokumencie w partii indeksowania.

IndexActionType

Wyliczenie

Operacja wykonywana na dokumencie w partii indeksowania.

Wartość	Opis
upload	Wstawia dokument do indeksu, jeśli jest on nowy i aktualizuje go, jeśli istnieje. Wszystkie pola są zastępowane w przypadku aktualizacji.
merge	Scala określone wartości pól z istniejącym dokumentem. Jeśli dokument nie istnieje, scalanie zakończy się niepowodzeniem. Każde pole określone w scalaniu spowoduje zastąpienie istniejącego pola w dokumencie. Dotyczy to również kolekcji typów pierwotnych i złożonych.
mergeOrUpload	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.
delete	Usuwa określony dokument z indeksu. Każde pole określone w operacji usuwania inne niż pole klucza zostanie zignorowane. Jeśli chcesz usunąć pojedyncze pole z dokumentu, użyj scalania zamiast tego i ustaw jawnie pole na wartość null.

IndexBatch

Objekt

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

Nazwa	Typ	Opis
value	IndexAction[]	Akcje w partii.

IndexDocumentsResult

Objekt

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

Objekt

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 (int32)	Kod stanu operacji indeksowania. Możliwe wartości to: 200 dla pomyślnej aktualizacji lub usunięcia, 201 w przypadku pomyślnego utworzenia dokumentu, 400 dla źle sformułowanego dokumentu wejściowego, 404 dla nie odnalezionego dokumentu, 409 w przypadku konfliktu wersji, 422, gdy indeks jest tymczasowo niedostępny lub 503, gdy usługa jest zbyt zajęta.