Share via


Transcriptions - List

Lekéri a hitelesített előfizetés átiratainak listáját.

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

URI-paraméterek

Name In Kötelező Típus Description
endpoint
path True

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus.api.cognitive.microsoft.com).

filter
query

string

Szűrőkifejezés az elérhető átiratok egy részhalmazának kiválasztásához.

        - 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

Kihagyandó adathalmazok száma.

top
query

integer

int32

A kihagyás után belefoglalandó adathalmazok száma.

Válaszok

Name Típus Description
200 OK

PaginatedTranscriptions

OK

Headers

Retry-After: integer

Other Status Codes

Error

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adhatja meg a Cognitive Services-fiókkulcsot.

Type: apiKey
In: header

Authorization

Adjon meg egy hozzáférési jogkivonatot a régió STS által visszaadott JWT-ből. Győződjön meg arról, hogy hozzáadja a felügyeleti hatókört a jogkivonathoz. Ehhez adja hozzá a következő lekérdezési sztringet az STS URL-címéhez: ?scope=speechservicesmanagement

Type: apiKey
In: header

Példák

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"
}

Definíciók

Name Description
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Hiba

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

PaginatedTranscriptions

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

ÍrásjelekMode

Status

Állapot

Transcription

Átírás

TranscriptionLinks

Átirathivatkozások

TranscriptionProperties

Átirattulajdonságok

DetailedErrorCode

DetailedErrorCode

Name Típus Description
DataImportFailed

string

Az adatimportálás nem sikerült.

DeleteNotAllowed

string

A törlés nem engedélyezett.

DeployNotAllowed

string

Az üzembe helyezés nem engedélyezett.

DeployingFailedModel

string

Sikertelen modell üzembe helyezése.

EmptyRequest

string

Üres kérelem.

EndpointCannotBeDefault

string

A végpont nem lehet alapértelmezett.

EndpointNotUpdatable

string

A végpont nem frissíthető.

EndpointWithoutLogging

string

Végpont naplózás nélkül.

ExceededNumberOfRecordingsUris

string

Túllépte a felvétel URI-jainak számát.

FailedDataset

string

Nem sikerült az adathalmaz.

Forbidden

string

Tiltott.

InUseViolation

string

Használaton belüli szabálysértés.

InaccessibleCustomerStorage

string

Nem érhető el az ügyféltároló.

InvalidAdaptationMapping

string

Érvénytelen adaptációs leképezés.

InvalidBaseModel

string

Érvénytelen alapmodell.

InvalidCallbackUri

string

Érvénytelen visszahívási URI.

InvalidCollection

string

Érvénytelen gyűjtemény.

InvalidDataset

string

Érvénytelen adatkészlet.

InvalidDocument

string

Érvénytelen dokumentum.

InvalidDocumentBatch

string

Érvénytelen dokumentumköteg.

InvalidLocale

string

Érvénytelen területi beállítás.

InvalidLogDate

string

Érvénytelen naplódátum.

InvalidLogEndTime

string

Érvénytelen naplóvégzési idő.

InvalidLogId

string

Érvénytelen naplóazonosító.

InvalidLogStartTime

string

Érvénytelen a napló kezdési időpontja.

InvalidModel

string

Érvénytelen modell.

InvalidModelUri

string

Érvénytelen modell URI-ja.

InvalidParameter

string

Érvénytelen paraméter.

InvalidParameterValue

string

Érvénytelen paraméterérték.

InvalidPayload

string

Érvénytelen hasznos adat.

InvalidPermissions

string

Érvénytelen engedélyek.

InvalidPrerequisite

string

Érvénytelen előfeltétel.

InvalidProductId

string

Érvénytelen termékazonosító.

InvalidProject

string

Érvénytelen projekt.

InvalidProjectKind

string

Érvénytelen projekttípus.

InvalidRecordingsUri

string

Érvénytelen felvételek URI-ja.

InvalidRequestBodyFormat

string

Érvénytelen kérelemtörzs-formátum.

InvalidSasValidityDuration

string

