Models - Create

Layanan:: Azure AI Services

Versi API:: v3.2-preview.2

Membuat model baru.

POST {endpoint}/speechtotext/v3.2-preview.2/models

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 minLength: 1	Nama tampilan objek.
locale	True	string minLength: 1	Lokal data yang terkandung.
baseModel		EntityReference	EntityReference
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.
datasets		EntityReference[]	Himpunan data yang digunakan untuk adaptasi.
description		string	Deskripsi objek.
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	Teks yang digunakan untuk menyesuaikan model bahasa ini.

Respons

Nama	Jenis	Deskripsi
201 Created	CustomModel	Respons berisi informasi tentang entitas sebagai payload dan lokasinya sebagai header. Header Location: string
Other Status Codes	Error	Terjadi kesalahan.

Nama

Jenis

Deskripsi

201 Created

CustomModel

Respons berisi informasi tentang entitas sebagai payload dan lokasinya sebagai header.

Header

Location: string

Other Status Codes

Error

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 a model

Create a model with custom model weight

Create a model

Permintaan sampel

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Respon sampel

Kode status:: 201

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Create a model with custom model weight

Permintaan sampel

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Respon sampel

Kode status:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 42,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Definisi

Nama	Deskripsi
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Kesalahan
ErrorCode	Kode Kesalahan
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Kedudukan

CustomModel

Objek

CustomModel

Nama	Jenis	Deskripsi
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	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.
datasets	EntityReference[]	Himpunan data yang digunakan untuk adaptasi.
description	string	Deskripsi objek.
displayName	string minLength: 1	Nama tampilan objek.
lastActionDateTime	string (date-time)	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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Lokal data yang terkandung.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Lokasi entitas ini.
status	Status	Kedudukan Menjelaskan status API saat ini
text	string	Teks yang digunakan untuk menyesuaikan model bahasa ini.

CustomModelDeprecationDates

Objek

CustomModelDeprecationDates

Nama	Jenis	Deskripsi
transcriptionDateTime	string (date-time)	Tanggal ketika transkripsi menjadi tidak digunakan lagi.

CustomModelFeatures

Objek

CustomModelFeatures

Nama	Jenis	Deskripsi
supportedOutputFormats	OutputFormatType[]	Format output yang didukung.
supportsEndpoints	boolean	Nilai yang menunjukkan apakah pembuatan titik akhir untuk transkripsi langsung didukung.
supportsTranscriptions	boolean	Nilai yang menunjukkan apakah transkripsi batch didukung.
supportsTranscriptionsOnSpeechContainers	boolean	Nilai yang menunjukkan apakah model ini dapat digunakan untuk transkripsi pada kontainer ucapan. Fitur ini dapat ditambahkan pada model yang ada ketika dapat digunakan pada kontainer ucapan.

CustomModelLinks

Objek

CustomModelLinks

Nama	Jenis	Deskripsi
copy	string (uri)	Lokasi ke tindakan penyalinan model. Lihat operasi "Models_Copy" untuk detail selengkapnya.
copyTo	string (uri)	Lokasi ke tindakan salin model usang. Lihat operasi "Models_CopyTo" untuk detail selengkapnya.
files	string (uri)	Lokasi untuk mendapatkan semua file entitas ini. Lihat operasi "Models_ListFiles" untuk detail selengkapnya.
manifest	string (uri)	Lokasi untuk mendapatkan manifes agar model ini digunakan dalam kontainer lokal. Lihat operasi "Models_GetCustomModelManifest" untuk detail selengkapnya.

CustomModelProperties

Objek

CustomModelProperties

Nama	Jenis	Deskripsi
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Berat model kustom antara 1 (1% model kustom dan model dasar 99%) dan 100 (model kustom 100% dan model dasar 0%). Ketika properti ini tidak diatur, layanan memilih nilai yang sesuai (dapatkan model untuk mengambil berat yang dipilih). Mulai tanpa menggunakan properti ini. Jika diperlukan, pilih bobot yang lebih besar (atau lebih kecil) untuk meningkatkan (atau mengurangi) dampak model kustom.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Alamat email untuk mengirim pemberitahuan email jika operasi selesai. Nilai akan dihapus setelah berhasil mengirim email.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Fitur yang didukung oleh model.

DetailedErrorCode

Enumeration

DetailedErrorCode

