Text Analysis Authoring - Import

Riferimento

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Attiva un processo per importare un progetto. Se esiste già un progetto con lo stesso nome, i dati del progetto vengono sostituiti.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da utilizzare.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Rappresenta i metadati del progetto.
projectFileVersion	True	string	Versione del file esportato.
stringIndexType	True	StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
assets		TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Rappresenta gli asset del progetto.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Headers operation-location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Nome

Tipo

Descrizione

202 Accepted

Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni di Azure Active Directory. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta account personali.

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

Scopes

Nome	Descrizione
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Type: apiKey
In: header

Esempio

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

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Tipo di progetto.
StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions	Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.
TextAnalysisAuthoringExportedClass	Rappresenta una classe di un progetto esportato.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Rappresenta un documento esportato per un progetto di riconoscimento di entità personalizzato.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Rappresenta gli asset esportati per un progetto di riconoscimento delle entità.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Rappresenta un documento esportato di un progetto di classificazione con più etichette personalizzato.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Rappresenta gli asset esportati per un progetto di classificazione con più etichette personalizzato.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Rappresenta un documento esportato per un progetto di classificazione con etichetta singola personalizzato.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Rappresenta gli asset esportati per un progetto di classificazione con etichetta singola.
TextAnalysisAuthoringExportedDocumentClass	Rappresenta un'etichetta di classificazione per un documento.
TextAnalysisAuthoringExportedDocumentEntityLabel	Rappresenta un'etichetta di entità per un documento.
TextAnalysisAuthoringExportedDocumentRegion	Rappresenta un'area in un documento per l'etichettatura delle entità.
TextAnalysisAuthoringExportedEntity	Rappresenta un'entità in un progetto esportato.
TextAnalysisAuthoringExportedProject	Rappresenta un progetto esportato.
TextAnalysisAuthoringProjectSettings	Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno dei set definiti dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione degli errori.

ProjectKind

Tipo di progetto.

Nome	Tipo	Descrizione
CustomEntityRecognition	string	Per creare un modello di estrazione per identificare le categorie di dominio usando i propri dati.
CustomMultiLabelClassification	string	Per la compilazione di un modello di classificazione per classificare il testo usando i propri dati. Ogni file può avere una o più etichette. Ad esempio, il file 1 viene classificato come A, B e C e il file 2 viene classificato come B e C.
CustomSingleLabelClassification	string	Per la compilazione di un modello di classificazione per classificare il testo usando i propri dati. Ogni file avrà una sola etichetta. Ad esempio, il file 1 viene classificato come A e il file 2 viene classificato come B.

StringIndexType

Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

Nome	Tipo	Descrizione
Utf16CodeUnit	string	I valori di offset e lunghezza corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

TextAnalysisAuthoringCreateProjectOptions

Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Lingua del progetto. Questa è la rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
multilingual	boolean	Indica se il progetto verrebbe usato o meno per più lingue.
projectKind	ProjectKind	Tipo di progetto.
projectName	string	Nome del nuovo progetto.
settings	TextAnalysisAuthoringProjectSettings	Impostazioni del progetto.
storageInputContainerName	string	Nome del contenitore di archiviazione.

TextAnalysisAuthoringExportedClass

Rappresenta una classe di un progetto esportato.

Nome	Tipo	Descrizione
category	string	Categoria di classi.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Rappresenta un documento esportato per un progetto di riconoscimento di entità personalizzato.

Nome	Tipo	Descrizione
dataset	string	Set di dati per questo documento. I valori consentiti sono 'Train' e 'Test'.
entities	TextAnalysisAuthoringExportedDocumentRegion[]	Elenco di etichette di entità appartenenti al documento.
language	string	Rappresenta la lingua del documento. Questa è la rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
location	string	Posizione del documento nella risorsa di archiviazione.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Rappresenta gli asset esportati per un progetto di riconoscimento delle entità.

