Text Analysis Authoring - Create Project
Erstellt ein neues Projekt oder aktualisiert ein vorhandenes Projekt.
PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Client-API-Version. |
Anforderungstext
Media Types: "application/merge-patch+json"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
language | True |
string |
Die Projektsprache. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
projectKind | True |
Die Projektart. |
|
projectName | True |
string |
Der neue Projektname. |
storageInputContainerName | True |
string |
Der Name des Speichercontainers. |
description |
string |
Die Projektbeschreibung. |
|
multilingual |
boolean |
Gibt an, ob das Projekt für mehrere Sprachen verwendet wird oder nicht. |
|
settings |
Die Projekteinstellungen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Metadaten des aktualisierten Projekts, sofern es bereits vorhanden ist. |
|
201 Created |
Die Metadaten des erstellten Projekts. |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Typ:
apiKey
In:
header
Beispiele
Successful Create Project
Beispielanforderung
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"
}
Beispiel für eine Antwort
{
"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"
}
{
"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"
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Das Fehlerobjekt. |
Error |
Für Menschen lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Inner |
Für Menschen lesbarer Fehlercode. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Die Projektart. |
Text |
Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden. |
Text |
Stellt die Metadaten eines Projekts dar. |
Text |
Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer der vom Server definierten Fehlercodes. |
|
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine für Menschen lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCode
Für Menschen lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
InnerErrorCode
Für Menschen lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer der vom Server definierten Fehlercodes. |
|
details |
object |
Fehlerdetails. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Fehlermeldung. |
target |
string |
Fehlerziel. |
ProjectKind
Die Projektart.
Name | Typ | Beschreibung |
---|---|---|
CustomEntityRecognition |
string |
Zum Erstellen eines Extraktionsmodells zum Identifizieren Ihrer Domänenkategorien mithilfe Ihrer eigenen Daten. |
CustomMultiLabelClassification |
string |
Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe Ihrer eigenen Daten. Jede Datei kann eine oder mehrere Bezeichnungen aufweisen. Beispielsweise wird Datei 1 als A, B und C klassifiziert, und Datei 2 wird als B und C klassifiziert. |
CustomSingleLabelClassification |
string |
Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe Ihrer eigenen Daten. Jede Datei hat nur eine Bezeichnung. Beispielsweise wird Datei 1 als A und Datei 2 als B klassifiziert. |
TextAnalysisAuthoringCreateProjectOptions
Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Die Projektbeschreibung. |
language |
string |
Die Projektsprache. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
multilingual |
boolean |
Gibt an, ob das Projekt für mehrere Sprachen verwendet wird oder nicht. |
projectKind |
Die Projektart. |
|
projectName |
string |
Der neue Projektname. |
settings |
Die Projekteinstellungen. |
|
storageInputContainerName |
string |
Der Name des Speichercontainers. |
TextAnalysisAuthoringProjectMetadata
Stellt die Metadaten eines Projekts dar.
Name | Typ | Beschreibung |
---|---|---|
createdDateTime |
string |
Stellt die Projekterstellung datetime dar. |
description |
string |
Die Projektbeschreibung. |
language |
string |
Die Projektsprache. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
lastDeployedDateTime |
string |
Stellt das Letzte Bereitstellungsdatum des Projekts dar. |
lastModifiedDateTime |
string |
Stellt das Datum der letzten Änderung des Projekts datetime dar. |
lastTrainedDateTime |
string |
Stellt das Letzte Training datetime des Projekts dar. |
multilingual |
boolean |
Gibt an, ob das Projekt für mehrere Sprachen verwendet wird oder nicht. |
projectKind |
Die Projektart. |
|
projectName |
string |
Der neue Projektname. |
settings |
Die Projekteinstellungen. |
|
storageInputContainerName |
string |
Der Name des Speichercontainers. |
TextAnalysisAuthoringProjectSettings
Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
confidenceThreshold |
number |
Der Schwellenwert der Klasse mit der höchsten Zuverlässigkeit, bei der die Vorhersage automatisch in "None" geändert wird. Der Wert des Schwellenwerts sollte zwischen 0 und 1 einschließlich liegen. |