Udostępnij za pośrednictwem

Projects - Get

  • Odwołanie
Usługa:
Azure AI Services
Wersja interfejsu API:
v3.2-preview.2

Pobiera projekt zidentyfikowany przez dany identyfikator.

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

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

Project

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 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 a project

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0

Przykładowa odpowiedź

Kod stanu:
200 
{
  "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"
}

Definicje

Nazwa Opis
DetailedErrorCode

DetailedErrorCode
Error

Błąd
ErrorCode

Kod błędu
InnerError

InnerError
Project

Projekt
ProjectLinks

Łącza projektu
ProjectProperties

Właściwości projektu

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość Opis
DataImportFailed

Importowanie danych nie powiodło się.
DeleteNotAllowed

Usuń niedozwolone.
DeployNotAllowed

Wdrażanie jest niedozwolone.
DeployingFailedModel

Wdrażanie modelu nie powiodło się.
EmptyRequest

Puste żądanie.
EndpointCannotBeDefault

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

Punkt końcowy nie można aktualizować.
EndpointWithoutLogging

Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris

Przekroczono liczbę nagrań uris.
FailedDataset

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

Zakazany.
InUseViolation

Naruszenie użycia.
InaccessibleCustomerStorage

Niedostępny magazyn klienta.
InvalidAdaptationMapping

Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel

Nieprawidłowy model podstawowy.
InvalidCallbackUri

Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidCollection

Nieprawidłowa kolekcja.
InvalidDataset

Nieprawidłowy zestaw danych.
InvalidDocument

Nieprawidłowy dokument.
InvalidDocumentBatch

Nieprawidłowa partia dokumentów.
InvalidLocale

Nieprawidłowe ustawienia regionalne.
InvalidLogDate

Nieprawidłowa data dziennika.
InvalidLogEndTime

Nieprawidłowy czas zakończenia dziennika.
InvalidLogId

Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime

Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel

Nieprawidłowy model.
InvalidModelUri

Nieprawidłowy identyfikator URI modelu.
InvalidParameter

Nieprawidłowy parametr.
InvalidParameterValue

Nieprawidłowa wartość parametru.
InvalidPayload

Nieprawidłowy ładunek.
InvalidPermissions

Nieprawidłowe uprawnienia.
InvalidPrerequisite

Nieprawidłowe wymaganie wstępne.
InvalidProductId

Nieprawidłowy identyfikator produktu.
InvalidProject

Nieprawidłowy projekt.
InvalidProjectKind

Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri

Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat

Nieprawidłowy format treści żądania.
InvalidSasValidityDuration

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

Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId

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

Nieprawidłowa subskrypcja.
InvalidTest

Nieprawidłowy test.
InvalidTimeToLive

Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs

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

Nieprawidłowa transkrypcja.
InvalidWebHookEventKind

Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords

Brak rekordów wejściowych.
ModelCopyOperationExists

Istnieje operacja kopiowania modelu.
ModelDeploymentNotCompleteState

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

Model jest przestarzały.
ModelExists

Model istnieje.
ModelMismatch

Niezgodność modelu.
ModelNotDeployable

Nie można wdrożyć modelu.
ModelVersionIncorrect

Nieprawidłowa wersja modelu.
NoUtf8WithBom

Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset

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

Niezgodność płci projektu.
QuotaViolation

Naruszenie limitu przydziału.
SingleDefaultEndpoint

Pojedynczy domyślny punkt końcowy.
SkuLimitsExist

Istnieją limity jednostek SKU.
SubscriptionNotFound

Nie można odnaleźć subskrypcji.
UnexpectedError

Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation

Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta

Nieobsługiwana delta.
UnsupportedDynamicConfiguration

Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter

Nieobsługiwany filtr.
UnsupportedLanguageCode

Nieobsługiwany kod języka.
UnsupportedOrderBy

Nieobsługiwana kolejność według.
UnsupportedPagination

Nieobsługiwane stronicowanie.
UnsupportedTimeRange

Nieobsługiwany zakres czasu.

Error

Objekt

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

Wyliczanie

Kod błędu

Wartość Opis
Conflict

Reprezentowanie kodu błędu powodującego konflikt.
Forbidden

Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed

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

Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument

Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest

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

Reprezentowanie niedozwolonego kodu błędu.
NotFound

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

Reprezentowanie kodu błędu potoku.
ServiceUnavailable

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

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

Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity

Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType

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

InnerError

Objekt

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.

Project

Objekt

Projekt

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

string

Opis obiektu.
displayName

string

minLength: 1

Nazwa wyświetlana obiektu.
links

ProjectLinks

Łącza projektu
locale

string

minLength: 1

Ustawienia regionalne zawartych danych.
properties

ProjectProperties

Właściwości projektu
self

string (uri)

Lokalizacja tej jednostki.
Objekt

Łącza projektu

Nazwa Typ Opis
datasets

string (uri)

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

string (uri)

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

string (uri)

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

string (uri)

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

string (uri)

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

ProjectProperties

Objekt

Właściwości projektu

Nazwa Typ Opis
datasetCount

integer (int32)

Liczba zestawów danych skojarzonych z tym projektem.
endpointCount

integer (int32)

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

integer (int32)

Liczba ocen skojarzonych z tym projektem.
modelCount

integer (int32)

Liczba modeli skojarzonych z tym projektem.
transcriptionCount

integer (int32)

Liczba transkrypcji skojarzonych z tym projektem.