Text Analysis Authoring - Import

Služba:

Azure AI Services

Verze rozhraní API:

2023-04-01

Aktivuje úlohu pro import projektu. Pokud projekt se stejným názvem již existuje, nahradí se data tohoto projektu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string url	Podporovaný koncový bod služeb Cognitive Services, například https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Představuje metadata projektu.
projectFileVersion	True	string	Verze exportovaného souboru.
stringIndexType	True	StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Představuje prostředky projektu.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

SuccessfulImportProject

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
ExportedProject	Představuje exportovaný projekt.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	Představuje nastavení použitá k definování chování projektu.
StringIndexType
TextAnalysisAuthoringCreateProjectOptions	Představuje možnosti použité k vytvoření nebo aktualizaci projektu.
TextAnalysisAuthoringExportedClass	Představuje třídu exportovaného projektu.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Představuje exportovaný dokument pro projekt rozpoznávání vlastních entit.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Představuje exportované prostředky pro projekt rozpoznávání entit.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Představuje exportovaný dokument vlastního projektu klasifikace s více popisky.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Představuje exportované prostředky pro vlastní projekt klasifikace s více popisky.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Představuje exportovaný dokument pro vlastní projekt klasifikace s jedním popiskem.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Představuje exportované prostředky pro projekt klasifikace s jedním popiskem.
TextAnalysisAuthoringExportedDocumentClass	Představuje popisek klasifikace dokumentu.
TextAnalysisAuthoringExportedDocumentEntityLabel	Představuje popisek entity pro dokument.
TextAnalysisAuthoringExportedDocumentEntityRegion	Představuje oblast v dokumentu pro označování entit.
TextAnalysisAuthoringExportedEntity	Představuje entitu v exportovaného projektu.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelné člověkem

Name	Typ	Description
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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

ExportedProject

Představuje exportovaný projekt.

Name	Typ	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Představuje prostředky projektu.
metadata	TextAnalysisAuthoringCreateProjectOptions	Představuje metadata projektu.
projectFileVersion	string	Verze exportovaného souboru.
stringIndexType	StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

InnerErrorCode

Kód chyby čitelné člověkem

Name	Typ	Description
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

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Zpráva o chybě.
target	string	Cíl chyby

ProjectKind

Name	Typ	Description
CustomEntityRecognition	string	Pro vytvoření modelu extrakce pro identifikaci kategorií domény pomocí vlastních dat.
CustomMultiLabelClassification	string	Vytvoření klasifikačního modelu pro klasifikaci textu pomocí vlastních dat Každý soubor může mít jeden nebo více popisků. Například soubor 1 je klasifikován jako A, B a C a soubor 2 je klasifikován jako B a C.
CustomSingleLabelClassification	string	Vytvoření klasifikačního modelu pro klasifikaci textu pomocí vlastních dat Každý soubor bude mít jenom jeden popisek. Například soubor 1 je klasifikován jako A a soubor 2 je klasifikován jako B.

ProjectSettings

Představuje nastavení použitá k definování chování projektu.

Name	Typ	Description
confidenceThreshold	number	Prahová hodnota třídy s nejvyšší jistotou, při které se předpověď automaticky změní na None( Žádné). Hodnota prahové hodnoty by měla být v rozmezí od 0 do 1 včetně.

StringIndexType

Name	Typ	Description
Utf16CodeUnit	string	Hodnoty posunu a délky budou odpovídat jednotkám kódu UTF-16. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje Unicode, například JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Představuje možnosti použité k vytvoření nebo aktualizaci projektu.

Name	Typ	Description
description	string	Popis projektu.
language	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
multilingual	boolean	Bez ohledu na to, jestli se projekt použije pro více jazyků, nebo ne.
projectKind	ProjectKind	Druh projektu.
projectName	string	Název nového projektu.
settings	ProjectSettings	Nastavení projektu.
storageInputContainerName	string	Název kontejneru úložiště.

TextAnalysisAuthoringExportedClass

Představuje třídu exportovaného projektu.

Name	Typ	Description
category	string	Kategorie třídy.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Představuje exportovaný dokument pro projekt rozpoznávání vlastních entit.

Name	Typ	Description
dataset	string	Datová sada pro tento dokument. Povolené hodnoty jsou Train a Test.
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Seznam popisků entit patřících do dokumentu
language	string	Představuje jazyk dokumentu. Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
location	string	Umístění dokumentu v úložišti.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Představuje exportované prostředky pro projekt rozpoznávání entit.

Name	Typ	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Seznam dokumentů, které patří do projektu.
entities	TextAnalysisAuthoringExportedEntity[]	Seznam entit, které patří do projektu.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Představuje exportovaný dokument vlastního projektu klasifikace s více popisky.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	Třídy dokumentů.
dataset	string	Datová sada pro tento dokument. Povolené hodnoty jsou Train a Test.
language	string	Představuje jazyk dokumentu. Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
location	string	Umístění dokumentu v úložišti.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Představuje exportované prostředky pro vlastní projekt klasifikace s více popisky.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedClass[]	Seznam tříd v projektu.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Seznam dokumentů v projektu
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Představuje exportovaný dokument pro vlastní projekt klasifikace s jedním popiskem.

Name	Typ	Description
class	TextAnalysisAuthoringExportedDocumentClass	Třída dokumentů.
dataset	string	Datová sada pro tento dokument. Povolené hodnoty jsou Train a Test.
language	string	Představuje jazyk dokumentu. Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
location	string	Umístění dokumentu v úložišti.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Představuje exportované prostředky pro projekt klasifikace s jedním popiskem.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedClass[]	Seznam tříd, které patří do tohoto projektu.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Seznam dokumentů patřících k tomuto projektu.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Představuje popisek klasifikace dokumentu.

Name	Typ	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Představuje popisek entity pro dokument.

Name	Typ	Description
category	string	Kategorie entity.
length	integer	Délka textu entity
offset	integer	Počáteční pozice textu entity

TextAnalysisAuthoringExportedDocumentEntityRegion

Představuje oblast v dokumentu pro označování entit.

Name	Typ	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Seznam popisků entit patřících do této oblasti
regionLength	integer	Délka textu oblasti
regionOffset	integer	Počáteční pozice pro oblast.

TextAnalysisAuthoringExportedEntity

Představuje entitu v exportovaného projektu.

Name	Typ	Description
category	string	Kategorie entity.