Skapar en instans av TextAnalysisClient med slutpunkten för en språkresurs och en autentiseringsmetod, till exempel en API-nyckel eller AAD.

API-nyckeln och slutpunkten finns på sidan Språkresurs i Azure-portalen. De kommer att finnas på resursens nyckel- och slutpunktssida under Resurshantering.

Exempel

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)

Parametrar

Skapar en instans av TextAnalysisClient med slutpunkten för en språkresurs och en autentiseringsmetod, till exempel en API-nyckel eller AAD.

API-nyckeln och slutpunkten finns på sidan Språkresurs i Azure-portalen. De kommer att finnas på resursens nyckel- och slutpunktssida under Resurshantering.

Exempel

Mer information om autentisering med Azure Active Directory finns i @azure/identity-paketet.

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)

Parametrar

Kör en förutsägelsemodell för att fastställa det språk som de skickade indatasträngarna skrivs i och returnerar, för var och en, det identifierade språket samt en poäng som anger modellens förtroende för att det härledda språket är korrekt. Poäng nära 1 indikerar hög säkerhet i resultatet. 120 språk stöds.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Språkidentifiering

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

Mer information om språkidentifiering finns i 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>>

Parametrar

Returnerar

en matris med resultat där varje element innehåller det primära språket för motsvarande indatadokument.

Kör en förutsägelsemodell för att fastställa det språk som de skickade indatasträngarna skrivs i och returnerar, för var och en, det identifierade språket samt en poäng som anger modellens förtroende för att det härledda språket är korrekt. Poäng nära 1 indikerar hög säkerhet i resultatet. 120 språk stöds.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Språkidentifiering

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

Mer information om språkidentifiering finns i 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>>

Parametrar

Returnerar

en matris med resultat där varje element innehåller det primära språket för motsvarande indatadokument.

Kör en förutsägelsemodell för att utföra valfri åtgärd på indatasträngarna. En lista över åtgärder som stöds finns i $AnalyzeActionName.

Layouten för varje objekt i resultatmatrisen beror på vilken åtgärd som valts. Till exempel består varje PIIEntityRecognition-dokumentresultat av både entities och redactedText där den förra är en lista över alla Pii-entiteter i texten och det senare är den ursprungliga texten när alla sådana Pii-entiteter har redigerats från den.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Åsiktsutvinning

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

Mer information om åsiktsutvinning finns i https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Personligt identifierbar information

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

Mer information om personligt identifierbar information finns i 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>>

Parametrar

Returnerar

en matris med resultat som motsvarar indatadokumenten

Kör en förutsägelsemodell för att utföra valfri åtgärd i indatadokumenten. En lista över åtgärder som stöds finns i $AnalyzeActionName.

Layouten för varje objekt i resultatmatrisen beror på vilken åtgärd som valts. Till exempel består varje PIIEntityRecognition-dokumentresultat av både entities och redactedText där den förra är en lista över alla Pii-entiteter i texten och det senare är den ursprungliga texten när alla sådana Pii-entiteter har redigerats från den.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Åsiktsutvinning

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

Mer information om åsiktsutvinning finns i https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Personligt identifierbar information

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

Mer information om personligt identifierbar information finns i 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>>

Parametrar

Returnerar

en matris med resultat som motsvarar indatadokumenten

Utför en matris (batch) med åtgärder i indatadokumenten. Varje åtgärd har ett kind fält som anger åtgärdens art. Se $AnalyzeBatchActionNames för en lista över åtgärder som stöds. Förutom kindkan åtgärder också ha andra parametrar som disableServiceLogs och modelVersion.

Resultatmatrisen innehåller resultatet för de indataåtgärder där varje objekt också har ett kind fält som anger typ av resultat.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Extrahering av nyckelfraser och Pii-entitetsigenkänning

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>

Parametrar

Returnerar

en matris med resultat som motsvarar indataåtgärderna

Utför en matris (batch) med åtgärder i indatadokumenten. Varje åtgärd har ett kind fält som anger åtgärdens art. Se $AnalyzeBatchActionNames för en lista över åtgärder som stöds. Förutom kindkan åtgärder också ha andra parametrar som disableServiceLogs och modelVersion.

Resultatmatrisen innehåller resultatet för de indataåtgärder där varje objekt också har ett kind fält som anger typ av resultat.

Se https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits för datagränser.

Exempel

Extrahering av nyckelfraser och Pii-entitetsigenkänning

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>

Parametrar

Returnerar

en matris med resultat som motsvarar indataåtgärderna

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

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

Returnerar