次の方法で共有


@azure/ai-language-conversations package

クラス

AzureKeyCredential

基になるキー値の更新をサポートする静的キーベースの資格情報。

ConversationAnalysisClient

Azure Cognitive Language Service の会話言語理解機能と対話するためのクライアント。

クライアントには、言語リソースのエンドポイントと、API キーや AAD などの認証方法が必要です。 API キーとエンドポイントは、Azure portal の [言語リソース] ページにあります。 リソースの [キーとエンドポイント] ページの [リソース管理] に表示されます。

認証の例:

API キー

import { AzureKeyCredential } from "@azure/core-auth";
import { ConversationAnalysisClient } from "@azure/ai-language-conversations";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new ConversationAnalysisClient(endpoint, credential);

Azure Active Directory

Azure Active Directory での認証の詳細については、@azure/identity パッケージを参照してください。

import { ConversationAnalysisClient } from "@azure/ai-language-conversations";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new ConversationAnalysisClient(endpoint, credential);

インターフェイス

AgeResolution

Age エンティティ解決モデルを表します。

AnalysisParameters

これは、オーケストレーション プロジェクト自体またはターゲット サービスの 1 つのパラメーター セットです。

AnalyzeConversationJobResult

会話ジョブ内のすべてのタスクの結果のコンテナー。

AnalyzeConversationJobState

関連する統計と共に送信された会話分析ジョブの状態を格納します。

AnalyzeConversationJobStatistics

送信されたジョブの統計情報を格納します。

AnalyzeConversationJobsInput
AnalyzeConversationLROTask

実行時間の長い会話入力タスクの基本クラス。

AnalyzeConversationOptionalParams

省略可能なパラメーター。

AnalyzeConversationPIIResult

会話の一覧に対して実行された個人を特定できる情報の検出と編集操作の結果。

AnalyzeConversationPIITask

会話での PII 編集のタスク定義。

AnalyzeConversationResult

会話分析応答を表します。

AnalyzeConversationSummarizationResult

会話の集計タスクの結果。

AnalyzeConversationSummarizationTask

会話型要約のタスク定義。

AnalyzeConversationTask

会話入力タスクの基本クラス。

AnalyzeConversationTaskResult

会話タスクの結果の基本クラス。

AnswerSpan

QnA の回答スパン オブジェクト。

AnswersOptions

ナレッジ ベースに対してクエリを実行するパラメーター。

AnswersResult

質問の回答の一覧を表します。

AreaResolution

エリア エンティティ解決モデルを表します。

AudioTiming

オーディオのタイミング情報。

BaseExtraInformation

エンティティの追加情報の抽象基本オブジェクト。

BasePrediction

これは予測の基本クラスです

BaseResolution

エンティティ解決の抽象基本クラス。

BooleanResolution

ブール式の解決

Conversation

分析に使用する 1 つ以上の話者による発話の完全な順序付けされたセット (音声または書き込み)。

ConversationAnalysisClientAnalyzeConversationExceptionHeaders

ConversationAnalysisClient_analyzeConversation操作のヘッダーを定義します。

ConversationAnalysisClientConversationAnalysisHeaders

ConversationAnalysisClient_conversationAnalysis操作のヘッダーを定義します。

ConversationAnalysisClientOptionalParams

省略可能なパラメーター。

ConversationAnalysisOptionalParams

省略可能なパラメーター。

ConversationAnalysisOptions

入力 ConversationItem とその省略可能なパラメーター

ConversationCallingOptions

Conversation プロジェクトを呼び出すために設定するオプション。

ConversationEntity

Conversation プロジェクトのエンティティ抽出結果。

ConversationIntent

Conversation プロジェクトの意図分類の結果。

ConversationItemBase

ユーザー入力形式の会話の抽象ベース (テキスト、トランスクリプトなど)。

ConversationPIIItemResult
ConversationPIIResult

各会話の PII 検出と編集操作の結果。

ConversationPIIResults

各会話の PII 検出と編集操作の結果。

ConversationPIIResultsConversationsItem

各会話の PII 検出と編集操作の結果。

ConversationPIITaskParameters

