Compartir a través de


TextAnalyticsClient class

Clase de cliente para interactuar con Azure Text Analytics.

Constructores

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Crea una instancia de TextAnalyticsClient.

Ejemplo de uso:

import { TextAnalyticsClient, AzureKeyCredential } from "@azure/ai-text-analytics";

const client = new TextAnalyticsClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);

Propiedades

defaultCountryHint

Sugerencia de país predeterminada que se va a usar. El valor predeterminado es "nosotros".

defaultLanguage

Idioma predeterminado que se va a usar. El valor predeterminado es "en".

endpointUrl

Dirección URL al punto de conexión de TextAnalytics

Métodos

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Ejecuta un modelo predictivo para identificar las opiniones positivas, negativas, neutras o mixtas contenidas en las cadenas de entrada, así como las puntuaciones que indican la confianza del modelo en cada una de las opiniones previstas. Opcionalmente, también puede identificar destinos en el texto y las evaluaciones sobre él a través de la minería de opiniones. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)

Ejecuta un modelo predictivo para identificar las opiniones positivas, negativas o neutras o mixtas contenidas en los documentos de entrada, así como puntuaciones que indican la confianza del modelo en cada una de las opiniones previstas. Opcionalmente, también puede identificar destinos en el texto y las evaluaciones sobre él a través de la minería de opiniones. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)

Envía una colección de documentos de texto para su análisis. Especifique una o varias acciones únicas que se van a ejecutar.

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Envía una colección de documentos de texto para su análisis. Especifique una o varias acciones únicas que se van a ejecutar.

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

Inicie una operación de análisis de atención sanitaria para reconocer entidades relacionadas con la atención sanitaria (medicamentos, condiciones, síntomas, etc.) y sus relaciones.

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Inicie una operación de análisis de atención sanitaria para reconocer entidades relacionadas con la atención sanitaria (medicamentos, condiciones, síntomas, etc.) y sus relaciones.

detectLanguage(DetectLanguageInput[], DetectLanguageOptions)

Ejecuta un modelo predictivo para determinar el idioma en el que se escribe el documento de entrada pasado 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.

detectLanguage(string[], string, DetectLanguageOptions)

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.

extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)

Ejecuta un modelo para identificar una colección de frases significativas que se encuentran en las cadenas de entrada pasadas. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Ejecuta un modelo para identificar una colección de frases significativas que se encuentran en los documentos de entrada pasados. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades con nombre en las cadenas de entrada pasadas y clasificar esas entidades en tipos como persona, ubicación u organización. Para obtener más información sobre las categorías disponibles,

Vea https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obtener una lista de los idiomas admitidos por esta operación, vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades con nombre en los documentos de entrada pasados y clasificar esas entidades en tipos como persona, ubicación u organización. Para obtener más información sobre las categorías disponibles,

Vea https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obtener una lista de los idiomas admitidos por esta operación, vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que se encuentran en las cadenas de entrada pasadas e incluye información que vincula las entidades a sus entradas correspondientes en un knowledge base conocido. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que se encuentran en los documentos de entrada pasados e incluye información que vincula las entidades a sus entradas correspondientes en un knowledge base conocido. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que contienen información de identificación personal encontrada en las cadenas de entrada pasadas y clasificar esas entidades en tipos como el número de seguridad social de EE. UU., el número de licencia de conducir o el número de tarjeta de crédito. Para obtener una lista de idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que contienen información de identificación personal encontrada en los documentos de entrada pasados y clasificar esas entidades en tipos como el número de seguridad social de EE. UU., el número de licencia de conducir o el número de tarjeta de crédito. Para obtener una lista de idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

Detalles del constructor

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Crea una instancia de TextAnalyticsClient.

Ejemplo de uso:

import { TextAnalyticsClient, AzureKeyCredential } from "@azure/ai-text-analytics";

const client = new TextAnalyticsClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);
new TextAnalyticsClient(endpointUrl: string, credential: TokenCredential | KeyCredential, options?: TextAnalyticsClientOptions)

Parámetros

endpointUrl

string

Dirección URL del punto de conexión textAnalytics

credential

TokenCredential | KeyCredential

Se usa para autenticar las solicitudes en el servicio.

options
TextAnalyticsClientOptions

Se usa para configurar el cliente TextAnalytics.

Detalles de las propiedades

defaultCountryHint

