Text Analysis Authoring - Import

Referens

Tjänst:: Azure AI Services

API-version:: 2023-04-01

Utlöser ett jobb för att importera ett projekt. Om det redan finns ett projekt med samma namn ersätts data för det projektet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Representerar projektets metadata.
projectFileVersion	True	string	Den exporterade filens version.
stringIndexType	True	StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representerar projekttillgångarna.

Svar

Name	Typ	Description
202 Accepted		Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status. Sidhuvuden operation-location: string
Other Status Codes	ErrorResponse	Felsvar.

Name

Typ

Description

202 Accepted

Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status.

Sidhuvuden

operation-location: string

Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful Import Project

Exempelbegäran

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

Exempelsvar

Statuskod:: 202

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Projekttypen.
StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	Representerar de alternativ som används för att skapa eller uppdatera ett projekt.
TextAnalysisAuthoringExportedClass	Representerar en klass för ett exporterat projekt.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Representerar ett exporterat dokument för ett anpassat entitetsigenkänningsprojekt.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Representerar de exporterade tillgångarna för ett entitetsigenkänningsprojekt.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Representerar ett exporterat dokument för ett anpassat klassificeringsprojekt med flera etiketter.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Representerar de exporterade tillgångarna för ett anpassat klassificeringsprojekt med flera etiketter.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Representerar ett exporterat dokument för ett anpassat klassificeringsprojekt med en etikett.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representerar de exporterade tillgångarna för ett klassificeringsprojekt med en etikett.
TextAnalysisAuthoringExportedDocumentClass	Representerar en klassificeringsetikett för ett dokument.
TextAnalysisAuthoringExportedDocumentEntityLabel	Representerar en entitetsetikett för ett dokument.
TextAnalysisAuthoringExportedDocumentRegion	Representerar en region i ett dokument för entitetsetiketter.
TextAnalysisAuthoringExportedEntity	Representerar en entitet i ett exporterat projekt.
TextAnalysisAuthoringExportedProject	Representerar ett exporterat projekt.
TextAnalysisAuthoringProjectSettings	Representerar de inställningar som används för att definiera projektbeteendet.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En läsbar återgivning av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

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

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

ProjectKind

Projekttypen.

Name	Typ	Description
CustomEntityRecognition	string	För att skapa en extraheringsmodell för att identifiera dina domänkategorier med hjälp av dina egna data.
CustomMultiLabelClassification	string	För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil kan ha en eller flera etiketter. Till exempel klassificeras fil 1 som A, B och C och fil 2 klassificeras som B och C.
CustomSingleLabelClassification	string	För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil har bara en etikett. Till exempel klassificeras fil 1 som A och fil 2 klassificeras som B.

StringIndexType

Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.

Name	Typ	Description
Utf16CodeUnit	string	Förskjutnings- och längdvärdena motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Representerar de alternativ som används för att skapa eller uppdatera ett projekt.

Name	Typ	Description
description	string	Projektbeskrivningen.
language	string	Projektspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
multilingual	boolean	Om projektet skulle användas för flera språk eller inte.
projectKind	ProjectKind	Projekttypen.
projectName	string	Det nya projektnamnet.
settings	TextAnalysisAuthoringProjectSettings	Projektinställningarna.
storageInputContainerName	string	Namnet på lagringscontainern.

TextAnalysisAuthoringExportedClass

Representerar en klass för ett exporterat projekt.

Name	Typ	Description
category	string	Klasskategorin.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Representerar ett exporterat dokument för ett anpassat entitetsigenkänningsprojekt.

Name	Typ	Description
dataset	string	Datauppsättningen för det här dokumentet. Tillåtna värden är "Träna" och "Test".
entities	TextAnalysisAuthoringExportedDocumentRegion[]	Listan över entitetsetiketter som tillhör dokumentet.
language	string	Representerar dokumentspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Platsen för dokumentet i lagringen.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Representerar de exporterade tillgångarna för ett entitetsigenkänningsprojekt.

Name	Typ	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Listan över dokument som hör till projektet.
entities	TextAnalysisAuthoringExportedEntity[]	Listan över entiteter som tillhör projektet.
projectKind	string: CustomEntityRecognition	Typen av projekt som tillgångarna tillhör.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Representerar ett exporterat dokument för ett anpassat klassificeringsprojekt med flera etiketter.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	Dokumentklasserna.
dataset	string	Datauppsättningen för det här dokumentet. Tillåtna värden är "Träna" och "Test".
language	string	Representerar dokumentspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Platsen för dokumentet i lagringen.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Representerar de exporterade tillgångarna för ett anpassat klassificeringsprojekt med flera etiketter.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedClass[]	Listan över klasser i projektet.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Listan över dokument i projektet.
projectKind	string: CustomMultiLabelClassification	Typen av projekt som tillgångarna tillhör.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Representerar ett exporterat dokument för ett anpassat klassificeringsprojekt med en etikett.

Name	Typ	Description
class	TextAnalysisAuthoringExportedDocumentClass	Klassen för dokumenten.
dataset	string	Datauppsättningen för det här dokumentet. Tillåtna värden är "Träna" och "Test".
language	string	Representerar dokumentspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Platsen för dokumentet i lagringen.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Representerar de exporterade tillgångarna för ett klassificeringsprojekt med en etikett.

Name	Typ	Description
classes	TextAnalysisAuthoringExportedClass[]	Listan över klasser som hör till det här projektet.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Listan över dokument som hör till det här projektet.
projectKind	string: CustomSingleLabelClassification	Typen av projekt som tillgångarna tillhör.

TextAnalysisAuthoringExportedDocumentClass

Representerar en klassificeringsetikett för ett dokument.

Name	Typ	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Representerar en entitetsetikett för ett dokument.

Name	Typ	Description
category	string	Entitetskategorin.
length	integer	Längd för entitetstexten.
offset	integer	Startposition för entitetstexten.

TextAnalysisAuthoringExportedDocumentRegion

Representerar en region i ett dokument för entitetsetiketter.

Name	Typ	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Listan över entitetsetiketter som tillhör den här regionen.
regionLength	integer	Längd för regiontexten.
regionOffset	integer	Startposition för regionen.

TextAnalysisAuthoringExportedEntity

Representerar en entitet i ett exporterat projekt.

Name	Typ	Description
category	string	Entitetskategorin.

TextAnalysisAuthoringExportedProject

Representerar ett exporterat projekt.

Name	Typ	Description
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Representerar projekttillgångarna.
metadata	TextAnalysisAuthoringCreateProjectOptions	Representerar projektets metadata.
projectFileVersion	string	Den exporterade filens version.
stringIndexType	StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.

TextAnalysisAuthoringProjectSettings

Representerar de inställningar som används för att definiera projektbeteendet.

Name	Typ	Description
confidenceThreshold	number	Tröskelvärdet för klassen med högsta konfidens, där förutsägelsen automatiskt ändras till "Ingen". Värdet för tröskelvärdet ska vara mellan 0 och 1 inklusive.

Dela via

Text Analysis Authoring - Import

URI-parametrar

Begärandetext

Svar

Säkerhet

AADToken

Kommentarer

Omfattningar

Ocp-Apim-Subscription-Key

Exempel

Successful Import Project

Exempelbegäran

Exempelsvar

Definitioner

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject

TextAnalysisAuthoringProjectSettings

Ytterligare resurser