Package com.ibm.watson.assistant.v2.model

Interface Summary

Interface	Description
AssistantSkill.Type	The type of the skill.
DialogLogMessage.Level	The severity of the log message.
DialogNodeAction.Type	The type of action to invoke.
EnvironmentReference.Environment	The type of the environment.
EnvironmentSkill.Type	The type of the skill.
ListAssistantsOptions.Sort	The attribute by which returned assistants will be sorted.
ListEnvironmentsOptions.Sort	The attribute by which returned environments will be sorted.
ListReleasesOptions.Sort	The attribute by which returned workspaces will be sorted.
LogRequestInput.MessageType	The type of the message:
MessageContextGlobalSystem.Locale	The language code for localization in the user input.
MessageInput.MessageType	The type of the message:
MessageOutputDebug.BranchExitedReason	When `branch_exited` is set to `true` by the assistant, the `branch_exited_reason` specifies whether the dialog completed by itself or got interrupted.
MessageOutputDebugTurnEvent.ConditionType	The type of condition (if any) that is defined for the action.
MessageOutputDebugTurnEvent.Reason	The reason the action was visited.
MessageOutputDebugTurnEventTurnEventActionFinished.ConditionType	The type of condition (if any) that is defined for the action.
MessageOutputDebugTurnEventTurnEventActionFinished.Reason	The reason the action finished processing.
MessageOutputDebugTurnEventTurnEventActionVisited.ConditionType	The type of condition (if any) that is defined for the action.
MessageOutputDebugTurnEventTurnEventActionVisited.Reason	The reason the action was visited.
MessageOutputDebugTurnEventTurnEventNodeVisited.Reason	The reason the dialog node was visited.
MessageOutputDebugTurnEventTurnEventStepAnswered.ConditionType	The type of condition (if any) that is defined for the action.
MessageOutputDebugTurnEventTurnEventStepVisited.ConditionType	The type of condition (if any) that is defined for the action.
Release.Status	The current status of the release: - **Available**: The release is available for deployment.
ReleaseSkill.Type	The type of the skill.
ReleaseSkillReference.Type	The type of the skill.
RuntimeEntityInterpretation.Granularity	The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.
RuntimeEntityRole.Type	The relationship of the entity to the range.
RuntimeResponseGeneric.Preference	The preferred type of control to display.
RuntimeResponseGenericRuntimeResponseTypeOption.Preference	The preferred type of control to display.
Skill.Status	The current status of the skill: - **Available**: The skill is available and ready to process messages.
Skill.Type	The type of skill.
SkillImport.Status	The current status of the skill: - **Available**: The skill is available and ready to process messages.
SkillImport.Type	The type of skill.
SkillReference.Type	The type of the skill.
SkillsAsyncRequestStatus.Status	The current status of the asynchronous operation: - `Available`: An asynchronous export is available.
StatelessMessageInput.MessageType	The type of the message:
TurnEventActionSource.Type	The type of turn event.
TurnEventCalloutCallout.Type	The type of callout.
TurnEventNodeSource.Type	The type of turn event.

Class Summary

