Transcriptions - Get

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-11-15

Pobiera transkrypcję zidentyfikowaną przez dany identyfikator.

GET {endpoint}/speechtotext/transcriptions/{id}?api-version=2024-11-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	Identyfikator transkrypcji.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz konta usług Cognitive Services.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Transcription	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

Transcription

Nagłówki

Retry-After: integer

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Przykłady

Get a transcription

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15

Przykładowa odpowiedź

Kod stanu:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  },
  "locale": "en-US",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
  },
  "properties": {
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "timeToLiveHours": 48,
    "durationMilliseconds": 42000
  },
  "status": "Succeeded"
}

Definicje

Nazwa	Opis
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Błąd
ErrorCode	Kod błędu
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	WulgaryzmFilterMode
PunctuationMode	InterpunkcjaMode
Status	Stan
Transcription	Transkrypcja
TranscriptionLinks	TranskrypcjaLinki
TranscriptionProperties	TranskrypcjaWłaściwości

DetailedErrorCode

Nazwa	Typ	Opis
AudioLengthLimitExceeded	string	Plik audio jest dłuższy niż maksymalny dozwolony czas trwania.
BadChannelConfiguration	string	Istnieje niezgodność między kanałami audio w danych, w konfiguracji lub wymaganiami aplikacji.
DataImportFailed	string	Importowanie danych nie powiodło się.
DeleteNotAllowed	string	Usuń niedozwolone.
DeployNotAllowed	string	Wdrażanie jest niedozwolone.
DeployingFailedModel	string	Wdrażanie modelu nie powiodło się.
EmptyAudioFile	string	Plik dźwiękowy jest pusty.
EmptyRequest	string	Puste żądanie.
EndpointCannotBeDefault	string	Punkt końcowy nie może być domyślny.
EndpointLoggingNotSupported	string	Rejestrowanie punktów końcowych nie jest obsługiwane.
EndpointNotUpdatable	string	Punkt końcowy nie można aktualizować.
EndpointWithoutLogging	string	Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris	string	Przekroczono liczbę nagrań uris.
FailedDataset	string	Zestaw danych, który zakończył się niepowodzeniem.
Forbidden	string	Zakazany.
InUseViolation	string	Naruszenie użycia.
InaccessibleCustomerStorage	string	Niedostępny magazyn klienta.
InvalidAdaptationMapping	string	Nieprawidłowe mapowanie adaptacji.
InvalidAudioFormat	string	Format audio wejściowego nie jest obsługiwany.
InvalidBaseModel	string	Nieprawidłowy model podstawowy.
InvalidCallbackUri	string	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidChannelSpecification	string	Wybór kanałów w żądaniu transkrypcji nie jest obsługiwany (np. nie wybrano ani 0, ani 1).
InvalidChannels	string	Nieprawidłowe kanały.
InvalidCollection	string	Nieprawidłowa kolekcja.
InvalidDataset	string	Nieprawidłowy zestaw danych.
InvalidDocument	string	Nieprawidłowy dokument.
InvalidDocumentBatch	string	Nieprawidłowa partia dokumentów.
InvalidLocale	string	Nieprawidłowe ustawienia regionalne.
InvalidLogDate	string	Nieprawidłowa data dziennika.
InvalidLogEndTime	string	Nieprawidłowy czas zakończenia dziennika.
InvalidLogId	string	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	string	Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel	string	Nieprawidłowy model.
InvalidModelUri	string	Nieprawidłowy identyfikator URI modelu.
InvalidParameter	string	Nieprawidłowy parametr.
InvalidParameterValue	string	Nieprawidłowa wartość parametru.
InvalidPayload	string	Nieprawidłowy ładunek.
InvalidPermissions	string	Nieprawidłowe uprawnienia.
InvalidPrerequisite	string	Nieprawidłowe wymaganie wstępne.
InvalidProductId	string	Nieprawidłowy identyfikator produktu.
InvalidProject	string	Nieprawidłowy projekt.
InvalidProjectKind	string	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	string	Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat	string	Nieprawidłowy format treści żądania.
InvalidSasValidityDuration	string	Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs	string	Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId	string	Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
InvalidSubscription	string	Nieprawidłowa subskrypcja.
InvalidTest	string	Nieprawidłowy test.
InvalidTimeToLive	string	Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs	string	Nieprawidłowy górny element dla dzienników.
InvalidTranscription	string	Nieprawidłowa transkrypcja.
InvalidWebHookEventKind	string	Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords	string	Brak rekordów wejściowych.
ModelCopyAuthorizationExpired	string	Wygasła metoda ModelCopyAuthorization.
ModelDeploymentNotCompleteState	string	Wdrożenie modelu nie zostało ukończone.
ModelDeprecated	string	Model jest przestarzały.
ModelExists	string	Model istnieje.
ModelMismatch	string	Niezgodność modelu.
ModelNotDeployable	string	Nie można wdrożyć modelu.
ModelVersionIncorrect	string	Nieprawidłowa wersja modelu.
MultipleLanguagesIdentified	string	Identyfikacja języka rozpoznała wiele języków. Nie można określić języka dominującego.
NoLanguageIdentified	string	Identyfikacja języka nie rozpoznała żadnego języka.
NoUtf8WithBom	string	Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch	string	Niezgodność płci projektu.
QuotaViolation	string	Naruszenie limitu przydziału.
SingleDefaultEndpoint	string	Pojedynczy domyślny punkt końcowy.
SkuLimitsExist	string	Istnieją limity jednostek SKU.
SubscriptionNotFound	string	Nie można odnaleźć subskrypcji.
UnexpectedError	string	Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation	string	Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta	string	Nieobsługiwana delta.
UnsupportedDynamicConfiguration	string	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter	string	Nieobsługiwany filtr.
UnsupportedLanguageCode	string	Nieobsługiwany kod języka.
UnsupportedOrderBy	string	Nieobsługiwana kolejność według.
UnsupportedPagination	string	Nieobsługiwane stronicowanie.
UnsupportedTimeRange	string	Nieobsługiwany zakres czasu.

