Sdílet prostřednictvím

Projects - Get

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
3.2

Získá projekt identifikovaný podle daného ID.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

Identifikátor projektu.

Odpovědi

Name Typ Description
200 OK

Project

OK
Other Status Codes

Error

Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Sem zadejte klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vrácený službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu na adresu URL služby STS: ?scope=speechservicesmanagement.

Typ: apiKey
V: header

Příklady

Get a project

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0",
  "links": {
    "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
    "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
    "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
    "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
    "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
}

Definice

Name Description
DetailedErrorCode

Podrobný kód chyby
Error

Chyba
ErrorCode

ErrorCode
InnerError

Vnitřní chyba
Project

Project
ProjectLinks

Odkazy na projekt
ProjectProperties

ProjectVlastnosti

DetailedErrorCode

Výčet

Podrobný kód chyby

Hodnota Description
DataImportFailed

Import dat se nezdařil.
DeleteNotAllowed

Odstranění není povoleno.
DeployNotAllowed

Nasazení není povoleno.
DeployingFailedModel

Nasazení modelu, který selhal
EmptyRequest

Prázdný požadavek.
EndpointCannotBeDefault

Koncový bod nemůže být výchozí.
EndpointNotUpdatable

Koncový bod není aktualizovatelný.
EndpointWithoutLogging

Koncový bod bez protokolování.
ExceededNumberOfRecordingsUris

Překročili jsme počet nahrávek uris.
FailedDataset

Datová sada se nezdařila.
Forbidden

Zakázaný.
InUseViolation

Porušením používání.
InaccessibleCustomerStorage

Nepřístupné úložiště zákazníka
InvalidAdaptationMapping

Neplatné mapování adaptace
InvalidBaseModel

Neplatný základní model.
InvalidCallbackUri

Neplatný identifikátor URI zpětného volání
InvalidChannels

Neplatné kanály.
InvalidCollection

Neplatná kolekce.
InvalidDataset

Neplatná datová sada
InvalidDocument

Neplatný dokument.
InvalidDocumentBatch

Neplatná dávka dokumentu.
InvalidLocale

Neplatné národní prostředí.
InvalidLogDate

Neplatné datum protokolu.
InvalidLogEndTime

Neplatný čas ukončení protokolu.
InvalidLogId

Neplatné ID protokolu
InvalidLogStartTime

Neplatný čas spuštění protokolu.
InvalidModel

Neplatný model.
InvalidModelUri

Neplatný identifikátor URI modelu
InvalidParameter

Neplatný parametr.
InvalidParameterValue

Neplatná hodnota parametru
InvalidPayload

Neplatná datová část.
InvalidPermissions

Neplatná oprávnění.
InvalidPrerequisite

Neplatný předpoklad.
InvalidProductId

Neplatné ID produktu.
InvalidProject

Neplatný projekt.
InvalidProjectKind

Neplatný druh projektu.
InvalidRecordingsUri

Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat

Neplatný formát textu požadavku.
InvalidSasValidityDuration

Neplatná doba platnosti SAS.
InvalidSkipTokenForLogs

Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId

Neplatné ID zdrojového prostředku Azure
InvalidSubscription

Neplatné předplatné.
InvalidTest

Neplatný test.
InvalidTimeToLive

Hodnota TTL (Time to Live) je neplatná.
InvalidTopForLogs

Neplatné top pro protokoly.
InvalidTranscription

Neplatný přepis.
InvalidWebHookEventKind

Neplatný druh události webhooku
MissingInputRecords

Chybí vstupní záznamy.
ModelCopyAuthorizationExpired

Vypršela platnost ModelCopyAuthorization.
ModelDeploymentNotCompleteState

Nasazení modelu není dokončeno.
ModelDeprecated

Model je zastaralý.
ModelExists

Model existuje.
ModelMismatch

Neshoda modelů.
ModelNotDeployable

Model nejde nasadit.
ModelVersionIncorrect

Nesprávná verze modelu.
NoUtf8WithBom

No utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset

Pouze jednu z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch

Neshoda mezi pohlavími projektu.
QuotaViolation

