Udostępnij za pośrednictwem


Projects - List

Pobiera listę projektów dla uwierzytelnionej subskrypcji.

GET {endpoint}/speechtotext/v3.2-preview.2/projects
GET {endpoint}/speechtotext/v3.2-preview.2/projects?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).

filter
query

string

Wyrażenie filtrowania do wybierania podzestawu dostępnych projektów.

        - Supported properties: displayName, description, createdDateTime, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime.

          - and, or, not are supported.

        - Example:

          filter=displayName eq 'My test'
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

PaginatedProjects

OK

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 JWT zwrócony 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 projects
Get all projects created in 2018 or 2019

Get all projects

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

Przykładowa odpowiedź

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}

Get all projects created in 2018 or 2019

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z

Przykładowa odpowiedź

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-03-03T12:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-12-19T17:54:57Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-02-01T00:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}

Definicje

Nazwa Opis
DetailedErrorCode

DetailedErrorCode

Error

Błąd

ErrorCode

ErrorCode

InnerError

InnerError

PaginatedProjects

Projekty podzielone na strony

Project

Project

ProjectLinks

Linki projektu

ProjectProperties

Właściwości projektu

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 zaktualizować.

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

Naruszenie 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łowa górna wierzchołka dzienników.

InvalidTranscription

string

Nieprawidłowa transkrypcja.

InvalidWebHookEventKind

string

Nieprawidłowy rodzaj zdarzenia haka internetowego.

MissingInputRecords

string

Brak rekordów wejściowych.

ModelCopyOperationExists

string

Operacja kopiowania modelu istnieje.

ModelDeploymentNotCompleteState

string

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

ModelDeprecated

string

Model przestarzały.

ModelExists

string

Model istnieje.

ModelMismatch

string

Niezgodność modelu.

ModelNotDeployable

string

Model nie można wdrożyć.

ModelVersionIncorrect

string

Wersja modelu jest nieprawidłowa.

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ługiwane zamówienie według.

UnsupportedPagination

string

Nieobsługiwane stronicowanie.

UnsupportedTimeRange

string

Nieobsługiwany zakres czasu.

Error

Błąd

Nazwa Typ Opis
code

ErrorCode

ErrorCode
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 pod adresem 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

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

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 pod adresem 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.

PaginatedProjects

Projekty podzielone na strony

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

Project[]

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.

Project

Project

Nazwa Typ Opis
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.

description

string

Opis obiektu.

displayName

string

Nazwa wyświetlana obiektu.

links

ProjectLinks

Linki projektu

locale

string

Ustawienia regionalne zawartych danych.

properties

ProjectProperties

Właściwości projektu

self

string

Lokalizacja tej jednostki.

Linki projektu

Nazwa Typ Opis
datasets

string

Lokalizacja pobierania listy wszystkich zestawów danych tego projektu. Aby uzyskać więcej informacji, zobacz operację "Projects_ListDatasets".

endpoints

string

Lokalizacja do pobrania listy wszystkich punktów końcowych tego projektu. Aby uzyskać więcej informacji, zobacz operację "Projects_ListEndpoints".

evaluations

string

Lokalizacja pobierania listy wszystkich ocen tego projektu. Aby uzyskać więcej informacji, zobacz operację "Projects_ListEvaluations".

models

string

Lokalizacja pobierania listy wszystkich modeli tego projektu. Aby uzyskać więcej informacji, zobacz operację "Projects_ListModels".

transcriptions

string

Lokalizacja pobierania listy wszystkich transkrypcji tego projektu. Aby uzyskać więcej informacji, zobacz operację "Projects_ListTranscriptions".

ProjectProperties

Właściwości projektu

Nazwa Typ Opis
datasetCount

integer

Liczba zestawów danych skojarzonych z tym projektem.

endpointCount

integer

Liczba punktów końcowych skojarzonych z tym projektem.

evaluationCount

integer

Liczba ocen skojarzonych z tym projektem.

modelCount

integer

Liczba modeli skojarzonych z tym projektem.

transcriptionCount

integer

Liczba transkrypcji skojarzonych z tym projektem.