Class	Description
AgentAvailabilityMessage	AgentAvailabilityMessage.
AssistantCollection	AssistantCollection.
AssistantData	AssistantData.
AssistantData.Builder	Builder.
AssistantSkill	AssistantSkill.
AssistantSkill.Builder	Builder.
AssistantState	Status information about the skills for the assistant.
AssistantState.Builder	Builder.
BaseEnvironmentOrchestration	The search skill orchestration settings for the environment.
BaseEnvironmentOrchestration.Builder	Builder.
BaseEnvironmentReleaseReference	An object describing the release that is currently deployed in the environment.
BaseEnvironmentReleaseReference.Builder	Builder.
BulkClassifyOptions	The bulkClassify options.
BulkClassifyOptions.Builder	Builder.
BulkClassifyOutput	BulkClassifyOutput.
BulkClassifyResponse	BulkClassifyResponse.
BulkClassifyUtterance	The user input utterance to classify.
BulkClassifyUtterance.Builder	Builder.
CaptureGroup	CaptureGroup.
CaptureGroup.Builder	Builder.
ChannelTransferInfo	Information used by an integration to transfer the conversation to a different channel.
ChannelTransferTarget	An object specifying target channels available for the transfer.
ChannelTransferTargetChat	Information for transferring to the web chat integration.
CreateAssistantOptions	The createAssistant options.
CreateAssistantOptions.Builder	Builder.
CreateReleaseOptions	The createRelease options.
CreateReleaseOptions.Builder	Builder.
CreateSessionOptions	The createSession options.
CreateSessionOptions.Builder	Builder.
DeleteAssistantOptions	The deleteAssistant options.
DeleteAssistantOptions.Builder	Builder.
DeleteReleaseOptions	The deleteRelease options.
DeleteReleaseOptions.Builder	Builder.
DeleteSessionOptions	The deleteSession options.
DeleteSessionOptions.Builder	Builder.
DeleteUserDataOptions	The deleteUserData options.
DeleteUserDataOptions.Builder	Builder.
DeployReleaseOptions	The deployRelease options.
DeployReleaseOptions.Builder	Builder.
DialogLogMessage	Dialog log message details.
DialogNodeAction	DialogNodeAction.
DialogNodeOutputConnectToAgentTransferInfo	Routing or other contextual information to be used by target service desk systems.
DialogNodeOutputOptionsElement	DialogNodeOutputOptionsElement.
DialogNodeOutputOptionsElementValue	An object defining the message input to be sent to the assistant if the user selects the corresponding option.
DialogNodeVisited	An objects containing detailed diagnostic information about a dialog node that was visited during processing of the input message.
DialogSuggestion	DialogSuggestion.
DialogSuggestionValue	An object defining the message input to be sent to the assistant if the user selects the corresponding disambiguation option.
Environment	Environment.
EnvironmentCollection	EnvironmentCollection.
EnvironmentOrchestration	The search skill orchestration settings for the environment.
EnvironmentReference	EnvironmentReference.
EnvironmentReference.Builder	Builder.
EnvironmentReleaseReference	An object describing the release that is currently deployed in the environment.
EnvironmentSkill	EnvironmentSkill.
EnvironmentSkill.Builder	Builder.
ExportSkillsOptions	The exportSkills options.
ExportSkillsOptions.Builder	Builder.
GetEnvironmentOptions	The getEnvironment options.
GetEnvironmentOptions.Builder	Builder.
GetReleaseOptions	The getRelease options.
GetReleaseOptions.Builder	Builder.
GetSkillOptions	The getSkill options.
GetSkillOptions.Builder	Builder.
ImportSkillsOptions	The importSkills options.
ImportSkillsOptions.Builder	Builder.
ImportSkillsStatusOptions	The importSkillsStatus options.
ImportSkillsStatusOptions.Builder	Builder.
IntegrationReference	IntegrationReference.
IntegrationReference.Builder	Builder.
ListAssistantsOptions	The listAssistants options.
ListAssistantsOptions.Builder	Builder.
ListEnvironmentsOptions	The listEnvironments options.
ListEnvironmentsOptions.Builder	Builder.
ListLogsOptions	The listLogs options.
ListLogsOptions.Builder	Builder.
ListReleasesOptions	The listReleases options.
ListReleasesOptions.Builder	Builder.
Log	Log.
LogCollection	LogCollection.
LogMessageSource	An object that identifies the dialog element that generated the error message.
LogMessageSourceAction	An object that identifies the dialog element that generated the error message.
LogMessageSourceDialogNode	An object that identifies the dialog element that generated the error message.
LogMessageSourceHandler	An object that identifies the dialog element that generated the error message.
LogMessageSourceStep	An object that identifies the dialog element that generated the error message.
LogPagination	The pagination data for the returned objects.
LogRequest	A message request formatted for the watsonx Assistant service.
LogRequestInput	An input object that includes the input text.
LogRequestInput.Builder	Builder.
LogResponse	A response from the watsonx Assistant service.
LogResponseOutput	Assistant output to be rendered or processed by the client.
MessageContext	MessageContext.
MessageContext.Builder	Builder.
MessageContextActionSkill	Context variables that are used by the action skill.
MessageContextActionSkill.Builder	Builder.
MessageContextDialogSkill	Context variables that are used by the dialog skill.
MessageContextDialogSkill.Builder	Builder.
MessageContextGlobal	Session context data that is shared by all skills used by the assistant.
MessageContextGlobal.Builder	Builder.
MessageContextGlobalStateless	Session context data that is shared by all skills used by the assistant.
MessageContextGlobalStateless.Builder	Builder.
MessageContextGlobalSystem	Built-in system properties that apply to all skills used by the assistant.
MessageContextGlobalSystem.Builder	Builder.
MessageContextSkillAction	Context variables that are used by the action skill.
MessageContextSkillAction.Builder	Builder.
MessageContextSkillDialog	Context variables that are used by the dialog skill.
MessageContextSkillDialog.Builder	Builder.
MessageContextSkills	Context data specific to particular skills used by the assistant.
MessageContextSkills.Builder	Builder.
MessageContextSkillSystem	System context data used by the skill.
MessageContextSkillSystem.Builder	Builder.
MessageInput	An input object that includes the input text.
MessageInput.Builder	Builder.
MessageInputAttachment	A reference to a media file to be sent as an attachment with the message.
MessageInputAttachment.Builder	Builder.
MessageInputOptions	Optional properties that control how the assistant responds.
MessageInputOptions.Builder	Builder.
MessageInputOptionsSpelling	Spelling correction options for the message.
MessageInputOptionsSpelling.Builder	Builder.
MessageOptions	The message options.
MessageOptions.Builder	Builder.
MessageOutput	Assistant output to be rendered or processed by the client.
MessageOutputDebug	Additional detailed information about a message response and how it was generated.
MessageOutputDebugTurnEvent	MessageOutputDebugTurnEvent.
MessageOutputDebugTurnEventTurnEventActionFinished	MessageOutputDebugTurnEventTurnEventActionFinished.
MessageOutputDebugTurnEventTurnEventActionVisited	MessageOutputDebugTurnEventTurnEventActionVisited.
MessageOutputDebugTurnEventTurnEventCallout	MessageOutputDebugTurnEventTurnEventCallout.
MessageOutputDebugTurnEventTurnEventHandlerVisited	MessageOutputDebugTurnEventTurnEventHandlerVisited.
MessageOutputDebugTurnEventTurnEventNodeVisited	MessageOutputDebugTurnEventTurnEventNodeVisited.
MessageOutputDebugTurnEventTurnEventSearch	MessageOutputDebugTurnEventTurnEventSearch.
MessageOutputDebugTurnEventTurnEventStepAnswered	MessageOutputDebugTurnEventTurnEventStepAnswered.
MessageOutputDebugTurnEventTurnEventStepVisited	MessageOutputDebugTurnEventTurnEventStepVisited.
MessageOutputSpelling	Properties describing any spelling corrections in the user input that was received.
MessageStatelessOptions	The messageStateless options.
MessageStatelessOptions.Builder	Builder.
Pagination	The pagination data for the returned objects.
Release	Release.
Release.Builder	Builder.
ReleaseCollection	ReleaseCollection.
ReleaseContent	An object identifying the versionable content objects (such as skill snapshots) that are included in the release.
ReleaseContent.Builder	Builder.
ReleaseSkill	ReleaseSkill.
ReleaseSkill.Builder	Builder.
ReleaseSkillReference	ReleaseSkillReference.
RequestAnalytics	An optional object containing analytics data.
RequestAnalytics.Builder	Builder.
ResponseGenericChannel	ResponseGenericChannel.
RuntimeEntity	The entity value that was recognized in the user input.
RuntimeEntity.Builder	Builder.
RuntimeEntityAlternative	An alternative value for the recognized entity.
RuntimeEntityAlternative.Builder	Builder.
RuntimeEntityInterpretation	RuntimeEntityInterpretation.
RuntimeEntityInterpretation.Builder	Builder.
RuntimeEntityRole	An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input.
RuntimeEntityRole.Builder	Builder.
RuntimeIntent	An intent identified in the user input.
RuntimeIntent.Builder	Builder.
RuntimeResponseGeneric	RuntimeResponseGeneric.
RuntimeResponseGenericRuntimeResponseTypeAudio	RuntimeResponseGenericRuntimeResponseTypeAudio.
RuntimeResponseGenericRuntimeResponseTypeChannelTransfer	RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.
RuntimeResponseGenericRuntimeResponseTypeConnectToAgent	RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.
RuntimeResponseGenericRuntimeResponseTypeDate	RuntimeResponseGenericRuntimeResponseTypeDate.
RuntimeResponseGenericRuntimeResponseTypeIframe	RuntimeResponseGenericRuntimeResponseTypeIframe.
RuntimeResponseGenericRuntimeResponseTypeImage	RuntimeResponseGenericRuntimeResponseTypeImage.
RuntimeResponseGenericRuntimeResponseTypeOption	RuntimeResponseGenericRuntimeResponseTypeOption.
RuntimeResponseGenericRuntimeResponseTypePause	RuntimeResponseGenericRuntimeResponseTypePause.
RuntimeResponseGenericRuntimeResponseTypeSearch	RuntimeResponseGenericRuntimeResponseTypeSearch.
RuntimeResponseGenericRuntimeResponseTypeSuggestion	RuntimeResponseGenericRuntimeResponseTypeSuggestion.
RuntimeResponseGenericRuntimeResponseTypeText	RuntimeResponseGenericRuntimeResponseTypeText.
RuntimeResponseGenericRuntimeResponseTypeUserDefined	RuntimeResponseGenericRuntimeResponseTypeUserDefined.
RuntimeResponseGenericRuntimeResponseTypeVideo	RuntimeResponseGenericRuntimeResponseTypeVideo.
SearchResult	SearchResult.
SearchResultAnswer	An object specifing a segment of text that was identified as a direct answer to the search query.
SearchResultHighlight	An object containing segments of text from search results with query-matching text highlighted using HTML `<em>` tags.
SearchResultMetadata	An object containing search result metadata from the Discovery service.
SearchSettings	An object describing the search skill configuration.
SearchSettings.Builder	Builder.
SearchSettingsDiscovery	Configuration settings for the Watson Discovery service instance used by the search integration.
SearchSettingsDiscovery.Builder	Builder.
SearchSettingsDiscoveryAuthentication	Authentication information for the Watson Discovery service.
SearchSettingsDiscoveryAuthentication.Builder	Builder.
SearchSettingsMessages	The messages included with responses from the search integration.
SearchSettingsMessages.Builder	Builder.
SearchSettingsSchemaMapping	The mapping between fields in the Watson Discovery collection and properties in the search response.
SearchSettingsSchemaMapping.Builder	Builder.
SearchSkillWarning	A warning describing an error in the search skill configuration.
SearchSkillWarning.Builder	Builder.
SessionResponse	SessionResponse.
Skill	Skill.
SkillImport	SkillImport.
SkillImport.Builder	Builder.
SkillReference	SkillReference.
SkillsAsyncRequestStatus	SkillsAsyncRequestStatus.
SkillsExport	SkillsExport.
StatefulMessageResponse	A response from the watsonx Assistant service.
StatelessMessageContext	StatelessMessageContext.
StatelessMessageContext.Builder	Builder.
StatelessMessageContextGlobal	Session context data that is shared by all skills used by the assistant.
StatelessMessageContextGlobal.Builder	Builder.
StatelessMessageContextSkills	Context data specific to particular skills used by the assistant.
StatelessMessageContextSkills.Builder	Builder.
StatelessMessageContextSkillsActionsSkill	Context variables that are used by the action skill.
StatelessMessageContextSkillsActionsSkill.Builder	Builder.
StatelessMessageInput	An input object that includes the input text.
StatelessMessageInput.Builder	Builder.
StatelessMessageInputOptions	Optional properties that control how the assistant responds.
StatelessMessageInputOptions.Builder	Builder.
StatelessMessageResponse	A stateless response from the watsonx Assistant service.
StatusError	An object describing an error that occurred during processing of an asynchronous operation.
StatusError.Builder	Builder.
TurnEventActionSource	TurnEventActionSource.
TurnEventCalloutCallout	TurnEventCalloutCallout.
TurnEventCalloutError	TurnEventCalloutError.
TurnEventNodeSource	TurnEventNodeSource.
TurnEventSearchError	TurnEventSearchError.
UpdateEnvironmentOptions	The updateEnvironment options.
UpdateEnvironmentOptions.Builder	Builder.
UpdateSkillOptions	The updateSkill options.
UpdateSkillOptions.Builder	Builder.