DiarizationProperties

Nazwa	Typ	Opis
enabled	boolean	Wartość wskazująca, czy jest włączona diaryzacja osoby mówiącej.
maxSpeakers	integer	Wskazówka dla maksymalnej liczby osób mówiących w przypadku diaryzacji. Musi być większa niż 1 i mniejsza niż 36.

EntityError

Nazwa	Typ	Opis
code	string	Kod tego błędu.
message	string	Komunikat o tym błędzie.

EntityReference

Nazwa	Typ	Opis
self	string	Lokalizacja odwoływania się do jednostki.

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Kod błędu

Nazwa	Typ	Opis
Conflict	string	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	string	Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed	string	Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
InternalServerError	string	Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument	string	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest	string	Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed	string	Reprezentowanie niedozwolonego kodu błędu.
NotFound	string	Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError	string	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	string	Reprezentowanie niedostępnego kodu błędu usługi.
TooManyRequests	string	Reprezentując kod błędu zbyt wielu żądań.
Unauthorized	string	Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity	string	Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType	string	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowy wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

LanguageIdentificationMode

Nazwa	Typ	Opis
Continuous	string	Ciągła identyfikacja języka (wartość domyślna).
Single	string	Identyfikacja pojedynczego języka. Jeśli nie można zidentyfikować żadnego języka, kod błędu NoLanguageIdentified zostanie zwrócony użytkownikowi. Jeśli istnieje niejednoznaczność między wieloma językami, kod błędu MultipleLanguagesIdentified zostanie zwrócony użytkownikowi.

LanguageIdentificationProperties

Nazwa	Typ	Domyślna wartość	Opis
candidateLocales	string[]		Ustawienia regionalne kandydata do identyfikacji języka (na przykład ["en-US", "de-DE", "es-ES"]). Co najmniej 2 i maksymalnie 10 ustawień regionalnych kandydatów, w tym główne ustawienia regionalne dla transkrypcji, jest obsługiwane w trybie ciągłym. W przypadku identyfikacji pojedynczego języka maksymalna liczba ustawień regionalnych kandydatów jest niezwiązana.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Tryb używany do identyfikacji języka.
speechModelMapping	<string, EntityReference>		Opcjonalne mapowanie ustawień regionalnych na jednostki modelu mowy. Jeśli dla ustawień regionalnych nie podano żadnego modelu, zostanie użyty domyślny model podstawowy. Klucze muszą być ustawieniami regionalnymi zawartymi w ustawieniach regionalnych kandydatów, a wartości to jednostki dla modeli odpowiednich ustawień regionalnych.

ProfanityFilterMode

WulgaryzmFilterMode

Nazwa	Typ	Opis
Masked	string	Maskuj wulgaryzm z * z wyjątkiem pierwszej litery, np. f***
None	string	Wyłącz filtrowanie wulgaryzmów.
Removed	string	Usuń wulgaryzmy.
Tags	string	Dodawanie tagów XML "wulgaryzmów"</Profanity>

PunctuationMode

InterpunkcjaMode

Nazwa	Typ	Opis
Automatic	string	Automatyczna interpunkcja.
Dictated	string	Tylko dyktowane znaki interpunkcyjne, tj. jawne znaki interpunkcyjne.
DictatedAndAutomatic	string	Dyktowane znaki interpunkcyjne lub automatyczne znaki interpunkcyjne.
None	string	Brak interpunkcji.

Status

Stan

