Question Answering Projects - Update Synonyms

Usługa:

Azure AI Services

Wersja interfejsu API:

2023-04-01

Aktualizuje wszystkie synonimy projektu.

PUT {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/synonyms?api-version=2023-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string (uri)	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nazwa projektu do użycia.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
value	True	WordAlterations[]	Elementy WordAlterations na tej stronie
nextLink		string (uri)	Link do następnej strony elementów

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Ładunek odpowiedzi po pomyślnym zaktualizowaniu synonimów.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Successful query

Przykładowe żądanie

HTTP

PUT {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/synonyms?api-version=2023-04-01

{
  "value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:

204

Definicje

Nazwa	Opis
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Żądanie ładunku aktualizacji synonimów.
WordAlterations	Kolekcja zmian słów.

Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchIndexLimitReached	Błąd osiągnięto limit indeksu usługi Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Nie znaleziono błędu indeksu usługi Azure Cognitive Search
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
Conflict	Błąd konfliktu
Forbidden	Błąd dostępu zabronionego
InternalServerError	Wewnętrzny błąd serwera.
InvalidArgument	Błąd nieprawidłowego argumentu
InvalidRequest	Błąd nieprawidłowego żądania
NotFound	Nie znaleziono błędu
OperationNotFound	Błąd nie znaleziono operacji
ProjectNotFound	Błąd nie znaleziono projektu
QuotaExceeded	Błąd przekroczenia limitu przydziału
ServiceUnavailable	Błąd niedostępności usługi
Timeout	Błąd przekroczenia limitu czasu
TooManyRequests	Błąd zbyt wielu żądań
Unauthorized	Błąd nieautoryzowanego dostępu
Warning	Błąd ostrzeżenia

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
EmptyRequest	Błąd pustego żądania
ExtractionFailure	Błąd wyodrębniania
InvalidCountryHint	Błąd nieprawidłowej wskazówki dotyczącej kraju
InvalidDocument	Błąd nieprawidłowego dokumentu
InvalidDocumentBatch	Błąd wsadowy nieprawidłowego dokumentu
InvalidParameterValue	Błąd nieprawidłowej wartości parametru
InvalidRequest	Błąd nieprawidłowego żądania
InvalidRequestBodyFormat	Błąd nieprawidłowego formatu treści żądania
KnowledgeBaseNotFound	Nie znaleziono błędu bazy wiedzy
MissingInputDocuments	Błąd brakujących dokumentów wejściowych
ModelVersionIncorrect	Błąd nieprawidłowej wersji modelu
UnsupportedLanguageCode	Nieobsługiwany błąd kodu języka

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

SynonymAssets

Objekt

Żądanie ładunku aktualizacji synonimów.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	WordAlterations[]	Elementy WordAlterations na tej stronie

WordAlterations

Objekt

Kolekcja zmian słów.

Nazwa	Typ	Opis
alterations	string[]	Kolekcja zmian słów.