Text Analysis Authoring - Create Project

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Új projektet hoz létre, vagy egy meglévőt frissít.

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	Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verziója.

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-es reprezentációja. Használhatja például az "en" szót az angolhoz, az "en-gb" szót az angolhoz (UK), az "es" szót a spanyolhoz stb.
projectKind	True	ProjectKind	A projekt típusa.
projectName	True	string	Az új projekt neve.
storageInputContainerName	True	string	A tároló neve.
description		string	A projekt leírása.
multilingual		boolean	Azt határozza meg, hogy a projekt több nyelvhez is használható-e.
settings		TextAnalysisAuthoringProjectSettings	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

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Egy nyelvi szolgáltatási erőforrás előfizetői kulcsa.

Type: apiKey
In: header

Példák

Successful Create Project

Sample Request

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

Sample Response

Status code:: 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"
}

Status code:: 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	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas hibakód.
InnerErrorModel	Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : 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.
TextAnalysisAuthoringProjectSettings	A projekt viselkedésének meghatározásához használt beállításokat jelöli.

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 emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCode

Emberi olvasásra alkalmas 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

Emberi olvasásra alkalmas hibakód.

Name	Típus	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : 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

A projekt típusa.

Name	Típus	Description
CustomEntityRecognition	string	Kinyerési modell létrehozásához a tartománykategóriák saját adatokkal történő azonosításához.
CustomMultiLabelClassification	string	Besorolási modell létrehozásához 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	string	Besorolási modell létrehozásához 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.