TextAnalyticsClient class

Пакет:

@azure/ai-text-analytics

Клиентский класс для взаимодействия с Azure Text Analytics.

Конструкторы

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Создает экземпляр TextAnalyticsClient. Пример использования: import { TextAnalyticsClient, AzureKeyCredential } from "@azure/ai-text-analytics"; const client = new TextAnalyticsClient( "<service endpoint>", new AzureKeyCredential("<api key>") );

Свойства

defaultCountryHint	Указание страны по умолчанию, используемое. По умолчанию используется значение "us".
defaultLanguage	Язык по умолчанию для использования. По умолчанию используется значение "en".
endpointUrl	URL-адрес конечной точки TextAnalytics

Методы

analyzeSentiment(string[], string, AnalyzeSentimentOptions)	Выполняет прогнозную модель, чтобы определить положительные, отрицательные, нейтральные или смешанные тональности, содержащиеся в входных строках, а также оценки, указывающие уверенность модели в каждом из прогнозируемых тональности. При необходимости он также может определить целевые объекты в тексте и оценках об этом с помощью интеллектуального анализа мнений. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)	Запускает прогнозную модель, чтобы определить положительные, отрицательные или нейтральные или смешанные тональности, содержащиеся в входных документах, а также оценки, указывающие уверенность модели в каждом из прогнозируемых тональности. При необходимости он также может определить целевые объекты в тексте и оценках об этом с помощью интеллектуального анализа мнений. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)	Отправьте коллекцию текстовых документов для анализа. Укажите одно или несколько уникальных действий для выполнения.
beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)	Отправьте коллекцию текстовых документов для анализа. Укажите одно или несколько уникальных действий для выполнения.
beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)	Запустите операцию анализа здравоохранения, чтобы распознать связанные с здравоохранением сущности (наркотики, условия, симптомы и т. д.) и их отношения.
beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)	Запустите операцию анализа здравоохранения, чтобы распознать связанные с здравоохранением сущности (наркотики, условия, симптомы и т. д.) и их отношения.
detectLanguage(DetectLanguageInput[], DetectLanguageOptions)	Запускает прогнозную модель, чтобы определить язык, на котором записывается переданный входной документ, и возвращается для каждого из них обнаруженный язык, а также оценка, указывающая уверенность модели в правильности вычисленного языка. Оценки, близкие к 1, указывают на высокую уверенность в результатах. Поддерживаются 120 языков.
detectLanguage(string[], string, DetectLanguageOptions)	Запускает прогнозную модель, чтобы определить язык, на котором записываются переданные входные строки, и возвращается для каждого из них обнаруженный язык, а также оценка, указывающая уверенность модели в правильности вычисленного языка. Оценки, близкие к 1, указывают на высокую уверенность в результатах. Поддерживаются 120 языков.
extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)	Запускает модель для идентификации коллекции важных фраз, найденных в переданных входных строках. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)	Запускает модель для идентификации коллекции важных фраз, найденных в переданных входных документах. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)	Запускает прогнозную модель, чтобы определить коллекцию именованных сущностей в передаваемых входных строках, а также классифицировать эти сущности на типы, такие как person, location или organization. Дополнительные сведения о доступных категориях См. https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Список языков, поддерживаемых этой операцией, см. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)	Выполняет прогнозную модель, чтобы определить коллекцию именованных сущностей в переданных входных документах, а также классифицировать эти сущности на типы, такие как person, location или organization. Дополнительные сведения о доступных категориях См. https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Список языков, поддерживаемых этой операцией, см. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)	Запускает прогнозную модель, чтобы определить коллекцию сущностей, найденных в передаваемых входных строках, и включить сведения, связывающие сущности с соответствующими записями в известной базе знаний. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)	Запускает прогнозную модель, чтобы определить коллекцию сущностей, найденных в переданных входных документах, и включить сведения, связывающие сущности с соответствующими записями в хорошо известной базе знаний. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)	Запускает прогнозную модель, чтобы определить коллекцию сущностей, содержащих личные сведения, найденные в входных строках, и классифицировать эти сущности на типы, такие как номер социального страхования США, номер лицензии водителя или номер кредитной карты. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)	Запускает прогнозную модель, чтобы определить коллекцию сущностей, содержащих личные данные, найденные в переданных входных документах, и классифицировать эти сущности на такие типы, как номер социального страхования США, номер лицензии водителя или номер кредитной карты. Список языков, поддерживаемых этой операцией, См. https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

