@azure/ai-language-conversations package

支援更新基礎金鑰值的靜態金鑰型認證。

用來與 Azure 認知語言服務中的交談語言理解功能互動的用戶端。

用戶端需要語言資源的端點和驗證方法，例如 API 金鑰或 AAD。 您可以在 Azure 入口網站的 [語言資源] 頁面中找到 API 金鑰和端點。 它們會位於資源 [金鑰和端點] 頁面的 [資源管理] 底下。

驗證的範例：

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

表示 Age 實體解析模型。

這是 Orchestration 專案本身或其中一個目標服務的參數集。

交談作業中所有工作結果的容器。

包含與相關統計數據一起提交之分析交談作業的狀態。

包含所提交作業的統計數據。

長時間執行交談輸入工作的基類。

選擇性參數。

個人標識資訊偵測和修訂作業在交談清單上執行的結果。

交談中 PII 修訂的工作定義。

表示交談分析回應。

交談上摘要工作的結果。

交談摘要的工作定義。

交談輸入工作的基類。

交談工作結果的基類。

回答 QnA 的 span 物件。

查詢知識庫的參數。

代表問題解答清單。

表示區域實體解析模型。

音訊計時資訊。

實體額外資訊的抽象基底物件。

這是預測的基類

實體解析的抽象基類。

布爾表達式的解析

由一或多個說話者用來分析的完整已排序語句集（口說或撰寫）。

定義ConversationAnalysisClient_analyzeConversation作業的標頭。

定義ConversationAnalysisClient_conversationAnalysis作業的標頭。

選擇性參數。

選擇性參數。

輸入 ConversationItem 及其選擇性參數

要設定為呼叫 Conversation 項目的選項。

Conversation 項目的實體擷取結果。

Conversation 專案的意圖分類結果。

使用者輸入格式化交談的抽象基底（例如文字、文字記錄）。

每個交談的 PII 偵測和修訂作業的結果。

每個交談的 PII 偵測和修訂作業的結果。

每個交談的 PII 偵測和修訂作業的結果。

交談 PII 偵測和修訂工作的支持參數。

這是自定義對話專案的一組要求參數。

代表 Conversation 專案的預測區段。

如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

Conversation 專案所傳回的回應。

所有交談式工作結果的共享屬性。

如果在要求中指定 showStats=true，此字段將會包含交談承載的相關信息。

交談摘要工作支持的參數。

交談項目回應的總結。

交談工作所需的輸入參數。

包含正在執行之工作的狀態，做為提交之分析交談作業的一部分。

自定義交談工作的輸入。

交談工作的結果。

表示貨幣實體解析模型。

datetime 實體實例的解析。

額外信息的具體實體子類型模型。

error 物件。

錯誤回應。

表示資訊（數據）實體解析模型。

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

包含作業執行期間所發生錯誤的詳細數據。

包含作業執行期間所遇到的警告詳細數據。

表示知識庫答案。

具有先前 QnA 資訊的內容物件。

與 Answer 相關聯的對話方塊。

提示輸入答案。

表示長度實體解析模型。

清單索引鍵額外數據類型。

這會自定義服務呼叫 LUIS 正式運作專案的方式。

這是 LUIS 正式推出專案的一組要求參數。

這是 LUIS 正式運作回應的總結。

尋找與指定元數據清單相關聯的 QnAs。

物件，以提供每個元數據的索引鍵值組。

非鏈接意圖回應的總結。

數值實體實例的解析。

表示數值間隔的解析度。

這代表協調流程項目的預測結果。

序數實體實例的解析。

使用預先建置模型之文字分析工作的Parameters物件。

代表數量的解決方案。

篩選知識庫。

這是問答知識庫的一組要求參數。

這是問題解答 KB 回應的總結。

服務所產生的文字記錄內容回應，並已編輯所有必要的個人標識資訊。

如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

若要設定回應範圍預測功能。

表示速度實體解析模型。

所有交談式工作結果的共享屬性。

這是意圖預測的基類

基底工作物件。

文字分析工作的基底參數物件。

傳回工作的目前狀態。

表示溫度實體解析模型。

表示日期和/或時間範圍的解析。

由一或多個說話者用來分析的完整已排序語句集（口說或撰寫）。

輸入交談的文字形式。

由一或多個說話者用來分析的完整已排序語句集（口說或撰寫）。

支援文字記錄交談的其他屬性。

表示磁碟區實體解析模型。

表示權數實體解析模型。

