Udostępnij za pośrednictwem


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.

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

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

PaginatedTranscriptions

OK

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

Authorization

Podaj token dostępu z zestawu JWT zwróconego przez usługę STS tego regionu. 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
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Błąd

ErrorCode

Kod błędu

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

Podział na stronyScriptions

ProfanityFilterMode

WulgaryzmFilterMode

PunctuationMode

InterpunkcjaMode

Status

Status

Transcription

Transkrypcja

TranscriptionLinks

TranskrypcjaLinki

TranscriptionProperties

TranskrypcjaWłaściwości

DetailedErrorCode

DetailedErrorCode

Wartość Opis
InvalidParameterValue

Nieprawidłowa wartość parametru.

InvalidRequestBodyFormat

Nieprawidłowy format treści żądania.

EmptyRequest

Puste żądanie.

MissingInputRecords

Brak rekordów wejściowych.

InvalidDocument

Nieprawidłowy dokument.

ModelVersionIncorrect

Nieprawidłowa wersja modelu.

InvalidDocumentBatch

Nieprawidłowa partia dokumentów.

UnsupportedLanguageCode

Nieobsługiwany kod języka.

DataImportFailed

Importowanie danych nie powiodło się.

InUseViolation

Naruszenie użycia.

InvalidLocale

Nieprawidłowe ustawienia regionalne.

InvalidBaseModel

Nieprawidłowy model podstawowy.

InvalidAdaptationMapping

Nieprawidłowe mapowanie adaptacji.

InvalidDataset

Nieprawidłowy zestaw danych.

InvalidTest

Nieprawidłowy test.

FailedDataset

Zestaw danych, który zakończył się niepowodzeniem.

InvalidModel

Nieprawidłowy model.

InvalidTranscription

Nieprawidłowa transkrypcja.

InvalidPayload

Nieprawidłowy ładunek.

InvalidParameter

Nieprawidłowy parametr.

EndpointWithoutLogging

Punkt końcowy bez rejestrowania.

InvalidPermissions

Nieprawidłowe uprawnienia.

InvalidPrerequisite

Nieprawidłowe wymaganie wstępne.

InvalidProductId

Nieprawidłowy identyfikator produktu.

InvalidSubscription

Nieprawidłowa subskrypcja.

InvalidProject

Nieprawidłowy projekt.

InvalidProjectKind

Nieprawidłowy rodzaj projektu.

InvalidRecordingsUri

Nieprawidłowy identyfikator URI nagrań.

OnlyOneOfUrlsOrContainerOrDataset

Tylko jeden z adresów URL lub kontenera lub zestawu danych.

ExceededNumberOfRecordingsUris

Przekroczono liczbę nagrań uris.

ModelMismatch

Niezgodność modelu.

ProjectGenderMismatch

Niezgodność płci projektu.

ModelDeprecated

Model jest przestarzały.

ModelExists

Model istnieje.

ModelNotDeployable

Nie można wdrożyć modelu.

EndpointNotUpdatable

Punkt końcowy nie można aktualizować.

SingleDefaultEndpoint

Pojedynczy domyślny punkt końcowy.

EndpointCannotBeDefault

Punkt końcowy nie może być domyślny.

InvalidModelUri

Nieprawidłowy identyfikator URI modelu.

SubscriptionNotFound

Nie można odnaleźć subskrypcji.

QuotaViolation

Naruszenie limitu przydziału.

UnsupportedDelta

Nieobsługiwana delta.

UnsupportedFilter

Nieobsługiwany filtr.

UnsupportedPagination

Nieobsługiwane stronicowanie.

UnsupportedDynamicConfiguration

Nieobsługiwana konfiguracja dynamiczna.

UnsupportedOrderBy

Nieobsługiwana kolejność według.

NoUtf8WithBom

Brak utf8 z bom.

ModelDeploymentNotCompleteState

Wdrożenie modelu nie zostało ukończone.

SkuLimitsExist

Istnieją limity jednostek SKU.

DeployingFailedModel

Wdrażanie modelu nie powiodło się.

UnsupportedTimeRange

Nieobsługiwany zakres czasu.

InvalidLogDate

Nieprawidłowa data dziennika.

InvalidLogId

Nieprawidłowy identyfikator dziennika.

InvalidLogStartTime

Nieprawidłowy czas rozpoczęcia dziennika.

InvalidLogEndTime

Nieprawidłowy czas zakończenia dziennika.

InvalidTopForLogs

Nieprawidłowy górny element dla dzienników.

InvalidSkipTokenForLogs

Nieprawidłowy token pomijania dzienników.

DeleteNotAllowed

Usuń niedozwolone.

Forbidden

Zakazany.

DeployNotAllowed

Wdrażanie jest niedozwolone.

UnexpectedError

Nieoczekiwany błąd.

InvalidCollection

Nieprawidłowa kolekcja.

InvalidCallbackUri

Nieprawidłowy identyfikator URI wywołania zwrotnego.

InvalidSasValidityDuration

Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.

InaccessibleCustomerStorage

Niedostępny magazyn klienta.

UnsupportedClassBasedAdaptation

Nieobsługiwana adaptacja oparta na klasach.

InvalidWebHookEventKind

Nieprawidłowy rodzaj zdarzenia elementu webhook.

InvalidTimeToLive

Nieprawidłowy czas wygaśnięcia.

InvalidSourceAzureResourceId

Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.

ModelCopyOperationExists

Istnieje operacja kopiowania modelu.

DiarizationProperties

DiarizationProperties

