Question Answering Projects - List Projects

Layanan:: Azure AI Services

Versi API:: 2023-04-01

Mendapatkan semua proyek untuk pengguna.

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

Dengan parameter opsional:

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string (uri)	Titik akhir Cognitive Services yang didukung (misalnya, https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
maxpagesize	query		integer (int32)	Jumlah maksimum sumber daya yang akan 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.

Respons

Nama	Jenis	Deskripsi
200 OK	PagedQuestionAnsweringProjectMetadata	Permintaan itu berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

PagedQuestionAnsweringProjectMetadata

Permintaan itu berhasil.

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Successful query

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "description": "proj1 is a test project.",
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "multilingualResource": true,
      "projectName": "proj1",
      "language": "en"
    },
    {
      "description": "proj2 is a test project.",
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "multilingualResource": true,
      "projectName": "proj2",
      "language": "fr"
    }
  ]
}

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.
PagedQuestionAnsweringProjectMetadata	Kumpulan halaman item QuestionAnsweringProjectMetadata
ProjectSettings	Pengaturan Proyek yang dapat dikonfigurasi.
QuestionAnsweringProjectMetadata	Mewakili proyek.

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	Kesalahan permintaan tidak valid
InvalidArgument	Kesalahan argumen tidak valid
Unauthorized	Kesalahan akses tidak sah
Forbidden	Kesalahan akses terlarang
NotFound	Kesalahan tidak ditemukan
ProjectNotFound	Kesalahan proyek tidak ditemukan
OperationNotFound	Operasi tidak ditemukan kesalahan
AzureCognitiveSearchNotFound	Kesalahan Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchIndexNotFound	Kesalahan indeks Azure Cognitive Search tidak ditemukan
TooManyRequests	Terlalu banyak kesalahan permintaan
AzureCognitiveSearchThrottling	Kesalahan pembatasan Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Kesalahan tercapainya batas indeks Azure Cognitive Search
InternalServerError	Kesalahan server internal
ServiceUnavailable	Kesalahan layanan tidak tersedia
Timeout	Kesalahan waktu habis
QuotaExceeded	Kesalahan kuota terlampaui
Conflict	Kesalahan konflik
Warning	Kesalahan peringatan

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
InvalidRequest	Kesalahan permintaan tidak valid
InvalidParameterValue	Kesalahan nilai parameter tidak valid
KnowledgeBaseNotFound	Pangkalan pengetahuan tidak menemukan kesalahan
AzureCognitiveSearchNotFound	Kesalahan Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchThrottling	Kesalahan pembatasan Azure Cognitive Search
ExtractionFailure	Kesalahan kegagalan ekstraksi
InvalidRequestBodyFormat	Kesalahan format isi permintaan tidak valid
EmptyRequest	Kesalahan permintaan kosong
MissingInputDocuments	Kesalahan dokumen input hilang
InvalidDocument	Kesalahan dokumen tidak valid
ModelVersionIncorrect	Kesalahan versi model salah
InvalidDocumentBatch	Kesalahan batch dokumen tidak valid
UnsupportedLanguageCode	Kesalahan kode bahasa yang tidak didukung
InvalidCountryHint	Kesalahan petunjuk negara tidak valid

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.

PagedQuestionAnsweringProjectMetadata

Objek

Kumpulan halaman item QuestionAnsweringProjectMetadata

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	QuestionAnsweringProjectMetadata[]	Item QuestionAnsweringProjectMetadata di halaman ini

ProjectSettings

Objek

Pengaturan Proyek yang dapat dikonfigurasi.

Nama	Jenis	Deskripsi
defaultAnswer	string	Respons Jawaban Default ketika tidak ada kecocokan yang baik yang ditemukan di pangkalan pengetahuan.

QuestionAnsweringProjectMetadata

Objek

Mewakili proyek.

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	Tanggal pembuatan proyek.
description	string	Deskripsi proyek.
language	string	Bahasa rekaman teks. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris; "es" untuk bahasa Spanyol dll. Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default.
lastDeployedDateTime	string (date-time)	Mewakili tanggal-waktu penyebaran terakhir proyek.
lastModifiedDateTime	string (date-time)	Mewakili proyek tanggal-waktu terakhir yang diubah.
multilingualResource	boolean	Sumber daya diaktifkan untuk beberapa bahasa di seluruh proyek atau tidak.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nama proyek.
settings	ProjectSettings	Pengaturan Proyek yang dapat dikonfigurasi.

Bagikan melalui

Question Answering Projects - List Projects

Parameter URI

Respons

Keamanan

Ocp-Apim-Subscription-Key

OAuth2Auth

Cakupan

Contoh

Successful query

Permintaan sampel

Respon sampel

Definisi

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

PagedQuestionAnsweringProjectMetadata

ProjectSettings

QuestionAnsweringProjectMetadata