Nome	Tipo	Descrizione
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Elenco di documenti appartenenti al progetto.
entities	TextAnalysisAuthoringExportedEntity[]	Elenco di entità appartenenti al progetto.
projectKind	string: CustomEntityRecognition	Tipo del progetto a cui appartengono gli asset.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Rappresenta un documento esportato di un progetto di classificazione con più etichette personalizzato.

Nome	Tipo	Descrizione
classes	TextAnalysisAuthoringExportedDocumentClass[]	Classi del documento.
dataset	string	Set di dati per questo documento. I valori consentiti sono 'Train' e 'Test'.
language	string	Rappresenta la lingua del documento. Questa è la rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
location	string	Posizione del documento nella risorsa di archiviazione.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Rappresenta gli asset esportati per un progetto di classificazione con più etichette personalizzato.

Nome	Tipo	Descrizione
classes	TextAnalysisAuthoringExportedClass[]	Elenco di classi nel progetto.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Elenco di documenti nel progetto.
projectKind	string: CustomMultiLabelClassification	Tipo del progetto a cui appartengono gli asset.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Rappresenta un documento esportato per un progetto di classificazione con etichetta singola personalizzato.

Nome	Tipo	Descrizione
class	TextAnalysisAuthoringExportedDocumentClass	Classe dei documenti.
dataset	string	Set di dati per questo documento. I valori consentiti sono 'Train' e 'Test'.
language	string	Rappresenta la lingua del documento. Questa è la rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
location	string	Posizione del documento nella risorsa di archiviazione.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Rappresenta gli asset esportati per un progetto di classificazione con etichetta singola.

Nome	Tipo	Descrizione
classes	TextAnalysisAuthoringExportedClass[]	Elenco di classi appartenenti a questo progetto.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Elenco di documenti appartenenti a questo progetto.
projectKind	string: CustomSingleLabelClassification	Tipo del progetto a cui appartengono gli asset.

TextAnalysisAuthoringExportedDocumentClass

Rappresenta un'etichetta di classificazione per un documento.

Nome	Tipo	Descrizione
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Rappresenta un'etichetta di entità per un documento.

Nome	Tipo	Descrizione
category	string	Categoria di entità.
length	integer	Lunghezza per il testo dell'entità.
offset	integer	Posizione iniziale per il testo dell'entità.

TextAnalysisAuthoringExportedDocumentRegion

Rappresenta un'area in un documento per l'etichettatura delle entità.

Nome	Tipo	Descrizione
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Elenco di etichette di entità appartenenti a questa area.
regionLength	integer	Lunghezza per il testo dell'area.
regionOffset	integer	Posizione iniziale per l'area.

TextAnalysisAuthoringExportedEntity

Rappresenta un'entità in un progetto esportato.

Nome	Tipo	Descrizione
category	string	Categoria di entità.

TextAnalysisAuthoringExportedProject

Rappresenta un progetto esportato.

Nome	Tipo	Descrizione
assets	TextAnalysisAuthoringExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Rappresenta gli asset del progetto.
metadata	TextAnalysisAuthoringCreateProjectOptions	Rappresenta i metadati del progetto.
projectFileVersion	string	Versione del file esportato.
stringIndexType	StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

TextAnalysisAuthoringProjectSettings

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

Nome	Tipo	Descrizione
confidenceThreshold	number	Soglia della classe con maggiore attendibilità, in cui la stima verrà automaticamente modificata in "Nessuno". Il valore della soglia deve essere compreso tra 0 e 1 inclusi.

Condividi tramite

Text Analysis Authoring - Import

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

AADToken

Note

Scopes

Ocp-Apim-Subscription-Key

Esempio

Successful Import Project

Sample Request

Sample Response

Definizioni

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentRegion

TextAnalysisAuthoringExportedEntity

TextAnalysisAuthoringExportedProject

TextAnalysisAuthoringProjectSettings

Risorse aggiuntive