Сведения о конструкторе

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Создает экземпляр TextAnalyticsClient.

Пример использования:

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)

Параметры

endpointUrl

string

URL-адрес конечной точки TextAnalytics

credential

TokenCredential | KeyCredential

Используется для проверки подлинности запросов к службе.

options

TextAnalyticsClientOptions

Используется для настройки клиента TextAnalytics.

Сведения о свойстве

defaultCountryHint

Указание страны по умолчанию, используемое. По умолчанию используется значение "us".

defaultCountryHint: string

Значение свойства

string

defaultLanguage

Язык по умолчанию для использования. По умолчанию используется значение "en".

defaultLanguage: string

Значение свойства

string

endpointUrl

URL-адрес конечной точки TextAnalytics

endpointUrl: string

Значение свойства

string

Сведения о методе

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Выполняет прогнозную модель, чтобы определить положительные, отрицательные, нейтральные или смешанные тональности, содержащиеся в входных строках, а также оценки, указывающие уверенность модели в каждом из прогнозируемых тональности. При необходимости он также может определить целевые объекты в тексте и оценках об этом с помощью интеллектуального анализа мнений. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

string[]

Входные строки для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой лануаж явно задано значение None.

options

AnalyzeSentimentOptions

Необязательные параметры, которые включают включение интеллектуального анализа мнений.

Возвращаемое значение

Promise<AnalyzeSentimentResultArray>

analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)

Запускает прогнозную модель, чтобы определить положительные, отрицательные или нейтральные или смешанные тональности, содержащиеся в входных документах, а также оценки, указывающие уверенность модели в каждом из прогнозируемых тональности. При необходимости он также может определить целевые объекты в тексте и оценках об этом с помощью интеллектуального анализа мнений. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

TextDocumentInput[]

Входные документы для анализа.

options

AnalyzeSentimentOptions

Необязательные параметры, которые включают включение интеллектуального анализа мнений.

Возвращаемое значение

Promise<AnalyzeSentimentResultArray>

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

Отправьте коллекцию текстовых документов для анализа. Укажите одно или несколько уникальных действий для выполнения.

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

Параметры

documents

string[]

Коллекция документов для анализа

actions

TextAnalyticsActions

TextAnalyticsActions для выполнения.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

BeginAnalyzeActionsOptions

Параметры операции.

Возвращаемое значение

Promise<AnalyzeActionsPollerLike>

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Отправьте коллекцию текстовых документов для анализа. Укажите одно или несколько уникальных действий для выполнения.

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

Параметры

documents

TextDocumentInput[]

Коллекция документов для анализа

actions

TextAnalyticsActions

TextAnalyticsActions для выполнения.

options

BeginAnalyzeActionsOptions

Параметры операции.

Возвращаемое значение

Promise<AnalyzeActionsPollerLike>

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

Запустите операцию анализа здравоохранения, чтобы распознать связанные с здравоохранением сущности (наркотики, условия, симптомы и т. д.) и их отношения.

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

Параметры

documents

string[]

Коллекция документов для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

BeginAnalyzeHealthcareEntitiesOptions

Параметры операции.

Возвращаемое значение

Promise<AnalyzeHealthcareEntitiesPollerLike>

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Запустите операцию анализа здравоохранения, чтобы распознать связанные с здравоохранением сущности (наркотики, условия, симптомы и т. д.) и их отношения.

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

Параметры

documents

TextDocumentInput[]

Коллекция документов для анализа.

options

BeginAnalyzeHealthcareEntitiesOptions

Параметры операции.

Возвращаемое значение

Promise<AnalyzeHealthcareEntitiesPollerLike>

detectLanguage(DetectLanguageInput[], DetectLanguageOptions)

Запускает прогнозную модель, чтобы определить язык, на котором записывается переданный входной документ, и возвращается для каждого из них обнаруженный язык, а также оценка, указывающая уверенность модели в правильности вычисленного языка. Оценки, близкие к 1, указывают на высокую уверенность в результатах. Поддерживаются 120 языков.

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

Параметры

documents

DetectLanguageInput[]

Коллекция входных документов для анализа.

options

DetectLanguageOptions

Необязательные параметры для операции.

Возвращаемое значение

Promise<DetectLanguageResultArray>

detectLanguage(string[], string, DetectLanguageOptions)

Запускает прогнозную модель, чтобы определить язык, на котором записываются переданные входные строки, и возвращается для каждого из них обнаруженный язык, а также оценка, указывающая уверенность модели в правильности вычисленного языка. Оценки, близкие к 1, указывают на высокую уверенность в результатах. Поддерживаются 120 языков.

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

