Text Analysis Authoring - Import

Referenz

Dienst:: Azure AI Services

API-Version:: 2022-05-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=2022-05-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 maxLength: 100	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Ein Abonnementschlüssel für eine Sprachdienstressource.

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 Zeichenfolgenversatzen 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. Header 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.

Header

operation-location: string

Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful Import Project

Beispielanforderung

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:import?api-version=2022-05-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
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
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	Die Projektart.
StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen 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 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.
TextAnalysisAuthoringExportedDocumentRegion	Stellt einen Bereich 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.

Error

Objekt

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

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objekt

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

Enumeration

Die Projektart.

Wert	Beschreibung
CustomEntityRecognition	Um ein Extraktionsmodell zu erstellen, um Ihre Domänenkategorien mithilfe Ihrer eigenen Daten zu identifizieren.
CustomMultiLabelClassification	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	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.

StringIndexType

Enumeration

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

Wert	Beschreibung
Utf16CodeUnit	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.

TextAnalysisAuthoringCreateProjectOptions

Objekt

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	object	Die Projekteinstellungen.
storageInputContainerName	string	Der Name des Speichercontainers.

TextAnalysisAuthoringExportedClass

Objekt

Stellt eine Klasse eines exportierten Projekts dar.

Name	Typ	Beschreibung
category	string	Die Klassenkategorie.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Objekt

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

Objekt

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

Objekt

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

Objekt

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

Objekt

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

Objekt

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	Der Typ des Projekts, zu dem die Ressourcen gehören.

TextAnalysisAuthoringExportedDocumentClass

Objekt

Stellt eine Klassifizierungsbezeichnung für ein Dokument dar.

Name	Typ	Beschreibung
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Objekt

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

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

TextAnalysisAuthoringExportedDocumentRegion

Objekt

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 (int32)	Länge für den Bereichstext.
regionOffset	integer (int32)	Startposition für den Bereich.

TextAnalysisAuthoringExportedEntity

Objekt

Stellt eine Entität in einem exportierten Projekt dar.

Name	Typ	Beschreibung
category	string	Die Entitätskategorie.

TextAnalysisAuthoringExportedProject

Objekt

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 Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Freigeben über

Text Analysis Authoring - Import

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Successful Import Project

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject