@azure/ai-language-conversations package

Classes

AzureKeyCredential

A static-key-based credential that supports updating the underlying key value.

ConversationAnalysisClient

A client for interacting with the conversational language understanding features in Azure Cognitive Language Service. The client needs the endpoint of a Language resource and an authentication method such as an API key or AAD. The API key and endpoint can be found in the Language resource page in the Azure portal. They will be located in the resource's Keys and Endpoint page, under Resource Management. Examples for authentication: API Key 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 See the @azure/identity package for more information about authenticating with Azure Active Directory. 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);

Interfaces

AgeResolution	Represents the Age entity resolution model.
AnalysisParameters	This is the parameter set of either the Orchestration project itself or one of the target services.
AnalyzeConversationJobResult	Container for results for all tasks in the conversation job.
AnalyzeConversationJobState	Contains the status of the analyze conversations job submitted along with related statistics.
AnalyzeConversationJobStatistics	Contains the statistics for the job submitted.
AnalyzeConversationJobsInput
AnalyzeConversationLROTask	The base class for an long running conversation input task.
AnalyzeConversationOptionalParams	Optional parameters.
AnalyzeConversationPIIResult	Result from the personally identifiable information detection and redaction operation performed on a list of conversations.
AnalyzeConversationPIITask	Task definition for a PII redaction in conversations.
AnalyzeConversationResult	Represents a conversation analysis response.
AnalyzeConversationSummarizationResult	Result for the summarization task on the conversation.
AnalyzeConversationSummarizationTask	Task definition for conversational summarization.
AnalyzeConversationTask	The base class of a conversation input task.
AnalyzeConversationTaskResult	The base class of a conversation task result.
AnswerSpan	Answer span object of QnA.
AnswersOptions	Parameters to query a knowledge base.
AnswersResult	Represents List of Question Answers.
AreaResolution	Represents the area entity resolution model.
AudioTiming	The audio timing information.
BaseExtraInformation	The abstract base object for entity extra information.
BasePrediction	This is the base class of prediction
BaseResolution	The abstract base class for entity resolutions.
BooleanResolution	A resolution for boolean expressions
Conversation	A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.
ConversationAnalysisClientAnalyzeConversationExceptionHeaders	Defines headers for ConversationAnalysisClient_analyzeConversation operation.
ConversationAnalysisClientConversationAnalysisHeaders	Defines headers for ConversationAnalysisClient_conversationAnalysis operation.
ConversationAnalysisClientOptionalParams	Optional parameters.
ConversationAnalysisOptionalParams	Optional parameters.
ConversationAnalysisOptions	The input ConversationItem and its optional parameters
ConversationCallingOptions	The option to set to call a Conversation project.
ConversationEntity	The entity extraction result of a Conversation project.
ConversationIntent	The intent classification result of a Conversation project.
ConversationItemBase	The abstract base for a user input formatted conversation (e.g., Text, Transcript).
ConversationPIIItemResult
ConversationPIIResult	The result from PII detection and redaction operation for each conversation.
ConversationPIIResults	The result from PII detection and redaction operation for each conversation.
ConversationPIIResultsConversationsItem	The result from PII detection and redaction operation for each conversation.
ConversationPIITaskParameters	Supported parameters for a Conversational PII detection and redaction task.
ConversationParameters	This is a set of request parameters for Customized Conversation projects.
ConversationPrediction	Represents the prediction section of a Conversation project.
ConversationRequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.
ConversationResult	The response returned by a Conversation project.
ConversationResultBase	Shared attributes for all conversational task results.
ConversationStatistics	If showStats=true was specified in the request this field will contain information about the conversation payload.
ConversationSummarizationTaskParameters	Supported parameters for an conversational summarization task.
ConversationTargetIntentResult	A wrap up of Conversation project response.
ConversationTaskParameters	Input parameters necessary for a Conversation task.
ConversationTasksState	Contains the state for the tasks being executed as part of the analyze conversation job submitted.
ConversationTasksStateTasks
ConversationalTask	The input for a custom conversation task.
ConversationalTaskResult	The results of a Conversation task.
ConversationsSummaryResult
ConversationsSummaryResultSummariesItem
CurrencyResolution	Represents the currency entity resolution model.
DateTimeResolution	A resolution for datetime entity instances.
Entity
EntitySubtype	The concrete entity Subtype model of extra information.
ErrorModel	The error object.
ErrorResponse	Error response.
InformationResolution	Represents the information (data) entity resolution model.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InputError	Contains details of errors encountered during a job execution.
InputWarning	Contains details of warnings encountered during a job execution.
JobStateAutoGenerated
KnowledgeBaseAnswer	Represents knowledge base answer.
KnowledgeBaseAnswerContext	Context object with previous QnA's information.
KnowledgeBaseAnswerDialog	Dialog associated with Answer.
KnowledgeBaseAnswerPrompt	Prompt for an answer.
LengthResolution	Represents the length entity resolution model.
ListKey	The list key extra data kind.
LuisCallingOptions	This customizes how the service calls LUIS Generally Available projects.
LuisParameters	This is a set of request parameters for LUIS Generally Available projects.
LuisTargetIntentResult	It is a wrap up of LUIS Generally Available response.
MetadataFilter	Find QnAs that are associated with the given list of metadata.
MetadataRecord	Object to provide the key value pair for each metadata.
MultiLanguageConversationAnalysisInput
NoneLinkedTargetIntentResult	A wrap up of non-linked intent response.
NumberResolution	A resolution for numeric entity instances.
NumericRangeResolution	represents the resolution of numeric intervals.
OrchestrationPrediction	This represents the prediction result of an Orchestration project.
OrdinalResolution	A resolution for ordinal numbers entity instances.
PreBuiltResult
PreBuiltTaskParameters	Parameters object for a text analysis task using pre-built models.
QuantityResolution	Represents resolutions for quantities.
QueryFilters	filters over knowledge base.
QuestionAnsweringParameters	This is a set of request parameters for Question Answering knowledge bases.
QuestionAnsweringTargetIntentResult	It is a wrap up a Question Answering KB response.
RedactedTranscriptContent	The transcript content response generated by the service with all necessary personally identifiable information redacted.
RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.
ShortAnswerOptions	To configure Answer span prediction feature.
SpeedResolution	Represents the speed entity resolution model.
SummaryResult
SummaryResultConversationsItem	Shared attributes for all conversational task results.
SummaryResultItem
TargetIntentResult	This is the base class of an intent prediction
TaskIdentifier	Base task object.
TaskParameters	Base parameters object for a text analysis task.
TaskStateAutoGenerated	Returns the current state of the task.
TemperatureResolution	Represents the temperature entity resolution model.
TemporalSpanResolution	represents the resolution of a date and/or time span.
TextConversation	A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.
TextConversationItem	The text modality of an input conversation.
TranscriptConversation	A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.
TranscriptConversationItem	Additional properties for supporting transcript conversation.
VolumeResolution	Represents the volume entity resolution model.
WeightResolution	Represents the weight entity resolution model.
WordLevelTiming	Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction.

