Delen via

Projects - Get

  • Referentie
Service:
Azure AI Services
API-versie:
v3.2-preview.2

Hiermee haalt u het project op dat wordt geïdentificeerd met de opgegeven id.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

De id van het project.

Antwoorden

Name Type Description
200 OK

Project

OK
Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik toevoegt aan het token door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get a project

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
DetailedErrorCode

DetailedErrorCode
Error

Fout
ErrorCode

ErrorCode
InnerError

InnerError
Project

Project
ProjectLinks

ProjectLinks
ProjectProperties

ProjectEigenschappen

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde Description
DataImportFailed

Het importeren van gegevens is mislukt.
DeleteNotAllowed

Verwijderen is niet toegestaan.
DeployNotAllowed

Implementeren is niet toegestaan.
DeployingFailedModel

Het implementeren van een mislukt model.
EmptyRequest

Lege aanvraag.
EndpointCannotBeDefault

Eindpunt kan niet standaard zijn.
EndpointNotUpdatable

Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging

Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris

Het aantal opnamen is overschreden.
FailedDataset

Mislukte gegevensset.
Forbidden

Verboden.
InUseViolation

In gebruiksovertreding.
InaccessibleCustomerStorage

Niet-toegankelijke klantopslag.
InvalidAdaptationMapping

Ongeldige aanpassingstoewijzing.
InvalidBaseModel

Ongeldig basismodel.
InvalidCallbackUri

Ongeldige callback-URI.
InvalidCollection

Ongeldige verzameling.
InvalidDataset

Ongeldige gegevensset.
InvalidDocument

Ongeldig document.
InvalidDocumentBatch

Ongeldige documentbatch.
InvalidLocale

Ongeldige landinstelling.
InvalidLogDate

Ongeldige logboekdatum.
InvalidLogEndTime

Ongeldige eindtijd van logboek.
InvalidLogId

Ongeldige logboek-id.
InvalidLogStartTime

Ongeldige begintijd van logboek.
InvalidModel

Ongeldig model.
InvalidModelUri

Ongeldige model-URI.
InvalidParameter

Ongeldige parameter.
InvalidParameterValue

Ongeldige parameterwaarde.
InvalidPayload

Ongeldige nettolading.
InvalidPermissions

Ongeldige machtigingen.
InvalidPrerequisite

Ongeldige vereiste.
InvalidProductId

Ongeldige product-id.
InvalidProject

Ongeldig project.
InvalidProjectKind

Ongeldige projectsoort.
InvalidRecordingsUri

Ongeldige URI voor opnamen.
InvalidRequestBodyFormat

Ongeldige indeling van aanvraagbody.
InvalidSasValidityDuration

Ongeldige geldigheidsduur sas.
InvalidSkipTokenForLogs

Ongeldig token voor overslaan voor logboeken.
InvalidSourceAzureResourceId

Ongeldige bron-id van Azure-resource.
InvalidSubscription

Ongeldig abonnement.
InvalidTest

Ongeldige test.
InvalidTimeToLive

Ongeldige time to live.
InvalidTopForLogs

Ongeldige bovenkant voor logboeken.
InvalidTranscription

Ongeldige transcriptie.
InvalidWebHookEventKind

Ongeldig soort webhook gebeurtenis.
MissingInputRecords

Ontbrekende invoerrecords.
ModelCopyOperationExists

De kopieerbewerking van het model bestaat.
ModelDeploymentNotCompleteState

De status modelimplementatie is niet voltooid.
ModelDeprecated

Het model is afgeschaft.
ModelExists

Het model bestaat.
ModelMismatch

Model komt niet overeen.
ModelNotDeployable

Het model kan niet worden geïmplementeerd.
ModelVersionIncorrect

Modelversie onjuist.
NoUtf8WithBom

Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset

Slechts één van de URL's of container of gegevensset.
ProjectGenderMismatch

Het geslacht van het project komt niet overeen.
QuotaViolation

Quotumschending.
SingleDefaultEndpoint

