Text Analysis Authoring - Import

Service:

Azure AI Services

API-versie:

2022-05-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=2022-05-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 maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een Taalserviceresource.

Aanvraagbody

Name	Vereist	Type	Description
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de projectmetagegevens.
projectFileVersion	True	string	De versie van het geëxporteerde bestand.
stringIndexType	True	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Vertegenwoordigt de projectactiva.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep met 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

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

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	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke 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 projecttype.
StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.
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.

Error

Object

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 hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Een object met meer specifieke 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 meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

ProjectKind

Inventarisatie

Het projecttype.

Waarde	Description
CustomEntityRecognition	Voor het bouwen van een extractiemodel om uw domeincategorieën te identificeren met behulp van uw eigen gegevens.
CustomMultiLabelClassification	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	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 wordt geclassificeerd als B.

StringIndexType

Inventarisatie

Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

Waarde	Description
Utf16CodeUnit	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 JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Object

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 nu wordt gebruikt voor meerdere talen of niet.
projectKind	ProjectKind	Het projecttype.
projectName	string	De naam van het nieuwe project.
settings	object	De projectinstellingen.
storageInputContainerName	string	De naam van de opslagcontainer.

TextAnalysisAuthoringExportedClass

Object

Vertegenwoordigt een klasse van een geëxporteerd project.

Name	Type	Description
category	string	De klassecategorie.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Object

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 deel uitmaken van het document.
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

Object

Vertegenwoordigt de geëxporteerde assets voor een entiteitsherkenningsproject.

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

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Object

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

Object

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 assets behoren.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Object

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

Object

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

Name	Type	Description
classes	TextAnalysisAuthoringExportedClass[]	De lijst met klassen die bij dit project horen.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	De lijst met documenten die bij dit project horen.
projectKind	string: CustomSingleLabelClassification	Het type project waartoe de assets behoren.

TextAnalysisAuthoringExportedDocumentClass

Object

Vertegenwoordigt een classificatielabel voor een document.

Name	Type	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Object

Vertegenwoordigt een entiteitslabel voor een document.

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

TextAnalysisAuthoringExportedDocumentRegion

Object

Vertegenwoordigt een regio in een document voor entiteitslabels.

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

TextAnalysisAuthoringExportedEntity

Object

Vertegenwoordigt een entiteit in een geëxporteerd project.

Name	Type	Description
category	string	De entiteitscategorie.

TextAnalysisAuthoringExportedProject

Object

Vertegenwoordigt een geëxporteerd project.

Name	Type	Description
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Vertegenwoordigt de projectactiva.
metadata	TextAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de projectmetagegevens.
projectFileVersion	string	De versie van het geëxporteerde bestand.
stringIndexType	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.