Conversational PII の検出と編集タスクでサポートされているパラメーター。

ConversationParameters

これは、カスタマイズされた会話プロジェクトの要求パラメーターのセットです。

ConversationPrediction

Conversation プロジェクトの予測セクションを表します。

ConversationRequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

ConversationResult

Conversation プロジェクトによって返される応答。

ConversationResultBase

すべての会話型タスクの結果の共有属性。

ConversationStatistics

要求で showStats=true が指定された場合、このフィールドには会話ペイロードに関する情報が含まれます。

ConversationSummarizationTaskParameters

会話型の要約タスクでサポートされているパラメーター。

ConversationTargetIntentResult

Conversation プロジェクトの応答のまとめ。

ConversationTaskParameters

会話タスクに必要な入力パラメーター。

ConversationTasksState

送信された会話分析ジョブの一部として実行されるタスクの状態を格納します。

ConversationTasksStateTasks
ConversationalTask

カスタム会話タスクの入力。

ConversationalTaskResult

会話タスクの結果。

ConversationsSummaryResult
ConversationsSummaryResultSummariesItem
CurrencyResolution

通貨エンティティ解決モデルを表します。

DateTimeResolution

datetime エンティティ インスタンスの解決。

Entity
EntitySubtype

追加情報の具象エンティティ サブタイプ モデル。

ErrorModel

エラー オブジェクト。

ErrorResponse

エラー応答。

InformationResolution

情報 (データ) エンティティ解決モデルを表します。

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

InputError

ジョブの実行中に発生したエラーの詳細が含まれます。

InputWarning

ジョブの実行中に発生した警告の詳細が含まれます。

JobStateAutoGenerated
KnowledgeBaseAnswer

ナレッジ ベースの回答を表します。

KnowledgeBaseAnswerContext

以前の QnA の情報を持つコンテキスト オブジェクト。

KnowledgeBaseAnswerDialog

回答に関連付けられているダイアログ。

KnowledgeBaseAnswerPrompt

回答を求めるメッセージを表示します。

LengthResolution

長さのエンティティ解決モデルを表します。

ListKey

リスト キーの追加データの種類。

LuisCallingOptions

これにより、サービスが LUIS 一般公開プロジェクトを呼び出す方法がカスタマイズされます。

LuisParameters

これは、LUIS 一般公開プロジェクトの要求パラメーターのセットです。

LuisTargetIntentResult

LUIS の一般公開応答のまとめです。

MetadataFilter

指定されたメタデータの一覧に関連付けられている QnA を検索します。

MetadataRecord

各メタデータのキー値ペアを提供するオブジェクト。

MultiLanguageConversationAnalysisInput
NoneLinkedTargetIntentResult

リンクされていない意図の応答のラップアップ。

NumberResolution

数値エンティティ インスタンスの解決。

NumericRangeResolution

は、数値の間隔の解像度を表します。

OrchestrationPrediction

これは、オーケストレーション プロジェクトの予測結果を表します。

OrdinalResolution

序数エンティティ インスタンスの解決。

PreBuiltResult
PreBuiltTaskParameters

事前構築済みモデルを使用したテキスト分析タスクの Parameters オブジェクト。

QuantityResolution

数量の解像度を表します。

QueryFilters

ナレッジ ベースをフィルター処理します。

QuestionAnsweringParameters

これは、Question Answering ナレッジ ベースの要求パラメーターのセットです。

QuestionAnsweringTargetIntentResult

これは、質問に回答する KB 応答をまとめる方法です。

RedactedTranscriptContent

サービスによって生成され、必要なすべての個人を特定できる情報が編集されたトランスクリプト コンテンツ応答。

RequestStatistics

要求で showStats=true が指定された場合、このフィールドには要求ペイロードに関する情報が含まれます。

ShortAnswerOptions

回答スパン予測機能を構成するには。

SpeedResolution

速度エンティティ解決モデルを表します。

SummaryResult
SummaryResultConversationsItem

すべての会話型タスクの結果の共有属性。

SummaryResultItem
TargetIntentResult

これは意図予測の基本クラスです

TaskIdentifier

基本タスク オブジェクト。

TaskParameters

