Freigeben über

TextAnalysisClient class

Paket:
@azure/ai-language-text

Ein Client für die Interaktion mit den Textanalysefeatures in Azure Cognitive Language Service.

Der Client benötigt den Endpunkt einer Sprachressource und eine Authentifizierungsmethode wie einen API-Schlüssel oder AAD. Der API-Schlüssel und -Endpunkt finden Sie auf der Ressourcenseite "Sprache" im Azure-Portal. Sie befinden sich auf der Seite "Schlüssel und Endpunkt" der Ressource unter "Ressourcenverwaltung".

Beispiele für die Authentifizierung:

API-Schlüssel

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

Weitere Informationen zur Authentifizierung mit Azure Active Directory finden Sie im @azure/identity-Paket.

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

Konstruktoren

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Erstellt eine Instanz von TextAnalysisClient mit dem Endpunkt einer Language-Ressource und einer Authentifizierungsmethode wie einem API-Schlüssel oder AAD.

Der API-Schlüssel und -Endpunkt finden Sie auf der Ressourcenseite "Sprache" im Azure-Portal. Sie befinden sich auf der Seite "Schlüssel und Endpunkt" der Ressource unter "Ressourcenverwaltung".

Beispiel

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)

Erstellt eine Instanz von TextAnalysisClient mit dem Endpunkt einer Language-Ressource und einer Authentifizierungsmethode wie einem API-Schlüssel oder AAD.

Der API-Schlüssel und -Endpunkt finden Sie auf der Ressourcenseite "Sprache" im Azure-Portal. Sie befinden sich auf der Seite "Schlüssel und Endpunkt" der Ressource unter "Ressourcenverwaltung".

Beispiel

Weitere Informationen zur Authentifizierung mit Azure Active Directory finden Sie im @azure/identity-Paket.

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

Methoden

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

Führt ein Prädiktivmodell aus, um die Sprache zu bestimmen, in die die übergebenen Eingabezeichenfolgen geschrieben werden, und gibt für jede Sprache die erkannte Sprache sowie eine Bewertung zurück, die das Vertrauen des Modells angibt, dass die abgeleitete Sprache korrekt ist. Ergebnisse in der Nähe von 1 deuten auf hohe Sicherheit im Ergebnis hin. 120 Sprachen werden unterstützt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Spracherkennung

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

Weitere Informationen zur Spracherkennung finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Führt ein Prädiktivmodell aus, um die Sprache zu bestimmen, in die die übergebenen Eingabezeichenfolgen geschrieben werden, und gibt für jede Sprache die erkannte Sprache sowie eine Bewertung zurück, die das Vertrauen des Modells angibt, dass die abgeleitete Sprache korrekt ist. Ergebnisse in der Nähe von 1 deuten auf hohe Sicherheit im Ergebnis hin. 120 Sprachen werden unterstützt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Spracherkennung

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

Weitere Informationen zur Spracherkennung finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Führt ein prädiktives Modell aus, um die Wahlaktion für die Eingabezeichenfolgen auszuführen. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeActionName-.

Das Layout der einzelnen Elemente im Ergebnisarray hängt von der ausgewählten Aktion ab. Beispielsweise besteht jedes PIIEntityRecognition-Dokumentergebnis aus entities und redactedText, wobei der frühere eine Liste aller pii-Entitäten im Text ist und letzteres der ursprüngliche Text ist, nachdem alle diese pii-Entitäten von ihr redagiert wurden.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Opinion Mining

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

Weitere Informationen zum Meinungsmining finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Persönlich identifizierbare Informationen

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

Weitere Informationen zu personenbezogenen Informationen finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview.
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Führt ein prädiktives Modell aus, um die Wahlaktion für die Eingabedokumente auszuführen. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeActionName-.

Das Layout der einzelnen Elemente im Ergebnisarray hängt von der ausgewählten Aktion ab. Beispielsweise besteht jedes PIIEntityRecognition-Dokumentergebnis aus entities und redactedText, wobei der frühere eine Liste aller pii-Entitäten im Text ist und letzteres der ursprüngliche Text ist, nachdem alle diese pii-Entitäten von ihr redagiert wurden.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Opinion Mining

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

