Projects - List Datasets

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.2-preview.2

Pobiera listę zestawów danych dla określonego projektu.

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

Z parametrami opcjonalnymi:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/datasets?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 do wybierania podzestawu dostępnych zestawów danych. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind. - 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	PaginatedDatasets	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

PaginatedDatasets

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c",
      "kind": "Language",
      "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language dataset"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definicje

Nazwa	Opis
Dataset	Zestaw danych
DatasetKind	DatasetKind
DatasetLinks	Zestawy danychLinki
DatasetProperties	Zestaw danychWłaściwości
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	Odwołanie do jednostki
Error	Błąd
ErrorCode	ErrorCode
InnerError	Błąd wewnętrzny
PaginatedDatasets	Zestawy danych podzielonych na strony
Status	Stan
TextNormalizationKind	TextNormalizationKind

Dataset

Zestaw danych

Nazwa	Typ	Opis
contentUrl	string	Adres URL danych dla zestawu danych.
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 to 10.
description	string	Opis obiektu.
displayName	string	Nazwa wyświetlana obiektu.
kind	DatasetKind	DatasetKind Typ importu danych.
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	DatasetLinks	Zestawy danychLinki
locale	string	Ustawienia regionalne zawartych danych.
project	EntityReference	Odwołanie do jednostki
properties	DatasetProperties	Zestaw danychWłaściwości
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opis bieżącego stanu interfejsu API

DatasetKind

Nazwa	Typ	Opis
Acoustic	string	Zestaw danych akustycznych.
AudioFiles	string	Zestaw danych plików audio.
Language	string	Zestaw danych języka.
LanguageMarkdown	string	Zestaw danych języka markdown.
OutputFormatting	string	Zestaw danych, który zawiera reguły dostosowywania normalizacji tekstu odwrotnego, wielkich liter, reformacji, wulgaryzmów, a także definiuje testy weryfikacji zestawu danych
Pronunciation	string	Zestaw danych wymowy.

DatasetLinks

Zestawy danychLinki

Nazwa	Typ	Opis
commitBlocks	string	Lokalizacja do zatwierdzenia listy bloków podczas przekazywania zestawu danych przy użyciu bloków. Aby uzyskać więcej informacji, zobacz operację "Datasets_CommitBlocks".
files	string	Lokalizacja do pobrania wszystkich plików tej jednostki. Aby uzyskać więcej informacji, zobacz operację "Datasets_ListFiles".
listBlocks	string	Lokalizacja do wyświetlenia listy już przekazanych bloków tej jednostki podczas przekazywania zestawu danych przy użyciu bloków. Aby uzyskać więcej informacji, zobacz operację "Datasets_GetBlocks".
uploadBlocks	string	Lokalizacja przekazywania bloków do podczas przekazywania zestawu danych przy użyciu bloków. Aby uzyskać więcej informacji, zobacz operację "Datasets_UploadBlock".

DatasetProperties

Zestaw danychWłaściwości

Nazwa	Typ	Opis
acceptedLineCount	integer	Liczba wierszy akceptowanych dla tego zestawu danych.
duration	string	Całkowity czas trwania zestawów danych, jeśli zawiera pliki audio. 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 wypadek zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.
error	EntityError	EntityError
rejectedLineCount	integer	Liczba wierszy odrzuconych dla tego zestawu danych.
textNormalizationKind	TextNormalizationKind	TextNormalizationKind Rodzaj normalizacji tekstu.

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.

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	ErrorCode Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	Błąd wewnętrzny Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), 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

Nazwa	Typ	Opis
Conflict	string	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	string	Reprezentowanie niedozwolonego kodu błędu.
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	Reprezentowanie kodu błędu, który nie został znaleziony.
PipelineError	string	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	string	Reprezentuje kod błędu niedostępności usługi.
TooManyRequests	string	Reprezentacja kodu 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

Błąd wewnętrzny

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowe wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	Błąd wewnętrzny Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), 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.

PaginatedDatasets

Zestawy danych podzielonych na strony

Nazwa	Typ	Opis
@nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.
values	Dataset[]	Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. W przypadku iteracji po liście przy użyciu stronicowania i równoległego usuwania jednostek niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie po pobraniu pełnej listy.

Nazwa

Typ

Opis

@nextLink

string

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

values

Dataset[]

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

W przypadku iteracji po liście przy użyciu stronicowania i równoległego usuwania jednostek niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie po pobraniu pełnej listy.

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.

TextNormalizationKind

Nazwa	Typ	Opis
Default	string	Domyślna normalizacja tekstu (np. "od 2 do 3" jest zastępowana przez "dwa do trzech" w en-US).
None	string	Do tekstu wejściowego nie zostanie zastosowana normalizacja tekstu. Jest to opcja zastąpienia, która powinna być używana tylko wtedy, gdy tekst jest znormalizowany przed przekazaniem.

Udostępnij za pośrednictwem

Projects - List Datasets

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Get all datasets

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedDatasets

Status

TextNormalizationKind

Dodatkowe zasoby