テキスト分析タスクの基本パラメーター オブジェクト。

TaskStateAutoGenerated

タスクの現在の状態を返します。

TemperatureResolution

温度エンティティ解決モデルを表します。

TemporalSpanResolution

は、日付または期間の解決を表します。

TextConversation

分析に使用する 1 つ以上の話者による発話の完全な順序付けされたセット (音声または書き込み)。

TextConversationItem

入力会話のテキスト モダリティ。

TranscriptConversation

分析に使用する 1 つ以上の話者による発話の完全な順序付けされたセット (音声または書き込み)。

TranscriptConversationItem

トランスクリプト会話をサポートするための追加のプロパティ。

VolumeResolution

ボリューム エンティティ解決モデルを表します。

WeightResolution

重みエンティティ解決モデルを表します。

WordLevelTiming

音声テキスト変換 API によって生成される単語レベルのタイミング情報。 このオブジェクト内の単語は、オーディオの編集を可能にするために、"字句" 入力と 1 対 1 の対応を持つ必要があります。

型エイリアス

AgeUnit

AgeUnit の値を定義します。 KnownAgeUnit を AgeUnit と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

指定されていない

AnalysisParametersUnion
AnalyzeConversationJobResultUnion
AnalyzeConversationLROTaskKind

AnalyzeConversationLROTaskKind の値を定義します。 KnownAnalyzeConversationLROTaskKind AnalyzeConversationLROTaskKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ConversationalPIITaskConversationalSummarizationTask

AnalyzeConversationLROTaskUnion
AnalyzeConversationResponse

analyzeConversation 操作の応答データが含まれています。

AnalyzeConversationResultsKind

AnalyzeConversationResultsKind の値を定義します。 KnownAnalyzeConversationResultsKind AnalyzeConversationResultsKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ConversationalPIIResultsConversationalSummarizationResults

AnalyzeConversationTaskKind

AnalyzeConversationTaskKind の値を定義します。 KnownAnalyzeConversationTaskKind AnalyzeConversationTaskKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

会話

AnalyzeConversationTaskResultUnion
AnalyzeConversationTaskResultsKind

AnalyzeConversationTaskResultsKind の値を定義します。 KnownAnalyzeConversationTaskResultsKind AnalyzeConversationTaskResultsKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ConversationResult

AnalyzeConversationTaskUnion
AreaUnit

AreaUnit の値を定義します。 KnownAreaUnit AreaUnit と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

指定されていないSquareKilometerSquareHectometerSquareDecameterSquareDecameterSquareCentimeterSquareMillimeterSquareInchSquareFootSquareMileSquareYardAcre

BaseExtraInformationUnion
BasePredictionUnion
BaseResolutionUnion
ConversationAnalysisResponse

conversationAnalysis 操作の応答データが含まれています。

ConversationDomain

ConversationDomain の値を定義します。 KnownConversationDomain ConversationDomain と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

金融医療汎用

ConversationPIICategory

ConversationPIICategory の値を定義します。 KnownConversationPIICategory ConversationPIICategory と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

AddressCreditCardEmailNameNumericIdentifierPhoneNumberAllDefault

ConversationUnion
DateTimeSubKind

DateTimeSubKind の値を定義します。 KnownDateTimeSubKind は DateTimeSubKind と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

日時日付日時期間セット

ErrorCode

ErrorCode の値を定義します。 KnownErrorCode ErrorCode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

InvalidRequestInvalidArgumentUnauthorizedForbiddenNotFoundProjectNotFoundOperationNotFoundAzureCognitiveSearchNotFoundAzureCognitiveSearchIndexNotFoundTooMany AzureCognitiveSearchThrottlingAzureCognitiveSearchIndexLimitReachedInternalServerErrorServiceUnavailableTimeoutQuotaExceedededConflictWarning

ExtraInformationKind

ExtraInformationKind の値を定義します。 KnownExtraInformationKind ExtraInformationKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

EntitySubtypeListKey

InformationUnit

InformationUnit の値を定義します。 KnownInformationUnit を InformationUnit と同じ意味で使用できる 、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