Nazwa	Typ	Opis
Failed	string	Długotrwała operacja nie powiodła się.
NotStarted	string	Długotrwała operacja nie została jeszcze uruchomiona.
Running	string	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	string	Długotrwała operacja została pomyślnie ukończona.

Transcription

Transkrypcja

Nazwa	Typ	Opis
contentContainerUrl	string	Adres URL kontenera obiektów blob platformy Azure, który zawiera pliki audio. Kontener może mieć maksymalny rozmiar 5 GB i maksymalną liczbę 10000 obiektów blob. Maksymalny rozmiar obiektu blob wynosi 2,5 GB. Sygnatura dostępu współdzielonego kontenera powinna zawierać uprawnienia "r" (odczyt) i "l" (lista). Ta właściwość nie zostanie zwrócona w odpowiedzi.
contentUrls	string[]	Lista adresów URL zawartości do transkrypcji plików audio. Dozwolone jest maksymalnie 1000 adresów URL. Ta właściwość nie zostanie zwrócona w odpowiedzi.
createdDateTime	string	Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
dataset	EntityReference	EntityReference
description	string	Opis obiektu.
displayName	string	Nazwa wyświetlana obiektu.
lastActionDateTime	string	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranskrypcjaLinki
locale	string	Ustawienia regionalne zawartych danych. Jeśli jest używana identyfikacja języka, to ustawienia regionalne są używane do transkrypcji mowy, dla której nie można wykryć języka.
model	EntityReference	EntityReference
properties	TranscriptionProperties	TranskrypcjaWłaściwości
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opisz bieżący stan interfejsu API.

TranscriptionLinks

TranskrypcjaLinki

Nazwa	Typ	Opis
files	string	Lokalizacja pobierania wszystkich plików tej jednostki. Aby uzyskać więcej informacji, zobacz operację "Transcriptions_ListFiles".

TranscriptionProperties

TranskrypcjaWłaściwości

Nazwa	Typ	Domyślna wartość	Opis
channels	integer[]		Kolekcja żądanych numerów kanałów. W domyślnym przypadku są brane pod uwagę kanały 0 i 1.
destinationContainerUrl	string		Żądany kontener docelowy. Uwagi Gdy kontener docelowy jest używany w połączeniu z `timeToLive`, metadane transkrypcji zostaną usunięte normalnie, ale dane przechowywane w kontenerze docelowym, w tym wyniki transkrypcji, pozostaną nietknięte, ponieważ nie są wymagane żadne uprawnienia usuwania dla tego kontenera. Aby obsługiwać automatyczne czyszczenie, skonfiguruj okresy istnienia obiektów blob w kontenerze lub użyj polecenia "Bring your own Storage (BYOS)" zamiast `destinationContainerUrl`, gdzie można wyczyścić obiekty blob.
diarization	DiarizationProperties		DiarizationProperties
displayFormWordLevelTimestampsEnabled	boolean		Żądana jest wartość wskazująca, czy są żądane znaczniki czasu na poziomie wyrazu dla formularza wyświetlania. Wartość domyślna to `false`.
durationMilliseconds	integer	0	Czas trwania w milisekundach transkrypcji. Czasy trwania większe niż 2^53–1 nie są obsługiwane w celu zapewnienia zgodności z liczbami całkowitymi języka JavaScript.
error	EntityError		EntityError
languageIdentification	LanguageIdentificationProperties		LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode		WulgaryzmFilterMode Tryb filtrowania wulgaryzmów.
punctuationMode	PunctuationMode		InterpunkcjaMode Tryb używany do interpunkcji.
timeToLiveHours	integer		Jak długo transkrypcja będzie przechowywana w systemie po jego zakończeniu. Gdy transkrypcja osiągnie czas wygaśnięcia po zakończeniu (powodzenie lub niepowodzenie), zostanie ona automatycznie usunięta. Uwaga: w przypadku korzystania z usługi BYOS (bring your own storage) pliki wynikowe na koncie magazynu należącego do klienta również zostaną usunięte. Użyj elementu destinationContainerUrl, aby określić oddzielny kontener dla plików wynikowych, które nie zostaną usunięte po wygaśnięciu wartości timeToLive lub pobrać pliki wyników za pośrednictwem interfejsu API i zapisać je w razie potrzeby. Najkrótszy obsługiwany czas trwania to 6 godzin, najdłuższy obsługiwany czas trwania to 31 dni. 2 dni (48 godzin) jest zalecaną wartością domyślną, gdy dane są używane bezpośrednio.
wordLevelTimestampsEnabled	boolean		Wartość wskazująca, czy żądane są znaczniki czasu na poziomie wyrazu. Wartość domyślna to `false`.

Udostępnij za pośrednictwem

Transcriptions - Get

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Get a transcription

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DetailedErrorCode

DiarizationProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Uwagi

Dodatkowe zasoby