Érvénytelen sas-érvényességi időtartam.

InvalidSkipTokenForLogs

string

Érvénytelen kihagyó jogkivonat a naplókhoz.

InvalidSourceAzureResourceId

string

Érvénytelen forrás Azure-erőforrás-azonosító.

InvalidSubscription

string

Érvénytelen előfizetés.

InvalidTest

string

Érvénytelen teszt.

InvalidTimeToLive

string

Érvénytelen élettartam.

InvalidTopForLogs

string

A naplók felső része érvénytelen.

InvalidTranscription

string

Érvénytelen átírás.

InvalidWebHookEventKind

string

Érvénytelen webhookesemény-típus.

MissingInputRecords

string

Hiányzó bemeneti rekordok.

ModelCopyOperationExists

string

Létezik modellmásolási művelet.

ModelDeploymentNotCompleteState

string

A modell üzembe helyezése nem fejeződött be.

ModelDeprecated

string

A modell elavult.

ModelExists

string

A modell létezik.

ModelMismatch

string

Modelleltérés.

ModelNotDeployable

string

A modell nem helyezhető üzembe.

ModelVersionIncorrect

string

A modell verziója helytelen.

NoUtf8WithBom

string

Nincs utf8 a bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Csak egy URL-cím, tároló vagy adatkészlet.

ProjectGenderMismatch

string

A projekt neme nem egyezik.

QuotaViolation

string

Kvóta megsértése.

SingleDefaultEndpoint

string

Egyetlen alapértelmezett végpont.

SkuLimitsExist

string

A termékváltozatra vonatkozó korlátozások léteznek.

SubscriptionNotFound

string

Az előfizetés nem található.

UnexpectedError

string

Váratlan hiba.

UnsupportedClassBasedAdaptation

string

Nem támogatott osztályalapú adaptáció.

UnsupportedDelta

string

Nem támogatott változás.

UnsupportedDynamicConfiguration

string

Nem támogatott dinamikus konfiguráció.

UnsupportedFilter

string

Nem támogatott szűrő.

UnsupportedLanguageCode

string

Nem támogatott nyelvi kód.

UnsupportedOrderBy

string

Nem támogatott sorrend szerint.

UnsupportedPagination

string

Nem támogatott lapozás.

UnsupportedTimeRange

string

Nem támogatott időtartomány.

DiarizationProperties

DiarizationProperties

Name Típus Description
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Name Típus Description
maxCount

integer

A diarizáláshoz használható hangszórók maximális száma. 36-nál kisebbnek és a minSpeakers tulajdonságnál nagyobbnak kell lennie.

minCount

integer

A diarizáláshoz szükséges hangszórók minimális számának tippje. A maxSpeakers tulajdonságnál kisebbnek vagy egyenlőnek kell lennie.

EntityError

EntityError

Name Típus Description
code

string

A hiba kódja.

message

string

A hiba üzenete.

EntityReference

EntityReference

Name Típus Description
self

string

A hivatkozott entitás helye.

Error

Hiba

Name Típus Description
code

ErrorCode

ErrorCode
Magas szintű hibakódok.

details

Error[]

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.

innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel a Cognitive Services API-irányelveinek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).

message

string

Magas szintű hibaüzenet.

target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

ErrorCode

ErrorCode

Name Típus Description
Conflict

string

Az ütközési hibakódnak megfelelő.

Forbidden

string

A tiltott hibakódot jelöli.

InternalCommunicationFailed

string

A belső kommunikáció hibakódját jelképező hibakód.

InternalServerError

string

A belső kiszolgáló hibakódját jelöli.

InvalidArgument

string

Az érvénytelen argumentum hibakódját jelöli.

InvalidRequest

string

Az érvénytelen kérelem hibakódját jelöli.

NotAllowed

string

A nem engedélyezett hibakódot jelöli.

NotFound

string

A nem található hibakódot jelöli.

PipelineError

string

A folyamat hibakódját jelöli.

ServiceUnavailable

string

A szolgáltatás nem érhető el hibakódját jelöli.