Sugerencia de país predeterminada que se va a usar. El valor predeterminado es "nosotros".

defaultCountryHint: string

Valor de propiedad

string

defaultLanguage

Idioma predeterminado que se va a usar. El valor predeterminado es "en".

defaultLanguage: string

Valor de propiedad

string

endpointUrl

Dirección URL al punto de conexión de TextAnalytics

endpointUrl: string

Valor de propiedad

string

Detalles del método

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Ejecuta un modelo predictivo para identificar las opiniones positivas, negativas, neutras o mixtas contenidas en las cadenas de entrada, así como las puntuaciones que indican la confianza del modelo en cada una de las opiniones previstas. Opcionalmente, también puede identificar destinos en el texto y las evaluaciones sobre él a través de la minería de opiniones. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function analyzeSentiment(documents: string[], language?: string, options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>

Parámetros

documents

string[]

Cadenas de entrada que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde lanuage se establezca explícitamente en "None".

options
AnalyzeSentimentOptions

Parámetros opcionales que incluyen la habilitación de la minería de opiniones.

Devoluciones

analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)

Ejecuta un modelo predictivo para identificar las opiniones positivas, negativas o neutras o mixtas contenidas en los documentos de entrada, así como puntuaciones que indican la confianza del modelo en cada una de las opiniones previstas. Opcionalmente, también puede identificar destinos en el texto y las evaluaciones sobre él a través de la minería de opiniones. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function analyzeSentiment(documents: TextDocumentInput[], options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>

Parámetros

documents

TextDocumentInput[]

Documentos de entrada que se van a analizar.

options
AnalyzeSentimentOptions

Parámetros opcionales que incluyen la habilitación de la minería de opiniones.

Devoluciones

beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)

Envía una colección de documentos de texto para su análisis. Especifique una o varias acciones únicas que se van a ejecutar.

