Text Analysis Authoring - Import

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Projekt importálásához aktivál egy feladatot. 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=2023-04-01

URI-paraméterek

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

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 projekteszközöket jelöli.

Válaszok

Name	Típus	Description
202 Accepted		A sikeres hívás eredménye egy Operation-Location fejléccel, amely a feladat állapotának ellenőrzésére szolgál. Headers operation-location: string
Other Status Codes	ErrorResponse	Hibaválasz.

Name

Típus

Description

202 Accepted

A sikeres hívás eredménye egy Operation-Location fejléccel, amely a feladat állapotának ellenőrzésére szolgál.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Hibaválasz.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Egy nyelvi szolgáltatási erőforrás előfizetői kulcsa.

Type: apiKey
In: header

Példák

Successful Import Project

Sample Request

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

Sample Response

Status code:: 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	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas 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	Megadja a sztringeltolások értelmezéséhez használt metódust. 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 osztályát jelöli.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Egyéni entitásfelismerő projekt exportált dokumentumát jelöli.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Egy entitásfelismerő projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Egyéni többcímke-besorolási projekt exportált dokumentumát jelöli.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Egy egyéni többcímke-besorolási projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Egy egyéni egycímke-besorolási projekt exportált dokumentumát jelöli.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Egy címkés besorolási projekt exportált eszközeit jelöli.
TextAnalysisAuthoringExportedDocumentClass	Egy dokumentum besorolási címkéjét jelöli.
TextAnalysisAuthoringExportedDocumentEntityLabel	Egy dokumentum entitáscímkéjét jelöli.
TextAnalysisAuthoringExportedDocumentRegion	Egy dokumentum egy régióját jelöli entitáscímkézéshez.
TextAnalysisAuthoringExportedEntity	Exportált projekt egy entitását jelöli.
TextAnalysisAuthoringExportedProject	Exportált projektet jelöl.
TextAnalysisAuthoringProjectSettings	A projekt viselkedésének meghatározásához használt beállításokat jelöli.

Error

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ókat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

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ókat tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

ProjectKind

A projekt típusa.

Name	Típus	Description
CustomEntityRecognition	string	Kinyerési modell létrehozásához, amely a saját adataival azonosítja a tartománykategóriákat.
CustomMultiLabelClassification	string	Besorolási modell létrehozásához a szöveg saját adatokkal történő besorolásához. Minden fájlhoz tartozhat egy vagy több címke. Az 1. fájl például A, B és C, a 2. fájl pedig B és C besorolású.
CustomSingleLabelClassification	string	Besorolási modell létrehozásához 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.

StringIndexType

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

Name	Típus	Description
Utf16CodeUnit	string	Az eltolás és a hosszértékek UTF-16 kódegységeknek felelnek meg. Akkor használja ezt a lehetőséget, ha az alkalmazás Unicode-ot támogató nyelven van megírva, például Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

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-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.
multilingual	boolean	Azt jelzi, hogy a projekt több nyelvhez is használható-e.
projectKind	ProjectKind	A projekt típusa.
projectName	string	Az új projekt neve.
settings	TextAnalysisAuthoringProjectSettings	A projekt beállításai.
storageInputContainerName	string	A tároló neve.

TextAnalysisAuthoringExportedClass

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

Name	Típus	Description
category	string	Az osztálykategória.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Egyéni entitásfelismerő 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ása" é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-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.
location	string	A dokumentum helye a tárolóban.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Egy entitásfelismerő 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	Annak a projektnek a típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Egyéni többcímke-besorolási projekt exportált dokumentumát jelöli.

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

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

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

Name	Típus	Description
classes	TextAnalysisAuthoringExportedClass[]	A projekt osztályainak listája.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	A projekt dokumentumainak listája.
projectKind	string: CustomMultiLabelClassification	Annak a projektnek a típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Egy egyéni egycímke-besorolási projekt exportált dokumentumát jelöli.

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

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Egy cí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	Annak a projektnek a típusa, amelyhez az eszközök tartoznak.

TextAnalysisAuthoringExportedDocumentClass

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

Name	Típus	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

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

Name	Típus	Description
category	string	Az entitáskategória.
length	integer	Az entitás szövegének hossza.
offset	integer	Az entitás szövegének kezdőpozíciója.

TextAnalysisAuthoringExportedDocumentRegion

Egy dokumentum egy régióját jelöli entitáscímkézéshez.

Name	Típus	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	A régióhoz tartozó entitáscímkék listája.
regionLength	integer	A régió szövegének hossza.
regionOffset	integer	A régió kezdőpozíciója.

TextAnalysisAuthoringExportedEntity

Exportált projekt egy entitását jelöli.

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

TextAnalysisAuthoringExportedProject

Exportált projektet jelöl.

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

TextAnalysisAuthoringProjectSettings

A projekt viselkedésének meghatározásához használt beállításokat jelöli.

Name	Típus	Description
confidenceThreshold	number	A legnagyobb megbízhatóságú osztály küszöbértéke, amelynél az előrejelzés automatikusan "Nincs" értékre változik. A küszöbérték értéke 0 és 1 közötti lehet.

Megosztás a következőn keresztül:

Text Analysis Authoring - Import

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

AADToken

Jegyzetek

Scopes

Ocp-Apim-Subscription-Key

Példák

Successful Import Project

Sample Request

Sample Response

Definíciók

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject

TextAnalysisAuthoringProjectSettings

További források