TextAnalysisClient class
Klient pro interakci s funkcemi analýzy textu ve službě Azure Cognitive Language Service
Klient potřebuje koncový bod prostředku jazyka a metodu ověřování, jako je klíč rozhraní API nebo AAD. Klíč rozhraní API a koncový bod najdete na stránce prostředku jazyka na webu Azure Portal. Budou umístěny na stránce klíče a koncového bodu prostředku v části Správa prostředků.
Příklady ověřování:
Klíč rozhraní 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
Další informace o ověřování pomocí Azure Active Directory najdete v balíčku @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);
Konstruktory
| Text |
Vytvoří instanci TextAnalysisClient s koncovým bodem prostředku jazyka a metodou ověřování, jako je klíč rozhraní API nebo AAD. Klíč rozhraní API a koncový bod najdete na stránce prostředku jazyka na webu Azure Portal. Budou umístěny na stránce klíče a koncového bodu prostředku v části Správa prostředků. Příklad
|
| Text |
Vytvoří instanci TextAnalysisClient s koncovým bodem prostředku jazyka a metodou ověřování, jako je klíč rozhraní API nebo AAD. Klíč rozhraní API a koncový bod najdete na stránce prostředku jazyka na webu Azure Portal. Budou umístěny na stránce klíče a koncového bodu prostředku v části Správa prostředků. PříkladDalší informace o ověřování pomocí Azure Active Directory najdete v balíčku
|
Metody
| analyze<Action |
Spustí prediktivní model, který určí jazyk, ve kterém se předané vstupní řetězce zapisují, a vrátí pro každý z nich zjištěný jazyk a skóre označující spolehlivost modelu, že odvozený jazyk je správný. Skóre blížící se 1 značí ve výsledku vysokou jistotu. Podporuje se 120 jazyků. Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyRozpoznávání jazyka
Další informace o rozpoznávání jazyka najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview. |
| analyze<Action |
Spustí prediktivní model, který určí jazyk, ve kterém se předané vstupní řetězce zapisují, a vrátí pro každý z nich zjištěný jazyk a skóre označující spolehlivost modelu, že odvozený jazyk je správný. Skóre blížící se 1 značí ve výsledku vysokou jistotu. Podporuje se 120 jazyků. Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyRozpoznávání jazyka
Další informace o rozpoznávání jazyka najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview. |
| analyze<Action |
Spustí prediktivní model, který provede akci výběru u vstupních řetězců. Seznam podporovaných akcí najdete v části $AnalyzeActionName. Rozložení každé položky v poli výsledků závisí na zvolené akci.
Například každý výsledek dokumentu PIIEntityRecognition se skládá z Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyStanovisko dolování
Další informace o dolování názorů najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview. Identifikovatelné osobní údaje
Další informace o identifikovatelných osobních údajích najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview. |
| analyze<Action |
Spustí prediktivní model, který provede akci výběru u vstupních dokumentů. Seznam podporovaných akcí najdete v části $AnalyzeActionName. Rozložení každé položky v poli výsledků závisí na zvolené akci.
Například každý výsledek dokumentu PIIEntityRecognition se skládá z Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyStanovisko dolování
Další informace o dolování názorů najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview. Identifikovatelné osobní údaje
Další informace o identifikovatelných osobních údajích najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview. |
| begin |
Provede pole (dávku) akcí na vstupních dokumentech. Každá akce má pole Pole výsledků obsahuje výsledky pro tyto vstupní akce, kde každá položka má také Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyExtrakce klíčových frází a rozpoznávání entit Pii
|
| begin |
Provede pole (dávku) akcí na vstupních dokumentech. Každá akce má pole Pole výsledků obsahuje výsledky pro tyto vstupní akce, kde každá položka má také Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits. PříkladyExtrakce klíčových frází a rozpoznávání entit Pii
|
| restore |
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu. |
Podrobnosti konstruktoru
TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)
Vytvoří instanci TextAnalysisClient s koncovým bodem prostředku jazyka a metodou ověřování, jako je klíč rozhraní API nebo AAD.
Klíč rozhraní API a koncový bod najdete na stránce prostředku jazyka na webu Azure Portal. Budou umístěny na stránce klíče a koncového bodu prostředku v části Správa prostředků.
Příklad
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)
Parametry
- endpointUrl
-
string
Adresa URL koncového bodu prostředku služby Cognitive Language Service
- credential
- KeyCredential
Přihlašovací údaje klíče, které se mají použít k ověřování požadavků na službu.
- options
- TextAnalysisClientOptions
Slouží ke konfiguraci klienta TextAnalytics.
TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)
Vytvoří instanci TextAnalysisClient s koncovým bodem prostředku jazyka a metodou ověřování, jako je klíč rozhraní API nebo AAD.
Klíč rozhraní API a koncový bod najdete na stránce prostředku jazyka na webu Azure Portal. Budou umístěny na stránce klíče a koncového bodu prostředku v části Správa prostředků.
Příklad
Další informace o ověřování pomocí Azure Active Directory najdete v balíčku @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)
Parametry
- endpointUrl
-
string
Adresa URL koncového bodu prostředku služby Cognitive Language Service
- credential
- TokenCredential
Přihlašovací údaje tokenu, které se mají použít k ověřování požadavků na službu.
- options
- TextAnalysisClientOptions
Slouží ke konfiguraci klienta TextAnalytics.
Podrobnosti metody
analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Spustí prediktivní model, který určí jazyk, ve kterém se předané vstupní řetězce zapisují, a vrátí pro každý z nich zjištěný jazyk a skóre označující spolehlivost modelu, že odvozený jazyk je správný. Skóre blížící se 1 značí ve výsledku vysokou jistotu. Podporuje se 120 jazyků.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Rozpoznávání jazyka
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;
}
}
Další informace o rozpoznávání jazyka najdete v 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>>
Parametry
- actionName
-
ActionName
název akce, která se má provést se vstupními dokumenty, viz $AnalyzeActionName
- documents
vstupní dokumenty, které se mají analyzovat
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
volitelné parametry a nastavení akce pro operaci
Návraty
Promise<AnalyzeResult<ActionName>>
pole výsledků, kde každý prvek obsahuje primární jazyk pro odpovídající vstupní dokument.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Spustí prediktivní model, který určí jazyk, ve kterém se předané vstupní řetězce zapisují, a vrátí pro každý z nich zjištěný jazyk a skóre označující spolehlivost modelu, že odvozený jazyk je správný. Skóre blížící se 1 značí ve výsledku vysokou jistotu. Podporuje se 120 jazyků.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Rozpoznávání jazyka
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;
}
}
Další informace o rozpoznávání jazyka najdete v 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>>
Parametry
- actionName
-
ActionName
název akce, která se má provést se vstupními dokumenty, viz $AnalyzeActionName
- documents
-
string[]
vstupní dokumenty, které se mají analyzovat
- countryHint
-
string
Označuje zemi původu pro všechny vstupní řetězce, které pomáhají modelu při předpovídání jazyka, ve kterém jsou napsané. Pokud není zadáno, bude tato hodnota nastavena na výchozí nápovědu země v TextAnalysisClientOptions. Pokud je nastaven prázdný řetězec nebo řetězec "none", služba použije model, ve kterém je země explicitně nenastavovaná. Stejný tip země se použije pro všechny řetězce ve vstupní kolekci.
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
volitelné parametry a nastavení akce pro operaci
Návraty
Promise<AnalyzeResult<ActionName>>
pole výsledků, kde každý prvek obsahuje primární jazyk pro odpovídající vstupní dokument.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Spustí prediktivní model, který provede akci výběru u vstupních řetězců. Seznam podporovaných akcí najdete v části $AnalyzeActionName.
Rozložení každé položky v poli výsledků závisí na zvolené akci.
Například každý výsledek dokumentu PIIEntityRecognition se skládá z entities i redactedText, kde první je seznam všech entit Pii v textu a druhý je původní text, jakmile se z nich všechny takové entity Pii znovu zřetězily.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Stanovisko dolování
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
}
}
}
}
}
Další informace o dolování názorů najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.
Identifikovatelné osobní údaje
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
}
}
}
Další informace o identifikovatelných osobních údajích najdete v 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>>
Parametry
- actionName
-
ActionName
název akce, která se má provést se vstupními dokumenty, viz $AnalyzeActionName
- documents
-
string[]
vstupní dokumenty, které se mají analyzovat
- languageCode
-
string
kód jazyka, ve kterém jsou zapsány všechny vstupní řetězce. Pokud není zadáno, tato hodnota bude nastavena na výchozí jazyk v TextAnalysisClientOptions. Pokud je nastavena na prázdný řetězec, služba použije model, ve kterém je jazyk explicitně nastaven na None. Podpora jazyků se liší podle akce, například další informace o jazycích podporovaných pro akce rozpoznávání entit najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support.
Pokud je nastavená hodnota "auto", služba automaticky odvodí jazyk ze vstupního textu.
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
volitelné parametry a nastavení akce pro operaci
Návraty
Promise<AnalyzeResult<ActionName>>
pole výsledků odpovídajících vstupním dokumentům
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)
Spustí prediktivní model, který provede akci výběru u vstupních dokumentů. Seznam podporovaných akcí najdete v části $AnalyzeActionName.
Rozložení každé položky v poli výsledků závisí na zvolené akci.
Například každý výsledek dokumentu PIIEntityRecognition se skládá z entities i redactedText, kde první je seznam všech entit Pii v textu a druhý je původní text, jakmile se z nich všechny takové entity Pii znovu zřetězily.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Stanovisko dolování
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
}
}
}
}
}
Další informace o dolování názorů najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.
Identifikovatelné osobní údaje
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
}
}
}
Další informace o identifikovatelných osobních údajích najdete v 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>>
Parametry
- actionName
-
ActionName
název akce, která se má provést se vstupními dokumenty, viz $AnalyzeActionName
- documents
vstupní dokumenty, které se mají analyzovat
- options
-
AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions
volitelné parametry a nastavení akce pro operaci
Návraty
Promise<AnalyzeResult<ActionName>>
pole výsledků odpovídajících vstupním dokumentům
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)
Provede pole (dávku) akcí na vstupních dokumentech. Každá akce má pole kind, které určuje povahu akce. Seznam podporovaných akcí najdete v tématu $AnalyzeBatchActionNames. Kromě kindmohou mít akce také další parametry, jako jsou disableServiceLogs a modelVersion.
Pole výsledků obsahuje výsledky pro tyto vstupní akce, kde každá položka má také kind pole, které určuje typ výsledků.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Extrakce klíčových frází a rozpoznávání 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>
Parametry
- actions
pole akcí, které se budou spouštět na vstupních dokumentech
- documents
-
string[]
vstupní dokumenty, které se mají analyzovat
- languageCode
-
string
kód jazyka, ve kterém jsou zapsány všechny vstupní řetězce. Pokud není zadáno, tato hodnota bude nastavena na výchozí jazyk v TextAnalysisClientOptions. Pokud je nastavena na prázdný řetězec, služba použije model, ve kterém je jazyk explicitně nastaven na None. Podpora jazyků se liší podle akce, například další informace o jazycích podporovaných pro akce rozpoznávání entit najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support.
Pokud je nastavená hodnota "auto", služba automaticky odvodí jazyk ze vstupního textu.
- options
- BeginAnalyzeBatchOptions
volitelná nastavení pro operaci
Návraty
Promise<AnalyzeBatchPoller>
pole výsledků odpovídajících vstupním akcím
beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)
Provede pole (dávku) akcí na vstupních dokumentech. Každá akce má pole kind, které určuje povahu akce. Seznam podporovaných akcí najdete v tématu $AnalyzeBatchActionNames. Kromě kindmohou mít akce také další parametry, jako jsou disableServiceLogs a modelVersion.
Pole výsledků obsahuje výsledky pro tyto vstupní akce, kde každá položka má také kind pole, které určuje typ výsledků.
Informace o omezeních dat najdete v https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits.
Příklady
Extrakce klíčových frází a rozpoznávání 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>
Parametry
- actions
pole akcí, které se budou spouštět na vstupních dokumentech
- documents
vstupní dokumenty, které se mají analyzovat
- options
- BeginAnalyzeBatchOptions
volitelná nastavení pro operaci
Návraty
Promise<AnalyzeBatchPoller>
pole výsledků odpovídajících vstupním akcím
restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.
function restoreAnalyzeBatchPoller(serializedState: string, options?: RestoreAnalyzeBatchPollerOptions): Promise<AnalyzeBatchPoller>
Parametry
- serializedState
-
string
serializovaný stav jiného vrtu. Jedná se o výsledek poller.toString()
- options
- RestoreAnalyzeBatchPollerOptions
volitelná nastavení pro operaci
Příklad
client.beginAnalyzeBatch vrátí slib, který se přeloží na poller.
Stav poller lze serializovat a použít k vytvoření další následujícím způsobem:
const serializedState = poller.toString();
const rehydratedPoller = await client.createAnalyzeBatchPoller(serializedState);
const actionResults = await rehydratedPoller.pollUntilDone();
Návraty
Promise<AnalyzeBatchPoller>