Weitere Informationen zum Meinungsmining finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Persönlich identifizierbare Informationen

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

Weitere Informationen zu personenbezogenen Informationen finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview.
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)

Führt ein Array (Batch) von Aktionen für die Eingabedokumente aus. Jede Aktion verfügt über ein kind Feld, das die Art der Aktion angibt. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeBatchActionNames. Neben kindkönnen Aktionen auch andere Parameter wie disableServiceLogs und modelVersionhaben.

Das Ergebnisarray enthält die Ergebnisse für die Eingabeaktionen, bei denen jedes Element auch ein kind Feld enthält, das den Typ der Ergebnisse angibt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Erkennung von Schlüsselausdrücken und Erkennung von Pii-Entitäten

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)

Führt ein Array (Batch) von Aktionen für die Eingabedokumente aus. Jede Aktion verfügt über ein kind Feld, das die Art der Aktion angibt. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeBatchActionNames. Neben kindkönnen Aktionen auch andere Parameter wie disableServiceLogs und modelVersionhaben.

Das Ergebnisarray enthält die Ergebnisse für die Eingabeaktionen, bei denen jedes Element auch ein kind Feld enthält, das den Typ der Ergebnisse angibt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Keyphrasenextraktion und Pii-Entitätserkennung

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)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Details zum Konstruktor

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Erstellt eine Instanz von TextAnalysisClient mit dem Endpunkt einer Language-Ressource und einer Authentifizierungsmethode wie einem API-Schlüssel oder AAD.

Der API-Schlüssel und -Endpunkt finden Sie auf der Ressourcenseite "Sprache" im Azure-Portal. Sie befinden sich auf der Seite "Schlüssel und Endpunkt" der Ressource unter "Ressourcenverwaltung".

Beispiel

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)

Parameter

endpointUrl

string

Die URL zum Endpunkt einer Cognitive Language Service-Ressource

credential
KeyCredential

Schlüsselanmeldeinformationen, die zum Authentifizieren von Anforderungen an den Dienst verwendet werden sollen.

options
TextAnalysisClientOptions

Wird verwendet, um den TextAnalytics-Client zu konfigurieren.

TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)

Erstellt eine Instanz von TextAnalysisClient mit dem Endpunkt einer Language-Ressource und einer Authentifizierungsmethode wie einem API-Schlüssel oder AAD.

Der API-Schlüssel und -Endpunkt finden Sie auf der Ressourcenseite "Sprache" im Azure-Portal. Sie befinden sich auf der Seite "Schlüssel und Endpunkt" der Ressource unter "Ressourcenverwaltung".

Beispiel

Weitere Informationen zur Authentifizierung mit Azure Active Directory finden Sie im @azure/identity-Paket.

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)

Parameter

endpointUrl

string

Die URL zum Endpunkt einer Cognitive Language Service-Ressource

credential
TokenCredential

Tokenanmeldeinformationen, die zum Authentifizieren von Anforderungen an den Dienst verwendet werden sollen.

options
TextAnalysisClientOptions

Wird verwendet, um den TextAnalytics-Client zu konfigurieren.

Details zur Methode

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

Führt ein Prädiktivmodell aus, um die Sprache zu bestimmen, in die die übergebenen Eingabezeichenfolgen geschrieben werden, und gibt für jede Sprache die erkannte Sprache sowie eine Bewertung zurück, die das Vertrauen des Modells angibt, dass die abgeleitete Sprache korrekt ist. Ergebnisse in der Nähe von 1 deuten auf hohe Sicherheit im Ergebnis hin. 120 Sprachen werden unterstützt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Spracherkennung

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

Weitere Informationen zur Spracherkennung finden Sie unter 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>>

Parameter

actionName

ActionName

der Name der Aktion, die für die Eingabedokumente ausgeführt werden soll, siehe $AnalyzeActionName

documents

LanguageDetectionInput[]

