Question Answering Projects - Get Synonyms

Layanan:

Azure AI Services

Versi API:

2021-10-01

Mendapatkan semua sinonim proyek.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API Klien.
maxpagesize	query		integer (int32)	Jumlah maksimum sumber daya untuk disertakan dalam satu respons.
skip	query		integer (int32)	Offset ke dalam kumpulan sumber daya pertama yang akan dikembalikan.
top	query		integer (int32)	Jumlah maksimum sumber daya yang akan dikembalikan dari koleksi.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	SynonymAssets	Semua sinonim proyek.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

Successful query

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
Error	Objek kesalahan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Semua aset sinonim untuk proyek ini.
WordAlterations	Kumpulan perubahan kata.

Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	InnerErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

SynonymAssets

Objek

Semua aset sinonim untuk proyek ini.

Nama	Jenis	Deskripsi
nextLink	string
value	WordAlterations[]	Kumpulan sinonim.

WordAlterations

Objek

Kumpulan perubahan kata.

Nama	Jenis	Deskripsi
alterations	string[]	Kumpulan perubahan kata.