Text Analysis Authoring - Create Project

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2023-04-01

Az erőforrásra vonatkozó legalapvetőbb művelet.

PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string url	Támogatott Cognitive Services-végpont (például https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Az új projektnév.
api-version	query	True	string	A művelethez használni kívánt API-verzió.

Kérelem törzse

Media Types: "application/merge-patch+json"

Name	Kötelező	Típus	Description
language	True	string	A projekt nyelve. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
projectKind	True	ProjectKind	A projekt típusa.
projectName	True	string	Az új projektnév.
storageInputContainerName	True	string	A tároló neve.
description		string	A projekt leírása.
multilingual		boolean	Azt jelzi, hogy a projekt több nyelvre is használható-e.
settings		ProjectSettings	A projekt beállításai.

Válaszok

Name	Típus	Description
200 OK	TextAnalysisAuthoringProjectMetadata	A kérés sikeres volt.
201 Created	TextAnalysisAuthoringProjectMetadata	A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

Name	Description
https://cognitiveservices.azure.com/.default

Példák

Successful Create Project

Mintakérelem

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

Mintaválasz

Állapotkód:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

Állapotkód:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

Definíciók

Name	Description
CreateProjectOptions	A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	A projekt viselkedésének meghatározásához használt beállításokat jelöli.
TextAnalysisAuthoringProjectMetadata	Egy projekt metaadatait jelöli.

CreateProjectOptions

A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.

Name	Típus	Description
description	string	A projekt leírása.
language	string	A projekt nyelve. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
multilingual	boolean	Azt jelzi, hogy a projekt több nyelvre is használható-e.
projectKind	ProjectKind	A projekt típusa.
projectName	string	Az új projektnév.
settings	ProjectSettings	A projekt beállításai.
storageInputContainerName	string	A tároló neve.

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Ember által olvasható hibakód.

Name	Típus	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode