Question Answering Projects - Get Synonyms

Hizmet:

Azure AI Services

API Sürümü:

2021-10-01

Bir projenin tüm eş anlamlılarını alır.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktası (örneğin, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Kullanılacak projenin adı.
api-version	query	True	string	İstemci API sürümü.
maxpagesize	query		integer (int32)	Tek bir yanıta eklenecek en fazla kaynak sayısı.
skip	query		integer (int32)	Döndürülecek ilk kaynağın koleksiyonuna uzaklık.
top	query		integer (int32)	Koleksiyondan döndürülecek en fazla kaynak sayısı.

İstek Başlığı

Name	Gerekli	Tür	Description
Ocp-Apim-Subscription-Key	True	string

Yanıtlar

Name	Tür	Description
200 OK	SynonymAssets	Bir projenin tüm eş anlamlıları.
Other Status Codes	ErrorResponse	Hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

Örnekler

Successful query

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilen hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilen hata kodu.
InnerErrorModel	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Bu proje için tüm eş anlamlı varlıklar.
WordAlterations	Sözcük değişiklikleri koleksiyonu.

Error

Object

Hata nesnesi.

Name	Tür	Description
code	ErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

Listeleme

İnsan tarafından okunabilen hata kodu.

Değer	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

InnerErrorCode

Listeleme

İnsan tarafından okunabilen hata kodu.

Değer	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	InnerErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	object	Hata ayrıntıları.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hata mesajı.
target	string	Hata hedefi.

SynonymAssets

Object

Bu proje için tüm eş anlamlı varlıklar.

Name	Tür	Description
nextLink	string
value	WordAlterations[]	Eş anlamlılar koleksiyonu.

WordAlterations

Object

Sözcük değişiklikleri koleksiyonu.

Name	Tür	Description
alterations	string[]	Sözcük değişiklikleri koleksiyonu.