Transcriptions - List

Mendapatkan daftar transkripsi untuk langganan yang diautentikasi.

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions
GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip={skip}&top={top}&filter={filter}

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).

filter
query

string

Ekspresi pemfilteran untuk memilih subset transkripsi yang tersedia.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=createdDateTime gt 2022-02-01T11:00:00Z
skip
query

integer

int32

Jumlah himpunan data yang akan dilewati.

top
query

integer

int32

Jumlah himpunan data yang akan disertakan setelah dilewati.

Respons

Nama Jenis Deskripsi
200 OK

PaginatedTranscriptions

OK

Headers

Retry-After: integer

Other Status Codes

Error

Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci akun layanan kognitif Anda di sini.

Type: apiKey
In: 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

Type: apiKey
In: header

Contoh

Get all failed transcriptions
Get all transcriptions

Get all failed transcriptions

Sample Request

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip=0&top=2&filter=status%20eq%20'Failed'

Sample Response

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ]
}

Get all transcriptions

Sample Request

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Sample Response

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": false,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definisi

Nama Deskripsi
DetailedErrorCode

DetailErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Kesalahan

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

PaginatedTranscriptions

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

Tanda BacaMode

Status

Status

Transcription

Transkripsi

TranscriptionLinks

TranskripsiLink

TranscriptionProperties

TranskripsiProperti

DetailedErrorCode

DetailErrorCode

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 yang tidak didukung.

UnsupportedOrderBy

string

Urutan yang tidak didukung oleh.

UnsupportedPagination

string

Penomoran halaman yang tidak didukung.

UnsupportedTimeRange

string

Rentang waktu yang tidak didukung.

DiarizationProperties

DiarizationProperties

Nama Jenis Deskripsi
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Nama Jenis Deskripsi
maxCount

integer

Jumlah maksimum speaker untuk diarisasi. Harus kurang dari 36 dan lebih besar dari atau sama dengan properti minSpeakers.

minCount

integer

Petunjuk untuk jumlah minimum pembicara untuk diarisasi. Harus lebih kecil dari atau sama dengan properti maxSpeakers.

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

ErrorCode
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 Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).

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 terlalu banyak kode kesalahan 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

DetailErrorCode
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 Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).

message

string

Pesan kesalahan tingkat tinggi.

target

string

Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid.

LanguageIdentificationMode

LanguageIdentificationMode

Nama Jenis Deskripsi
Continuous

string

Identifikasi bahasa berkelanjutan (Default).

Single

string

Identifikasi bahasa tunggal.

LanguageIdentificationProperties

LanguageIdentificationProperties

Nama Jenis Nilai Default Deskripsi
candidateLocales

string[]

Kandidat lokal untuk identifikasi bahasa (misalnya ["en-US", "de-DE", "es-ES"]). Minimal 2 dan maksimum 10 lokal kandidat, termasuk lokal utama untuk transkripsi, didukung.

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
Mode yang digunakan untuk identifikasi bahasa.

speechModelMapping

<string,  EntityReference>

Pemetaan opsional lokal ke entitas model ucapan. Jika tidak ada model yang diberikan untuk lokal, model dasar default akan digunakan. Kunci harus berupa lokal yang terkandung dalam lokal kandidat, nilai adalah entitas untuk model masing-masing lokal.

PaginatedTranscriptions

PaginatedTranscriptions

Nama Jenis Deskripsi
@nextLink

string

Tautan ke kumpulan hasil paginasi berikutnya jika ada lebih banyak entitas yang tersedia; jika tidak null.

values

Transcription[]

Daftar entitas yang dibatasi oleh parameter kueri yang diteruskan 'lewati' dan 'atas' atau nilai defaultnya.

Saat melakukan iterasi melalui daftar menggunakan pagination dan menghapus entitas secara paralel, beberapa entitas akan dilewati dalam hasil. Disarankan untuk membuat daftar pada klien dan menghapus setelah pengambilan daftar lengkap.

ProfanityFilterMode

ProfanityFilterMode

Nama Jenis Deskripsi
Masked

string

Menutupi kata-kata kotor dengan * kecuali huruf pertama, misalnya, f***

None

string

Nonaktifkan pemfilteran kata-kata kosan.

Removed

string

Hapus kata-kata kok.

Tags

string

Menambahkan tag< XML "kata-kata korta"/Kata-kata tidak benar>

PunctuationMode

Tanda BacaMode

Nama Jenis Deskripsi
Automatic

string

Tanda baca otomatis.

Dictated

string

Tanda baca yang ditentukan saja, yaitu tanda baca eksplisit.

DictatedAndAutomatic

