Question Answering Projects - Get Synonyms

Usługa:

Azure AI Services

Wersja interfejsu API:

2021-10-01

Pobiera wszystkie synonimy projektu.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01

Z parametrami opcjonalnymi:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://< nazwa-zasobu.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.
maxpagesize	query		integer (int32)	Maksymalna liczba zasobów do uwzględnienia w pojedynczej odpowiedzi.
skip	query		integer (int32)	Przesunięcie do kolekcji pierwszego zasobu, który ma zostać zwrócony.
top	query		integer (int32)	Maksymalna liczba zasobów do zwrócenia z kolekcji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SynonymAssets	Wszystkie synonimy projektu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/synonyms?api-version=2021-10-01

Przykładowa odpowiedź

Kod stanu:

200

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

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	Wszystkie zasoby synonimów dla tego projektu.
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
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

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
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

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

Wszystkie zasoby synonimów dla tego projektu.

Nazwa	Typ	Opis
nextLink	string
value	WordAlterations[]	Kolekcja synonimów.

WordAlterations

Objekt

Kolekcja zmian słów.

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