Text Analysis Authoring - Import

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2023-04-01

Wyzwala zadanie importowania projektu. Jeśli projekt o tej samej nazwie już istnieje, dane tego projektu zostaną zastąpione.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string url	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
metadata	True	CreateProjectOptions	Reprezentuje metadane projektu.
projectFileVersion	True	string	Wersja wyeksportowanego pliku.
stringIndexType	True	StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Reprezentuje zasoby projektu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Nagłówki Operation-Location: string
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

202 Accepted

Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Nagłówki

Operation-Location: string

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

SuccessfulImportProject

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 202

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

Definicje

Nazwa	Opis
CreateProjectOptions	Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
ExportedProject	Reprezentuje wyeksportowany projekt.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	Reprezentuje ustawienia używane do definiowania zachowania projektu.
StringIndexType
TextAnalysisAuthoringExportedClass	Reprezentuje klasę wyeksportowanego projektu.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Reprezentuje wyeksportowany dokument dla niestandardowego projektu rozpoznawania jednostek.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Reprezentuje wyeksportowane zasoby dla projektu rozpoznawania jednostek.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Reprezentuje wyeksportowany dokument niestandardowego projektu klasyfikacji z wieloma etykietami.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Reprezentuje wyeksportowane zasoby dla niestandardowego projektu klasyfikacji z wieloma etykietami.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Reprezentuje wyeksportowany dokument dla niestandardowego projektu klasyfikacji z jedną etykietą.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Reprezentuje wyeksportowane zasoby dla projektu klasyfikacji z jedną etykietą.
TextAnalysisAuthoringExportedDocumentClass	Reprezentuje etykietę klasyfikacji dla dokumentu.
TextAnalysisAuthoringExportedDocumentEntityLabel	Reprezentuje etykietę jednostki dla dokumentu.
TextAnalysisAuthoringExportedDocumentEntityRegion	Reprezentuje region w dokumencie na potrzeby etykietowania jednostek.
TextAnalysisAuthoringExportedEntity	Reprezentuje jednostkę w wyeksportowanym projekcie.

CreateProjectOptions

Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.

Nazwa	Typ	Opis
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
multilingual	boolean	Czy projekt będzie używany w wielu językach, czy nie.
projectKind	ProjectKind	Rodzaj projektu.
projectName	string	Nowa nazwa projektu.
settings	ProjectSettings	Ustawienia projektu.
storageInputContainerName	string	Nazwa kontenera magazynu.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

ExportedProject

Reprezentuje wyeksportowany projekt.

Nazwa	Typ	Opis
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Reprezentuje zasoby projektu.
metadata	CreateProjectOptions	Reprezentuje metadane projektu.
projectFileVersion	string	Wersja wyeksportowanego pliku.
stringIndexType	StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ProjectKind

Nazwa	Typ	Opis
CustomEntityRecognition	string	Aby sbudować model wyodrębniania w celu zidentyfikowania kategorii domen przy użyciu własnych danych.
CustomMultiLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik może mieć jedną lub wiele etykiet. Na przykład plik 1 jest klasyfikowany jako A, B i C, a plik 2 jest klasyfikowany jako B i C.
CustomSingleLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik będzie miał tylko jedną etykietę. Na przykład plik 1 jest klasyfikowany jako A, a plik 2 jest klasyfikowany jako B.

ProjectSettings

Reprezentuje ustawienia używane do definiowania zachowania projektu.

Nazwa	Typ	Opis
confidenceThreshold	number	Próg klasy o najwyższym ufności, przy którym przewidywanie zostanie automatycznie zmienione na "Brak". Wartość progu powinna należeć do przedziału od 0 do 1 włącznie.

StringIndexType

Nazwa	Typ	Opis
Utf16CodeUnit	string	Wartości przesunięcia i długości odpowiadają jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

TextAnalysisAuthoringExportedClass

Reprezentuje klasę wyeksportowanego projektu.

Nazwa	Typ	Opis
category	string	Kategoria klasy.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Reprezentuje wyeksportowany dokument dla niestandardowego projektu rozpoznawania jednostek.

Nazwa	Typ	Opis
dataset	string	Zestaw danych dla tego dokumentu. Dozwolone wartości to "Train" (Trenowanie) i "Test".
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Lista etykiet jednostek należących do dokumentu.
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Lokalizacja dokumentu w magazynie.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Reprezentuje wyeksportowane zasoby dla projektu rozpoznawania jednostek.

Nazwa	Typ	Opis
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Lista dokumentów należących do projektu.
entities	TextAnalysisAuthoringExportedEntity[]	Lista jednostek należących do projektu.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Reprezentuje wyeksportowany dokument niestandardowego projektu klasyfikacji z wieloma etykietami.

Nazwa	Typ	Opis
classes	TextAnalysisAuthoringExportedDocumentClass[]	Klasy dokumentów.
dataset	string	Zestaw danych dla tego dokumentu. Dozwolone wartości to "Train" (Trenowanie) i "Test".
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Lokalizacja dokumentu w magazynie.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Reprezentuje wyeksportowane zasoby dla niestandardowego projektu klasyfikacji z wieloma etykietami.

Nazwa	Typ	Opis
classes	TextAnalysisAuthoringExportedClass[]	Lista klas w projekcie.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Lista dokumentów w projekcie.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Reprezentuje wyeksportowany dokument dla niestandardowego projektu klasyfikacji z jedną etykietą.

Nazwa	Typ	Opis
class	TextAnalysisAuthoringExportedDocumentClass	Klasa dokumentów.
dataset	string	Zestaw danych dla tego dokumentu. Dozwolone wartości to "Train" (Trenowanie) i "Test".
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Lokalizacja dokumentu w magazynie.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Reprezentuje wyeksportowane zasoby dla projektu klasyfikacji z jedną etykietą.

Nazwa	Typ	Opis
classes	TextAnalysisAuthoringExportedClass[]	Lista klas należących do tego projektu.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Lista dokumentów należących do tego projektu.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Reprezentuje etykietę klasyfikacji dla dokumentu.

Nazwa	Typ	Opis
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Reprezentuje etykietę jednostki dla dokumentu.

Nazwa	Typ	Opis
category	string	Kategoria jednostki.
length	integer	Długość tekstu jednostki.
offset	integer	Pozycja początkowa dla tekstu jednostki.

TextAnalysisAuthoringExportedDocumentEntityRegion

Reprezentuje region w dokumencie na potrzeby etykietowania jednostek.

Nazwa	Typ	Opis
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Lista etykiet jednostek należących do tego regionu.
regionLength	integer	Długość tekstu regionu.
regionOffset	integer	Pozycja początkowa dla regionu.

TextAnalysisAuthoringExportedEntity

Reprezentuje jednostkę w wyeksportowanym projekcie.

Nazwa	Typ	Opis
category	string	Kategoria jednostki.

Udostępnij za pośrednictwem

Text Analysis Authoring - Import

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

OAuth2Auth

Zakresy

Przykłady

SuccessfulImportProject

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Dodatkowe zasoby