die zu analysierenden Eingabedokumente

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

optionale Aktionsparameter und -einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeResult<ActionName>>

ein Array von Ergebnissen, in dem jedes Element die primäre Sprache für das entsprechende Eingabedokument enthält.

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

Führt ein Prädiktivmodell aus, um die Sprache zu bestimmen, in die die übergebenen Eingabezeichenfolgen geschrieben werden, und gibt für jede Sprache die erkannte Sprache sowie eine Bewertung zurück, die das Vertrauen des Modells angibt, dass die abgeleitete Sprache korrekt ist. Ergebnisse in der Nähe von 1 deuten auf hohe Sicherheit im Ergebnis hin. 120 Sprachen werden unterstützt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Spracherkennung

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

Weitere Informationen zur Spracherkennung finden Sie unter 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>>

Parameter

actionName

ActionName

der Name der Aktion, die für die Eingabedokumente ausgeführt werden soll, siehe $AnalyzeActionName

documents

string[]

die zu analysierenden Eingabedokumente

countryHint

string

Gibt das Ursprungsland für alle Eingabezeichenfolgen an, um das Modell bei der Vorhersage der Sprache zu unterstützen, in der sie geschrieben sind. Wenn nicht angegeben, wird dieser Wert in TextAnalysisClientOptionsauf den Standardlandhinweis festgelegt. Wenn sie auf eine leere Zeichenfolge oder die Zeichenfolge "none" festgelegt ist, wendet der Dienst ein Modell an, bei dem das Land explizit nicht festgelegt ist. Derselbe Länderhinweis wird auf alle Zeichenfolgen in der Eingabeauflistung angewendet.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

optionale Aktionsparameter und -einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeResult<ActionName>>

ein Array von Ergebnissen, in dem jedes Element die primäre Sprache für das entsprechende Eingabedokument enthält.

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

Führt ein prädiktives Modell aus, um die Wahlaktion für die Eingabezeichenfolgen auszuführen. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeActionName-.

Das Layout der einzelnen Elemente im Ergebnisarray hängt von der ausgewählten Aktion ab. Beispielsweise besteht jedes PIIEntityRecognition-Dokumentergebnis aus entities und redactedText, wobei der frühere eine Liste aller pii-Entitäten im Text ist und letzteres der ursprüngliche Text ist, nachdem alle diese pii-Entitäten von ihr redagiert wurden.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Opinion Mining

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

Weitere Informationen zum Meinungsmining finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Persönlich identifizierbare Informationen

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

Weitere Informationen zu personenbezogenen Informationen finden Sie unter 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>>

Parameter

actionName

ActionName

der Name der Aktion, die für die Eingabedokumente ausgeführt werden soll, siehe $AnalyzeActionName

documents

string[]

die zu analysierenden Eingabedokumente

languageCode

string

der Code der Sprache, in der alle Eingabezeichenfolgen geschrieben sind. Wenn nicht angegeben, wird dieser Wert in TextAnalysisClientOptionsauf die Standardsprache festgelegt. Wenn dieser Wert auf eine leere Zeichenfolge festgelegt ist, wendet der Dienst ein Modell an, bei dem die Sprache explizit auf "None" festgelegt ist. Die Sprachunterstützung variiert je nach Aktion, z. B. weitere Informationen zu den sprachen, die für Entitätserkennungsaktionen unterstützt werden, finden Sie in https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Wenn diese Einstellung auf "auto" festgelegt ist, leitet der Dienst automatisch die Sprache vom Eingabetext ab.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

optionale Aktionsparameter und -einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeResult<ActionName>>

ein Array von Ergebnissen, die den Eingabedokumenten entsprechen

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

Führt ein prädiktives Modell aus, um die Wahlaktion für die Eingabedokumente auszuführen. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeActionName-.

Das Layout der einzelnen Elemente im Ergebnisarray hängt von der ausgewählten Aktion ab. Beispielsweise besteht jedes PIIEntityRecognition-Dokumentergebnis aus entities und redactedText, wobei der frühere eine Liste aller pii-Entitäten im Text ist und letzteres der ursprüngliche Text ist, nachdem alle diese pii-Entitäten von ihr redagiert wurden.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Opinion Mining

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

