TextAnalysisClient class
Un client per interagire con le funzionalità di analisi del testo in Servizi linguistici cognitivi di Azure.
Il client richiede l'endpoint di una risorsa language e un metodo di autenticazione, ad esempio una chiave API o AAD. La chiave API e l'endpoint sono disponibili nella pagina Della risorsa lingua nel portale di Azure. Si troveranno nella pagina Chiavi ed endpoint della risorsa, in Gestione risorse.
Esempi per l'autenticazione:
Chiave API
import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-text-analytics";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new TextAnalysisClient(endpoint, credential);
Azure Active Directory
Per altre informazioni sull'autenticazione con Azure Active Directory, vedere il pacchetto @azure/identity.
import { TextAnalysisClient } from "@azure/ai-text-analytics";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new TextAnalysisClient(endpoint, credential);
Costruttori
| Text |
Crea un'istanza di TextAnalysisClient con l'endpoint di una risorsa Language e un metodo di autenticazione, ad esempio una chiave API o AAD. La chiave API e l'endpoint sono disponibili nella pagina Della risorsa lingua nel portale di Azure. Si troveranno nella pagina Chiavi ed endpoint della risorsa, in Gestione risorse. Esempio
|
| Text |
Crea un'istanza di TextAnalysisClient con l'endpoint di una risorsa Language e un metodo di autenticazione, ad esempio una chiave API o AAD. La chiave API e l'endpoint sono disponibili nella pagina Della risorsa lingua nel portale di Azure. Si troveranno nella pagina Chiavi ed endpoint della risorsa, in Gestione risorse. EsempioPer altre informazioni sull'autenticazione con Azure Active Directory, vedere il pacchetto
|
Metodi
| analyze<Action |
Esegue un modello predittivo per determinare la lingua in cui vengono scritte le stringhe di input passate e restituisce, per ogni lingua, la lingua rilevata e un punteggio che indica che la lingua dedotta è corretta. I punteggi vicini a 1 indicano una certezza elevata nel risultato. Sono supportate 120 lingue. Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiRilevamento della lingua
Per altre informazioni sul rilevamento della lingua, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview. |
| analyze<Action |
Esegue un modello predittivo per determinare la lingua in cui vengono scritte le stringhe di input passate e restituisce, per ogni lingua, la lingua rilevata e un punteggio che indica che la lingua dedotta è corretta. I punteggi vicini a 1 indicano una certezza elevata nel risultato. Sono supportate 120 lingue. Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiRilevamento della lingua
Per altre informazioni sul rilevamento della lingua, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview. |
| analyze<Action |
Esegue un modello predittivo per eseguire l'azione scelta sulle stringhe di input. Per un elenco delle azioni supportate, vedere $AnalyzeActionName. Il layout di ogni elemento nella matrice di risultati dipende dall'azione scelta.
Ad esempio, ogni risultato del documento PIIEntityRecognition è costituito sia da Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiEstrazione di opinioni
Per altre informazioni sul opinion mining, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview. Informazioni personali
Per altre informazioni sulle informazioni personali, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview. |
| analyze<Action |
Esegue un modello predittivo per eseguire l'azione scelta nei documenti di input. Per un elenco delle azioni supportate, vedere $AnalyzeActionName. Il layout di ogni elemento nella matrice di risultati dipende dall'azione scelta.
Ad esempio, ogni risultato del documento PIIEntityRecognition è costituito sia da Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiEstrazione di opinioni
Per altre informazioni sul opinion mining, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview. Informazioni personali
Per altre informazioni sulle informazioni personali, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview. |
| begin |
Esegue una matrice (batch) di azioni nei documenti di input. Ogni azione ha un campo La matrice dei risultati contiene i risultati per le azioni di input in cui ogni elemento include anche un campo Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiEstrazione di frasi chiave e riconoscimento delle entità Pii
|
| begin |
Esegue una matrice (batch) di azioni nei documenti di input. Ogni azione ha un campo La matrice dei risultati contiene i risultati per le azioni di input in cui ogni elemento include anche un campo Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati. EsempiEstrazione di keyphrase e riconoscimento delle entità Pii
|
| restore |
Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito. |
Dettagli costruttore
TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)
Crea un'istanza di TextAnalysisClient con l'endpoint di una risorsa Language e un metodo di autenticazione, ad esempio una chiave API o AAD.
La chiave API e l'endpoint sono disponibili nella pagina Della risorsa lingua nel portale di Azure. Si troveranno nella pagina Chiavi ed endpoint della risorsa, in Gestione risorse.
Esempio
import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-text-analytics";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");
const client = new TextAnalysisClient(endpoint, credential);
new TextAnalysisClient(endpointUrl: string, credential: KeyCredential, options?: TextAnalysisClientOptions)
Parametri
- endpointUrl
-
string
URL dell'endpoint di una risorsa di Servizi linguistici cognitivi
- credential
- KeyCredential
Credenziali chiave da usare per autenticare le richieste al servizio.
- options
- TextAnalysisClientOptions
Usato per configurare il client TextAnalytics.
TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)
Crea un'istanza di TextAnalysisClient con l'endpoint di una risorsa Language e un metodo di autenticazione, ad esempio una chiave API o AAD.
La chiave API e l'endpoint sono disponibili nella pagina Della risorsa lingua nel portale di Azure. Si troveranno nella pagina Chiavi ed endpoint della risorsa, in Gestione risorse.
Esempio
Per altre informazioni sull'autenticazione con Azure Active Directory, vedere il pacchetto @azure/identity.
import { TextAnalysisClient } from "@azure/ai-text-analytics";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();
const client = new TextAnalysisClient(endpoint, credential);
new TextAnalysisClient(endpointUrl: string, credential: TokenCredential, options?: TextAnalysisClientOptions)
Parametri
- endpointUrl
-
string
URL dell'endpoint di una risorsa di Servizi linguistici cognitivi
- credential
- TokenCredential
Credenziali del token da usare per autenticare le richieste al servizio.
- options
- TextAnalysisClientOptions
Usato per configurare il client TextAnalytics.
Dettagli metodo
analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Esegue un modello predittivo per determinare la lingua in cui vengono scritte le stringhe di input passate e restituisce, per ogni lingua, la lingua rilevata e un punteggio che indica che la lingua dedotta è corretta. I punteggi vicini a 1 indicano una certezza elevata nel risultato. Sono supportate 120 lingue.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Rilevamento della lingua
const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);
for (let i = 0; i < results.length; i++) {
const result = results[i];
if (result.error) {
// a document has an error instead of results
} else {
const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
}
}
Per altre informazioni sul rilevamento della lingua, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
function analyze<ActionName>(actionName: ActionName, documents: LanguageDetectionInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parametri
- actionName
-
ActionName
nome dell'azione da eseguire nei documenti di input, vedere $AnalyzeActionName
- documents
documenti di input da analizzare
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parametri e impostazioni di azione facoltativi per l'operazione
Restituisce
Promise<AnalyzeResult<ActionName>>
matrice di risultati in cui ogni elemento contiene la lingua primaria per il documento di input corrispondente.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Esegue un modello predittivo per determinare la lingua in cui vengono scritte le stringhe di input passate e restituisce, per ogni lingua, la lingua rilevata e un punteggio che indica che la lingua dedotta è corretta. I punteggi vicini a 1 indicano una certezza elevata nel risultato. Sono supportate 120 lingue.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Rilevamento della lingua
const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
}
}
Per altre informazioni sul rilevamento della lingua, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
function analyze<ActionName>(actionName: ActionName, documents: string[], countryHint?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parametri
- actionName
-
ActionName
nome dell'azione da eseguire nei documenti di input, vedere $AnalyzeActionName
- documents
-
string[]
documenti di input da analizzare
- countryHint
-
string
Indica il paese di origine per tutte le stringhe di input per facilitare il modello nella stima della lingua in cui sono scritti. Se non specificato, questo valore verrà impostato sull'hint paese predefinito in TextAnalysisClientOptions. Se è impostata su una stringa vuota o la stringa "none", il servizio applicherà un modello in cui il paese non è impostato in modo esplicito. Lo stesso hint paese viene applicato a tutte le stringhe nella raccolta di input.
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parametri e impostazioni di azione facoltativi per l'operazione
Restituisce
Promise<AnalyzeResult<ActionName>>
matrice di risultati in cui ogni elemento contiene la lingua primaria per il documento di input corrispondente.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Esegue un modello predittivo per eseguire l'azione scelta sulle stringhe di input. Per un elenco delle azioni supportate, vedere $AnalyzeActionName.
Il layout di ogni elemento nella matrice di risultati dipende dall'azione scelta.
Ad esempio, ogni risultato del documento PIIEntityRecognition è costituito sia da entities che da redactedText dove il primo è un elenco di tutte le entità Pii nel testo e quest'ultimo è il testo originale dopo che tutte le entità Pii sono state elaborate.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Estrazione di opinioni
const documents = ["The food and service aren't the best"];
const results = await client.analyze("SentimentAnalysis", documents, {
includeOpinionMining: true,
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { sentiment, confidenceScores, sentences } = result;
for (const { sentiment, confidenceScores, opinions } of sentences) {
for (const { target, assessments } of opinions) {
const { text, sentiment, confidenceScores } = target;
for (const { text, sentiment } of assessments) {
// Do something
}
}
}
}
}
Per altre informazioni sul opinion mining, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.
Informazioni personali
const documents = [<input strings>];
const languageHint = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageHint, {
domainFilter, categoriesFilter
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { entities, redactedText } = result;
for (const { text, category, confidenceScore, length, offset } of entities) {
// Do something
}
}
}
Per altre informazioni sulle informazioni personali, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview.
function analyze<ActionName>(actionName: ActionName, documents: string[], languageCode?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parametri
- actionName
-
ActionName
nome dell'azione da eseguire nei documenti di input, vedere $AnalyzeActionName
- documents
-
string[]
documenti di input da analizzare
- languageCode
-
string
codice del linguaggio in cui vengono scritte tutte le stringhe di input. Se non specificato, questo valore verrà impostato sulla lingua predefinita in TextAnalysisClientOptions. Se impostato su una stringa vuota, il servizio applicherà un modello in cui la lingua è impostata in modo esplicito su "Nessuno". Il supporto linguistico varia in base all'azione, ad esempio altre informazioni sulle lingue supportate per le azioni di riconoscimento delle entità sono disponibili in https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parametri e impostazioni di azione facoltativi per l'operazione
Restituisce
Promise<AnalyzeResult<ActionName>>
matrice di risultati corrispondenti ai documenti di input
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Esegue un modello predittivo per eseguire l'azione scelta nei documenti di input. Per un elenco delle azioni supportate, vedere $AnalyzeActionName.
Il layout di ogni elemento nella matrice di risultati dipende dall'azione scelta.
Ad esempio, ogni risultato del documento PIIEntityRecognition è costituito sia da entities che da redactedText dove il primo è un elenco di tutte le entità Pii nel testo e quest'ultimo è il testo originale dopo che tutte le entità Pii sono state elaborate.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Estrazione di opinioni
const documents = [{
id: "1",
text: "The food and service aren't the best",
language: "en"
}];
const results = await client.analyze("SentimentAnalysis", documents, {
includeOpinionMining: true,
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { sentiment, confidenceScores, sentences } = result;
for (const { sentiment, confidenceScores, opinions } of sentences) {
for (const { target, assessments } of opinions) {
const { text, sentiment, confidenceScores } = target;
for (const { text, sentiment } of assessments) {
// Do something
}
}
}
}
}
Per altre informazioni sul opinion mining, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.
Informazioni personali
const documents = [<input documents>];
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, {
domainFilter, categoriesFilter
});
for (const result of results) {
if (result.error) {
// a document has an error instead of results
} else {
const { entities, redactedText } = result;
for (const { text, category, confidenceScore, length, offset } of entities) {
// Do something
}
}
}
Per altre informazioni sulle informazioni personali, vedere https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview.
function analyze<ActionName>(actionName: ActionName, documents: TextDocumentInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>
Parametri
- actionName
-
ActionName
nome dell'azione da eseguire nei documenti di input, vedere $AnalyzeActionName
- documents
documenti di input da analizzare
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
parametri e impostazioni di azione facoltativi per l'operazione
Restituisce
Promise<AnalyzeResult<ActionName>>
matrice di risultati corrispondenti ai documenti di input
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)
Esegue una matrice (batch) di azioni nei documenti di input. Ogni azione ha un campo kind che specifica la natura dell'azione. Per un elenco delle azioni supportate, vedere $AnalyzeBatchActionNames. Oltre a kind, le azioni potrebbero avere anche altri parametri, ad esempio disableServiceLogs e modelVersion.
La matrice dei risultati contiene i risultati per le azioni di input in cui ogni elemento include anche un campo kind che specifica il tipo dei risultati.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Estrazione di frasi chiave e riconoscimento delle entità Pii
const poller = await client.beginAnalyzeBatch(
[{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
documents
);
const actionResults = await poller.pollUntilDone();
for await (const actionResult of actionResults) {
if (actionResult.error) {
throw new Error(`Unexpected error`);
}
switch (actionResult.kind) {
case "KeyPhraseExtraction": {
for (const doc of actionResult.results) {
// do something
}
break;
}
case "PiiEntityRecognition": {
for (const doc of actionResult.results) {
// do something
}
break;
}
}
}
function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: string[], languageCode?: string, options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>
Parametri
- actions
matrice di azioni che verranno eseguite nei documenti di input
- documents
-
string[]
documenti di input da analizzare
- languageCode
-
string
codice del linguaggio in cui vengono scritte tutte le stringhe di input. Se non specificato, questo valore verrà impostato sulla lingua predefinita in TextAnalysisClientOptions. Se impostato su una stringa vuota, il servizio applicherà un modello in cui la lingua è impostata in modo esplicito su "Nessuno". Il supporto linguistico varia in base all'azione, ad esempio altre informazioni sulle lingue supportate per le azioni di riconoscimento delle entità sono disponibili in https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support
- options
- BeginAnalyzeBatchOptions
impostazioni facoltative per l'operazione
Restituisce
Promise<AnalyzeBatchPoller>
matrice di risultati corrispondenti alle azioni di input
beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)
Esegue una matrice (batch) di azioni nei documenti di input. Ogni azione ha un campo kind che specifica la natura dell'azione. Per un elenco delle azioni supportate, vedere $AnalyzeBatchActionNames. Oltre a kind, le azioni potrebbero avere anche altri parametri, ad esempio disableServiceLogs e modelVersion.
La matrice dei risultati contiene i risultati per le azioni di input in cui ogni elemento include anche un campo kind che specifica il tipo dei risultati.
Vedere https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits per i limiti dei dati.
Esempi
Estrazione di keyphrase e riconoscimento delle entità Pii
const poller = await client.beginAnalyzeBatch(
[{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
documents
);
const actionResults = await poller.pollUntilDone();
for await (const actionResult of actionResults) {
if (actionResult.error) {
throw new Error(`Unexpected error`);
}
switch (actionResult.kind) {
case "KeyPhraseExtraction": {
for (const doc of actionResult.results) {
// do something
}
break;
}
case "PiiEntityRecognition": {
for (const doc of actionResult.results) {
// do something
}
break;
}
}
}
function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: TextDocumentInput[], options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>
Parametri
- actions
matrice di azioni che verranno eseguite nei documenti di input
- documents
documenti di input da analizzare
- options
- BeginAnalyzeBatchOptions
impostazioni facoltative per l'operazione
Restituisce
Promise<AnalyzeBatchPoller>
matrice di risultati corrispondenti alle azioni di input
restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)
Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.
function restoreAnalyzeBatchPoller(serializedState: string, options?: RestoreAnalyzeBatchPollerOptions): Promise<AnalyzeBatchPoller>
Parametri
- serializedState
-
string
stato serializzato di un altro poller. È il risultato di poller.toString()
- options
- RestoreAnalyzeBatchPollerOptions
impostazioni facoltative per l'operazione
Esempio
client.beginAnalyzeBatch restituisce una promessa che verrà risolta in un poller.
Lo stato del poller può essere serializzato e usato per creare un altro come indicato di seguito:
const serializedState = poller.toString();
const rehydratedPoller = await client.createAnalyzeBatchPoller(serializedState);
const actionResults = await rehydratedPoller.pollUntilDone();
Restituisce
Promise<AnalyzeBatchPoller>