指定されていないビットキロビットメガビットギガビットテラビットペタビットバイトキロバイトメガバイトギガバイトテラバイトペタバイト

InnerErrorCode

InnerErrorCode の値を定義します。 KnownInnerErrorCode は InnerErrorCode と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

InvalidRequestInvalidParameterValueKnowledgeBaseNotFoundAzureCognitiveSearchNotFoundAzureCognitiveSearchThrottlingExtractionFailureInvalidRequestBodyFormatEmptyRequestMissingInputDocumentsInvalidDocumentModelVersionIncorrectInvalidDocumentBatchUnsupportedLanguageCodeInvalidCountryHint

InputModality

InputModality の値を定義します。 KnownInputModality InputModality と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

テキストトランスクリプトを する

JobState

JobState の値を定義します。 KnownJobState を JobState と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

notStartedを実行の取り消し取り消 の取り消しに失敗成功しました

LengthUnit

LengthUnit の値を定義します。 KnownLengthUnit を LengthUnit と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不特定のキロメートルメートル十字メートルデシメーターセンチメートルミリメートルナノメートルマイクロメートルマイルヤードインチフィートLightYearPt

LogicalOperationKind

LogicalOperationKind の値を定義します。 KnownLogicalOperationKind LogicalOperationKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ANDOR

NumberKind

NumberKind の値を定義します。 KnownNumberKind を NumberKind と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

整数10 進数Power分数パーセント指定されていない

ProjectKind

ProjectKind の値を定義します。 KnownProjectKind を ProjectKind と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ConversationOrchestration

RangeKind

RangeKind の値を定義します。 KnownRangeKind は RangeKind と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

速度重量長さ体積面積 年齢 情報温度通貨

RankerKind

RankerKind の値を定義します。 KnownRankerKind を RankerKind と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

QuestionOnly: 質問のみのランカー。 既定の: 既定のランカー。

RelativeTo

RelativeTo の値を定義します。 KnownRelativeTo RelativeTo と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

現在の 終了開始する

ResolutionKind

ResolutionKind の値を定義します。 KnownResolutionKind は ResolutionKind と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれます。

サービスでサポートされている既知の値

ブール値DateTime数値速度重み長さ体積面積 年齢情報温度通貨 数値範囲時間範囲 時間経過

Role

Role の値を定義します。 KnownRole Role と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

エージェント顧客汎用

SpeedUnit

SpeedUnit の値を定義します。 KnownSpeedUnit SpeedUnit と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

未指定のmPerSecondKmsPerHourKmsPerMinuteKmsPerSecondMilesPerHourKnotFootPerPerSecondFootPerMinuteYardsPerMinuteYardsPerMillisecondMetersPerMillisecondCentimetersPerMillisecondKmsPerMillisecond

StringIndexType

StringIndexType の値を定義します。 KnownStringIndexType を StringIndexType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

TextElements_v8: 返されるオフセット値と長さの値は、Unicode 8.0.0 標準を確認する TextElements (Graphemes および Grapheme クラスター) に対応します。 アプリケーションが .Net Framework または .Net Core で記述されていて、StringInfo を使用する場合は、このオプションを使用します。 UnicodeCodePoint: 返されるオフセットと長さの値は、Unicode コード ポイントに対応します。 このオプションは、アプリケーションが Unicode (Python など) をサポートする言語で記述されている場合に使用します。 Utf16CodeUnit: 返されるオフセットと長さの値は UTF-16 コード単位に対応します。 アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。

SummaryAspect

SummaryAspect の値を定義します。 KnownSummaryAspect を SummaryAspect と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

問題解決

TargetIntentResultUnion
TargetProjectKind

TargetProjectKind の値を定義します。 KnownTargetProjectKind を TargetProjectKind と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

LuisConversationQuestionAnsweringNonLinked

TaskState

TaskState の値を定義します。 KnownTaskState は TaskState と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれます。

サービスでサポートされている既知の値

notStartedrunning 成功 失敗 キャンセル キャンセル

TemperatureUnit

TemperatureUnit の値を定義します。 KnownTemperatureUnit を TemperatureUnit と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不特定華氏ケルビンランキン摂氏

TemporalModifier