TooManyRequests

string

A túl sok kérés hibakódját jelöli.

Unauthorized

string

A jogosulatlan hibakódot jelöli.

UnprocessableEntity

string

A feldolgozhatatlan entitás hibakódját jelöli.

UnsupportedMediaType

string

A nem támogatott médiatípus hibakódját jelöli.

InnerError

InnerError

Name Típus Description
code

DetailedErrorCode

DetailedErrorCode
Részletes hibakód enumerálás.

details

object

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.

innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel a Cognitive Services API-irányelveinek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).

message

string

Magas szintű hibaüzenet.

target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

LanguageIdentificationMode

LanguageIdentificationMode

Name Típus Description
Continuous

string

Folyamatos nyelvazonosítás (alapértelmezett).

Single

string

Egynyelvű azonosítás.

LanguageIdentificationProperties

LanguageIdentificationProperties

Name Típus Alapértelmezett érték Description
candidateLocales

string[]

A nyelvi azonosításra jelölt területi beállítások (például ["en-US", "de-DE", "es-ES"]). Legalább 2 és legfeljebb 10 jelölt területi beállítás támogatott, beleértve az átírás fő területi beállítását is.

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
A nyelvi azonosításhoz használt mód.

speechModelMapping

<string,  EntityReference>

A területi beállítások beszédmodell-entitásokhoz való nem kötelező leképezése. Ha nincs megadva modell egy területi beállításhoz, a rendszer az alapértelmezett alapmodellt használja. A kulcsoknak a jelölt területi beállításokban kell lenniük, az értékek a megfelelő területi beállítások modelljeinek entitásai.

PaginatedTranscriptions

PaginatedTranscriptions

Name Típus Description
@nextLink

string

Hivatkozás a lapszámozott eredmények következő készletére, ha több entitás érhető el; egyébként null értékű.

values

Transcription[]

A "skip" és a "top" átadott lekérdezési paraméterek vagy az alapértelmezett értékek által korlátozott entitások listája.

Ha egy listát lapszámozással és entitások párhuzamos törlésével iterál, egyes entitások kimaradnak az eredményekből. Javasoljuk, hogy hozzon létre egy listát az ügyfélen, és törölje a teljes lista lekérése után.

ProfanityFilterMode

ProfanityFilterMode

Name Típus Description
Masked

string

Maszkolja a trágárságot * betűvel, kivéve az első betűt, pl. f***

None

string

Tiltsa le a trágárság szűrését.

Removed

string

Távolítsa el a trágárságot.

Tags

string

"trágárság" XML-címkék</trágárság hozzáadása>

PunctuationMode

ÍrásjelekMode

Name Típus Description
Automatic

string

Automatikus írásjelek.

Dictated

string

A diktált írásjelek csak explicit írásjelek, azaz explicit írásjelek.

DictatedAndAutomatic

string

Diktált írásjelek vagy automatikus írásjelek.

None

string

Nincs írásjel.

Status

Állapot

Name Típus Description
Failed

string

A hosszú ideig futó művelet nem sikerült.

NotStarted

string

A hosszú ideig futó művelet még nem indult el.

Running

string

A hosszú ideig futó művelet jelenleg feldolgozásra kerül.

Succeeded

string

A hosszú ideig futó művelet sikeresen befejeződött.

Transcription

Átírás

Name Típus Description
contentContainerUrl

string

A hangfájlokat tartalmazó Azure Blob-tároló URL-címe. A tárolók maximális mérete 5 GB és legfeljebb 10000 blob lehet. A blobok maximális mérete 2,5 GB. A tároló SAS-nak tartalmaznia kell az "r" (olvasás) és az "l" (lista) engedélyeket. Ezt a tulajdonságot a rendszer nem adja vissza válaszként.

contentUrls

string[]

A tartalom URL-címeinek listája, a hangfájlok átírásához. Legfeljebb 1000 URL-cím engedélyezett. Ezt a tulajdonságot a rendszer nem adja vissza válaszként.

createdDateTime

string

