Endpoints - Create
Membuat titik akhir baru.
POST {endpoint}/speechtotext/v3.2-preview.2/endpoints
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
endpoint
|
path | True |
string |
Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus.api.cognitive.microsoft.com). |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
displayName | True |
string |
Nama tampilan objek. |
locale | True |
string |
Lokal data yang terkandung. |
customProperties |
object |
Properti kustom entitas ini. Panjang kunci maksimum yang diizinkan adalah 64 karakter, panjang nilai maksimum yang diizinkan adalah 256 karakter dan jumlah entri yang diizinkan adalah 10. |
|
description |
string |
Deskripsi objek . |
|
model |
EntityReference |
||
project |
EntityReference |
||
properties |
EndpointProperties |
||
text |
string |
Teks yang digunakan untuk mengadaptasi model bahasa untuk titik akhir ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
201 Created |
Respons berisi informasi tentang entitas sebagai payload dan lokasinya sebagai header. Header Location: string |
|
Other Status Codes |
Terjadi kesalahan. |
Keamanan
Ocp-Apim-Subscription-Key
Berikan kunci akun layanan kognitif Anda di sini.
Jenis:
apiKey
Dalam:
header
Authorization
Berikan token akses dari JWT yang dikembalikan oleh STS wilayah ini. Pastikan untuk menambahkan cakupan manajemen ke token dengan menambahkan string kueri berikut ke URL STS: ?scope=speechservicesmanagement
Jenis:
apiKey
Dalam:
header
Contoh
Create an endpoint
Permintaan sampel
POST {
"model": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
},
"properties": {
"loggingEnabled": true
},
"locale": "en-US",
"displayName": "Speech endpoint definition",
"description": "This is a speech endpoint"
}/speechtotext/v3.2-preview.2/endpoints
{
"model": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
},
"properties": {
"loggingEnabled": true
},
"locale": "en-US",
"displayName": "Speech endpoint definition",
"description": "This is a speech endpoint"
}
Respon sampel
Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
"model": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
},
"links": {
"logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
"restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
"restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
"restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
"webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
"webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
"webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
},
"properties": {
"timeToLive": "PT30M",
"loggingEnabled": true
},
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Succeeded",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "Speech endpoint",
"description": "Example for speech endpoint"
}
Definisi
Nama | Deskripsi |
---|---|
Detailed |
DetailedErrorCode |
Endpoint |
Titik akhir |
Endpoint |
EndpointLinks |
Endpoint |
EndpointProperties |
Entity |
EntityError |
Entity |
EntityReference |
Error |
Kesalahan |
Error |
ErrorCode |
Inner |
InnerError |
Status |
Status |
DetailedErrorCode
DetailedErrorCode
Nama | Jenis | Deskripsi |
---|---|---|
DataImportFailed |
string |
Impor data gagal. |
DeleteNotAllowed |
string |
Hapus tidak diperbolehkan. |
DeployNotAllowed |
string |
Penyebaran tidak diperbolehkan. |
DeployingFailedModel |
string |
Menyebarkan model yang gagal. |
EmptyRequest |
string |
Permintaan Kosong. |
EndpointCannotBeDefault |
string |
Titik akhir tidak boleh default. |
EndpointNotUpdatable |
string |
Titik akhir tidak dapat diperbarui. |
EndpointWithoutLogging |
string |
Titik akhir tanpa pengelogan. |
ExceededNumberOfRecordingsUris |
string |
Melebihi jumlah uri rekaman. |
FailedDataset |
string |
Himpunan data yang gagal. |
Forbidden |
string |
Terlarang. |
InUseViolation |
string |
Dalam pelanggaran penggunaan. |
InaccessibleCustomerStorage |
string |
Penyimpanan pelanggan yang tidak dapat diakses. |
InvalidAdaptationMapping |
string |
Pemetaan adaptasi tidak valid. |
InvalidBaseModel |
string |
Model dasar tidak valid. |
InvalidCallbackUri |
string |
Uri panggilan balik tidak valid. |
InvalidCollection |
string |
Koleksi tidak valid. |
InvalidDataset |
string |
Himpunan data tidak valid. |
InvalidDocument |
string |
Dokumen Tidak Valid. |
InvalidDocumentBatch |
string |
Batch Dokumen Tidak Valid. |
InvalidLocale |
string |
Lokal tidak valid. |
InvalidLogDate |
string |
Tanggal log tidak valid. |
InvalidLogEndTime |
string |
Waktu akhir log tidak valid. |
InvalidLogId |
string |
Id log tidak valid. |
InvalidLogStartTime |
string |
Waktu mulai log tidak valid. |
InvalidModel |
string |
Model tidak valid. |
InvalidModelUri |
string |
Uri model tidak valid. |
InvalidParameter |
string |
Parameter tidak valid. |
InvalidParameterValue |
string |
Nilai parameter tidak valid. |
InvalidPayload |
string |
Payload tidak valid. |
InvalidPermissions |
string |
Izin tidak valid. |
InvalidPrerequisite |
string |
Prasyarat tidak valid. |
InvalidProductId |
string |
Id produk tidak valid. |
InvalidProject |
string |
Proyek tidak valid. |
InvalidProjectKind |
string |
Jenis proyek tidak valid. |
InvalidRecordingsUri |
string |
uri rekaman tidak valid. |
InvalidRequestBodyFormat |
string |
Format isi permintaan tidak valid. |
InvalidSasValidityDuration |
string |
Durasi validitas sas tidak valid. |
InvalidSkipTokenForLogs |
string |
Tidak valid melewati token untuk log. |
InvalidSourceAzureResourceId |
string |
ID sumber daya Azure sumber tidak valid. |
InvalidSubscription |
string |
Langganan tidak valid. |
InvalidTest |
string |
Tes tidak valid. |
InvalidTimeToLive |
string |
Waktu hidup tidak valid. |
InvalidTopForLogs |
string |
Bagian atas untuk log tidak valid. |
InvalidTranscription |
string |
Transkripsi tidak valid. |
InvalidWebHookEventKind |
string |
Jenis peristiwa webhook tidak valid. |
MissingInputRecords |
string |
Rekaman Input hilang. |
ModelCopyOperationExists |
string |
Operasi penyalinan model ada. |
ModelDeploymentNotCompleteState |
string |
Penyebaran model tidak selesai. |
ModelDeprecated |
string |
Model tidak digunakan lagi. |
ModelExists |
string |
Model ada. |
ModelMismatch |
string |
Model tidak cocok. |
ModelNotDeployable |
string |
Model tidak dapat disebarkan. |
ModelVersionIncorrect |
string |
Versi Model Salah. |
NoUtf8WithBom |
string |
Tidak ada utf8 dengan bom. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Hanya salah satu url atau kontainer atau himpunan data. |
ProjectGenderMismatch |
string |
Ketidakcocokan jenis kelamin proyek. |
QuotaViolation |
string |
Pelanggaran kuota. |
SingleDefaultEndpoint |
string |
Titik akhir default tunggal. |
SkuLimitsExist |
string |
Batas Sku ada. |
SubscriptionNotFound |
string |
Langganan tidak ditemukan. |
UnexpectedError |
string |
Kesalahan tak terduga. |
UnsupportedClassBasedAdaptation |
string |
Adaptasi berbasis kelas yang tidak didukung. |
UnsupportedDelta |
string |
Delta yang tidak didukung. |
UnsupportedDynamicConfiguration |
string |
Konfigurasi dinamis yang tidak didukung. |
UnsupportedFilter |
string |
Filter yang tidak didukung. |
UnsupportedLanguageCode |
string |
Kode bahasa tidak didukung. |
UnsupportedOrderBy |
string |
Urutan yang tidak didukung oleh. |
UnsupportedPagination |
string |
Penomoran halaman yang tidak didukung. |
UnsupportedTimeRange |
string |
Rentang waktu yang tidak didukung. |
Endpoint
Titik akhir
Nama | Jenis | Deskripsi |
---|---|---|
createdDateTime |
string |
Stempel waktu saat objek dibuat. Stempel waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
customProperties |
object |
Properti kustom entitas ini. Panjang kunci maksimum yang diizinkan adalah 64 karakter, panjang nilai maksimum yang diizinkan adalah 256 karakter dan jumlah entri yang diizinkan adalah 10. |
description |
string |
Deskripsi objek . |
displayName |
string |
Nama tampilan objek. |
lastActionDateTime |
string |
Stempel waktu ketika status saat ini dimasukkan. Stempel waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
links |
EndpointLinks |
|
locale |
string |
Lokal data yang terkandung. |
model |
EntityReference |
|
project |
EntityReference |
|
properties |
EndpointProperties |
|
self |
string |
Lokasi entitas ini. |
status |
Status |
|
text |
string |
Teks yang digunakan untuk mengadaptasi model bahasa untuk titik akhir ini. |
EndpointLinks
EndpointLinks
Nama | Jenis | Deskripsi |
---|---|---|
logs |
string |
Log audio dan transkripsi untuk titik akhir ini. Lihat operasi "Endpoints_ListLogs" untuk detail selengkapnya. |
restConversation |
string |
Titik akhir REST untuk permintaan hingga 60 detik. |
restDictation |
string |
Titik akhir REST untuk permintaan hingga 60 detik, mendukung dikte tanda baca. |
restInteractive |
string |
Titik akhir REST untuk permintaan singkat hingga 15 detik. |
webSocketConversation |
string |
Titik akhir Speech SDK untuk permintaan panjang dengan beberapa hasil akhir. |
webSocketDictation |
string |
Titik akhir Speech SDK untuk permintaan panjang dengan beberapa hasil akhir, mendukung dikte tanda baca. |
webSocketInteractive |
string |
Titik akhir Speech SDK untuk permintaan singkat hingga 15 detik dengan satu hasil akhir. |
EndpointProperties
EndpointProperties
Nama | Jenis | Deskripsi |
---|---|---|
string |
Alamat email untuk mengirim pemberitahuan email jika operasi selesai. Nilai akan dihapus setelah berhasil mengirim email. |
|
error |
EntityError |
|
loggingEnabled |
boolean |
Nilai yang menunjukkan apakah pengelogan konten (audio & transkripsi) sedang digunakan untuk penyebaran. |
timeToLive |
string |
Berapa lama titik akhir akan disimpan dalam sistem. Setelah titik akhir mencapai waktu hidup setelah selesai (berhasil atau gagal) titik akhir akan dihapus secara otomatis. Tidak mengatur nilai atau pengaturan ini ke 0 akan menonaktifkan penghapusan otomatis. Durasi terpanjang yang didukung adalah 31 hari. Durasi dikodekan sebagai durasi ISO 8601 ("PnYnMnDTnHnMnS", lihat https://en.wikipedia.org/wiki/ISO_8601#Durations). |
EntityError
EntityError
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan ini. |
message |
string |
Pesan untuk kesalahan ini. |
EntityReference
EntityReference
Nama | Jenis | Deskripsi |
---|---|---|
self |
string |
Lokasi entitas yang dirujuk. |
Error
Kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan. |
innerError |
InnerError |
|
message |
string |
Pesan kesalahan tingkat tinggi. |
target |
string |
Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid. |
ErrorCode
ErrorCode
Nama | Jenis | Deskripsi |
---|---|---|
Conflict |
string |
Mewakili kode kesalahan konflik. |
Forbidden |
string |
Mewakili kode kesalahan terlarang. |
InternalCommunicationFailed |
string |
Mewakili kode kesalahan komunikasi internal yang gagal. |
InternalServerError |
string |
Mewakili kode kesalahan server internal. |
InvalidArgument |
string |
Mewakili kode kesalahan argumen yang tidak valid. |
InvalidRequest |
string |
Mewakili kode kesalahan permintaan yang tidak valid. |
NotAllowed |
string |
Mewakili kode kesalahan yang tidak diizinkan. |
NotFound |
string |
Mewakili kode kesalahan yang tidak ditemukan. |
PipelineError |
string |
Mewakili kode kesalahan kesalahan alur. |
ServiceUnavailable |
string |
Mewakili kode kesalahan layanan yang tidak tersedia. |
TooManyRequests |
string |
Mewakili kode kesalahan terlalu banyak permintaan. |
Unauthorized |
string |
Mewakili kode kesalahan yang tidak sah. |
UnprocessableEntity |
string |
Mewakili kode kesalahan entitas yang tidak dapat diolah. |
UnsupportedMediaType |
string |
Mewakili kode kesalahan jenis media yang tidak didukung. |
InnerError
InnerError
Nama | Jenis | Deskripsi |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan. |
innerError |
InnerError |
|
message |
string |
Pesan kesalahan tingkat tinggi. |
target |
string |
Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid. |
Status
Status
Nama | Jenis | Deskripsi |
---|---|---|
Failed |
string |
Operasi yang berjalan lama telah gagal. |
NotStarted |
string |
Operasi jangka panjang belum dimulai. |
Running |
string |
Operasi jangka panjang saat ini sedang diproses. |
Succeeded |
string |
Operasi jangka panjang telah berhasil diselesaikan. |