Text Analysis Authoring - Create Project

Szolgáltatás:

Azure AI Services

API-verzió:

2022-05-01

Létrehoz egy új projektet, vagy frissít egy meglévőt.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (például https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Egy language service-erőforrás előfizetési kulcsa.

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		object	A projekt beállításai.

Válaszok

Name	Típus	Description
200 OK	TextAnalysisAuthoringProjectMetadata	A frissített projekt metaadatai, ha már létezik.
201 Created	TextAnalysisAuthoringProjectMetadata	A létrehozott projekt metaadatai.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Egy language service-erőforrás előfizetési kulcsa.

Típus: apiKey
In: header

Példák

Successful Create Project

Mintakérelem

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2022-05-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
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	A projekt típusa.
TextAnalysisAuthoringCreateProjectOptions	A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.
TextAnalysisAuthoringProjectMetadata	Egy projekt metaadatait jelöli.

Error

Objektum

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

Enumerálás

Ember által olvasható hibakód.

Érték	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Objektum

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Enumerálás

Ember által olvasható hibakód.

Érték	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objektum

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.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

ProjectKind

Enumerálás

A projekt típusa.

Érték	Description
CustomEntityRecognition	Kinyerési modell létrehozásához a saját adataival azonosíthatja a tartománykategóriákat.
CustomMultiLabelClassification	Besorolási modell létrehozása a szöveg saját adatokkal történő besorolásához. Minden fájl egy vagy több címkét tartalmazhat. Az 1. fájl például A, B és C, a 2. fájl pedig B és C besorolású.
CustomSingleLabelClassification	Besorolási modell létrehozása a szöveg saját adatokkal történő besorolásához. Minden fájlnak csak egy címkéje lesz. Az 1. fájl például A, a 2. fájl pedig B besorolású.

TextAnalysisAuthoringCreateProjectOptions

Objektum

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	object	A projekt beállításai.
storageInputContainerName	string	A tároló neve.

TextAnalysisAuthoringProjectMetadata

Objektum

Egy projekt metaadatait jelöli.

Name	Típus	Description
createdDateTime	string (date-time)	A projekt létrehozásának dátumidejét jelöli.
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.
lastDeployedDateTime	string (date-time)	A projekt utolsó üzembehelyezési dátumát jelöli.
lastModifiedDateTime	string (date-time)	A projekt utolsó módosítási dátumidejét jelöli.
lastTrainedDateTime	string (date-time)	A projekt utolsó betanítási dátumidejét jelöli.
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	object	A projekt beállításai.
storageInputContainerName	string	A tároló neve.