Partager via

TextAnalysisClient class

Paquet:
@azure/ai-language-text

Un client pour interagir avec les fonctionnalités d’analyse de texte dans Azure Cognitive Language Service.

Le client a besoin du point de terminaison d’une ressource language et d’une méthode d’authentification, comme une clé API ou AAD. La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemples d’authentification :

Clé API

import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-language-text";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new TextAnalysisClient(endpoint, credential);

Azure Active Directory

Pour plus d’informations sur l’authentification auprès d’Azure Active Directory, consultez le package @azure/identity.

import { TextAnalysisClient } from "@azure/ai-language-text";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new TextAnalysisClient(endpoint, credential);

Constructeurs

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Crée une instance de TextAnalysisClient avec le point de terminaison d’une ressource language et une méthode d’authentification telle qu’une clé API ou AAD.

La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemple

import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-language-text";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new TextAnalysisClient(endpoint, credential);
TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)

Crée une instance de TextAnalysisClient avec le point de terminaison d’une ressource language et une méthode d’authentification telle qu’une clé API ou AAD.

La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemple

Pour plus d’informations sur l’authentification auprès d’Azure Active Directory, consultez le package @azure/identity.

import { TextAnalysisClient } from "@azure/ai-language-text";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new TextAnalysisClient(endpoint, credential);

Méthodes

analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour déterminer la langue dans laquelle les chaînes d’entrée passées sont écrites et retourne, pour chacune d’elles, la langue détectée ainsi qu’un score indiquant la confiance du modèle que la langue déduite est correcte. Les scores proches de 1 indiquent une certitude élevée dans le résultat. 120 langues sont prises en charge.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Détection de langue

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

Pour plus d’informations sur la détection de langue, consultez https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour déterminer la langue dans laquelle les chaînes d’entrée passées sont écrites et retourne, pour chacune d’elles, la langue détectée ainsi qu’un score indiquant la confiance du modèle que la langue déduite est correcte. Les scores proches de 1 indiquent une certitude élevée dans le résultat. 120 langues sont prises en charge.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Détection de langue

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

Pour plus d’informations sur la détection de langue, consultez https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour effectuer l’action de choix sur les chaînes d’entrée. Consultez $AnalyzeActionName pour obtenir la liste des actions prises en charge.

La disposition de chaque élément dans le tableau de résultats dépend de l’action choisie. Par exemple, chaque résultat du document PIIEntityRecognition se compose à la fois de entities et de redactedText où l’ancien est une liste de toutes les entités Pii dans le texte et que ce dernier est le texte d’origine après que toutes ces entités Pii ont été supprimées.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Exploration des opinions

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview pour plus d’informations sur l’exploration de données d’opinion.

Informations d’identification personnelle

const documents = [<input strings>];
const languageCode = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageCode, {
  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
    }
  }
}

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview pour plus d’informations sur les informations d’identification personnelle.
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour effectuer l’action de choix sur les documents d’entrée. Consultez $AnalyzeActionName pour obtenir la liste des actions prises en charge.

La disposition de chaque élément dans le tableau de résultats dépend de l’action choisie. Par exemple, chaque résultat du document PIIEntityRecognition se compose à la fois de entities et de redactedText où l’ancien est une liste de toutes les entités Pii dans le texte et que ce dernier est le texte d’origine après que toutes ces entités Pii ont été supprimées.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Exploration des opinions

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview pour plus d’informations sur l’exploration de données d’opinion.

Informations d’identification personnelle

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview pour plus d’informations sur les informations d’identification personnelle.
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)

Effectue un tableau (lot) d’actions sur les documents d’entrée. Chaque action a un champ kind qui spécifie la nature de l’action. Consultez $AnalyzeBatchActionNames pour obtenir la liste des actions prises en charge. Outre kind, les actions peuvent également avoir d’autres paramètres tels que disableServiceLogs et modelVersion.

Le tableau de résultats contient les résultats de ces actions d’entrée où chaque élément a également un champ kind qui spécifie le type des résultats.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Extraction d’expressions clés et reconnaissance d’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;
   }
 }
}
beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)

Effectue un tableau (lot) d’actions sur les documents d’entrée. Chaque action a un champ kind qui spécifie la nature de l’action. Consultez $AnalyzeBatchActionNames pour obtenir la liste des actions prises en charge. Outre kind, les actions peuvent également avoir d’autres paramètres tels que disableServiceLogs et modelVersion.

Le tableau de résultats contient les résultats de ces actions d’entrée où chaque élément a également un champ kind qui spécifie le type des résultats.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Extraction de cléphrase et reconnaissance d’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;
   }
 }
}
restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