Eén standaardeindpunt.
SkuLimitsExist

Er bestaan SKU-limieten.
SubscriptionNotFound

Kan het abonnement niet vinden.
UnexpectedError

Onverwachte fout.
UnsupportedClassBasedAdaptation

Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta

Niet-ondersteunde delta.
UnsupportedDynamicConfiguration

Niet-ondersteunde dynamische configuratie.
UnsupportedFilter

Niet-ondersteund filter.
UnsupportedLanguageCode

Niet-ondersteunde taalcode.
UnsupportedOrderBy

Niet-ondersteunde bestelling door.
UnsupportedPagination

Niet-ondersteunde paginering.
UnsupportedTimeRange

Niet-ondersteund tijdsbereik.

Error

Object

Fout

Name Type Description
code

ErrorCode

ErrorCode
Foutcodes op hoog niveau.
details

Error[]

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message

string

Foutbericht op hoog niveau.
target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Inventarisatie

ErrorCode

Waarde Description
Conflict

Vertegenwoordigt de conflictfoutcode.
Forbidden

Vertegenwoordigt de verboden foutcode.
InternalCommunicationFailed

De foutcode voor de interne communicatie mislukt.
InternalServerError

Vertegenwoordigt de foutcode van de interne serverfout.
InvalidArgument

Vertegenwoordigt de foutcode van het ongeldige argument.
InvalidRequest

Vertegenwoordigt de ongeldige aanvraagfoutcode.
NotAllowed

Vertegenwoordigt de niet-toegestane foutcode.
NotFound

Vertegenwoordigt de foutcode die niet is gevonden.
PipelineError

Vertegenwoordigt de foutcode van de pijplijnfout.
ServiceUnavailable

Vertegenwoordigt de foutcode die niet beschikbaar is voor de service.
TooManyRequests

Vertegenwoordigt de foutcode voor te veel aanvragen.
Unauthorized

Vertegenwoordigt de foutcode voor onbevoegden.
UnprocessableEntity

Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.
UnsupportedMediaType

Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

InnerError

Object

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde foutcode- enum.
details

object

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message

string

Foutbericht op hoog niveau.
target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

Project

Object

Project

Name Type Description
createdDateTime

string (date-time)

De tijdstempel waarop het object is gemaakt. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description

string

De beschrijving van het object.
displayName

string

minLength: 1

De weergavenaam van het object.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

De landinstelling van de opgenomen gegevens.
properties

ProjectProperties

ProjectEigenschappen
self

string (uri)

De locatie van deze entiteit.
Object

ProjectLinks

Name Type Description
datasets

string (uri)

De locatie voor het ophalen van een lijst met alle gegevenssets van dit project. Zie bewerking 'Projects_ListDatasets' voor meer informatie.
endpoints

string (uri)

De locatie voor het ophalen van een lijst met alle eindpunten van dit project. Zie bewerking 'Projects_ListEndpoints' voor meer informatie.
evaluations

string (uri)

De locatie voor het ophalen van een lijst met alle evaluaties van dit project. Zie bewerking 'Projects_ListEvaluations' voor meer informatie.
models

string (uri)

De locatie voor het ophalen van een lijst met alle modellen van dit project. Zie bewerking 'Projects_ListModels' voor meer informatie.
transcriptions

string (uri)

De locatie voor het ophalen van een lijst met alle transcripties van dit project. Zie bewerking 'Projects_ListTranscriptions' voor meer informatie.

ProjectProperties

Object

ProjectEigenschappen

Name Type Description
datasetCount

integer (int32)

Het aantal gegevenssets dat aan dit project is gekoppeld.
endpointCount

integer (int32)

Het aantal eindpunten dat aan dit project is gekoppeld.
evaluationCount

integer (int32)

Het aantal evaluaties dat aan dit project is gekoppeld.
modelCount

integer (int32)

Het aantal modellen dat aan dit project is gekoppeld.
transcriptionCount

integer (int32)

Het aantal transcripties dat aan dit project is gekoppeld.