Dela via

Projects - Create

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

Skapar ett nytt projekt.

POST {endpoint}/speechtotext/v3.2-preview.2/projects

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).

Begärandetext

Name Obligatorisk Typ Description
displayName True

string

minLength: 1

Objektets visningsnamn.
locale True

string

minLength: 1

Nationella inställningar för inneslutna data.
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.

Svar

Name Typ Description
201 Created

Project

Svaret innehåller information om entiteten som nyttolast och dess plats som rubrik.

Sidhuvuden

Location: string
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

Create a project

Exempelbegäran

POST {endpoint}/speechtotext/v3.2-preview.2/projects

{
  "locale": "en-US",
  "displayName": "My speech project"
}

Exempelsvar

Statuskod:
201 
{
  "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
InvalidParameterValue

Ogiltigt parametervärde.
InvalidRequestBodyFormat

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

Tom begäran.
MissingInputRecords

Indataposter saknas.
InvalidDocument

Ogiltigt dokument.
ModelVersionIncorrect

Modellversionen är felaktig.
InvalidDocumentBatch

Ogiltig dokumentbatch.
UnsupportedLanguageCode

Språkkod som inte stöds.
DataImportFailed

Dataimporten misslyckades.
InUseViolation

Vid användningsöverträdelse.
InvalidLocale

Ogiltigt språk.
InvalidBaseModel

Ogiltig basmodell.
InvalidAdaptationMapping

Ogiltig anpassningsmappning.
InvalidDataset

Ogiltig datauppsättning.
InvalidTest

Ogiltigt test.
FailedDataset

Datauppsättningen misslyckades.
InvalidModel

Ogiltig modell.
InvalidTranscription

Ogiltig transkription.
InvalidPayload

Ogiltig nyttolast.
InvalidParameter

Ogiltig parameter.
EndpointWithoutLogging

Slutpunkt utan loggning.
InvalidPermissions

Ogiltiga behörigheter.
InvalidPrerequisite

Ogiltigt krav.
InvalidProductId

Ogiltigt produkt-ID.
InvalidSubscription

Ogiltig prenumeration.
InvalidProject

Ogiltigt projekt.
InvalidProjectKind

Ogiltig projekttyp.
InvalidRecordingsUri

Ogiltig inspelnings-URI.
OnlyOneOfUrlsOrContainerOrDataset

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

Överskred antalet inspelningar uris.
ModelMismatch

Modellmatchningsfel.
ProjectGenderMismatch

Matchningsfel för projektkön.
ModelDeprecated

Modellen är inaktuell.
ModelExists

Modellen finns.
ModelNotDeployable

Modellen kan inte distribueras.
EndpointNotUpdatable

Slutpunkten kan inte uppdateras.
SingleDefaultEndpoint

Enskild standardslutpunkt.
EndpointCannotBeDefault

Slutpunkten kan inte vara standard.
InvalidModelUri

Ogiltig modell-URI.
SubscriptionNotFound

Det går inte att hitta prenumerationen.
QuotaViolation

Kvotöverträdelse.
UnsupportedDelta

Delta stöds inte.
UnsupportedFilter

Filter som inte stöds.
UnsupportedPagination

Sidnumrering stöds inte.
UnsupportedDynamicConfiguration

Dynamisk konfiguration stöds inte.
UnsupportedOrderBy

Order som inte stöds av.
NoUtf8WithBom

Ingen utf8 med bom.
ModelDeploymentNotCompleteState

Modelldistributionen har inte slutförts.
SkuLimitsExist

Det finns SKU-gränser.
DeployingFailedModel

Distribution av en misslyckad modell.
UnsupportedTimeRange

Tidsintervall som inte stöds.
InvalidLogDate

Ogiltigt loggdatum.
InvalidLogId

Ogiltigt logg-ID.
InvalidLogStartTime

Ogiltig starttid för loggen.
InvalidLogEndTime

Ogiltig loggsluttid.
InvalidTopForLogs

Ogiltig topp för loggar.
InvalidSkipTokenForLogs

Ogiltig hopptoken för loggar.
DeleteNotAllowed

Ta bort tillåts inte.
Forbidden

Förbjuden.
DeployNotAllowed

Distribution tillåts inte.
UnexpectedError

Oväntat fel.
InvalidCollection

Ogiltig samling.
InvalidCallbackUri

Ogiltig återanrops-URI.
InvalidSasValidityDuration

Ogiltig varaktighet för sas-giltighet.
InaccessibleCustomerStorage

Otillgänglig kundlagring.
UnsupportedClassBasedAdaptation

Klassbaserad anpassning som inte stöds.
InvalidWebHookEventKind

Ogiltig typ av webbhookhändelse.
InvalidTimeToLive

Ogiltig tid att leva.
InvalidSourceAzureResourceId

Ogiltigt azure-källresurs-ID.
ModelCopyOperationExists

Modellkopieringsåtgärden finns.

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
InvalidRequest

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

Representerar den ogiltiga argumentfelkoden.
InternalServerError

Representerar felkoden för den interna servern.
ServiceUnavailable

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

Representerar felkoden som inte hittades.
PipelineError

Representerar felkoden för pipelinefel.
Conflict

Representerar konfliktfelkoden.
InternalCommunicationFailed

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

Representerar den otillåtna felkoden.
NotAllowed

Representerar den felkod som inte tillåts.
Unauthorized

Representerar den obehöriga felkoden.
UnsupportedMediaType

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

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

Representerar felkoden för entitetsfel som inte kan bearbetas.

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.