Détails du constructeur

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Crée une instance de TextAnalysisClient avec le point de terminaison d’une ressource language et une méthode d’authentification telle qu’une clé API ou AAD.

La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemple

import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-language-text";

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)

Paramètres

endpointUrl

string

URL du point de terminaison d’une ressource Cognitive Language Service

credential
KeyCredential

Informations d’identification clés à utiliser pour authentifier les demandes auprès du service.

options
TextAnalysisClientOptions

Utilisé pour configurer le client TextAnalytics.

TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)

Crée une instance de TextAnalysisClient avec le point de terminaison d’une ressource language et une méthode d’authentification telle qu’une clé API ou AAD.

La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemple

Pour plus d’informations sur l’authentification auprès d’Azure Active Directory, consultez le package @azure/identity.

import { TextAnalysisClient } from "@azure/ai-language-text";
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)

Paramètres

endpointUrl

string

URL du point de terminaison d’une ressource Cognitive Language Service

credential
TokenCredential

Informations d’identification du jeton à utiliser pour authentifier les demandes auprès du service.

options
TextAnalysisClientOptions

Utilisé pour configurer le client TextAnalytics.

Détails de la méthode

analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour déterminer la langue dans laquelle les chaînes d’entrée passées sont écrites et retourne, pour chacune d’elles, la langue détectée ainsi qu’un score indiquant la confiance du modèle que la langue déduite est correcte. Les scores proches de 1 indiquent une certitude élevée dans le résultat. 120 langues sont prises en charge.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Détection de langue

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

Pour plus d’informations sur la détection de langue, consultez 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>>

Paramètres

actionName

ActionName

nom de l’action à effectuer sur les documents d’entrée, voir $AnalyzeActionName

documents

LanguageDetectionInput[]

documents d’entrée à analyser

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

paramètres et paramètres d’action facultatifs pour l’opération

Retours

Promise<AnalyzeResult<ActionName>>

tableau de résultats où chaque élément contient la langue principale du document d’entrée correspondant.

analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour déterminer la langue dans laquelle les chaînes d’entrée passées sont écrites et retourne, pour chacune d’elles, la langue détectée ainsi qu’un score indiquant la confiance du modèle que la langue déduite est correcte. Les scores proches de 1 indiquent une certitude élevée dans le résultat. 120 langues sont prises en charge.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Détection de langue

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

Pour plus d’informations sur la détection de langue, consultez 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>>

Paramètres

actionName

ActionName

nom de l’action à effectuer sur les documents d’entrée, voir $AnalyzeActionName

documents

string[]

documents d’entrée à analyser

countryHint

string

Indique le pays d’origine de toutes les chaînes d’entrée pour aider le modèle à prédire la langue dans laquelle ils sont écrits. Si elle n’est pas spécifiée, cette valeur est définie sur l’indicateur de pays par défaut dans TextAnalysisClientOptions. Si la valeur est définie sur une chaîne vide ou la chaîne « none », le service applique un modèle dans lequel le pays est explicitement non défini. Le même indicateur de pays est appliqué à toutes les chaînes de la collection d’entrée.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

paramètres et paramètres d’action facultatifs pour l’opération

Retours

Promise<AnalyzeResult<ActionName>>

tableau de résultats où chaque élément contient la langue principale du document d’entrée correspondant.

analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour effectuer l’action de choix sur les chaînes d’entrée. Consultez $AnalyzeActionName pour obtenir la liste des actions prises en charge.

La disposition de chaque élément dans le tableau de résultats dépend de l’action choisie. Par exemple, chaque résultat du document PIIEntityRecognition se compose à la fois de entities et de redactedText où l’ancien est une liste de toutes les entités Pii dans le texte et que ce dernier est le texte d’origine après que toutes ces entités Pii ont été supprimées.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Exploration des opinions

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview pour plus d’informations sur l’exploration de données d’opinion.

Informations d’identification personnelle

const documents = [<input strings>];
const languageCode = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageCode, {
  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
    }
  }
}

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview pour plus d’informations sur les informations d’identification personnelle.

