TextAnalyticsClient class
Azure Text Analyticsと対話するためのクライアント クラス。
コンストラクター
| Text |
TextAnalyticsClient のインスタンスを作成します。 使用例: |
プロパティ
| default |
使用する既定の国ヒント。 既定値は "us" です。 |
| default |
使用される既定の言語です。 既定値は "en" です。 |
| endpoint |
TextAnalytics エンドポイントの URL |
メソッド
コンストラクターの詳細
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
TextAnalytics エンドポイントの URL
- credential
サービスへの要求を認証するために使用されます。
- options
- TextAnalyticsClientOptions
TextAnalytics クライアントを構成するために使用します。
プロパティの詳細
defaultCountryHint
使用する既定の国ヒント。 既定値は "us" です。
defaultCountryHint: stringプロパティ値
string
defaultLanguage
使用される既定の言語です。 既定値は "en" です。
defaultLanguage: stringプロパティ値
string
endpointUrl
TextAnalytics エンドポイントの URL
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設定されます。
空の文字列に設定すると、サービスは、lanuage が明示的に "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
分析する入力ドキュメント。
- options
- AnalyzeSentimentOptions
オピニオン マイニングの有効化を含む省略可能なパラメーター。
戻り値
Promise<AnalyzeSentimentResultArray>
beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)
分析用のテキスト ドキュメントのコレクションを送信します。 実行する 1 つ以上の一意のアクションを指定します。
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)
分析用のテキスト ドキュメントのコレクションを送信します。 実行する 1 つ以上の一意のアクションを指定します。
function beginAnalyzeActions(documents: TextDocumentInput[], actions: TextAnalyticsActions, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>パラメーター
- documents
分析するドキュメントのコレクション
- 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" に設定されているモデルがサービスによって適用されます。
操作のオプション。
戻り値
Promise<AnalyzeHealthcareEntitiesPollerLike>
beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)
医療関連エンティティ (薬物、状態、症状など) とその関係を認識するための医療分析操作を開始します。
function beginAnalyzeHealthcareEntities(documents: TextDocumentInput[], options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>パラメーター
- documents
分析するドキュメントのコレクション。
操作のオプション。
戻り値
Promise<AnalyzeHealthcareEntitiesPollerLike>
detectLanguage(DetectLanguageInput[], DetectLanguageOptions)
予測モデルを実行して、渡された入力ドキュメントが書き込まれる言語を決定し、検出された言語と、推論された言語が正しいというモデルの信頼度を示すスコアを返します。 1 に近いスコアは、結果の高い確実性を示します。 120 の言語がサポートされています。
function detectLanguage(documents: DetectLanguageInput[], options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>パラメーター
- documents
分析する入力ドキュメントのコレクション。
- 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
分析する入力ドキュメント。
- options
- ExtractKeyPhrasesOptions
操作のオプション。
戻り値
Promise<ExtractKeyPhrasesResultArray>
recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)
予測モデルを実行して、渡された入力文字列内の名前付きエンティティのコレクションを識別し、それらのエンティティを人物、場所、組織などの型に分類します。 利用可能なカテゴリの詳細については、
「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" に設定されているモデルがサービスによって適用されます。
操作の省略可能なパラメーター。
戻り値
recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)
予測モデルを実行して、渡された入力ドキュメント内の名前付きエンティティのコレクションを識別し、それらのエンティティを人物、場所、組織などの種類に分類します。 利用可能なカテゴリの詳細については、
「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
分析する入力ドキュメント。
操作の省略可能なパラメーター。
戻り値
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
分析する入力ドキュメント。
- 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
分析する入力ドキュメント。
- options
- RecognizePiiEntitiesOptions
操作の省略可能なパラメーター。
戻り値
Promise<RecognizePiiEntitiesResultArray>