Projects - List Transcriptions
Pobiera listę transkrypcji dla określonego projektu.
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions?skip={skip}&top={top}&filter={filter}
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 projektu. |
filter
|
query |
string |
Wyrażenie filtrowania służące do wybierania podzestawu dostępnych transkrypcji.
|
|
skip
|
query |
integer int32 |
Liczba zestawów danych, które zostaną pominięte. |
|
top
|
query |
integer int32 |
Liczba zestawów danych, które zostaną uwzględnione po pomijaniu. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK Nagłówki Retry-After: integer |
|
Other Status Codes |
Wystąpił błąd. |
Zabezpieczenia
Ocp-Apim-Subscription-Key
Tutaj podaj klucz konta usług Cognitive Services.
Typ:
apiKey
W:
header
Authorization
Podaj token dostępu z zestawu JWT zwróconego przez usługę STS w tym regionie. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement
Typ:
apiKey
W:
header
Przykłady
Get all transcriptions
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"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"
}
Definicje
Nazwa | Opis |
---|---|
Detailed |
DetailedErrorCode |
Diarization |
DiarizationProperties |
Diarization |
Prelegenci diaryzacjiWłaściwości |
Entity |
EntityError |
Entity |
Odwołanie do jednostki |
Error |
Błąd |
Error |
ErrorCode |
Inner |
InnerError |
Language |
LanguageIdentificationMode |
Language |
LanguageIdentificationProperties |
Paginated |
Podział na stronySkrypcje |
Profanity |
WulgaryzmyFilterMode |
Punctuation |
Tryb interpunkcyjny |
Status |
Stan |
Transcription |
Transkrypcji |
Transcription |
TranskrypcjaLinki |
Transcription |
TranskrypcjaWłaściwości |
DetailedErrorCode
DetailedErrorCode
Nazwa | Typ | Opis |
---|---|---|
DataImportFailed |
string |
Importowanie danych nie powiodło się. |
DeleteNotAllowed |
string |
Usuń niedozwolone. |
DeployNotAllowed |
string |
Wdrażanie jest niedozwolone. |
DeployingFailedModel |
string |
Wdrażanie modelu, który zakończył się niepowodzeniem. |
EmptyRequest |
string |
Puste żądanie. |
EndpointCannotBeDefault |
string |
Punkt końcowy nie może być domyślny. |
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 |
Zakazane. |
InUseViolation |
string |
W przypadku naruszenia użycia. |
InaccessibleCustomerStorage |
string |
Niedostępny magazyn klienta. |
InvalidAdaptationMapping |
string |
Nieprawidłowe mapowanie adaptacji. |
InvalidBaseModel |
string |
Nieprawidłowy model podstawowy. |
InvalidCallbackUri |
string |
Nieprawidłowy identyfikator URI wywołania zwrotnego. |
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 trwania 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. |
ModelCopyOperationExists |
string |
Istnieje operacja kopiowania modelu. |
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. |
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ługiwana stronicowanie. |
UnsupportedTimeRange |
string |
Nieobsługiwany zakres czasu. |
DiarizationProperties
DiarizationProperties
Nazwa | Typ | Opis |
---|---|---|
speakers |
Prelegenci diaryzacjiWłaściwości |
DiarizationSpeakersProperties
Prelegenci diaryzacjiWłaściwości
Nazwa | Typ | Opis |
---|---|---|
maxCount |
integer |
Maksymalna liczba osób mówiących do dykaryzacji. Musi być mniejsza niż 36 i większa niż lub równa właściwości minSpeakers. |
minCount |
integer |
Wskazówka dotycząca minimalnej liczby osób mówiących do dykaryzacji. Musi być mniejsza lub równa właściwości maxSpeakers. |
EntityError
EntityError
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod tego błędu. |
message |
string |
Komunikat o tym błędzie. |
EntityReference
Odwołanie do jednostki
Nazwa | Typ | Opis |
---|---|---|
self |
string |
Lokalizacja odwoływania się do jednostki. |
Error
Błąd
Nazwa | Typ | Opis |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad. |
innerError |
InnerError |
|
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
ErrorCode
Nazwa | Typ | Opis |
---|---|---|
Conflict |
string |
Reprezentowanie kodu błędu powodującego konflikt. |
Forbidden |
string |
Reprezentuje kod błędu zabronionego. |
InternalCommunicationFailed |
string |
Reprezentowanie kodu błędu komunikacji wewnętrznej 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 |
Reprezentując kod błędu nie znaleziono. |
PipelineError |
string |
Reprezentowanie kodu błędu potoku. |
ServiceUnavailable |
string |
Reprezentuje kod błędu niedostępności usługi. |
TooManyRequests |
string |
Reprezentowanie zbyt wielu żądań kod błędu. |
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
InnerError
Nazwa | Typ | Opis |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad. |
innerError |
InnerError |
|
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
LanguageIdentificationMode
Nazwa | Typ | Opis |
---|---|---|
Continuous |
string |
Ciągła identyfikacja języka (wartość domyślna). |
Single |
string |
Identyfikacja pojedynczego języka. |
LanguageIdentificationProperties
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"]). Obsługiwane są co najmniej 2 i maksymalnie 10 ustawień regionalnych kandydatów, w tym główne ustawienia regionalne dla transkrypcji. |
|
mode | Continuous |
LanguageIdentificationMode |
|
speechModelMapping |
<string,
Entity |
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 są jednostkami dla modeli odpowiednich ustawień regionalnych. |
PaginatedTranscriptions
Podział na stronySkrypcje
Nazwa | Typ | Opis |
---|---|---|
@nextLink |
string |
Link do następnego zestawu wyników podzielonych na strony, jeśli dostępnych jest więcej jednostek; w przeciwnym razie wartość null. |
values |
Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. Podczas iteracji listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie po pobraniu pełnej listy. |
ProfanityFilterMode
WulgaryzmyFilterMode
Nazwa | Typ | Opis |
---|---|---|
Masked |
string |
Maskuj wulgaryzmy * z wyjątkiem pierwszej litery, np. f *** |
None |
string |
Wyłącz filtrowanie wulgaryzmów. |
Removed |
string |
Usuń wulgaryzmy. |
Tags |
string |
Dodawanie "wulgaryzmów" tagów XML/wulgaryzmów<> |
PunctuationMode
Tryb interpunkcyjny
Nazwa | Typ | Opis |
---|---|---|
Automatic |
string |
Automatyczna interpunkcja. |
Dictated |
string |
Tylko dyktowane znaki interpunkcyjne, tj. jawne znaki interpunkcyjne. |
DictatedAndAutomatic |
string |
Dyktowane znaki interpunkcyjne lub automatyczna interpunkcja. |
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
Transkrypcji
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 są 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 |
Odwołanie do jednostki |
|
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 |
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 |
Odwołanie do jednostki |
|
project |
Odwołanie do jednostki |
|
properties |
TranskrypcjaWłaściwości |
|
self |
string |
Lokalizacja tej jednostki. |
status |
Stan |
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 | 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. UwagiGdy kontener docelowy jest używany w połączeniu z elementem |
diarization |
DiarizationProperties |
|
diarizationEnabled |
boolean |
Żądana jest wartość wskazująca, czy żądano diaryzacji (identyfikacji osoby mówiącej). Wartość domyślna to Podstawowy system dykaryzacji jest przestarzały i zostanie usunięty w następnej wersji głównej interfejsu API.
To |
displayFormWordLevelTimestampsEnabled |
boolean |
Wartość wskazująca, czy żądane są znaczniki czasu na poziomie wyrazów dla formularza wyświetlania. Wartość domyślna to |
duration |
string |
Czas trwania transkrypcji. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations). |
string |
Adres e-mail do wysyłania powiadomień e-mail na wypadek zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail. |
|
error |
EntityError |
|
languageIdentification |
LanguageIdentificationProperties |
|
profanityFilterMode |
WulgaryzmFilterMode |
|
punctuationMode |
InterpunkcjaMode |
|
timeToLive |
string |
Jak długo transkrypcja będzie przechowywana w systemie po jego zakończeniu. Gdy transkrypcja osiągnie czas wygaśnięcia po zakończeniu (zakończonym powodzeniem lub niepowodzeniem), zostanie ona automatycznie usunięta. Ustawienie tej wartości lub ustawienie wartości 0 spowoduje wyłączenie automatycznego usuwania. Najdłuższy obsługiwany czas trwania wynosi 31 dni. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations). |
wordLevelTimestampsEnabled |
boolean |
Wartość wskazująca, czy są żądane znaczniki czasu na poziomie wyrazu. Wartość domyślna to |