Text Analysis Authoring - Import

Referenz

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Löst einen Auftrag zum Importieren eines Projekts aus. Wenn bereits ein Projekt mit demselben Namen existiert, werden die Daten dieses Projekts ersetzt.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?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).
projectName	path	True	string	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Stellt die Projektmetadaten dar.
projectFileVersion	True	string	Die Version der exportierten Datei.
stringIndexType	True	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Stellt die Projektressourcen dar.

Antworten

Name	Typ	Beschreibung
202 Accepted		Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird. Headers operation-location: string
Other Status Codes	ErrorResponse	Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure 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 einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von 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 Arbeit, Schule und Gäste, aber keine persönlichen Konten.

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

Scopes

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

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Type: apiKey
In: header

Beispiele

Successful Import Project

Sample Request

HTTP

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

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "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"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

Sample Response

Status code:: 202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen lesbarer Fehlercode.
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.
ProjectKind	Die Projektart.
StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
TextAnalysisAuthoringExportedClass	Stellt eine Klasse eines exportierten Projekts dar.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Stellt ein exportiertes Dokument für ein benutzerdefiniertes Entitätserkennungsprojekt dar.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Stellt die exportierten Ressourcen für ein Entitätserkennungsprojekt dar.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Stellt ein exportiertes Dokument eines benutzerdefinierten Klassifizierungsprojekts mit mehreren Bezeichnungen dar.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Stellt die exportierten Ressourcen für ein benutzerdefiniertes Klassifizierungsprojekt mit mehreren Bezeichnungen dar.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Stellt ein exportiertes Dokument für ein benutzerdefiniertes Klassifizierungsprojekt mit nur einer Bezeichnung dar.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Stellt die exportierten Ressourcen für ein Klassifizierungsprojekt mit nur einer Bezeichnung dar.
TextAnalysisAuthoringExportedDocumentClass	Stellt eine Klassifizierungsbezeichnung für ein Dokument dar.
TextAnalysisAuthoringExportedDocumentEntityLabel	Stellt eine Entitätsbezeichnung für ein Dokument dar.
TextAnalysisAuthoringExportedDocumentRegion	Stellt eine Region in einem Dokument für die Entitätsbezeichnung dar.
TextAnalysisAuthoringExportedEntity	Stellt eine Entität in einem exportierten Projekt dar.
TextAnalysisAuthoringExportedProject	Stellt ein exportiertes Projekt dar.
TextAnalysisAuthoringProjectSettings	Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer der vom Server definierten Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	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	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	InnerErrorCode	Einer der vom Server definierten Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	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.

StringIndexType

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Name	Typ	Beschreibung
Utf16CodeUnit	string	Die Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben ist, die Unicode unterstützt, z. B. Java, JavaScript.

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	ProjectKind	Die Projektart.
projectName	string	Der neue Projektname.
settings	TextAnalysisAuthoringProjectSettings	Die Projekteinstellungen.
storageInputContainerName	string	Der Name des Speichercontainers.

TextAnalysisAuthoringExportedClass

Stellt eine Klasse eines exportierten Projekts dar.

Name	Typ	Beschreibung
category	string	Die Klassenkategorie.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Stellt ein exportiertes Dokument für ein benutzerdefiniertes Entitätserkennungsprojekt dar.

Name	Typ	Beschreibung
dataset	string	Das Dataset für dieses Dokument. Zulässige Werte sind "Train" und "Test".
entities	TextAnalysisAuthoringExportedDocumentRegion[]	Die Liste der Entitätsbezeichnungen, die zum Dokument gehören.
language	string	Stellt die Dokumentsprache dar. 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.
location	string	Der Speicherort des Dokuments im Speicher.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Stellt die exportierten Ressourcen für ein Entitätserkennungsprojekt dar.

Name	Typ	Beschreibung
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Die Liste der Dokumente, die zum Projekt gehören.
entities	TextAnalysisAuthoringExportedEntity[]	Die Liste der Entitäten, die zum Projekt gehören.
projectKind	string: CustomEntityRecognition	Der Typ des Projekts, zu dem die Ressourcen gehören.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Stellt ein exportiertes Dokument eines benutzerdefinierten Klassifizierungsprojekts mit mehreren Bezeichnungen dar.

Name	Typ	Beschreibung
classes	TextAnalysisAuthoringExportedDocumentClass[]	Die Dokumentklassen.
dataset	string	Das Dataset für dieses Dokument. Zulässige Werte sind "Train" und "Test".
language	string	Stellt die Dokumentsprache dar. 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.
location	string	Der Speicherort des Dokuments im Speicher.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Stellt die exportierten Ressourcen für ein benutzerdefiniertes Klassifizierungsprojekt mit mehreren Bezeichnungen dar.

Name	Typ	Beschreibung
classes	TextAnalysisAuthoringExportedClass[]	Die Liste der Klassen im Projekt.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Die Liste der Dokumente im Projekt.
projectKind	string: CustomMultiLabelClassification	Der Typ des Projekts, zu dem die Ressourcen gehören.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Stellt ein exportiertes Dokument für ein benutzerdefiniertes Klassifizierungsprojekt mit nur einer Bezeichnung dar.

Name	Typ	Beschreibung
class	TextAnalysisAuthoringExportedDocumentClass	Die Klasse der Dokumente.
dataset	string	Das Dataset für dieses Dokument. Zulässige Werte sind "Train" und "Test".
language	string	Stellt die Dokumentsprache dar. 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.
location	string	Der Speicherort des Dokuments im Speicher.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Stellt die exportierten Ressourcen für ein Klassifizierungsprojekt mit nur einer Bezeichnung dar.

Name	Typ	Beschreibung
classes	TextAnalysisAuthoringExportedClass[]	Die Liste der Klassen, die zu diesem Projekt gehören.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Die Liste der Dokumente, die zu diesem Projekt gehören.
projectKind	string: CustomSingleLabelClassification	Der Typ des Projekts, zu dem die Ressourcen gehören.

TextAnalysisAuthoringExportedDocumentClass

Stellt eine Klassifizierungsbezeichnung für ein Dokument dar.

Name	Typ	Beschreibung
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Stellt eine Entitätsbezeichnung für ein Dokument dar.

Name	Typ	Beschreibung
category	string	Die Entitätskategorie.
length	integer	Länge für den Entitätstext.
offset	integer	Startposition für den Entitätstext.

TextAnalysisAuthoringExportedDocumentRegion

Stellt eine Region in einem Dokument für die Entitätsbezeichnung dar.

Name	Typ	Beschreibung
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Die Liste der Entitätsbezeichnungen, die zu dieser Region gehören.
regionLength	integer	Länge für den Bereichstext.
regionOffset	integer	Startposition für die Region.

TextAnalysisAuthoringExportedEntity

Stellt eine Entität in einem exportierten Projekt dar.

Name	Typ	Beschreibung
category	string	Die Entitätskategorie.

TextAnalysisAuthoringExportedProject

Stellt ein exportiertes Projekt dar.

Name	Typ	Beschreibung
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Stellt die Projektressourcen dar.
metadata	TextAnalysisAuthoringCreateProjectOptions	Stellt die Projektmetadaten dar.
projectFileVersion	string	Die Version der exportierten Datei.
stringIndexType	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

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.

Share via

Text Analysis Authoring - Import

URI-Parameter

Anforderungstext

Antworten

Sicherheit

AADToken

Hinweise

Scopes

Ocp-Apim-Subscription-Key

Beispiele

Successful Import Project

Sample Request

Sample Response

Definitionen

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject

TextAnalysisAuthoringProjectSettings

Zusätzliche Ressourcen