語音轉換文字 API 所產生的文字層級計時資訊。 此物件中的單字應該有 1：1 與 「語彙」輸入的對應，以允許音訊修訂。

定義 AgeUnit 的值。 KnownAgeUnit 可以與 AgeUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的年月周日

定義 AnalyzeConversationLROTaskKind 的值。 KnownAnalyzeConversationLROTaskKind 可以與 AnalyzeConversationLROTaskKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

ConversationalPIITaskConversationalSummarizationTask

包含 analyzeConversation 作業的響應數據。

定義 AnalyzeConversationResultsKind 的值。 KnownAnalyzeConversationResultsKind 可以與 AnalyzeConversationResultsKind 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

ConversationalPIIResultsConversationalSummarizationResults

定義 AnalyzeConversationTaskKind 的值。 KnownAnalyzeConversationTaskKind 可以與 AnalyzeConversationTaskKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

交談

定義 AnalyzeConversationTaskResultsKind 的值。 KnownAnalyzeConversationTaskResultsKind 可以與 AnalyzeConversationTaskResultsKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

ConversationResult

定義 AreaUnit 的值。 KnownAreaUnit 可以與 AreaUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的SquareKilometerSquareHectometerSquareDecameterSquareDecimeterSquareCentimeterSquareCentimeterSquareCentimeterSquareInchSquareFootSquareMileSquareYardAcre

包含 conversationAnalysis 作業的響應數據。

定義 ConversationDomain 的值。 KnownConversationDomain 可以與 ConversationDomain 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

財務醫療保健一般

定義 ConversationPIICategory 的值。 KnownConversationPIICategory 可以與 ConversationPIICategory 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

AddressCreditCardEmailNameNumericIdentifierPhoneNumberAllDefault

定義 DateTimeSubKind 的值。 KnownDateTimeSubKind 可與 DateTimeSubKind 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

timeDateTimeDateTimedurationset

定義 ErrorCode 的值。 KnownErrorCode 可以與 ErrorCode 互換使用，此枚舉包含服務支援的已知值。

服務支援的已知值

InvalidRequestInvalidArgumentUnauthorizedForbidden NotFoundProjectNotFoundOperationNotFoundAzureCognitiveSearchNotFoundAzureCognitiveSearchIndexNotFoundTooManyRequestsAzureCognitiveSearchThrottlingAzureCognitiveSearchIndexLimitReachedInternalServerErrorServiceUnavailableTimeoutQuotaExceeded衝突警告

定義 ExtraInformationKind 的值。 KnownExtraInformationKind 可以與 ExtraInformationKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

EntitySubtypeListKey

定義 InformationUnit 的值。 KnownInformationUnit 可以與 InformationUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的位千位兆位千兆位TerabitPetabit位元組千位元組兆位元組GBTBPetabyte

定義 InnerErrorCode 的值。 KnownInnerErrorCode 可以與 InnerErrorCode 互換使用，此枚舉包含服務支援的已知值。

服務支援的已知值

無效請求無效參數值知識庫未找到AzureCognitiveSearch未找到AzureCognitiveSearchThrottlingExtractionFailureInvalidRequestBodyFormatEmptyRequestMissingInputDocumentsInvalidDocumentModelVersionIncorrectInvalidDocumentBatchUnsupportedLanguageCodeInvalidCountryHint

定義 InputModality 的值。 KnownInputModality 可以與 InputModality 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

文字記錄文字

定義 JobState 的值。 KnownJobState 可以與 JobState 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未啟動執行部分完成取消取消

定義 LengthUnit 的值。 KnownLengthUnit 可以與 LengthUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定公里百米十米米分米釐米毫米微米納米皮米英里碼英寸英尺光年Pt

定義LogicalOperationKind的值。 KnownLogicalOperationKind 可以與 LogicalOperationKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

AND或

定義 NumberKind 的值。 KnownNumberKind 可以與 NumberKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

整數十進位數Power分數百分比未指定

定義 ProjectKind 的值。 KnownProjectKind 可以與 ProjectKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

對話協調流程

定義 RangeKind 的值。 KnownRangeKind 可以與 RangeKind 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

速度重量長度量面積年齡溫度貨幣

定義 RankerKind 的值。 KnownRankerKind 可以與 RankerKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

QuestionOnly：僅限問題排名器。 預設：預設排名器。

定義 RelativeTo 的值。 KnownRelativeTo 可以與 RelativeTo 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

目前結束開始

定義 ResolutionKind 的值。 KnownResolutionKind 可以與 ResolutionKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