Porušení kvóty.
SingleDefaultEndpoint

Jeden výchozí koncový bod.
SkuLimitsExist

Existují omezení skladových položek.
SubscriptionNotFound

Předplatné se nenašlo.
UnexpectedError

Neočekávaná chyba.
UnsupportedClassBasedAdaptation

Nepodporovaná adaptace na základě třídy
UnsupportedDelta

Nepodporovaná rozdílová.
UnsupportedDynamicConfiguration

Nepodporovaná dynamická konfigurace
UnsupportedFilter

Nepodporovaný filtr
UnsupportedLanguageCode

Nepodporovaný kód jazyka.
UnsupportedOrderBy

Nepodporované řazení podle.
UnsupportedPagination

Nepodporovaná stránkování.
UnsupportedTimeRange

Nepodporovaný časový rozsah.

Error

Objekt

Chyba

Name Typ Description
code

ErrorCode

ErrorCode
Kódy chyb vysoké úrovně.
details

Error[]

Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError

InnerError

Vnitřní chyba
Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message

string

Chybová zpráva vysoké úrovně.
target

string

Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

ErrorCode

Výčet

ErrorCode

Hodnota Description
Conflict

Představuje kód chyby konfliktu.
Forbidden

Představuje zakázaný kód chyby.
InternalCommunicationFailed

Představuje kód chyby selhání interní komunikace.
InternalServerError

Představuje kód vnitřní chyby serveru.
InvalidArgument

Představuje neplatný kód chyby argumentu.
InvalidRequest

Představuje neplatný kód chyby požadavku.
NotAllowed

Představuje nepovolený kód chyby.
NotFound

Představuje kód chyby nenalezena.
PipelineError

Představuje kód chyby kanálu.
ServiceUnavailable

Představuje kód chyby nedostupné služby.
TooManyRequests

Představuje kód chyby příliš mnoho požadavků.
Unauthorized

Představuje neoprávněný kód chyby.
UnprocessableEntity

Představuje nezpracovaný kód chyby entity.
UnsupportedMediaType

Představuje kód chyby nepodporovaného typu média.

InnerError

Objekt

Vnitřní chyba

Name Typ Description
code

DetailedErrorCode

Podrobný kód chyby
Podrobný výčet kódu chyby
details

object

Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError

InnerError

Vnitřní chyba
Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message

string

Chybová zpráva vysoké úrovně.
target

string

Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

Project

Objekt

Project

Name Typ Description
createdDateTime

string (date-time)

Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální délka povolené hodnoty je 256 znaků a počet povolených položek je 10.
description

string

Popis objektu.
displayName

string

minLength: 1

Zobrazovaný název objektu.
links

ProjectLinks

Odkazy na projekt
locale

string

minLength: 1

Národní prostředí obsažených dat.
properties

ProjectProperties

ProjectVlastnosti
self

string (uri)

Umístění této entity.
Objekt

Odkazy na projekt

Name Typ Description
datasets

string (uri)

Umístění pro získání seznamu všech datových sad tohoto projektu Další podrobnosti najdete v operaci "Projects_ListDatasets".
endpoints

string (uri)

Umístění pro získání seznamu všech koncových bodů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListEndpoints".
evaluations

string (uri)

Umístění pro získání seznamu všech hodnocení tohoto projektu. Další podrobnosti najdete v operaci "Projects_ListEvaluations".
models

string (uri)

Umístění pro získání seznamu všech modelů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListModels".
transcriptions

string (uri)

Umístění pro získání seznamu všech přepisů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListTranscriptions".

ProjectProperties

Objekt

ProjectVlastnosti

Name Typ Description
datasetCount

integer (int32)

Počet datových sad přidružených k tomuto projektu.
endpointCount

integer (int32)

Počet koncových bodů přidružených k tomuto projektu.
evaluationCount

integer (int32)

Počet hodnocení přidružených k tomuto projektu.
modelCount

integer (int32)

Počet modelů přidružených k tomuto projektu.
transcriptionCount

integer (int32)

Počet přepisů přidružených k tomuto projektu