Nazwa Typ Opis
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Nazwa Typ Opis
maxCount

integer (int32)

minimum: 1

Maksymalna liczba osób mówiących na potrzeby diaryzacji. Musi być mniejsza niż 36 i większa niż lub równa właściwości minSpeakers.

minCount

integer (int32)

minimum: 1

Wskazówka dotycząca minimalnej liczby osób mówiących w przypadku diaryzacji. 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

EntityReference

Nazwa Typ Opis
self

string (uri)

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

Wartość Opis
InvalidRequest

Reprezentowanie nieprawidłowego kodu błędu żądania.

InvalidArgument

Reprezentowanie nieprawidłowego kodu błędu argumentu.

InternalServerError

Reprezentowanie wewnętrznego kodu błędu serwera.

ServiceUnavailable

Reprezentowanie niedostępnego kodu błędu usługi.

NotFound

Reprezentacja kodu błędu, który nie został znaleziony.

PipelineError

Reprezentowanie kodu błędu potoku.

Conflict

Reprezentowanie kodu błędu powodującego konflikt.

InternalCommunicationFailed

Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.

Forbidden

Reprezentowanie niedozwolonego kodu błędu.

NotAllowed

Reprezentowanie niedozwolonego kodu błędu.

Unauthorized

Reprezentowanie nieautoryzowanego kodu błędu.

UnsupportedMediaType

Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

TooManyRequests

Reprezentując kod błędu zbyt wielu żądań.

UnprocessableEntity

Reprezentowanie nieprzetworzonego kodu błędu jednostki.

InnerError

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

LanguageIdentificationMode

Wartość Opis
Continuous

Ciągła identyfikacja języka (wartość domyślna).

Single

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ługiwany jest co najmniej 2 i maksymalnie 10 ustawień regionalnych kandydatów, w tym główne ustawienia regionalne dla transkrypcji.

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.

PaginatedTranscriptions

Podział na stronyScriptions

Nazwa Typ Opis
@nextLink

string (uri)

Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.

values

Transcription[]

Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne.

Podczas iteracji za pośrednictwem 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 jej po pobraniu pełnej listy.

ProfanityFilterMode

WulgaryzmFilterMode

Wartość Opis
None

Wyłącz filtrowanie wulgaryzmów.

Removed

Usuń wulgaryzmy.

Tags

Dodawanie tagów XML "wulgaryzmów"</Profanity>

Masked

Maskuj wulgaryzm z * z wyjątkiem pierwszej litery, np. f***

PunctuationMode

InterpunkcjaMode

Wartość Opis
None

Brak interpunkcji.

Dictated

Tylko dyktowane znaki interpunkcyjne, tj. jawne znaki interpunkcyjne.

Automatic

Automatyczna interpunkcja.

DictatedAndAutomatic

Dyktowane znaki interpunkcyjne lub automatyczne znaki interpunkcyjne.

Status

Status

Wartość Opis
NotStarted

Długotrwała operacja nie została jeszcze uruchomiona.

Running

Długotrwała operacja jest obecnie przetwarzana.

Succeeded

Długotrwała operacja została pomyślnie ukończona.

Failed

Długotrwała operacja nie powiodła się.

Transcription

Transkrypcja

Nazwa Typ Opis
contentContainerUrl

string (uri)

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[] (uri)

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 (date-time)

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

minLength: 1

Nazwa wyświetlana obiektu.

lastActionDateTime

string (date-time)

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

minLength: 1

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

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranskrypcjaWłaściwości

self

string (uri)

Lokalizacja tej jednostki.

status

Status

Status
Opis bieżącego stanu interfejsu API

TranskrypcjaLinki

Nazwa Typ Opis
files

string (uri)

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[] (int32)

Kolekcja żądanych numerów kanałów. W domyślnym przypadku są brane pod uwagę kanały 0 i 1.

destinationContainerUrl

string (uri)

Żą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

diarizationEnabled

boolean

Wartość wskazująca, czy żądana jest diaryzacja (identyfikacja osoby mówiącej). Wartość domyślna to false. Jeśli to pole ma wartość true, a ulepszony system diaryzacji został skonfigurowany przez określenie DiarizationProperties, ulepszony system diaryzacji zapewni diaryzacja dla konfigurowalnego zakresu głośników. Jeśli to pole ma wartość true, a ulepszony system diaryzacji nie jest włączony (nie określa DiarizationProperties), podstawowy system diaryzacji będzie rozróżniać maksymalnie dwa głośniki. Nie są naliczane dodatkowe opłaty za podstawową diaryzacji.

Podstawowy system słownika jest przestarzały i zostanie usunięty w następnej wersji głównej interfejsu API. To ustawienie diarizationEnabled zostanie również usunięte.

displayFormWordLevelTimestampsEnabled

boolean

Żądana jest wartość wskazująca, czy są żądane znaczniki czasu na poziomie wyrazu dla formularza wyświetlania. Wartość domyślna to false.

duration

string

Czas trwania transkrypcji. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Adres e-mail do wysyłania powiadomień e-mail na adres w przypadku zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

WulgaryzmFilterMode
Tryb filtrowania wulgaryzmów.

punctuationMode

PunctuationMode

InterpunkcjaMode
Tryb używany do interpunkcji.

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 (powodzenie lub niepowodzenie) zostanie automatycznie usunięta. Ustawienie tej wartości lub ustawienie wartości 0 spowoduje wyłączenie automatycznego usuwania. Najdłuższy obsługiwany czas trwania to 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 żądane są znaczniki czasu na poziomie wyrazu. Wartość domyślna to false.