Параметры

documents

string[]

Коллекция входных строк для анализа.

countryHint

string

Указывает страну происхождения для всех входных строк, помогающих модели анализа текста прогнозировать язык, на который они написаны. Если не указано, это значение будет задано для указания страны по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки или строка "none", служба будет применять модель, в которой страна явно не настроена. Одно и то же указание страны применяется ко всем строкам в коллекции входных данных.

options

DetectLanguageOptions

Необязательные параметры для операции.

Возвращаемое значение

Promise<DetectLanguageResultArray>

extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)

Запускает модель для идентификации коллекции важных фраз, найденных в переданных входных строках. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

string[]

Входные строки для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

ExtractKeyPhrasesOptions

Параметры операции.

Возвращаемое значение

Promise<ExtractKeyPhrasesResultArray>

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Запускает модель для идентификации коллекции важных фраз, найденных в переданных входных документах. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

TextDocumentInput[]

Входные документы для анализа.

options

ExtractKeyPhrasesOptions

Параметры операции.

Возвращаемое значение

Promise<ExtractKeyPhrasesResultArray>

recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)

Запускает прогнозную модель, чтобы определить коллекцию именованных сущностей в передаваемых входных строках, а также классифицировать эти сущности на типы, такие как person, location или organization. Дополнительные сведения о доступных категориях

См. https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Список языков, поддерживаемых этой операцией, см. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

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

Параметры

documents

string[]

Входные строки для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

RecognizeCategorizedEntitiesOptions

Необязательные параметры для операции.

Возвращаемое значение

Promise<RecognizeCategorizedEntitiesResultArray>

recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)

Выполняет прогнозную модель, чтобы определить коллекцию именованных сущностей в переданных входных документах, а также классифицировать эти сущности на типы, такие как person, location или organization. Дополнительные сведения о доступных категориях

См. https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Список языков, поддерживаемых этой операцией, см. https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

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

Параметры

documents

TextDocumentInput[]

Входные документы для анализа.

options

RecognizeCategorizedEntitiesOptions

Необязательные параметры для операции.

Возвращаемое значение

Promise<RecognizeCategorizedEntitiesResultArray>

recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)

Запускает прогнозную модель, чтобы определить коллекцию сущностей, найденных в передаваемых входных строках, и включить сведения, связывающие сущности с соответствующими записями в известной базе знаний. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

string[]

Входные строки для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

RecognizeLinkedEntitiesOptions

Параметры операции.

Возвращаемое значение

Promise<RecognizeLinkedEntitiesResultArray>

recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)

Запускает прогнозную модель, чтобы определить коллекцию сущностей, найденных в переданных входных документах, и включить сведения, связывающие сущности с соответствующими записями в хорошо известной базе знаний. Список языков, поддерживаемых этой операцией,

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

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

Параметры

documents

TextDocumentInput[]

Входные документы для анализа.

options

RecognizeLinkedEntitiesOptions

Параметры операции.

Возвращаемое значение

Promise<RecognizeLinkedEntitiesResultArray>

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Запускает прогнозную модель, чтобы определить коллекцию сущностей, содержащих личные сведения, найденные в входных строках, и классифицировать эти сущности на типы, такие как номер социального страхования США, номер лицензии водителя или номер кредитной карты. Список языков, поддерживаемых этой операцией,

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

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

Параметры

inputs

string[]

Входные строки для анализа.

language

string

Язык, на который записываются все входные строки. Если не указано, это значение будет присвоено языку по умолчанию в TextAnalyticsClientOptions. Если задано значение пустой строки, служба будет применять модель, в которой язык явно имеет значение None.

options

RecognizePiiEntitiesOptions

Параметры операции.

Возвращаемое значение

Promise<RecognizePiiEntitiesResultArray>

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Запускает прогнозную модель, чтобы определить коллекцию сущностей, содержащих личные данные, найденные в переданных входных документах, и классифицировать эти сущности на такие типы, как номер социального страхования США, номер лицензии водителя или номер кредитной карты. Список языков, поддерживаемых этой операцией,

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

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

Параметры

inputs

TextDocumentInput[]

Входные документы для анализа.

options

RecognizePiiEntitiesOptions

Необязательные параметры для операции.

Возвращаемое значение

Promise<RecognizePiiEntitiesResultArray>