布爾值DateTime數位序數速度重量長度量區域年齡溫度貨幣NumericRangeTemporalSpan

定義 Role 的值。 KnownRole 可以與 Role 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

代理程式客戶一般

定義 SpeedUnit 的值。 KnownSpeedUnit 可以與 SpeedUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的米PerSecond公里PerHour公里PerMinute公里PerSecondMilesPerHour結腳PerSecondfootPerMinute碼PerMinute碼PerSecondMeterPerMillisecond公分PerMillisecond公里PerMillisecond

定義 StringIndexType 的值。 KnownStringIndexType 可以與 StringIndexType 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

TextElements_v8：傳回的位移和長度值會對應至 TextElements （Graphemes 和 Grapheme 叢集）確認為 Unicode 8.0.0 標準。 如果您的應用程式是以 .Net Framework 或 .Net Core 撰寫，而且您將使用 StringInfo，請使用此選項。 UnicodeCodePoint：傳回的位移和長度值會對應至 Unicode 字碼點。 如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Python，請使用此選項。 Utf16CodeUnit：傳回的位移和長度值會對應至 UTF-16 代碼單位。 如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Java、JavaScript，請使用此選項。

定義 SummaryAspect 的值。 KnownSummaryAspect 可以與 SummaryAspect 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

問題解決

定義 TargetProjectKind 的值。 KnownTargetProjectKind 可以與 TargetProjectKind 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

LuisConversationQuestionAnsweringNonLinked

定義TaskState的值。 KnownTaskState 可以與 TaskState 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未啟動執行成功失敗，取消

定義 TemperatureUnit 的值。 KnownTemperatureUnit 可與 TemperatureUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的華氏凱爾文蘭丁攝氏

定義 TemporalModifier 的值。 KnownTemporalModifier 可以與 TemporalModifier 互換使用，此枚舉包含服務支援的已知值。

服務支援的已知值

AfterApprox之前BeforeStartApproxReferenceUndefinedSinceEndAfterMidStartAfterBeforeEndUntilEnd LesssinceAfterStartBeforeApproxMidMore

定義 TranscriptContentType 的值。 KnownTranscriptContentType 可以與 TranscriptContentType 交換使用，此列舉包含服務支援的已知值。

服務支援的已知值

語彙它maskedItn文字

定義 VolumeUnit 的值。 KnownVolumeUnit 可以與 VolumeUnit 互換使用，此枚舉包含服務支援的已知值。

服務支援的已知值

未指定立方米立方釐米 立方毫米 百升十升升釐米毫升立方碼 立方英寸立方英尺立方英里液量盎司茶匙湯匙品脫誇脫杯鰓捏液Dram桶最小值繩啄蒲式耳大桶頭

定義 WeightUnit 的值。 KnownWeightUnit 可以與 WeightUnit 交替使用，此列舉包含服務支援的已知值。

服務支援的已知值

未指定的公斤克米隆加侖噸磅盎司穀物佩尼重量朗頓比利短頓USShortHundredWeightUS石德拉姆

服務接受 AgeUnit 的已知值。

AnalyzeConversationLROTaskKind 服務的已知值。

AnalyzeConversationResultsKind 服務的已知值。

AnalyzeConversationTaskKind 服務的已知值。

AnalyzeConversationTaskResultsKind 服務的已知值。

服務接受 AreaUnit 的已知值。

服務接受的 ConversationDomain 已知值。

服務接受的 ConversationPIICategory 已知值。

服務的已知值 DateTimeSubKind。

服務的已知值 ErrorCode。

服務的已知值 ExtraInformationKind。

服務接受的已知值 InformationUnit。

Service 接受的 InnerErrorCode 已知值。

服務接受的已知 InputModality 值。

服務的已知值 JobState。

服務接受的已知 LengthUnit 值。

服務接受的已知 LogicalOperationKind 值。

服務的已知值 NumberKind。

服務接受 ProjectKind 的已知值。

服務接受 RangeKind 的已知值。

服務接受 RankerKind 的已知值。

服務的已知 RelativeTo 值。

服務的已知 ResolutionKind 值。

服務接受 角色 的已知值。

服務接受的 SpeedUnit 已知值。

StringIndexType 服務的已知值。

服務的已知值 SummaryAspect。

服務接受 TargetProjectKind 的已知值。

服務接受 TaskState 的已知值。

服務接受 TemperatureUnit 的已知值。

服務接受的 TemporalModifier 已知值。

服務接受的已知值 TranscriptContentType。

VolumeUnit 服務的已知值。

服務的已知值 WeightUnit。