Nilai	Deskripsi
InvalidParameterValue	Nilai parameter tidak valid.
InvalidRequestBodyFormat	Format isi permintaan tidak valid.
EmptyRequest	Permintaan Kosong.
MissingInputRecords	Rekaman Input hilang.
InvalidDocument	Dokumen Tidak Valid.
ModelVersionIncorrect	Versi Model Salah.
InvalidDocumentBatch	Batch Dokumen Tidak Valid.
UnsupportedLanguageCode	Kode bahasa yang tidak didukung.
DataImportFailed	Impor data gagal.
InUseViolation	Dalam pelanggaran penggunaan.
InvalidLocale	Lokal tidak valid.
InvalidBaseModel	Model dasar tidak valid.
InvalidAdaptationMapping	Pemetaan adaptasi tidak valid.
InvalidDataset	Himpunan data tidak valid.
InvalidTest	Tes tidak valid.
FailedDataset	Himpunan data yang gagal.
InvalidModel	Model tidak valid.
InvalidTranscription	Transkripsi tidak valid.
InvalidPayload	Payload tidak valid.
InvalidParameter	Parameter tidak valid.
EndpointWithoutLogging	Titik akhir tanpa pengelogan.
InvalidPermissions	Izin tidak valid.
InvalidPrerequisite	Prasyarat tidak valid.
InvalidProductId	Id produk tidak valid.
InvalidSubscription	Langganan tidak valid.
InvalidProject	Proyek tidak valid.
InvalidProjectKind	Jenis proyek tidak valid.
InvalidRecordingsUri	uri rekaman tidak valid.
OnlyOneOfUrlsOrContainerOrDataset	Hanya salah satu url atau kontainer atau himpunan data.
ExceededNumberOfRecordingsUris	Melebihi jumlah uri rekaman.
ModelMismatch	Ketidakcocokan model.
ProjectGenderMismatch	Ketidakcocokan jenis kelamin proyek.
ModelDeprecated	Model tidak digunakan lagi.
ModelExists	Model ada.
ModelNotDeployable	Model tidak dapat disebarkan.
EndpointNotUpdatable	Titik akhir tidak dapat diperbarui.
SingleDefaultEndpoint	Titik akhir default tunggal.
EndpointCannotBeDefault	Titik akhir tidak boleh default.
InvalidModelUri	Uri model tidak valid.
SubscriptionNotFound	Langganan tidak ditemukan.
QuotaViolation	Pelanggaran kuota.
UnsupportedDelta	Delta yang tidak didukung.
UnsupportedFilter	Filter yang tidak didukung.
UnsupportedPagination	Penomoran halaman yang tidak didukung.
UnsupportedDynamicConfiguration	Konfigurasi dinamis yang tidak didukung.
UnsupportedOrderBy	Urutan yang tidak didukung oleh.
NoUtf8WithBom	Tidak ada utf8 dengan bom.
ModelDeploymentNotCompleteState	Penyebaran model tidak menyelesaikan status.
SkuLimitsExist	Batas Sku ada.
DeployingFailedModel	Menyebarkan model yang gagal.
UnsupportedTimeRange	Rentang waktu yang tidak didukung.
InvalidLogDate	Tanggal log tidak valid.
InvalidLogId	Id log tidak valid.
InvalidLogStartTime	Waktu mulai log tidak valid.
InvalidLogEndTime	Waktu akhir log tidak valid.
InvalidTopForLogs	Atas tidak valid untuk log.
InvalidSkipTokenForLogs	Melewati token untuk log tidak valid.
DeleteNotAllowed	Hapus tidak diperbolehkan.
Forbidden	Dilarang.
DeployNotAllowed	Sebarkan tidak diizinkan.
UnexpectedError	Kesalahan tak terduga.
InvalidCollection	Koleksi tidak valid.
InvalidCallbackUri	Uri panggilan balik tidak valid.
InvalidSasValidityDuration	Durasi validitas sas tidak valid.
InaccessibleCustomerStorage	Penyimpanan pelanggan yang tidak dapat diakses.
UnsupportedClassBasedAdaptation	Adaptasi berbasis kelas yang tidak didukung.
InvalidWebHookEventKind	Jenis peristiwa web hook tidak valid.
InvalidTimeToLive	Waktu hidup tidak valid.
InvalidSourceAzureResourceId	ID sumber daya Azure sumber tidak valid.
ModelCopyOperationExists	Operasi penyalinan model ada.

EntityError

Objek

EntityError

Nama	Jenis	Deskripsi
code	string	Kode kesalahan ini.
message	string	Pesan untuk kesalahan ini.

EntityReference

Objek

EntityReference

Nama	Jenis	Deskripsi
self	string (uri)	Lokasi entitas yang dirujuk.

Error

Objek

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	Kode Kesalahan Kode kesalahan tingkat tinggi.
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

ErrorCode

Enumeration

Kode Kesalahan

Nilai	Deskripsi
InvalidRequest	Mewakili kode kesalahan permintaan yang tidak valid.
InvalidArgument	Mewakili kode kesalahan argumen yang tidak valid.
InternalServerError	Mewakili kode kesalahan server internal.
ServiceUnavailable	Mewakili kode kesalahan layanan yang tidak tersedia.
NotFound	Mewakili kode kesalahan yang tidak ditemukan.
PipelineError	Mewakili kode kesalahan kesalahan alur.
Conflict	Mewakili kode kesalahan konflik.
InternalCommunicationFailed	Mewakili kode kesalahan komunikasi internal gagal.
Forbidden	Mewakili kode kesalahan terlarang.
NotAllowed	Mewakili kode kesalahan yang tidak diizinkan.
Unauthorized	Mewakili kode kesalahan yang tidak sah.
UnsupportedMediaType	Mewakili kode kesalahan jenis media yang tidak didukung.
TooManyRequests	Mewakili terlalu banyak kode kesalahan permintaan.
UnprocessableEntity	Mewakili kode kesalahan entitas yang tidak dapat diolah.

InnerError

Objek

InnerError

Nama	Jenis	Deskripsi
code	DetailedErrorCode	DetailedErrorCode Enum kode kesalahan terperinci.
details	object	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

OutputFormatType

Enumeration

OutputFormatType

Nilai	Deskripsi
Lexical	Model menyediakan output transkripsi tanpa pemformatan.
Display	Model mendukung tampilan output atau titik akhir transkripsi pemformatan.

Status

Enumeration

Kedudukan

Nilai	Deskripsi
NotStarted	Operasi jangka panjang belum dimulai.
Running	Operasi yang berjalan lama saat ini sedang diproses.
Succeeded	Operasi jangka panjang berhasil diselesaikan.
Failed	Operasi yang berjalan lama gagal.