TemporalModifier の値を定義します。 KnownTemporalModifier は TemporalModifier と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

AfterApproxbeforeBeforeStartApprox ReferenceUndefinedSinceEndAfterMidStartAfterBeforeEnduntilEnd Less Since AfterStartBeforeApproxMidMore

TranscriptContentType

TranscriptContentType の値を定義します。 KnownTranscriptContentType TranscriptContentType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

字句ITNmaskedItnテキスト

VolumeUnit

VolumeUnit の値を定義します。 KnownVolumeUnit は VolumeUnit と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

不特定立方メートル立方センチメートル立方リメートルクトリットルカリットルリットルセンチリットル立方ヤード立方インチ立方フィート立方マイルフルイドオンスティースプーン大さじイントクォートカップギピン液ドラムバレルミニムコードペックブッシェルホグスヘッド

WeightUnit

WeightUnit の値を定義します。 KnownWeightUnit を WeightUnit と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

指定されていないキログラムグラムガロンメトリックトントンポンドグラムグレインペニーウェイトロングトンブリッシショートトンブリッシShortHundredWeightUSストーンドラム

列挙型

KnownAgeUnit

サービスが受け入れる ageUnit 既知の値。

KnownAnalyzeConversationLROTaskKind

AnalyzeConversationLROTaskKind の既知の値は、サービスが受け入れる

KnownAnalyzeConversationResultsKind

AnalyzeConversationResultsKind の既知の値は、サービスが受け入れる

KnownAnalyzeConversationTaskKind

AnalyzeConversationTaskKind の既知の値は、サービスが受け入れる

KnownAnalyzeConversationTaskResultsKind

AnalyzeConversationTaskResultsKind の既知の値は、サービスが受け入れる

KnownAreaUnit

AreaUnit の既知の値は、サービスが受け入れる

KnownConversationDomain

サービス 受け入れる ConversationDomain の既知の値。

KnownConversationPIICategory

サービス 受け入れる ConversationPIICategory の既知の値。

KnownDateTimeSubKind

サービス 受け入れる DateTimeSubKind の既知の値。

KnownErrorCode

ErrorCode の既知の値は、サービスが受け入れる

KnownExtraInformationKind

ExtraInformationKind の既知の値は、サービスが受け入れる

KnownInformationUnit

サービスが受け入れる InformationUnit の既知の値。

KnownInnerErrorCode

InnerErrorCode 既知の値は、サービスが受け入れる

KnownInputModality

InputModality の既知の値は、サービスが受け入れる

KnownJobState

サービス 受け入れる JobState の既知の値。

KnownLengthUnit

サービスが受け入れる LengthUnit の既知の値。

KnownLogicalOperationKind

LogicalOperationKind の既知の値は、サービスが受け入れる

KnownNumberKind

サービス 受け入れる NumberKind の既知の値。

KnownProjectKind

ProjectKind の既知の値は、サービスが受け入れる

KnownRangeKind

サービスが受け入れる RangeKind 既知の値。

KnownRankerKind

RankerKind 既知の値は、サービスが受け入れる

KnownRelativeTo

サービス 受け入れる RelativeTo の既知の値。

KnownResolutionKind

ResolutionKind の既知の値は、サービスが受け入れる

KnownRole

サービスが受け入れる ロールの既知の値。

KnownSpeedUnit

SpeedUnit の既知の値は、サービスが受け入れる

KnownStringIndexType

サービス 受け入れる StringIndexType の既知の値。

KnownSummaryAspect

SummaryAspect の既知の値は、サービスが受け入れる

KnownTargetProjectKind

TargetProjectKind の既知の値は、サービスが受け入れる

KnownTaskState

サービスが受け入れる TaskState の既知の値

KnownTemperatureUnit

サービスが受け入れる temperatureUnit 既知の値。

KnownTemporalModifier

TemporalModifier の既知の値は、サービスが受け入れる

KnownTranscriptContentType

TranscriptContentType の既知の値は、サービスが受け入れる

KnownVolumeUnit

VolumeUnit の既知の値は、サービスが受け入れる

KnownWeightUnit

サービスが受け入れる weightUnit 既知の値。