function analyze<ActionName>(actionName: ActionName, documents: string[], languageCode?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

Paramètres

actionName

ActionName

nom de l’action à effectuer sur les documents d’entrée, voir $AnalyzeActionName

documents

string[]

documents d’entrée à analyser

languageCode

string

code de la langue dans laquelle toutes les chaînes d’entrée sont écrites. Si elle n’est pas spécifiée, cette valeur est définie sur la langue par défaut dans TextAnalysisClientOptions. Si la valeur est définie sur une chaîne vide, le service applique un modèle dans lequel la langue est explicitement définie sur « None ». La prise en charge linguistique varie par action, par exemple, plus d’informations sur les langues prises en charge pour les actions De reconnaissance d’entité se trouvent dans https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Si la valeur est « automatique », le service déduit automatiquement la langue du texte d’entrée.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

paramètres et paramètres d’action facultatifs pour l’opération

Retours

Promise<AnalyzeResult<ActionName>>

tableau de résultats correspondant aux documents d’entrée

analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Exécute un modèle prédictif pour effectuer l’action de choix sur les documents d’entrée. Consultez $AnalyzeActionName pour obtenir la liste des actions prises en charge.

La disposition de chaque élément dans le tableau de résultats dépend de l’action choisie. Par exemple, chaque résultat du document PIIEntityRecognition se compose à la fois de entities et de redactedText où l’ancien est une liste de toutes les entités Pii dans le texte et que ce dernier est le texte d’origine après que toutes ces entités Pii ont été supprimées.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Exploration des opinions

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview pour plus d’informations sur l’exploration de données d’opinion.

Informations d’identification personnelle

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

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview pour plus d’informations sur les informations d’identification personnelle.

function analyze<ActionName>(actionName: ActionName, documents: TextDocumentInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

Paramètres

actionName

ActionName

nom de l’action à effectuer sur les documents d’entrée, voir $AnalyzeActionName

documents

TextDocumentInput[]

documents d’entrée à analyser

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

paramètres et paramètres d’action facultatifs pour l’opération

Retours

Promise<AnalyzeResult<ActionName>>

tableau de résultats correspondant aux documents d’entrée

beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)

Effectue un tableau (lot) d’actions sur les documents d’entrée. Chaque action a un champ kind qui spécifie la nature de l’action. Consultez $AnalyzeBatchActionNames pour obtenir la liste des actions prises en charge. Outre kind, les actions peuvent également avoir d’autres paramètres tels que disableServiceLogs et modelVersion.

Le tableau de résultats contient les résultats de ces actions d’entrée où chaque élément a également un champ kind qui spécifie le type des résultats.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Extraction d’expressions clés et reconnaissance d’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>

Paramètres

actions

AnalyzeBatchAction[]

tableau d’actions qui seront exécutées sur les documents d’entrée

documents

string[]

documents d’entrée à analyser

languageCode

string

code de la langue dans laquelle toutes les chaînes d’entrée sont écrites. Si elle n’est pas spécifiée, cette valeur est définie sur la langue par défaut dans TextAnalysisClientOptions. Si la valeur est définie sur une chaîne vide, le service applique un modèle dans lequel la langue est explicitement définie sur « None ». La prise en charge linguistique varie par action, par exemple, plus d’informations sur les langues prises en charge pour les actions De reconnaissance d’entité se trouvent dans https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Si la valeur est « automatique », le service déduit automatiquement la langue du texte d’entrée.

options
BeginAnalyzeBatchOptions

paramètres facultatifs pour l’opération

Retours

Promise<AnalyzeBatchPoller>

tableau de résultats correspondant aux actions d’entrée

beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)

Effectue un tableau (lot) d’actions sur les documents d’entrée. Chaque action a un champ kind qui spécifie la nature de l’action. Consultez $AnalyzeBatchActionNames pour obtenir la liste des actions prises en charge. Outre kind, les actions peuvent également avoir d’autres paramètres tels que disableServiceLogs et modelVersion.

Le tableau de résultats contient les résultats de ces actions d’entrée où chaque élément a également un champ kind qui spécifie le type des résultats.

Consultez https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits pour connaître les limites de données.

Exemples

Extraction de cléphrase et reconnaissance d’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>

Paramètres

actions

AnalyzeBatchAction[]

tableau d’actions qui seront exécutées sur les documents d’entrée

documents

TextDocumentInput[]

documents d’entrée à analyser

options
BeginAnalyzeBatchOptions

paramètres facultatifs pour l’opération

Retours

Promise<AnalyzeBatchPoller>

tableau de résultats correspondant aux actions d’entrée

restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

function restoreAnalyzeBatchPoller(serializedState: string, options?: RestoreAnalyzeBatchPollerOptions): Promise<AnalyzeBatchPoller>

Paramètres

serializedState

string

l’état sérialisé d’un autre polleur. C’est le résultat de poller.toString()

options
RestoreAnalyzeBatchPollerOptions

paramètres facultatifs pour l’opération

Exemple

client.beginAnalyzeBatch retourne une promesse qui sera résolue à un polleur. L’état du polleur peut être sérialisé et utilisé pour créer un autre comme suit :

const serializedState = poller.toString();
const rehydratedPoller = await client.createAnalyzeBatchPoller(serializedState);
const actionResults = await rehydratedPoller.pollUntilDone();

Retours

Promise<AnalyzeBatchPoller>