Type Aliases

AgeUnit	Defines values for AgeUnit. KnownAgeUnit can be used interchangeably with AgeUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified Year Month Week Day
AnalysisParametersUnion
AnalyzeConversationJobResultUnion
AnalyzeConversationLROTaskKind	Defines values for AnalyzeConversationLROTaskKind. KnownAnalyzeConversationLROTaskKind can be used interchangeably with AnalyzeConversationLROTaskKind, this enum contains the known values that the service supports. Known values supported by the service ConversationalPIITask ConversationalSummarizationTask
AnalyzeConversationLROTaskUnion
AnalyzeConversationResponse	Contains response data for the analyzeConversation operation.
AnalyzeConversationResultsKind	Defines values for AnalyzeConversationResultsKind. KnownAnalyzeConversationResultsKind can be used interchangeably with AnalyzeConversationResultsKind, this enum contains the known values that the service supports. Known values supported by the service ConversationalPIIResults ConversationalSummarizationResults
AnalyzeConversationTaskKind	Defines values for AnalyzeConversationTaskKind. KnownAnalyzeConversationTaskKind can be used interchangeably with AnalyzeConversationTaskKind, this enum contains the known values that the service supports. Known values supported by the service Conversation
AnalyzeConversationTaskResultUnion
AnalyzeConversationTaskResultsKind	Defines values for AnalyzeConversationTaskResultsKind. KnownAnalyzeConversationTaskResultsKind can be used interchangeably with AnalyzeConversationTaskResultsKind, this enum contains the known values that the service supports. Known values supported by the service ConversationResult
AnalyzeConversationTaskUnion
AreaUnit	Defines values for AreaUnit. KnownAreaUnit can be used interchangeably with AreaUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified SquareKilometer SquareHectometer SquareDecameter SquareDecimeter SquareMeter SquareCentimeter SquareMillimeter SquareInch SquareFoot SquareMile SquareYard Acre
BaseExtraInformationUnion
BasePredictionUnion
BaseResolutionUnion
ConversationAnalysisResponse	Contains response data for the conversationAnalysis operation.
ConversationDomain	Defines values for ConversationDomain. KnownConversationDomain can be used interchangeably with ConversationDomain, this enum contains the known values that the service supports. Known values supported by the service finance healthcare generic
ConversationPIICategory	Defines values for ConversationPIICategory. KnownConversationPIICategory can be used interchangeably with ConversationPIICategory, this enum contains the known values that the service supports. Known values supported by the service Address CreditCard Email Name NumericIdentifier PhoneNumber All Default
ConversationUnion
DateTimeSubKind	Defines values for DateTimeSubKind. KnownDateTimeSubKind can be used interchangeably with DateTimeSubKind, this enum contains the known values that the service supports. Known values supported by the service Time Date DateTime Duration Set
ErrorCode	Defines values for ErrorCode. KnownErrorCode can be used interchangeably with ErrorCode, this enum contains the known values that the service supports. Known values supported by the service InvalidRequest InvalidArgument Unauthorized Forbidden NotFound ProjectNotFound OperationNotFound AzureCognitiveSearchNotFound AzureCognitiveSearchIndexNotFound TooManyRequests AzureCognitiveSearchThrottling AzureCognitiveSearchIndexLimitReached InternalServerError ServiceUnavailable Timeout QuotaExceeded Conflict Warning
ExtraInformationKind	Defines values for ExtraInformationKind. KnownExtraInformationKind can be used interchangeably with ExtraInformationKind, this enum contains the known values that the service supports. Known values supported by the service EntitySubtype ListKey
InformationUnit	Defines values for InformationUnit. KnownInformationUnit can be used interchangeably with InformationUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified Bit Kilobit Megabit Gigabit Terabit Petabit Byte Kilobyte Megabyte Gigabyte Terabyte Petabyte
InnerErrorCode	Defines values for InnerErrorCode. KnownInnerErrorCode can be used interchangeably with InnerErrorCode, this enum contains the known values that the service supports. Known values supported by the service InvalidRequest InvalidParameterValue KnowledgeBaseNotFound AzureCognitiveSearchNotFound AzureCognitiveSearchThrottling ExtractionFailure InvalidRequestBodyFormat EmptyRequest MissingInputDocuments InvalidDocument ModelVersionIncorrect InvalidDocumentBatch UnsupportedLanguageCode InvalidCountryHint
InputModality	Defines values for InputModality. KnownInputModality can be used interchangeably with InputModality, this enum contains the known values that the service supports. Known values supported by the service transcript text
JobState	Defines values for JobState. KnownJobState can be used interchangeably with JobState, this enum contains the known values that the service supports. Known values supported by the service notStarted running succeeded partiallyCompleted failed cancelled cancelling
LengthUnit	Defines values for LengthUnit. KnownLengthUnit can be used interchangeably with LengthUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified Kilometer Hectometer Decameter Meter Decimeter Centimeter Millimeter Micrometer Nanometer Picometer Mile Yard Inch Foot LightYear Pt
LogicalOperationKind	Defines values for LogicalOperationKind. KnownLogicalOperationKind can be used interchangeably with LogicalOperationKind, this enum contains the known values that the service supports. Known values supported by the service AND OR
NumberKind	Defines values for NumberKind. KnownNumberKind can be used interchangeably with NumberKind, this enum contains the known values that the service supports. Known values supported by the service Integer Decimal Power Fraction Percent Unspecified
ProjectKind	Defines values for ProjectKind. KnownProjectKind can be used interchangeably with ProjectKind, this enum contains the known values that the service supports. Known values supported by the service Conversation Orchestration
RangeKind	Defines values for RangeKind. KnownRangeKind can be used interchangeably with RangeKind, this enum contains the known values that the service supports. Known values supported by the service Number Speed Weight Length Volume Area Age Information Temperature Currency
RankerKind	Defines values for RankerKind. KnownRankerKind can be used interchangeably with RankerKind, this enum contains the known values that the service supports. Known values supported by the service QuestionOnly: Question only ranker. Default: Default ranker.
RelativeTo	Defines values for RelativeTo. KnownRelativeTo can be used interchangeably with RelativeTo, this enum contains the known values that the service supports. Known values supported by the service Current End Start
ResolutionKind	Defines values for ResolutionKind. KnownResolutionKind can be used interchangeably with ResolutionKind, this enum contains the known values that the service supports. Known values supported by the service Boolean DateTime Number Ordinal Speed Weight Length Volume Area Age Information Temperature Currency NumericRange TemporalSpan
Role	Defines values for Role. KnownRole can be used interchangeably with Role, this enum contains the known values that the service supports. Known values supported by the service agent customer generic
SpeedUnit	Defines values for SpeedUnit. KnownSpeedUnit can be used interchangeably with SpeedUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified MetersPerSecond KilometersPerHour KilometersPerMinute KilometersPerSecond MilesPerHour Knot FootPerSecond FootPerMinute YardsPerMinute YardsPerSecond MetersPerMillisecond CentimetersPerMillisecond KilometersPerMillisecond
StringIndexType	Defines values for StringIndexType. KnownStringIndexType can be used interchangeably with StringIndexType, this enum contains the known values that the service supports. Known values supported by the service TextElements_v8: Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo. UnicodeCodePoint: Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python. Utf16CodeUnit: Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript.
SummaryAspect	Defines values for SummaryAspect. KnownSummaryAspect can be used interchangeably with SummaryAspect, this enum contains the known values that the service supports. Known values supported by the service issue resolution
TargetIntentResultUnion
TargetProjectKind	Defines values for TargetProjectKind. KnownTargetProjectKind can be used interchangeably with TargetProjectKind, this enum contains the known values that the service supports. Known values supported by the service Luis Conversation QuestionAnswering NonLinked
TaskState	Defines values for TaskState. KnownTaskState can be used interchangeably with TaskState, this enum contains the known values that the service supports. Known values supported by the service notStarted running succeeded failed cancelled cancelling
TemperatureUnit	Defines values for TemperatureUnit. KnownTemperatureUnit can be used interchangeably with TemperatureUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified Fahrenheit Kelvin Rankine Celsius
TemporalModifier	Defines values for TemporalModifier. KnownTemporalModifier can be used interchangeably with TemporalModifier, this enum contains the known values that the service supports. Known values supported by the service AfterApprox Before BeforeStart Approx ReferenceUndefined SinceEnd AfterMid Start After BeforeEnd Until End Less Since AfterStart BeforeApprox Mid More
TranscriptContentType	Defines values for TranscriptContentType. KnownTranscriptContentType can be used interchangeably with TranscriptContentType, this enum contains the known values that the service supports. Known values supported by the service lexical itn maskedItn text
VolumeUnit	Defines values for VolumeUnit. KnownVolumeUnit can be used interchangeably with VolumeUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified CubicMeter CubicCentimeter CubicMillimeter Hectoliter Decaliter Liter Centiliter Milliliter CubicYard CubicInch CubicFoot CubicMile FluidOunce Teaspoon Tablespoon Pint Quart Cup Gill Pinch FluidDram Barrel Minim Cord Peck Bushel Hogshead
WeightUnit	Defines values for WeightUnit. KnownWeightUnit can be used interchangeably with WeightUnit, this enum contains the known values that the service supports. Known values supported by the service Unspecified Kilogram Gram Milligram Gallon MetricTon Ton Pound Ounce Grain PennyWeight LongTonBritish ShortTonUS ShortHundredWeightUS Stone Dram

