Text Analysis Authoring - Import

Szolgáltatás:: Azure AI Services

API-verzió:: 2022-05-01

Elindít egy feladatot egy projekt importálásához. Ha már létezik ilyen nevű projekt, a program lecseréli a projekt adatait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services végpont (például https:// resource-name.api.cognitiveservices.azure.com<>).
projectName	path	True	string maxLength: 100	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Nyelvi szolgáltatási erőforrás előfizetési kulcsa.

Kérelem törzse

Name	Kötelező	Típus	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	A projekt metaadatait jelöli.
projectFileVersion	True	string	Az exportált fájl verziója.
stringIndexType	True	StringIndexType	A sztringeltolások értelmezéséhez használt metódust adja meg. További információ: https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	A projekt eszközeit jelöli.

Válaszok

Name	Típus	Description
202 Accepted		Egy sikeres hívás eredményeként egy Művelet-hely fejlécet kapunk, amely a feladat állapotának ellenőrzésére szolgál. Fejlécek operation-location: string
Other Status Codes	ErrorResponse	Hibaválasz.

Name

Típus

Description

202 Accepted

Egy sikeres hívás eredményeként egy Művelet-hely fejlécet kapunk, amely a feladat állapotának ellenőrzésére szolgál.

Fejlécek

operation-location: string

Other Status Codes

ErrorResponse

Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Nyelvi szolgáltatási erőforrás előfizetési kulcsa.

Típus: apiKey
In: header

Példák

Successful Import Project

Mintakérelem

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

Mintaválasz

Állapotkód:: 202

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

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	A projekt típusa.
StringIndexType	A sztringeltolások értelmezéséhez használt metódust adja meg. További információ: https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.
TextAnalysisAuthoringExportedClass	Egy exportált projekt egy osztályát jelöli.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Egyéni entitásfelismerési projekt exportált dokumentumát jelöli.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Az entitásfelismerési projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Egy egyéni többcímkés osztályozási projekt exportált dokumentumát jelöli.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Egy egyéni többcímkés besorolási projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Egy egyéni egycímkés osztályozási projekthez exportált dokumentumot jelöl.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Az egycímkés besorolási projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedDocumentClass	Egy dokumentum osztályozási címkéjét jelöli.
TextAnalysisAuthoringExportedDocumentEntityLabel	Egy dokumentum entitáscímkéjét jelöli.
TextAnalysisAuthoringExportedDocumentRegion	Egy régiót jelöl egy dokumentumban az entitáscímkézéshez.
TextAnalysisAuthoringExportedEntity	Egy entitást jelöl egy exportált projektben.
TextAnalysisAuthoringExportedProject	Exportált projektet jelöl.

Error

Tárgy

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Tárgy

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

ProjectKind

Felsorolás

A projekt típusa.

Érték	Description
CustomSingleLabelClassification	Besorolási modell létrehozása a szöveg saját adatokkal történő besorolásához. Minden fájlnak csak egy címkéje lesz. Az 1. fájl például A, a 2. fájl pedig B besorolású.
CustomMultiLabelClassification	Besorolási modell létrehozása a szöveg saját adatokkal történő besorolásához. Minden fájl egy vagy több címkét tartalmazhat. Az 1. fájl például A, B és C, a 2. fájl pedig B és C besorolású.
CustomEntityRecognition	Kinyerési modell létrehozásához a saját adataival azonosíthatja a tartománykategóriákat.

StringIndexType

Felsorolás

A sztringeltolások értelmezéséhez használt metódust adja meg. További információ: https://aka.ms/text-analytics-offsets.

Érték	Description
Utf16CodeUnit	Az eltolás és a hossz értékei UTF-16 kódegységeknek felelnek meg. Ezt a lehetőséget akkor használja, ha az alkalmazás Unicode-ot támogató nyelven van megírva, például Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Tárgy

A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.

Name	Típus	Description
description	string	A projekt leírása.
language	string	A projekt nyelve. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
multilingual	boolean	Azt jelzi, hogy a projekt több nyelvre is használható-e.
projectKind	ProjectKind	A projekt típusa.
projectName	string	Az új projektnév.
settings	object	A projekt beállításai.
storageInputContainerName	string	A tároló neve.

TextAnalysisAuthoringExportedClass

Tárgy

Egy exportált projekt egy osztályát jelöli.

Name	Típus	Description
category	string	Az osztály kategóriája.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Tárgy

Egyéni entitásfelismerési projekt exportált dokumentumát jelöli.

Name	Típus	Description
dataset	string	A dokumentum adatkészlete. Az engedélyezett értékek a "Betanítás" és a "Teszt".
entities	TextAnalysisAuthoringExportedDocumentRegion[]	A dokumentumhoz tartozó entitáscímkék listája.
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
location	string	A dokumentum helye a tárolóban.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Tárgy

Az entitásfelismerési projekt exportált eszközeit jelöli.

Name	Típus	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	A projekthez tartozó dokumentumok listája.
entities	TextAnalysisAuthoringExportedEntity[]	A projekthez tartozó entitások listája.
projectKind	string: CustomEntityRecognition	A projekt típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Tárgy

Egy egyéni többcímkés osztályozási projekt exportált dokumentumát jelöli.

Name	Típus	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	A dokumentum osztályok.
dataset	string	A dokumentum adatkészlete. Az engedélyezett értékek a "Betanítás" és a "Teszt".
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
location	string	A dokumentum helye a tárolóban.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Tárgy

Egy egyéni többcímkés besorolási projekt exportált eszközeit jelöli.

Name	Típus	Description
classes	TextAnalysisAuthoringExportedClass[]	A projektben szereplő osztályok listája.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	A projektben szereplő dokumentumok listája.
projectKind	string: CustomMultiLabelClassification	A projekt típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Tárgy

Egy egyéni egycímkés osztályozási projekthez exportált dokumentumot jelöl.

Name	Típus	Description
class	TextAnalysisAuthoringExportedDocumentClass	A dokumentumok osztálya.
dataset	string	A dokumentum adatkészlete. Az engedélyezett értékek a "Betanítás" és a "Teszt".
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-ábrázolása. Használja például az "en" for English, "en-gb" for English (UK), "es" for Spanyol stb.
location	string	A dokumentum helye a tárolóban.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Tárgy

Az egycímkés besorolási projekt exportált eszközeit jelöli.

Name	Típus	Description
classes	TextAnalysisAuthoringExportedClass[]	A projekthez tartozó osztályok listája.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	A projekthez tartozó dokumentumok listája.
projectKind	string: CustomSingleLabelClassification	A projekt típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedDocumentClass

Tárgy

Egy dokumentum osztályozási címkéjét jelöli.

Name	Típus	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Tárgy

Egy dokumentum entitáscímkéjét jelöli.

Name	Típus	Description
category	string	Az entitáskategória.
length	integer (int32)	Az entitásszöveg hossza.
offset	integer (int32)	Az entitásszöveg kezdőpozíciója.

TextAnalysisAuthoringExportedDocumentRegion

Tárgy

Egy régiót jelöl egy dokumentumban az entitáscímkézéshez.

Name	Típus	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	A régióhoz tartozó entitáscímkék listája.
regionLength	integer (int32)	A terület szövegének hossza.
regionOffset	integer (int32)	A régió kiinduló pozíciója.

TextAnalysisAuthoringExportedEntity

Tárgy

Egy entitást jelöl egy exportált projektben.

Name	Típus	Description
category	string	Az entitáskategória.

TextAnalysisAuthoringExportedProject

Tárgy

Exportált projektet jelöl.

Name	Típus	Description
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	A projekt eszközeit jelöli.
metadata	TextAnalysisAuthoringCreateProjectOptions	A projekt metaadatait jelöli.
projectFileVersion	string	Az exportált fájl verziója.
stringIndexType	StringIndexType	A sztringeltolások értelmezéséhez használt metódust adja meg. További információ: https://aka.ms/text-analytics-offsets.