string

Tanda baca yang ditentukan atau tanda baca otomatis.

None

string

Tidak ada tanda baca.

Status

Status

Nama Jenis Deskripsi
Failed

string

Operasi jangka panjang telah gagal.

NotStarted

string

Operasi jangka panjang belum dimulai.

Running

string

Operasi yang berjalan lama saat ini sedang diproses.

Succeeded

string

Operasi jangka panjang berhasil diselesaikan.

Transcription

Transkripsi

Nama Jenis Deskripsi
contentContainerUrl

string

URL untuk kontainer blob Azure yang berisi file audio. Kontainer diizinkan untuk memiliki ukuran maksimum 5GB dan jumlah maksimum 10000 blob. Ukuran maksimum untuk blob adalah 2,5GB. SAS kontainer harus berisi izin 'r' (baca) dan 'l' (daftar). Properti ini tidak akan dikembalikan sebagai respons.

contentUrls

string[]

Daftar url konten untuk mendapatkan file audio untuk ditranskripsikan. Hingga 1000 url diizinkan. Properti ini tidak akan dikembalikan sebagai respons.

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.

dataset

EntityReference

EntityReference

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

TranscriptionLinks

TranskripsiLink

locale

string

Lokal data yang terkandung. Jika Identifikasi Bahasa digunakan, lokal ini digunakan untuk mentranskripsikan ucapan yang tidak ada bahasa yang dapat dideteksi.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranskripsiProperti

self

string

Lokasi entitas ini.

status

Status

Status
Menjelaskan status API saat ini

TranskripsiLink

Nama Jenis Deskripsi
files

string

Lokasi untuk mendapatkan semua file entitas ini. Lihat operasi "Transcriptions_ListFiles" untuk detail selengkapnya.

TranscriptionProperties

TranskripsiProperti

Nama Jenis Deskripsi
channels

integer[]

Kumpulan nomor saluran yang diminta. Dalam kasus default, saluran 0 dan 1 dipertimbangkan.

destinationContainerUrl

string

Kontainer tujuan yang diminta.

Keterangan

Ketika kontainer tujuan digunakan dalam kombinasi dengan timeToLive, metadata transkripsi akan dihapus secara normal, tetapi data yang disimpan dalam kontainer tujuan, termasuk hasil transkripsi, akan tetap tidak tersentuh, karena tidak ada izin penghapusan yang diperlukan untuk kontainer ini.
Untuk mendukung pembersihan otomatis, konfigurasikan masa pakai blob pada kontainer, atau gunakan "Bring your own Storage (BYOS)" alih-alih destinationContainerUrl, tempat blob dapat dibersihkan.

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

Nilai yang menunjukkan apakah diarisasi (identifikasi pembicara) diminta. Nilai defaultnya adalah false. Jika bidang ini diatur ke true dan sistem diarisasi yang ditingkatkan dikonfigurasi dengan menentukan DiarizationProperties, sistem diarisasi yang ditingkatkan akan memberikan diarisasi untuk rentang speaker yang dapat dikonfigurasi. Jika bidang ini diatur ke true dan sistem diarisasi yang ditingkatkan tidak diaktifkan (tidak menentukan DiarizationProperties), sistem diarisasi dasar akan membedakan antara hingga dua speaker. Tidak ada biaya tambahan yang diterapkan untuk diarisasi dasar.

Sistem diarisasi dasar tidak digunakan lagi dan akan dihapus dalam versi utama API berikutnya. Pengaturan ini diarizationEnabled juga akan dihapus.

displayFormWordLevelTimestampsEnabled

boolean

Nilai yang menunjukkan apakah tanda waktu tingkat kata untuk formulir tampilan diminta. Nilai defaultnya adalah false.

duration

string

Durasi transkripsi. Durasi dikodekan sebagai durasi ISO 8601 ("PnYnMnDTnHnMnS", lihat https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Alamat email untuk mengirim pemberitahuan email jika operasi selesai. Nilai akan dihapus setelah berhasil mengirim email.

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
Mode pemfilteran kata-kata kosan.

punctuationMode

PunctuationMode

Tanda BacaMode
Mode yang digunakan untuk tanda baca.

timeToLive

string

Berapa lama transkripsi akan disimpan dalam sistem setelah selesai. Setelah transkripsi mencapai waktu hidup setelah selesai (berhasil atau gagal) transkripsi akan dihapus secara otomatis. Tidak mengatur nilai ini atau mengaturnya 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).

wordLevelTimestampsEnabled

boolean

Nilai yang menunjukkan apakah tanda waktu tingkat kata diminta. Nilai defaultnya adalah false.