Az objektum létrehozásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

Az entitás egyéni tulajdonságai. A maximális megengedett kulcshossz 64 karakter, a megengedett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.

dataset

EntityReference

EntityReference

description

string

Az objektum leírása.

displayName

string

Az objektum megjelenítendő neve.

lastActionDateTime

string

Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

TranscriptionLinks

Átirathivatkozások

locale

string

A tartalmazott adatok területi beállítása. Nyelvazonosítás használata esetén ez a területi beállítás olyan beszéd átírására szolgál, amelyhez nem észlelhető nyelv.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

Átirattulajdonságok

self

string

Az entitás helye.

status

Status

Állapot
Az API aktuális állapotának ismertetése

Átirathivatkozások

Name Típus Description
files

string

Az entitás összes fájljának lekérésének helye. További részletekért lásd a "Transcriptions_ListFiles" műveletet.

TranscriptionProperties

Átirattulajdonságok

Name Típus Description
channels

integer[]

A kért csatornaszámok gyűjteménye. Az alapértelmezett esetben a 0 és az 1 csatornát veszi figyelembe a rendszer.

destinationContainerUrl

string

A kért céltároló.

Megjegyzések

Ha egy céltárolót a-val timeToLiveegyütt használ, az átírás metaadatait a rendszer általában törli, de a céltárolóban tárolt adatok , beleértve az átírási eredményeket is, érintetlenek maradnak, mivel ehhez a tárolóhoz nincs szükség törlési engedélyekre.
Az automatikus törlés támogatásához konfigurálja a blobélettartamokat a tárolón, vagy használja a "Saját tároló használata (BYOS)" lehetőséget a helyett destinationContainerUrl, ahol a blobok törölhetők.

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

Érték, amely jelzi, hogy szükség van-e diarizálásra (beszélőazonosításra). Az alapértelmezett érték false. Ha ez a mező igaz értékre van állítva, és a továbbfejlesztett diarizációs rendszer a beállítással DiarizationPropertiesvan konfigurálva, a továbbfejlesztett diarizációs rendszer diarizálást biztosít a konfigurálható hangszórókhoz. Ha ez a mező igaz értékre van állítva, és a továbbfejlesztett diarizációs rendszer nincs engedélyezve (nem adja meg DiarizationProperties), az alapszintű diarizálási rendszer legfeljebb két hangszórót különböztet meg. Az alapszintű diarizációért nem számítunk fel további díjakat.

Az alapszintű diarizációs rendszer elavult, és az API következő főverziójában el lesz távolítva. Ez a diarizationEnabled beállítás szintén el lesz távolítva.

displayFormWordLevelTimestampsEnabled

boolean

Egy érték, amely azt jelzi, hogy a rendszer kéri-e a megjelenítési űrlap szószintű időbélyegét. Az alapértelmezett érték false.

duration

string

Az átírás időtartama. Az időtartam ISO 8601-es időtartamként van kódolva ("PnYnMnDTnHnMnS", lásd: https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Az e-mail-értesítések küldéséhez használt e-mail-cím, ha a művelet befejeződik. Az érték az e-mail sikeres elküldése után törlődik.

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
A káromkodás szűrésének módja.

punctuationMode

PunctuationMode

ÍrásjelekMode
Az írásjelekhez használt mód.

timeToLive

string

Mennyi ideig marad az átírás a rendszerben a befejezése után. Ha az átírás eléri a befejezés utáni élettartamot (sikeres vagy sikertelen), a rendszer automatikusan törli. Ha nem állítja be ezt az értéket, vagy nem állítja be 0 értékre, az letiltja az automatikus törlést. A leghosszabb támogatott időtartam 31 nap. Az időtartam ISO 8601-es időtartamként van kódolva ("PnYnMnDTnHnMnS", lásd: https://en.wikipedia.org/wiki/ISO_8601#Durations).

wordLevelTimestampsEnabled

boolean

Egy érték, amely azt jelzi, hogy a rendszer kéri-e a szószintű időbélyegeket. Az alapértelmezett érték false.