Text Analysis Authoring - Get Project

Referensi

Layanan:: Cognitive Services - Language

Versi API:: 2023-04-01

Mendapatkan detail proyek.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API klien.

Respons

Nama	Jenis	Deskripsi
200 OK	TextAnalysisAuthoringProjectMetadata	Metadata proyek.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory . Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi direktori Azure Active. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

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

Cakupan

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

Ocp-Apim-Subscription-Key

Kunci langganan untuk sumber daya layanan Bahasa.

Jenis: apiKey
Dalam: header

Contoh

Successful Get Project

Permintaan sampel

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

Respon sampel

Kode status:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

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 tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Jenis proyek.
TextAnalysisAuthoringProjectMetadata	Mewakili metadata proyek.
TextAnalysisAuthoringProjectSettings	Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu set 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

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. 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 set 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.

ProjectKind

Jenis proyek.

Nama	Jenis	Deskripsi
CustomEntityRecognition	string	Untuk membangun model ekstraksi guna mengidentifikasi kategori domain Anda menggunakan data Anda sendiri.
CustomMultiLabelClassification	string	Untuk membangun model klasifikasi untuk mengklasifikasikan teks menggunakan data Anda sendiri. Setiap file dapat memiliki satu atau banyak label. Misalnya, file 1 diklasifikasikan sebagai A, B, dan C dan file 2 diklasifikasikan sebagai B dan C.
CustomSingleLabelClassification	string	Untuk membangun model klasifikasi untuk mengklasifikasikan teks menggunakan data Anda sendiri. Setiap file hanya akan memiliki satu label. Misalnya, file 1 diklasifikasikan sebagai A dan file 2 diklasifikasikan sebagai B.

TextAnalysisAuthoringProjectMetadata

Mewakili metadata proyek.

Nama	Jenis	Deskripsi
createdDateTime	string	Mewakili tanggalwaktu pembuatan proyek.
description	string	Deskripsi proyek.
language	string	Bahasa proyek. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll.
lastDeployedDateTime	string	Mewakili tanggalwaktu penyebaran terakhir proyek.
lastModifiedDateTime	string	Mewakili tanggalwaktu modifikasi terakhir proyek.
lastTrainedDateTime	string	Mewakili tanggalwaktu pelatihan terakhir proyek.
multilingual	boolean	Apakah proyek akan digunakan untuk beberapa bahasa atau tidak.
projectKind	ProjectKind	Jenis proyek.
projectName	string	Nama proyek baru.
settings	TextAnalysisAuthoringProjectSettings	Pengaturan proyek.
storageInputContainerName	string	Nama kontainer penyimpanan.

TextAnalysisAuthoringProjectSettings

Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek.

Nama	Jenis	Deskripsi
confidenceThreshold	number	Ambang kelas dengan keyakinan tertinggi, di mana prediksi akan secara otomatis diubah menjadi "Tidak Ada". Nilai ambang batas harus antara 0 dan 1 inklusif.

Bagikan melalui