Enums

KnownAgeUnit	Known values of AgeUnit that the service accepts.
KnownAnalyzeConversationLROTaskKind	Known values of AnalyzeConversationLROTaskKind that the service accepts.
KnownAnalyzeConversationResultsKind	Known values of AnalyzeConversationResultsKind that the service accepts.
KnownAnalyzeConversationTaskKind	Known values of AnalyzeConversationTaskKind that the service accepts.
KnownAnalyzeConversationTaskResultsKind	Known values of AnalyzeConversationTaskResultsKind that the service accepts.
KnownAreaUnit	Known values of AreaUnit that the service accepts.
KnownConversationDomain	Known values of ConversationDomain that the service accepts.
KnownConversationPIICategory	Known values of ConversationPIICategory that the service accepts.
KnownDateTimeSubKind	Known values of DateTimeSubKind that the service accepts.
KnownErrorCode	Known values of ErrorCode that the service accepts.
KnownExtraInformationKind	Known values of ExtraInformationKind that the service accepts.
KnownInformationUnit	Known values of InformationUnit that the service accepts.
KnownInnerErrorCode	Known values of InnerErrorCode that the service accepts.
KnownInputModality	Known values of InputModality that the service accepts.
KnownJobState	Known values of JobState that the service accepts.
KnownLengthUnit	Known values of LengthUnit that the service accepts.
KnownLogicalOperationKind	Known values of LogicalOperationKind that the service accepts.
KnownNumberKind	Known values of NumberKind that the service accepts.
KnownProjectKind	Known values of ProjectKind that the service accepts.
KnownRangeKind	Known values of RangeKind that the service accepts.
KnownRankerKind	Known values of RankerKind that the service accepts.
KnownRelativeTo	Known values of RelativeTo that the service accepts.
KnownResolutionKind	Known values of ResolutionKind that the service accepts.
KnownRole	Known values of Role that the service accepts.
KnownSpeedUnit	Known values of SpeedUnit that the service accepts.
KnownStringIndexType	Known values of StringIndexType that the service accepts.
KnownSummaryAspect	Known values of SummaryAspect that the service accepts.
KnownTargetProjectKind	Known values of TargetProjectKind that the service accepts.
KnownTaskState	Known values of TaskState that the service accepts.
KnownTemperatureUnit	Known values of TemperatureUnit that the service accepts.
KnownTemporalModifier	Known values of TemporalModifier that the service accepts.
KnownTranscriptContentType	Known values of TranscriptContentType that the service accepts.
KnownVolumeUnit	Known values of VolumeUnit that the service accepts.
KnownWeightUnit	Known values of WeightUnit that the service accepts.