Azure.AI.Language.Conversations.Models Namespace

Classes

AgeResolution

Represents the Age entity resolution model.

AnalysisConfig

This is the parameter set of either the Orchestration project itself or one of the target services. Please note AnalysisConfig is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationConfig, LuisConfig and QuestionAnsweringConfig.

AnalyzeConversationActionResult

The base class of a conversation input task result. Please note AnalyzeConversationActionResult is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationActionResult.

AnalyzeConversationInput

The base class of a conversation input task. Please note AnalyzeConversationInput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationLanguageUnderstandingInput.

AnalyzeConversationOperationAction

Base class for a long-running conversation input task. Please note AnalyzeConversationOperationAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include PiiOperationAction, SummarizationOperationAction and CustomSummarizationOperationAction.

AnalyzeConversationOperationInput

It is a wrap up a Question Answering KB response.

AnalyzeConversationOperationResult

Container for results of all tasks in the conversation job. Please note AnalyzeConversationOperationResult is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationPiiOperationResult, SummarizationOperationResult and CustomSummarizationOperationResult.

AnalyzeConversationOperationState

Contains the status of the submitted job for analyzing a conversation, along with related statistics.

AnalyzeConversationResult

Represents a conversation analysis response.

AnswerSpan

Answer span object of QnA.

AnswersResult

Represents List of Question Answers.

AreaResolution

Represents the area entity resolution model.

AudioTiming

Audio timing information.

BooleanResolution

A resolution for boolean expressions.

ConversationActionResult

The results of a Conversation task.

ConversationActions

Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation.

ConversationalPiiResult

Conversation PII result item.

ConversationAnalysisInput

The input ConversationItem and its optional parameters.

ConversationCallingConfig

The option to set to call a Conversation project.

ConversationConfig

This is a set of request parameters for Customized Conversation projects.

ConversationEntity

The entity extraction result of a Conversation project.

ConversationEntityExtraInformation

The abstract base object for entity extra information. Please note ConversationEntityExtraInformation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include EntitySubtype, ListKey and RegexKey.

ConversationError

The error object.

ConversationInput

Complete ordered set of utterances (spoken or written) by one or more speakers to be used for analysis. Please note ConversationInput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TextConversation and TranscriptConversation.

ConversationIntent

The intent classification result of a Conversation project.

ConversationItemLevelTiming

Audio timing at the conversation item level.

ConversationLanguageUnderstandingActionContent

Input parameters necessary for a Conversation task.

ConversationLanguageUnderstandingInput

The input for a conversation language understanding task.

ConversationPiiActionContent

Supported parameters for a conversational pii task.

ConversationPiiItemResult

The result from PII detection and redaction operation for each conversation.

ConversationPiiOperationResult

Result from the personally identifiable information detection and redaction operation performed on a list of conversations.

ConversationPiiResults

The result from PII detection and redaction operation for each conversation.

ConversationPrediction

Represents the prediction section of a Conversation project.

ConversationRequestStatistics

if showStats=true was specified in the request, this field contains information about the request payload.

ConversationResult

The response returned by a Conversation project.

ConversationsSummaryResult

Conversations Summary Result.

ConversationStatistics

If showStats=true was specified in the request, this field contains information about the conversation payload.

ConversationSummarizationActionContent

Supported parameters for pre-build conversational summarization task.

ConversationTargetIntentResult

A wrap up of Conversation project response.

CurrencyResolution

Represents the currency entity resolution model.

CustomConversationSummarizationActionContent

Supported parameters for a custom conversation summarization task.

CustomSummarizationOperationAction

Task definition for custom conversational summarization.

CustomSummarizationOperationResult

Result for the custom summarization task on the conversation.

CustomSummaryResult

Custom Summary Results.

DateTimeResolution

A resolution for datetime entity instances.

DocumentError

Contains details of errors encountered during a job execution.

EntitySubtype

The concrete entity Subtype model of extra information.

EntityTag

Tags express similarities between entity categories for the extracted entity type.

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.

InputWarning

Contains details of warnings encountered during a job execution.