Weitere Informationen zum Meinungsmining finden Sie unter https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Persönlich identifizierbare Informationen

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

Weitere Informationen zu personenbezogenen Informationen finden Sie unter 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>>

Parameter

actionName

ActionName

der Name der Aktion, die für die Eingabedokumente ausgeführt werden soll, siehe $AnalyzeActionName

documents

TextDocumentInput[]

die zu analysierenden Eingabedokumente

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

optionale Aktionsparameter und -einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeResult<ActionName>>

ein Array von Ergebnissen, die den Eingabedokumenten entsprechen

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

Führt ein Array (Batch) von Aktionen für die Eingabedokumente aus. Jede Aktion verfügt über ein kind Feld, das die Art der Aktion angibt. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeBatchActionNames. Neben kindkönnen Aktionen auch andere Parameter wie disableServiceLogs und modelVersionhaben.

Das Ergebnisarray enthält die Ergebnisse für die Eingabeaktionen, bei denen jedes Element auch ein kind Feld enthält, das den Typ der Ergebnisse angibt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Erkennung von Schlüsselausdrücken und Erkennung von Pii-Entitäten

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>

Parameter

actions

AnalyzeBatchAction[]

ein Array von Aktionen, die für die Eingabedokumente ausgeführt werden

documents

string[]

die zu analysierenden Eingabedokumente

languageCode

string

der Code der Sprache, in der alle Eingabezeichenfolgen geschrieben sind. Wenn nicht angegeben, wird dieser Wert in TextAnalysisClientOptionsauf die Standardsprache festgelegt. Wenn dieser Wert auf eine leere Zeichenfolge festgelegt ist, wendet der Dienst ein Modell an, bei dem die Sprache explizit auf "None" festgelegt ist. Die Sprachunterstützung variiert je nach Aktion, z. B. weitere Informationen zu den sprachen, die für Entitätserkennungsaktionen unterstützt werden, finden Sie in https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Wenn diese Einstellung auf "auto" festgelegt ist, leitet der Dienst automatisch die Sprache vom Eingabetext ab.

options
BeginAnalyzeBatchOptions

optionale Einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeBatchPoller>

ein Array von Ergebnissen, die den Eingabeaktionen entsprechen

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

Führt ein Array (Batch) von Aktionen für die Eingabedokumente aus. Jede Aktion verfügt über ein kind Feld, das die Art der Aktion angibt. Eine Liste der unterstützten Aktionen finden Sie unter $AnalyzeBatchActionNames. Neben kindkönnen Aktionen auch andere Parameter wie disableServiceLogs und modelVersionhaben.

Das Ergebnisarray enthält die Ergebnisse für die Eingabeaktionen, bei denen jedes Element auch ein kind Feld enthält, das den Typ der Ergebnisse angibt.

Siehe https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits für Datenbeschränkungen.

Beispiele

Keyphrasenextraktion und Pii-Entitätserkennung

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>

Parameter

actions

AnalyzeBatchAction[]

ein Array von Aktionen, die für die Eingabedokumente ausgeführt werden

documents

TextDocumentInput[]

die zu analysierenden Eingabedokumente

options
BeginAnalyzeBatchOptions

optionale Einstellungen für den Vorgang

Gibt zurück

Promise<AnalyzeBatchPoller>

ein Array von Ergebnissen, die den Eingabeaktionen entsprechen

restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

serializedState

string

der serialisierte Zustand eines anderen Pollers. Es ist das Ergebnis von poller.toString()

options
RestoreAnalyzeBatchPollerOptions

optionale Einstellungen für den Vorgang

Beispiel

client.beginAnalyzeBatch gibt eine Zusage zurück, die zu einem Poller aufgelöst wird. Der Zustand des Pollers kann serialisiert und verwendet werden, um eine weitere wie folgt zu erstellen:

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

Gibt zurück

Promise<AnalyzeBatchPoller>