function beginAnalyzeActions(documents: string[], actions: TextAnalyticsActions, language?: string, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>

Parámetros

documents

string[]

Colección de documentos que se van a analizar

actions
TextAnalyticsActions

TextAnalyticsActions que se va a ejecutar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde el lenguaje se establezca explícitamente en "None".

options
BeginAnalyzeActionsOptions

Opciones de la operación.

Devoluciones

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Envía una colección de documentos de texto para su análisis. Especifique una o varias acciones únicas que se van a ejecutar.

function beginAnalyzeActions(documents: TextDocumentInput[], actions: TextAnalyticsActions, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>

Parámetros

documents

TextDocumentInput[]

Colección de documentos que se van a analizar

actions
TextAnalyticsActions

TextAnalyticsActions que se va a ejecutar.

options
BeginAnalyzeActionsOptions

Opciones de la operación.

Devoluciones

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

Inicie una operación de análisis de atención sanitaria para reconocer entidades relacionadas con la atención sanitaria (medicamentos, condiciones, síntomas, etc.) y sus relaciones.

function beginAnalyzeHealthcareEntities(documents: string[], language?: string, options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>

Parámetros

documents

string[]

Colección de documentos que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde el lenguaje se establezca explícitamente en "None".

options
BeginAnalyzeHealthcareEntitiesOptions

Opciones de la operación.

Devoluciones

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Inicie una operación de análisis de atención sanitaria para reconocer entidades relacionadas con la atención sanitaria (medicamentos, condiciones, síntomas, etc.) y sus relaciones.

function beginAnalyzeHealthcareEntities(documents: TextDocumentInput[], options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>

Parámetros

documents

TextDocumentInput[]

Colección de documentos que se van a analizar.

options
BeginAnalyzeHealthcareEntitiesOptions

Opciones de la operación.

Devoluciones

detectLanguage(DetectLanguageInput[], DetectLanguageOptions)

Ejecuta un modelo predictivo para determinar el idioma en el que se escribe el documento de entrada pasado 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.

function detectLanguage(documents: DetectLanguageInput[], options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>

Parámetros

documents

DetectLanguageInput[]

Colección de documentos de entrada que se van a analizar.

options
DetectLanguageOptions

Parámetros opcionales para la operación.

Devoluciones

detectLanguage(string[], string, DetectLanguageOptions)

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.

function detectLanguage(documents: string[], countryHint?: string, options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>

Parámetros

documents

string[]

Colección de cadenas de entrada que se van a analizar.

countryHint

string

Indica el país de origen de todas las cadenas de entrada para ayudar al modelo de análisis de texto a predecir el idioma en el que se escriben. Si no se especifica, este valor se establecerá en la sugerencia de país predeterminada en TextAnalyticsClientOptions. Si se establece en una cadena vacía o la cadena "none", el servicio aplicará un modelo en el que el país no esté establecido explícitamente. La misma sugerencia de país se aplica a todas las cadenas de la colección de entrada.

options
DetectLanguageOptions

Parámetros opcionales para la operación.

Devoluciones

extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)

Ejecuta un modelo para identificar una colección de frases significativas que se encuentran en las cadenas de entrada pasadas. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>

Parámetros

documents

string[]

Cadenas de entrada que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde el lenguaje se establezca explícitamente en "None".

options
ExtractKeyPhrasesOptions

Opciones de la operación.

Devoluciones

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Ejecuta un modelo para identificar una colección de frases significativas que se encuentran en los documentos de entrada pasados. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function extractKeyPhrases(documents: TextDocumentInput[], options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>

Parámetros

documents

TextDocumentInput[]

Documentos de entrada que se van a analizar.

options
ExtractKeyPhrasesOptions

Opciones de la operación.

Devoluciones

recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades con nombre en las cadenas de entrada pasadas y clasificar esas entidades en tipos como persona, ubicación u organización. Para obtener más información sobre las categorías disponibles,

Vea https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obtener una lista de los idiomas admitidos por esta operación, vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>

Parámetros

documents

string[]

Cadenas de entrada que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde el lenguaje se establezca explícitamente en "None".

options
RecognizeCategorizedEntitiesOptions

Parámetros opcionales para la operación.

Devoluciones

recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades con nombre en los documentos de entrada pasados y clasificar esas entidades en tipos como persona, ubicación u organización. Para obtener más información sobre las categorías disponibles,

Vea https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obtener una lista de los idiomas admitidos por esta operación, vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeEntities(documents: TextDocumentInput[], options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>

Parámetros

documents

TextDocumentInput[]

Documentos de entrada que se van a analizar.

options
RecognizeCategorizedEntitiesOptions

Parámetros opcionales para la operación.

Devoluciones

recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que se encuentran en las cadenas de entrada pasadas e incluye información que vincula las entidades a sus entradas correspondientes en un knowledge base conocido. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>

Parámetros

documents

string[]

Cadenas de entrada que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo donde el lenguaje se establezca explícitamente en "None".

options
RecognizeLinkedEntitiesOptions

Opciones de la operación.

Devoluciones

recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que se encuentran en los documentos de entrada pasados e incluye información que vincula las entidades a sus entradas correspondientes en un knowledge base conocido. Para obtener una lista de los idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeLinkedEntities(documents: TextDocumentInput[], options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>

Parámetros

documents

TextDocumentInput[]

Documentos de entrada que se van a analizar.

options
RecognizeLinkedEntitiesOptions

Opciones de la operación.

Devoluciones

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que contienen información de identificación personal encontrada en las cadenas de entrada pasadas y clasificar esas entidades en tipos como el número de seguridad social de EE. UU., el número de licencia de conducir o el número de tarjeta de crédito. Para obtener una lista de idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

function recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>

Parámetros

inputs

string[]

Cadenas de entrada que se van a analizar.

language

string

Idioma en el que se escriben todas las cadenas de entrada. Si no se especifica, este valor se establecerá en el idioma predeterminado en TextAnalyticsClientOptions. Si se establece en una cadena vacía, el servicio aplicará un modelo en el que el lenguaje se establezca explícitamente en "None".

options
RecognizePiiEntitiesOptions

Opciones de la operación.

Devoluciones

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Ejecuta un modelo predictivo para identificar una colección de entidades que contienen información de identificación personal encontrada en los documentos de entrada pasados y clasificar esas entidades en tipos como el número de seguridad social de EE. UU., el número de licencia de conducir o el número de tarjeta de crédito. Para obtener una lista de idiomas admitidos por esta operación,

Vea https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

function recognizePiiEntities(inputs: TextDocumentInput[], options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>

Parámetros

inputs

TextDocumentInput[]

Documentos de entrada que se van a analizar.

options
RecognizePiiEntitiesOptions

Parámetros opcionales para la operación.

Devoluciones