Projects - List Transcriptions

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v3.2-preview.2

Získá seznam přepisů pro zadaný projekt.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identifikátor projektu.
filter	query		string	Výraz filtrování pro výběr podmnožina dostupných přepisů. `- 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)	Počet datových sad, které se přeskočí
top	query		integer (int32)	Počet datových sad, které budou zahrnuté po přeskočení

Odpovědi

Name	Typ	Description
200 OK	PaginatedTranscriptions	OK Hlavičky Retry-After: integer
Other Status Codes	Error	Došlo k chybě.

Name

Typ

Description

200 OK

PaginatedTranscriptions

Hlavičky

Retry-After: integer

Other Status Codes

Error

Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vráceného službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu do adresy URL služby STS: ?scope=speechservicesmanagement

Typ: apiKey
V: header

Příklady

Get all transcriptions

Ukázkový požadavek

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Chyba
ErrorCode	Kód chyby
InnerError	Vnitřní chyba
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
PaginatedTranscriptions	Stránkované popisy
ProfanityFilterMode	Vulgární výrazFilterMode
PunctuationMode	Interpunkční znaméčko
Status	Stav
Transcription	Transkripce
TranscriptionLinks	Přepislinky
TranscriptionProperties	PřepisProperties

DetailedErrorCode

Výčet

DetailedErrorCode

Hodnota	Description
DataImportFailed	Import dat se nezdařil.
DeleteNotAllowed	Odstranění není povoleno.
DeployNotAllowed	Nasazení není povoleno.
DeployingFailedModel	Nasazení neúspěšného modelu
EmptyRequest	Prázdný požadavek.
EndpointCannotBeDefault	Koncový bod nemůže být výchozí.
EndpointNotUpdatable	Koncový bod nejde aktualizovat.
EndpointWithoutLogging	Koncový bod bez protokolování
ExceededNumberOfRecordingsUris	Byl překročen počet nahrávek.
FailedDataset	Datová sada se nezdařila.
Forbidden	Zakázaný.
InUseViolation	V narušení používání.
InaccessibleCustomerStorage	Nepřístupné úložiště zákazníka
InvalidAdaptationMapping	Neplatné mapování adaptací
InvalidBaseModel	Neplatný základní model
InvalidCallbackUri	Neplatný identifikátor URI zpětného volání.
InvalidCollection	Neplatná kolekce.
InvalidDataset	Neplatná datová sada
InvalidDocument	Neplatný dokument
InvalidDocumentBatch	Neplatná dávka dokumentu
InvalidLocale	Neplatné národní prostředí
InvalidLogDate	Neplatné datum protokolu
InvalidLogEndTime	Neplatný čas ukončení protokolu
InvalidLogId	Neplatné ID protokolu
InvalidLogStartTime	Neplatný čas spuštění protokolu
InvalidModel	Neplatný model.
InvalidModelUri	Neplatný identifikátor URI modelu
InvalidParameter	Neplatný parametr.
InvalidParameterValue	Neplatná hodnota parametru
InvalidPayload	Neplatná datová část
InvalidPermissions	Neplatná oprávnění
InvalidPrerequisite	Neplatný požadavek.
InvalidProductId	Neplatné ID produktu
InvalidProject	Neplatný projekt.
InvalidProjectKind	Neplatný druh projektu.
InvalidRecordingsUri	Identifikátor URI pro neplatné nahrávky
InvalidRequestBodyFormat	Neplatný formát textu požadavku
InvalidSasValidityDuration	Neplatná doba platnosti SAS.
InvalidSkipTokenForLogs	Neplatný token pro přeskočení protokolů
InvalidSourceAzureResourceId	Neplatné ID zdroje prostředku Azure
InvalidSubscription	Neplatné předplatné
InvalidTest	Neplatný test.
InvalidTimeToLive	Neplatný čas naživo.
InvalidTopForLogs	Neplatný horní okraj pro protokoly.
InvalidTranscription	Neplatný přepis
InvalidWebHookEventKind	Neplatný druh události webhooku
MissingInputRecords	Chybí vstupní záznamy.
ModelCopyOperationExists	Operace kopírování modelu existuje.
ModelDeploymentNotCompleteState	Nasazení modelu není dokončeno.
ModelDeprecated	Model je zastaralý.
ModelExists	Model existuje.
ModelMismatch	Neshoda modelů
ModelNotDeployable	Model nejde nasadit.
ModelVersionIncorrect	Verze modelu není správná.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Pouze jedna z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch	Neshoda pohlaví projektu
QuotaViolation	Porušení kvóty
SingleDefaultEndpoint	Jeden výchozí koncový bod
SkuLimitsExist	Existují omezení skladové položky.
SubscriptionNotFound	Předplatné se nenašlo.
UnexpectedError	Neočekávaná chyba
UnsupportedClassBasedAdaptation	Nepodporovaná úprava založená na třídách.
UnsupportedDelta	Nepodporovaný rozdíl.
UnsupportedDynamicConfiguration	Nepodporovaná dynamická konfigurace
UnsupportedFilter	Nepodporovaný filtr
UnsupportedLanguageCode	Nepodporovaný kód jazyka
UnsupportedOrderBy	Nepodporované pořadí podle.
UnsupportedPagination	Nepodporované stránkování
UnsupportedTimeRange	Nepodporovaný časový rozsah

DiarizationProperties

Objekt

DiarizationProperties

Name	Typ	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Objekt

DiarizationSpeakersProperties

Name	Typ	Description
maxCount	integer (int32) minimum: 1	Maximální počet reproduktorů pro diarizaci. Musí být menší než 36 a větší než nebo rovno vlastnosti minSpeakers.
minCount	integer (int32) minimum: 1	Tip pro minimální počet reproduktorů pro diarizaci. Musí být menší než nebo rovno vlastnosti maxSpeakers.

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Kód této chyby.
message	string	Zpráva pro tuto chybu.

EntityReference

Objekt

EntityReference

Name	Typ	Description
self	string (uri)	Umístění odkazované entity.

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb vysoké úrovně.
details	Error[]	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

ErrorCode

Výčet

Kód chyby

Hodnota	Description
Conflict	Představuje kód chyby konfliktu.
Forbidden	Představuje zakázaný kód chyby.
InternalCommunicationFailed	Představuje kód chyby selhání interní komunikace.
InternalServerError	Představuje kód chyby vnitřní chyby serveru.
InvalidArgument	Představuje neplatný kód chyby argumentu.
InvalidRequest	Představuje neplatný kód chyby požadavku.
NotAllowed	Představuje kód chyby, který není povolený.
NotFound	Představuje kód chyby, který nebyl nalezen.
PipelineError	Představuje kód chyby kanálu.
ServiceUnavailable	Představuje kód chyby nedostupné služby.
TooManyRequests	Představuje kód chyby příliš velkého počtu požadavků.
Unauthorized	Představuje neautorizovaný kód chyby.
UnprocessableEntity	Představuje nezpracovaný kód chyby entity.
UnsupportedMediaType	Představuje nepodporovaný kód chyby typu média.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Podrobný výčet kódu chyby
details	object	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

LanguageIdentificationMode

Výčet

LanguageIdentificationMode

Hodnota	Description
Continuous	Průběžná identifikace jazyka (výchozí).
Single	Identifikace jednoho jazyka.

LanguageIdentificationProperties

Objekt

LanguageIdentificationProperties

Name	Typ	Default value	Description
candidateLocales	string[]		Kandidátské národní prostředí pro identifikaci jazyka (například ["en-US", "de-DE", "es-ES"]). Podporuje se minimálně 2 a maximálně 10 kandidátských národních prostředí, včetně hlavního národního prostředí pro přepis.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Režim používaný k identifikaci jazyka.
speechModelMapping	<string, EntityReference>		Volitelné mapování národních prostředí na entity modelu řeči. Pokud pro národní prostředí není zadaný žádný model, použije se výchozí základní model. Klíče musí být národní prostředí obsažená v kandidátských národních prostředích, hodnoty jsou entity pro modely příslušných národních prostředí.

PaginatedTranscriptions

Objekt

Stránkované popisy

Name	Typ	Description
@nextLink	string (uri)	Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.
values	Transcription[]	Seznam entit omezený buď předanými parametry dotazu "skip" a "top" nebo jejich výchozími hodnotami. Při paralelním procházení seznamu pomocí stránkování a odstranění entit se ve výsledcích přeskočí některé entity. Po načtení kompletního seznamu doporučujeme sestavit seznam na klientovi a odstranit ho.

Name

Typ

Description

@nextLink

string (uri)

Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.

values

Transcription[]

Seznam entit omezený buď předanými parametry dotazu "skip" a "top" nebo jejich výchozími hodnotami.

Při paralelním procházení seznamu pomocí stránkování a odstranění entit se ve výsledcích přeskočí některé entity. Po načtení kompletního seznamu doporučujeme sestavit seznam na klientovi a odstranit ho.

ProfanityFilterMode

Výčet

Vulgární výrazFilterMode

Hodnota	Description
Masked	Maskujte vulgární výraz * s výjimkou prvního písmena, např. f***
None	Zakažte filtrování vulgárních výrazů.
Removed	Odstraňte vulgární výrazy.
Tags	Přidání značek XML "vulgárních výrazů"</vulgárních výrazů>

PunctuationMode

Výčet

Interpunkční znaméčko

Hodnota	Description
Automatic	Automatická interpunkce
Dictated	Diktované interpunkční znaménka pouze, tj. explicitní interpunkce.
DictatedAndAutomatic	Diktované interpunkční znaménka nebo automatická interpunkce
None	Žádná interpunkce.

Status

Výčet

Stav

Hodnota	Description
Failed	Dlouhotrvající operace se nezdařila.
NotStarted	Dlouhotrvající operace ještě nebyla spuštěna.
Running	Dlouhotrvající operace se právě zpracovává.
Succeeded	Dlouhotrvající operace byla úspěšně dokončena.

Transcription

Objekt

Transkripce

Name	Typ	Description
contentContainerUrl	string (uri)	Adresa URL kontejneru objektů blob Azure, který obsahuje zvukové soubory. Kontejner může mít maximální velikost 5 GB a maximální počet 1 0000 objektů blob. Maximální velikost objektu blob je 2,5 GB. Sas kontejneru by měl obsahovat oprávnění r (read) a l (list). Tato vlastnost nebude vrácena v odpovědi.
contentUrls	string[] (uri)	Seznam adres URL obsahu pro získání zvukových souborů k přepisu Je povoleno až 1 000 adres URL. Tato vlastnost nebude vrácena v odpovědi.
createdDateTime	string (date-time)	Časové razítko při vytvoření objektu. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální povolená délka je 256 znaků a počet povolených položek je 10.
dataset	EntityReference	EntityReference
description	string	Popis objektu.
displayName	string minLength: 1	Zobrazovaný název objektu.
lastActionDateTime	string (date-time)	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	Přepislinky
locale	string minLength: 1	Národní prostředí obsažených dat. Pokud se používá identifikace jazyka, použije se toto národní prostředí k přepisu řeči, pro kterou nelze rozpoznat žádný jazyk.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	PřepisProperties
self	string (uri)	Umístění této entity.
status	Status	Stav Popis aktuálního stavu rozhraní API

TranscriptionLinks

Objekt

Přepislinky

Name	Typ	Description
files	string (uri)	Umístění pro získání všech souborů této entity. Další podrobnosti najdete v operaci "Transcriptions_ListFiles".

TranscriptionProperties

Objekt

PřepisProperties

Name	Typ	Description
channels	integer[] (int32)	Kolekce požadovaných čísel kanálů. Ve výchozím případě se považují kanály 0 a 1.
destinationContainerUrl	string (uri)	Požadovaný cílový kontejner. Poznámky Při použití cílového kontejneru v kombinaci s `timeToLive`se metadata přepisu odstraní normálně, ale data uložená v cílovém kontejneru, včetně výsledků přepisu, zůstanou nedotčená, protože pro tento kontejner nejsou nutná žádná oprávnění k odstranění. Pokud chcete podporovat automatické vyčištění, buď nakonfigurujte životnost objektů blob v kontejneru, nebo místo `destinationContainerUrl`použijte funkci Přineste si vlastní úložiště (BYOS), kde je možné objekty blob vyčistit.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Hodnota označující, zda je požadována diarizace (identifikace mluvčího). Výchozí hodnota je `false`. Pokud je toto pole nastaveno na hodnotu true a vylepšený systém diarizace je nakonfigurován zadáním `DiarizationProperties`, vylepšený systém diarizace poskytne diarizaci pro konfigurovatelný rozsah mluvčích. Pokud je toto pole nastaveno na hodnotu true a vylepšený systém diarizace není povolen (není určen `DiarizationProperties`), základní systém diarizace bude rozlišovat až mezi dvěma reproduktory. Pro základní diarizaci se nepoužijí žádné další poplatky. Základní systém diarizace je zastaralý a bude odebrán v další hlavní verzi rozhraní API. Toto nastavení `diarizationEnabled` bude také odebráno.
displayFormWordLevelTimestampsEnabled	boolean	Hodnota označující, zda jsou požadovány časové razítka na úrovni slova pro formulář pro zobrazení. Výchozí hodnota je `false`.
duration	string	Doba trvání přepisu. Doba trvání je kódována jako ISO 8601 duration ("PnYnMnDTnHnMnS", viz https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	E-mailová adresa pro odesílání e-mailových oznámení pro případ, že se operace dokončí. Hodnota se odebere po úspěšném odeslání e-mailu.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	Vulgární výrazFilterMode Režim filtrování vulgárních výrazů
punctuationMode	PunctuationMode	Interpunkční znaméčko Režim používaný pro interpunkci.
timeToLive	string	Jak dlouho se přepis bude uchovávat v systému po jeho dokončení. Jakmile přepis dosáhne doby, po které se dokončí (úspěšné nebo neúspěšné), automaticky se odstraní. Nenastavíte tuto hodnotu nebo ji nastavíte na 0, zakáže se automatické odstranění. Nejdelší podporovaná doba trvání je 31 dní. Doba trvání je kódována jako ISO 8601 duration ("PnYnMnDTnHnMnS", viz https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Hodnota označující, zda jsou požadovány časová razítka na úrovni slova. Výchozí hodnota je `false`.

Sdílet prostřednictvím

Projects - List Transcriptions

Parametry identifikátoru URI

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

Příklady

Get all transcriptions

Ukázkový požadavek

Ukázková odpověď

Definice

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

PaginatedTranscriptions

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Poznámky

Další materiály