Crea una instancia de TextAnalysisClient con el punto de conexión de un recurso language y un método de autenticación, como una clave de API o AAD.

La clave de API y el punto de conexión se pueden encontrar en la página Recurso de idioma en Azure Portal. Se ubicarán en la página Claves y punto de conexión del recurso, en Administración de recursos.

Ejemplo

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)

Parámetros

Crea una instancia de TextAnalysisClient con el punto de conexión de un recurso language y un método de autenticación, como una clave de API o AAD.

La clave de API y el punto de conexión se pueden encontrar en la página Recurso de idioma en Azure Portal. Se ubicarán en la página Claves y punto de conexión del recurso, en Administración de recursos.

Ejemplo

Consulte el paquete de @azure/identity para obtener más información sobre la autenticación con Azure Active Directory.

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)

Parámetros

Ejecuta un modelo predictivo para determinar el idioma en el que se escriben las cadenas de entrada pasadas y devuelve, para cada uno, el idioma detectado, así como una puntuación que indica la confianza del modelo de que el idioma inferido es correcto. Las puntuaciones cercanas a 1 indican una alta certeza en el resultado. Se admiten 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Detección de idioma

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obtener más información sobre la detección de idioma.

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

Parámetros

Devoluciones

matriz de resultados donde cada elemento contiene el idioma principal del documento de entrada correspondiente.

Ejecuta un modelo predictivo para determinar el idioma en el que se escriben las cadenas de entrada pasadas y devuelve, para cada uno, el idioma detectado, así como una puntuación que indica la confianza del modelo de que el idioma inferido es correcto. Las puntuaciones cercanas a 1 indican una alta certeza en el resultado. Se admiten 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Detección de idioma

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obtener más información sobre la detección de idioma.

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

Parámetros

Devoluciones

matriz de resultados donde cada elemento contiene el idioma principal del documento de entrada correspondiente.

Ejecuta un modelo predictivo para realizar la acción que prefiera en las cadenas de entrada. Consulte $AnalyzeActionName para obtener una lista de las acciones admitidas.

El diseño de cada elemento de la matriz de resultados depende de la acción elegida. Por ejemplo, cada resultado del documento PIIEntityRecognition consta de entities y redactedText donde el primero es una lista de todas las entidades Pii del texto y este último es el texto original después de que se hayan censurado todas esas entidades Pii.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Minería de opiniones

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obtener más información sobre la minería de opiniones.

Información de identificación personal

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obtener más información sobre la información de identificación personal.

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

Parámetros

Devoluciones

matriz de resultados correspondientes a los documentos de entrada

Ejecuta un modelo predictivo para realizar la acción que prefiera en los documentos de entrada. Consulte $AnalyzeActionName para obtener una lista de las acciones admitidas.

El diseño de cada elemento de la matriz de resultados depende de la acción elegida. Por ejemplo, cada resultado del documento PIIEntityRecognition consta de entities y redactedText donde el primero es una lista de todas las entidades Pii del texto y este último es el texto original después de que se hayan censurado todas esas entidades Pii.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Minería de opiniones

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obtener más información sobre la minería de opiniones.

Información de identificación personal

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

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obtener más información sobre la información de identificación personal.

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

Parámetros

Devoluciones

matriz de resultados correspondientes a los documentos de entrada

Realiza una matriz (lote) de acciones en los documentos de entrada. Cada acción tiene un campo kind que especifica la naturaleza de la acción. Consulte $AnalyzeBatchActionNames para obtener una lista de las acciones admitidas. Además de kind, las acciones también podrían tener otros parámetros, como disableServiceLogs y modelVersion.

La matriz de resultados contiene los resultados de esas acciones de entrada donde cada elemento también tiene un campo kind que especifica el tipo de los resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Extracción de frases clave y reconocimiento de entidades 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>

Parámetros

Devoluciones

matriz de resultados correspondientes a las acciones de entrada

Realiza una matriz (lote) de acciones en los documentos de entrada. Cada acción tiene un campo kind que especifica la naturaleza de la acción. Consulte $AnalyzeBatchActionNames para obtener una lista de las acciones admitidas. Además de kind, las acciones también podrían tener otros parámetros, como disableServiceLogs y modelVersion.

La matriz de resultados contiene los resultados de esas acciones de entrada donde cada elemento también tiene un campo kind que especifica el tipo de los resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para conocer los límites de datos.

Ejemplos

Extracción de frases clave y reconocimiento de entidades 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>

Parámetros

Devoluciones

matriz de resultados correspondientes a las acciones de entrada

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

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

Parámetros

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

Devoluciones