Text Analysis Authoring - Import

Service:

Azure AI Services

API-versie:

2023-04-01

Hiermee wordt een taak geactiveerd om een project te importeren. Als er al een project met dezelfde naam bestaat, worden de gegevens van dat project vervangen.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de metagegevens van het project.
projectFileVersion	True	string	De versie van het geëxporteerde bestand.
stringIndexType	True	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Vertegenwoordigt de projectassets.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep resulteert in een Operation-Location-header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

• Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Import Project

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Het soort project.
StringIndexType	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.
TextAnalysisAuthoringExportedClass	Vertegenwoordigt een klasse van een geëxporteerd project.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Vertegenwoordigt een geëxporteerd document voor een aangepast entiteitsherkenningsproject.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Vertegenwoordigt de geëxporteerde assets voor een entiteitsherkenningsproject.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Vertegenwoordigt een geëxporteerd document van een aangepast classificatieproject met meerdere labels.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Vertegenwoordigt de geëxporteerde assets voor een aangepast classificatieproject met meerdere labels.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Vertegenwoordigt een geëxporteerd document voor een aangepast classificatieproject met één label.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Vertegenwoordigt de geëxporteerde assets voor een classificatieproject met één label.
TextAnalysisAuthoringExportedDocumentClass	Vertegenwoordigt een classificatielabel voor een document.
TextAnalysisAuthoringExportedDocumentEntityLabel	Vertegenwoordigt een entiteitslabel voor een document.
TextAnalysisAuthoringExportedDocumentRegion	Vertegenwoordigt een regio in een document voor entiteitslabels.
TextAnalysisAuthoringExportedEntity	Vertegenwoordigt een entiteit in een geëxporteerd project.
TextAnalysisAuthoringExportedProject	Vertegenwoordigt een geëxporteerd project.
TextAnalysisAuthoringProjectSettings	Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

ProjectKind

Het soort project.

Name	Type	Description
CustomEntityRecognition	string	Voor het bouwen van een extractiemodel om uw domeincategorieën te identificeren met behulp van uw eigen gegevens.
CustomMultiLabelClassification	string	Voor het bouwen van een classificatiemodel om tekst te classificeren met behulp van uw eigen gegevens. Elk bestand kan een of meer labels hebben. Bestand 1 is bijvoorbeeld geclassificeerd als A, B en C en bestand 2 is geclassificeerd als B en C.
CustomSingleLabelClassification	string	Voor het bouwen van een classificatiemodel om tekst te classificeren met behulp van uw eigen gegevens. Elk bestand heeft slechts één label. Bestand 1 is bijvoorbeeld geclassificeerd als A en bestand 2 is geclassificeerd als B.

StringIndexType

Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

Name	Type	Description
Utf16CodeUnit	string	De offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.

Name	Type	Description
description	string	De projectbeschrijving.
language	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
multilingual	boolean	Of het project voor meerdere talen wordt gebruikt of niet.
projectKind	ProjectKind	Het soort project.
projectName	string	De nieuwe projectnaam.
settings	TextAnalysisAuthoringProjectSettings	De projectinstellingen.
storageInputContainerName	string	De naam van de opslagcontainer.

TextAnalysisAuthoringExportedClass

Vertegenwoordigt een klasse van een geëxporteerd project.

Name	Type	Description
category	string	De klassecategorie.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Vertegenwoordigt een geëxporteerd document voor een aangepast entiteitsherkenningsproject.

Name	Type	Description
dataset	string	De gegevensset voor dit document. Toegestane waarden zijn Trainen en Testen.
entities	TextAnalysisAuthoringExportedDocumentRegion[]	De lijst met entiteitslabels die bij het document horen.
language	string	Vertegenwoordigt de documenttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
location	string	De locatie van het document in de opslag.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Vertegenwoordigt de geëxporteerde assets voor een entiteitsherkenningsproject.

Name	Type	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	De lijst met documenten die deel uitmaken van het project.
entities	TextAnalysisAuthoringExportedEntity[]	De lijst met entiteiten die deel uitmaken van het project.
projectKind	string: CustomEntityRecognition	Het type project waartoe de activa behoren.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Vertegenwoordigt een geëxporteerd document van een aangepast classificatieproject met meerdere labels.

Name	Type	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	De documentklassen.
dataset	string	De gegevensset voor dit document. Toegestane waarden zijn Trainen en Testen.
language	string	Vertegenwoordigt de documenttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
location	string	De locatie van het document in de opslag.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Vertegenwoordigt de geëxporteerde assets voor een aangepast classificatieproject met meerdere labels.

Name	Type	Description
classes	TextAnalysisAuthoringExportedClass[]	De lijst met klassen in het project.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	De lijst met documenten in het project.
projectKind	string: CustomMultiLabelClassification	Het type project waartoe de activa behoren.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Vertegenwoordigt een geëxporteerd document voor een aangepast classificatieproject met één label.

Name	Type	Description
class	TextAnalysisAuthoringExportedDocumentClass	De klasse van de documenten.
dataset	string	De gegevensset voor dit document. Toegestane waarden zijn Trainen en Testen.
language	string	Vertegenwoordigt de documenttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
location	string	De locatie van het document in de opslag.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Vertegenwoordigt de geëxporteerde assets voor een classificatieproject met één label.

Name	Type	Description
classes	TextAnalysisAuthoringExportedClass[]	De lijst met klassen die deel uitmaken van dit project.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	De lijst met documenten die deel uitmaken van dit project.
projectKind	string: CustomSingleLabelClassification	Het type project waartoe de activa behoren.

TextAnalysisAuthoringExportedDocumentClass

Vertegenwoordigt een classificatielabel voor een document.

Name	Type	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Vertegenwoordigt een entiteitslabel voor een document.

Name	Type	Description
category	string	De entiteitscategorie.
length	integer	Lengte voor de entiteitstekst.
offset	integer	Beginpositie voor de entiteitstekst.

TextAnalysisAuthoringExportedDocumentRegion

Vertegenwoordigt een regio in een document voor entiteitslabels.

Name	Type	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	De lijst met entiteitslabels die tot deze regio behoren.
regionLength	integer	Lengte voor de regiotekst.
regionOffset	integer	Beginpositie voor de regio.

TextAnalysisAuthoringExportedEntity

Vertegenwoordigt een entiteit in een geëxporteerd project.

Name	Type	Description
category	string	De entiteitscategorie.

TextAnalysisAuthoringExportedProject

Vertegenwoordigt een geëxporteerd project.

Name	Type	Description
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Vertegenwoordigt de projectassets.
metadata	TextAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de metagegevens van het project.
projectFileVersion	string	De versie van het geëxporteerde bestand.
stringIndexType	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

TextAnalysisAuthoringProjectSettings

Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.

Name	Type	Description
confidenceThreshold	number	De drempelwaarde van de klasse met de hoogste betrouwbaarheid, waarbij de voorspelling automatisch wordt gewijzigd in 'Geen'. De waarde van de drempelwaarde moet tussen 0 en 1 liggen.