Documents - Index
Wysyła partię akcji zapisu dokumentu do indeksu.
POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2024-07-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
endpoint
|
path | True |
string |
Adres URL punktu końcowego usługi wyszukiwania. |
index
|
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 |
Akcje w partii. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Odpowiedź zawierająca stan operacji dla wszystkich akcji w partii. |
|
Other Status Codes |
Odpowiedź zawierająca stan operacji dla wszystkich akcji w partii. |
|
Other Status Codes |
Odpowiedź na błąd. |
Przykłady
SearchIndexIndexDocuments
Przykładowe żądanie
POST https://exampleservice.search.windows.net/indexes('indexdocumentsexample')/docs/search.index?api-version=2024-07-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"
}
]
}
Przykładowa odpowiedź
{
"value": [
{
"key": "1",
"status": true,
"errorMessage": null,
"statusCode": 200
},
{
"key": "2",
"status": true,
"errorMessage": null,
"statusCode": 200
},
{
"key": "3",
"status": true,
"errorMessage": null,
"statusCode": 200
},
{
"key": "4",
"status": true,
"errorMessage": null,
"statusCode": 200
}
]
}
{
"value": [
{
"key": "1",
"status": true,
"errorMessage": null,
"statusCode": 201
},
{
"key": "2",
"status": false,
"errorMessage": "Document not found.",
"statusCode": 404
},
{
"key": "3",
"status": true,
"errorMessage": null,
"statusCode": 201
},
{
"key": "4",
"status": true,
"errorMessage": null,
"statusCode": 200
}
]
}
Definicje
Nazwa | Opis |
---|---|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Index |
Reprezentuje akcję indeksu działającą w dokumencie. |
Index |
Operacja wykonywana na dokumencie w partii indeksowania. |
Index |
Zawiera partię akcji zapisu dokumentu do wysłania do indeksu. |
Index |
Odpowiedź zawierająca stan operacji dla wszystkich dokumentów w żądaniu indeksowania. |
Indexing |
Stan operacji indeksowania dla pojedynczego dokumentu. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
IndexAction
Reprezentuje akcję indeksu działającą w dokumencie.
Nazwa | Typ | Opis |
---|---|---|
@search.action |
Operacja wykonywana na dokumencie w partii indeksowania. |
IndexActionType
Operacja wykonywana na dokumencie w partii indeksowania.
Nazwa | Typ | Opis |
---|---|---|
delete |
string |
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. |
merge |
string |
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 |
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 on 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 |
Akcje w partii. |
IndexDocumentsResult
Odpowiedź zawierająca stan operacji dla wszystkich dokumentów w żądaniu indeksowania.
Nazwa | Typ | Opis |
---|---|---|
value |
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 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. |