Dela via

Projects - Get

  • Referens
Tjänst:
Azure AI Services
API-version:
v3.2-preview.2

Hämtar projektet som identifieras av det angivna ID:t.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

Identifieraren för projektet.

Svar

Name Typ Description
200 OK

Project

OK
Other Status Codes

Error

Ett fel uppstod.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Get a project

Exempelbegäran

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

Exempelsvar

Statuskod:
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"
}

Definitioner

Name Description
DetailedErrorCode

DetailedErrorCode
Error

Fel
ErrorCode

Felkod
InnerError

InnerError
Project

Projekt
ProjectLinks

ProjectLinks
ProjectProperties

ProjectProperties

DetailedErrorCode

Uppräkning

DetailedErrorCode

Värde Description
DataImportFailed

Dataimporten misslyckades.
DeleteNotAllowed

Ta bort tillåts inte.
DeployNotAllowed

Distribution tillåts inte.
DeployingFailedModel

Distribution av en misslyckad modell.
EmptyRequest

Tom begäran.
EndpointCannotBeDefault

Slutpunkten kan inte vara standard.
EndpointNotUpdatable

Slutpunkten kan inte uppdateras.
EndpointWithoutLogging

Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris

Överskred antalet inspelningar uris.
FailedDataset

Datauppsättningen misslyckades.
Forbidden

Förbjuden.
InUseViolation

Vid användningsöverträdelse.
InaccessibleCustomerStorage

Otillgänglig kundlagring.
InvalidAdaptationMapping

Ogiltig anpassningsmappning.
InvalidBaseModel

Ogiltig basmodell.
InvalidCallbackUri

Ogiltig återanrops-URI.
InvalidCollection

Ogiltig samling.
InvalidDataset

Ogiltig datauppsättning.
InvalidDocument

Ogiltigt dokument.
InvalidDocumentBatch

Ogiltig dokumentbatch.
InvalidLocale

Ogiltigt språk.
InvalidLogDate

Ogiltigt loggdatum.
InvalidLogEndTime

Ogiltig loggsluttid.
InvalidLogId

Ogiltigt logg-ID.
InvalidLogStartTime

Ogiltig starttid för loggen.
InvalidModel

Ogiltig modell.
InvalidModelUri

Ogiltig modell-URI.
InvalidParameter

Ogiltig parameter.
InvalidParameterValue

Ogiltigt parametervärde.
InvalidPayload

Ogiltig nyttolast.
InvalidPermissions

Ogiltiga behörigheter.
InvalidPrerequisite

Ogiltigt krav.
InvalidProductId

Ogiltigt produkt-ID.
InvalidProject

Ogiltigt projekt.
InvalidProjectKind

Ogiltig projekttyp.
InvalidRecordingsUri

Ogiltig inspelnings-URI.
InvalidRequestBodyFormat

Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration

Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs

Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId

Ogiltigt azure-källresurs-ID.
InvalidSubscription

Ogiltig prenumeration.
InvalidTest

Ogiltigt test.
InvalidTimeToLive

Ogiltig tid att leva.
InvalidTopForLogs

Ogiltig topp för loggar.
InvalidTranscription

Ogiltig transkription.
InvalidWebHookEventKind

Ogiltig typ av webbhookhändelse.
MissingInputRecords

Indataposter saknas.
ModelCopyOperationExists

Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState

Modelldistributionen har inte slutförts.
ModelDeprecated

Modellen är inaktuell.
ModelExists

Modellen finns.
ModelMismatch

Modellmatchningsfel.
ModelNotDeployable

Modellen kan inte distribueras.
ModelVersionIncorrect

Modellversionen är felaktig.
NoUtf8WithBom

Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset

Endast en av url:erna eller containern eller datamängden.
ProjectGenderMismatch

Matchningsfel för projektkön.
QuotaViolation

Kvotöverträdelse.
SingleDefaultEndpoint

Enskild standardslutpunkt.
SkuLimitsExist

Det finns SKU-gränser.
SubscriptionNotFound

Det går inte att hitta prenumerationen.
UnexpectedError

Oväntat fel.
UnsupportedClassBasedAdaptation

Klassbaserad anpassning som inte stöds.
UnsupportedDelta

Delta stöds inte.
UnsupportedDynamicConfiguration

Dynamisk konfiguration stöds inte.
UnsupportedFilter

Filter som inte stöds.
UnsupportedLanguageCode

Språkkod som inte stöds.
UnsupportedOrderBy

Order som inte stöds av.
UnsupportedPagination

Sidnumrering stöds inte.
UnsupportedTimeRange

Tidsintervall som inte stöds.

Error

Objekt

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder på hög nivå.
details

Error[]

Ytterligare stödjande information om fel och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Uppräkning

Felkod

Värde Description
Conflict

Representerar konfliktfelkoden.
Forbidden

Representerar den otillåtna felkoden.
InternalCommunicationFailed

Det gick inte att ange felkoden för intern kommunikation.
InternalServerError

Representerar felkoden för den interna servern.
InvalidArgument

Representerar den ogiltiga argumentfelkoden.
InvalidRequest

Representerar den ogiltiga felkoden för begäran.
NotAllowed

Representerar den felkod som inte tillåts.
NotFound

Representerar felkoden som inte hittades.
PipelineError

Representerar felkoden för pipelinefel.
ServiceUnavailable

Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests

Representerar felkoden för för många begäranden.
Unauthorized

Representerar den obehöriga felkoden.
UnprocessableEntity

Representerar felkoden för entitetsfel som inte kan bearbetas.
UnsupportedMediaType

Representerar felkoden för medietypen som inte stöds.

InnerError

Objekt

InnerError

Name Typ Description
code

DetailedErrorCode

DetailedErrorCode
Detaljerad felkodsuppräkning.
details

object

Ytterligare stödjande information om fel och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

Project

Objekt

Projekt

Name Typ Description
createdDateTime

string (date-time)

Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description

string

Beskrivningen av objektet.
displayName

string

minLength: 1

Objektets visningsnamn.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

Nationella inställningar för inneslutna data.
properties

ProjectProperties

ProjectProperties
self

string (uri)

Platsen för den här entiteten.
Objekt

ProjectLinks

Name Typ Description
datasets

string (uri)

Platsen där du kan hämta en lista över alla datauppsättningar i det här projektet. Mer information finns i åtgärden "Projects_ListDatasets".
endpoints

string (uri)

Platsen där du kan hämta en lista över alla slutpunkter i det här projektet. Mer information finns i åtgärden "Projects_ListEndpoints".
evaluations

string (uri)

Platsen där du kan hämta en lista över alla utvärderingar av det här projektet. Mer information finns i åtgärden "Projects_ListEvaluations".
models

string (uri)

Platsen där du kan hämta en lista över alla modeller i det här projektet. Mer information finns i åtgärden "Projects_ListModels".
transcriptions

string (uri)

Platsen där du kan hämta en lista över alla transkriptioner av det här projektet. Mer information finns i åtgärden "Projects_ListTranscriptions".

ProjectProperties

Objekt

ProjectProperties

Name Typ Description
datasetCount

integer (int32)

Antalet datauppsättningar som är associerade med det här projektet.
endpointCount

integer (int32)

Antalet slutpunkter som är associerade med det här projektet.
evaluationCount

integer (int32)

Antalet utvärderingar som är kopplade till det här projektet.
modelCount

integer (int32)

Antalet modeller som är associerade med det här projektet.
transcriptionCount

integer (int32)

Antalet transkriptioner som är associerade med det här projektet.