ItemizedSummaryContext

Context of the summary with a conversation item ID.

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.

LuisCallingConfig

This customizes how the service calls LUIS Generally Available projects.

LuisConfig

This is a set of request parameters for LUIS Generally Available projects.

LuisResult

It is the response from a LUIS Generally Available application.

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.

MultiLanguageConversationInput

Multi Language Conversation Analysis Input.

NamedEntity

Text that has been categorized into pre-defined classes or types such as: person, location, event, product, and organization.

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.

PiiOperationAction

Task definition for a PII redaction in conversations.

PredictionBase

This is the base class of prediction Please note PredictionBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationPrediction and OrchestrationPrediction.

QueryFilters

filters over knowledge base.

QuestionAnsweringConfig

This is a set of request parameters for Question Answering knowledge bases.

QuestionAnsweringTargetIntentResult

It is a wrap up a Question Answering KB response.

QuestionAnswersConfig

Parameters to query a knowledge base.

RedactedTranscriptContent

Transcript content response that the service generates, with all necessary personally identifiable information redacted.

RegexKey

The regex key extra data kind.

RequestStatistics

if showStats=true was specified in the request this field will contain information about the request payload.

ResolutionBase

The abstract base class for entity resolutions. Please note ResolutionBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AgeResolution, AreaResolution, BooleanResolution, CurrencyResolution, DateTimeResolution, InformationResolution, LengthResolution, NumberResolution, NumericRangeResolution, OrdinalResolution, SpeedResolution, TemperatureResolution, TemporalSpanResolution, VolumeResolution and WeightResolution.

ShortAnswerConfig

To configure Answer span prediction feature.

SpeedResolution

Represents the speed entity resolution model.

SummarizationOperationAction

Task definition for conversational summarization.

SummarizationOperationResult

Result for the summarization task on the conversation.

SummaryResult

Summary Results.

SummaryResultItem

Summary Result Item.

TargetIntentResult

This is the base class of an intent prediction Please note TargetIntentResult is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ConversationTargetIntentResult, LuisTargetIntentResult, NoneLinkedTargetIntentResult and QuestionAnsweringTargetIntentResult.

TemperatureResolution

Represents the temperature entity resolution model.

TemporalSpanResolution

represents the resolution of a date and/or time span.

TextConversation

model for text conversation.

TextConversationItem

The text modality of an input conversation.

TranscriptConversation

model for transcript conversation.

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 that the speech-to-text API generates. The words in this object should have 1:1 correspondence with the lexical input to allow for audio redaction.

Structs

AgeUnit

The Age Unit of measurement.

AreaUnit

The area unit of measurement.

ConversationActionState

The status of the task at the mentioned last update time.

ConversationDomain

Enumeration of supported conversational domains.

ConversationErrorCode

Human-readable error code.

ConversationPiiCategories

Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.

ConversationPiiCategoryExclusions

Describes the PII categories to exclude for detection. If not provided, 'default' categories will be returned which will vary with the language.

DateTimeSubKind

The Datetime SubKind.

InformationUnit

The information (data) Unit of measurement.

InnerErrorCode

Human-readable error code.

InputModality

Enumeration of supported conversational modalities.

LengthUnit

The length unit of measurement.

LogicalOperationKind

Set to 'OR' or 'AND' for using corresponding logical operation.

NumberKind

The type of the extracted number entity.

ParticipantRole

Role of the participant.

RangeKind

The kind of range that the resolution object represents.

RankerKind

Type of ranker to be used.

RedactionCharacter

Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.

RelativeTo

The reference point that the ordinal number denotes.

SpeedUnit

The speed Unit of measurement.

StringIndexType

Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.

SummaryAspect

Supported parameters for a conversational summarization task.

SummaryLengthBucket

Enum that defines the length of the output summaries.

TemperatureUnit

The temperature Unit of measurement.

TemporalModifier

An optional modifier of a date/time instance.

TranscriptContentType

Enumeration of supported transcript content types.

VolumeUnit

The Volume Unit of measurement.

WeightUnit

The weight Unit of measurement.