Text Analysis Authoring - Import

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Löst einen Auftrag aus, um ein Projekt zu importieren. Wenn bereits ein Projekt mit demselben Namen vorhanden ist, 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 url	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	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

SuccessfulImportProject

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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
CreateProjectOptions	Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
ExportedProject	Stellt ein exportiertes Projekt dar.
InnerErrorCode	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
ProjectSettings	Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.
StringIndexType
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 Multibezeichnungsklassifizierungsprojekts dar.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Stellt die exportierten Ressourcen für ein benutzerdefiniertes Klassifizierungsprojekt mit mehreren Bezeichnungen dar.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Stellt ein exportiertes Dokument für ein benutzerdefiniertes Einbezeichnungsklassifizierungsprojekt dar.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Stellt die exportierten Ressourcen für ein Einbezeichnungsklassifizierungsprojekt dar.
TextAnalysisAuthoringExportedDocumentClass	Stellt eine Klassifizierungsbezeichnung für ein Dokument dar.
TextAnalysisAuthoringExportedDocumentEntityLabel	Stellt eine Entitätsbezeichnung für ein Dokument dar.
TextAnalysisAuthoringExportedDocumentEntityRegion	Stellt einen Bereich in einem Dokument für die Entitätsbezeichnung dar.
TextAnalysisAuthoringExportedEntity	Stellt eine Entität in einem exportierten Projekt dar.

CreateProjectOptions

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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "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	ProjectSettings	Die Projekteinstellungen.
storageInputContainerName	string	Der Name des Speichercontainers.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von 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 lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

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.

ExportedProject

Stellt ein exportiertes Projekt dar.

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

InnerErrorCode

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	Eine serverdefinierte Gruppe von 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

Name	Typ	Beschreibung
CustomEntityRecognition	string	Um ein Extraktionsmodell zu erstellen, um Ihre Domänenkategorien mithilfe Ihrer eigenen Daten zu identifizieren.
CustomMultiLabelClassification	string	Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe ihrer eigenen Daten. Jede Datei kann über eine oder mehrere Bezeichnungen verfügen. Beispielsweise wird Datei 1 als A, B und C klassifiziert und Datei 2 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. Die Datei 1 wird beispielsweise als A klassifiziert, und Datei 2 wird als B klassifiziert.

ProjectSettings

Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.

Name	Typ	Beschreibung
confidenceThreshold	number	Der Schwellenwert der Klasse mit der höchsten Konfidenz, bei der die Vorhersage automatisch in "Keine" geändert wird. Der Wert des Schwellenwerts sollte zwischen 0 und einschließlich 1 liegen.

StringIndexType

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 wird, die Unicode unterstützt, z. B. JavaScript.

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	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Die Liste der Entitätsbezeichnungen, die zum Dokument gehören.
language	string	Stellt die Dokumentsprache dar. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "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

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Stellt ein exportiertes Dokument eines benutzerdefinierten Multibezeichnungsklassifizierungsprojekts 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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "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

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Stellt ein exportiertes Dokument für ein benutzerdefiniertes Einbezeichnungsklassifizierungsprojekt 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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "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 Einbezeichnungsklassifizierungsprojekt 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

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.

TextAnalysisAuthoringExportedDocumentEntityRegion

Stellt einen Bereich 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 den Bereich.

TextAnalysisAuthoringExportedEntity

Stellt eine Entität in einem exportierten Projekt dar.

Name	Typ	Beschreibung
category	string	Die Entitätskategorie.

Freigeben über

Text Analysis Authoring - Import

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

SuccessfulImportProject

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Zusätzliche Ressourcen