| Interface | Description |
|---|---|
| AssistantSkill.Type |
The type of the skill.
|
| ClientAction.Skill |
The skill that is requesting the action.
|
| CompleteItem.Preference |
The preferred type of control to display.
|
| CreateAssistantReleaseImportResponse.SkillImpactInDraft |
The type of the skill in the draft environment.
|
| CreateAssistantReleaseImportResponse.Status |
The current status of the artifact import process: - **Failed**: The asynchronous artifact
import process has failed.
|
| CreateReleaseExportWithStatusErrors.Status |
The current status of the release export creation process: - **Available**: The release export
package is available for download.
|
| 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.
|
| ListProvidersOptions.Sort |
The attribute by which returned conversational skill providers 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.
|
| MessageOutputDebugTurnEventTurnEventActionRoutingDenied.ConditionType |
The type of condition (if any) that is defined for the action.
|
| MessageOutputDebugTurnEventTurnEventActionRoutingDenied.Reason |
The reason the action was visited.
|
| MessageOutputDebugTurnEventTurnEventActionVisited.ConditionType |
The type of condition (if any) that is defined for the action.
|
| MessageOutputDebugTurnEventTurnEventActionVisited.Reason |
The reason the action was visited.
|
| MessageOutputDebugTurnEventTurnEventConversationalSearchEnd.ConditionType |
The type of condition (if any) that is defined for the action.
|
| MessageOutputDebugTurnEventTurnEventManualRoute.ConditionType |
The type of condition (if any) that is defined for the action.
|
| 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.
|
| MessageOutputDebugTurnEventTurnEventTopicSwitchDenied.ConditionType |
The type of condition (if any) that is defined for the action.
|
| MessageOutputDebugTurnEventTurnEventTopicSwitchDenied.Reason |
The reason the action was visited.
|
| MonitorAssistantReleaseImportArtifactResponse.SkillImpactInDraft |
The type of the skill in the draft environment.
|
| MonitorAssistantReleaseImportArtifactResponse.Status |
The current status of the release import process: - **Completed**: The artifact import has
completed.
|
| ProviderAuthenticationOAuth2.PreferredFlow |
The preferred "flow" or "grant type" for the API client to fetch an access token from the
authorization server.
|
| ProviderAuthenticationOAuth2Flows.ClientAuthType |
The client authorization type.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2AuthorizationCode.ClientAuthType |
The client authorization type.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2ClientCredentials.ClientAuthType |
The client authorization type.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2Password.ClientAuthType |
The client authorization type.
|
| ProviderAuthenticationOAuth2PasswordUsername.Type |
The type of property observed in "value".
|
| ProviderAuthenticationTypeAndValue.Type |
The type of property observed in "value".
|
| ProviderPrivateAuthenticationOAuth2PasswordPassword.Type |
The type of property observed in "value".
|
| ProviderResponseSpecificationComponentsSecuritySchemes.AuthenticationMethod |
The authentication method required for requests made from watsonx Assistant to the
conversational skill provider.
|
| ProviderSpecificationComponentsSecuritySchemes.AuthenticationMethod |
The authentication method required for requests made from watsonx Assistant to the
conversational skill provider.
|
| 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.
|
| SearchSettingsConversationalSearchResponseLength.Option |
The response length option.
|
| SearchSettingsConversationalSearchSearchConfidence.Threshold |
The search confidence threshold.
|
| SearchSettingsServerSideSearch.AuthType |
The authorization type that is used.
|
| 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.
|
| TurnEventCalloutCalloutRequest.Method |
The REST method of the request.
|
| TurnEventGenerativeAICalledCalloutRequest.Method |
The REST method of the request.
|
| TurnEventNodeSource.Type |
The type of turn event.
|
| TurnEventStepSource.Type |
The type of turn event.
|
| 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.
|
| BaseEnvironmentReleaseReference |
An object describing the release that is currently deployed in the environment.
|
| 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.
|
| ClientAction |
ClientAction.
|
| ClientActionParameters |
ClientActionParameters.
|
| CompleteItem |
CompleteItem.
|
| CreateAssistantOptions |
The createAssistant options.
|
| CreateAssistantOptions.Builder |
Builder.
|
| CreateAssistantReleaseImportResponse |
CreateAssistantReleaseImportResponse.
|
| CreateProviderOptions |
The createProvider options.
|
| CreateProviderOptions.Builder |
Builder.
|
| CreateReleaseExportOptions |
The createReleaseExport options.
|
| CreateReleaseExportOptions.Builder |
Builder.
|
| CreateReleaseExportWithStatusErrors |
CreateReleaseExportWithStatusErrors.
|
| CreateReleaseImportOptions |
The createReleaseImport options.
|
| CreateReleaseImportOptions.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.
|
| DownloadReleaseExportOptions |
The downloadReleaseExport options.
|
| DownloadReleaseExportOptions.Builder |
Builder.
|
| 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.
|
| FinalResponse |
Message final response content.
|
| FinalResponseOutput |
Assistant output to be rendered or processed by the client.
|
| GenerativeAITask |
GenerativeAITask.
|
| GenerativeAITaskConfidenceScores |
The confidence scores for determining whether to show the generated response or an “I don't know”
response.
|
| GenerativeAITaskContentGroundedAnswering |
GenerativeAITaskContentGroundedAnswering.
|
| GenerativeAITaskGeneralPurposeAnswering |
GenerativeAITaskGeneralPurposeAnswering.
|
| GetEnvironmentOptions |
The getEnvironment options.
|
| GetEnvironmentOptions.Builder |
Builder.
|
| GetReleaseImportStatusOptions |
The getReleaseImportStatus options.
|
| GetReleaseImportStatusOptions.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.
|
| InputStreamConnectStrategy | |
| InputStreamConnectStrategy.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.
|
| ListProvidersOptions |
The listProviders options.
|
| ListProvidersOptions.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.
|
| MessageEventDeserializer | |
| MessageEventDeserializer.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.
|
| MessageOutputDebugTurnEventTurnEventActionRoutingDenied |
MessageOutputDebugTurnEventTurnEventActionRoutingDenied.
|
| MessageOutputDebugTurnEventTurnEventActionVisited |
MessageOutputDebugTurnEventTurnEventActionVisited.
|
| MessageOutputDebugTurnEventTurnEventCallout |
MessageOutputDebugTurnEventTurnEventCallout.
|
| MessageOutputDebugTurnEventTurnEventClientActions |
MessageOutputDebugTurnEventTurnEventClientActions.
|
| MessageOutputDebugTurnEventTurnEventConversationalSearchEnd |
MessageOutputDebugTurnEventTurnEventConversationalSearchEnd.
|
| MessageOutputDebugTurnEventTurnEventGenerativeAICalled |
MessageOutputDebugTurnEventTurnEventGenerativeAICalled.
|
| MessageOutputDebugTurnEventTurnEventHandlerVisited |
MessageOutputDebugTurnEventTurnEventHandlerVisited.
|
| MessageOutputDebugTurnEventTurnEventManualRoute |
MessageOutputDebugTurnEventTurnEventManualRoute.
|
| MessageOutputDebugTurnEventTurnEventNodeVisited |
MessageOutputDebugTurnEventTurnEventNodeVisited.
|
| MessageOutputDebugTurnEventTurnEventSearch |
MessageOutputDebugTurnEventTurnEventSearch.
|
| MessageOutputDebugTurnEventTurnEventStepAnswered |
MessageOutputDebugTurnEventTurnEventStepAnswered.
|
| MessageOutputDebugTurnEventTurnEventStepVisited |
MessageOutputDebugTurnEventTurnEventStepVisited.
|
| MessageOutputDebugTurnEventTurnEventSuggestionIntentsDenied |
MessageOutputDebugTurnEventTurnEventSuggestionIntentsDenied.
|
| MessageOutputDebugTurnEventTurnEventTopicSwitchDenied |
MessageOutputDebugTurnEventTurnEventTopicSwitchDenied.
|
| MessageOutputLLMMetadata |
MessageOutputLLMMetadata.
|
| MessageOutputSpelling |
Properties describing any spelling corrections in the user input that was received.
|
| MessageStatelessOptions |
The messageStateless options.
|
| MessageStatelessOptions.Builder |
Builder.
|
| MessageStreamMetadata |
Contains meta-information about the item(s) being streamed.
|
| MessageStreamOptions |
The messageStream options.
|
| MessageStreamOptions.Builder |
Builder.
|
| MessageStreamResponse |
A streamed response from the watsonx Assistant service.
|
| MessageStreamStatelessOptions |
The messageStreamStateless options.
|
| MessageStreamStatelessOptions.Builder |
Builder.
|
| Metadata |
Contains meta-information about the item(s) being streamed.
|
| MonitorAssistantReleaseImportArtifactResponse |
MonitorAssistantReleaseImportArtifactResponse.
|
| Pagination |
The pagination data for the returned objects.
|
| PartialItem |
Message response partial item content.
|
| ProviderAuthenticationOAuth2 |
Non-private settings for oauth2 authentication.
|
| ProviderAuthenticationOAuth2.Builder |
Builder.
|
| ProviderAuthenticationOAuth2Flows |
Scenarios performed by the API client to fetch an access token from the authorization server.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2AuthorizationCode |
Non-private authentication settings for authorization-code flow.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2AuthorizationCode.Builder |
Builder.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2ClientCredentials |
ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2ClientCredentials.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2ClientCredentials.Builder |
Builder.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2Password |
Non-private authentication settings for resource owner password flow.
|
| ProviderAuthenticationOAuth2FlowsProviderAuthenticationOAuth2Password.Builder |
Builder.
|
| ProviderAuthenticationOAuth2PasswordUsername |
The username for oauth2 authentication when the preferred flow is "password".
|
| ProviderAuthenticationOAuth2PasswordUsername.Builder |
Builder.
|
| ProviderAuthenticationTypeAndValue |
ProviderAuthenticationTypeAndValue.
|
| ProviderAuthenticationTypeAndValue.Builder |
Builder.
|
| ProviderCollection |
ProviderCollection.
|
| ProviderPrivate |
Private information of the provider.
|
| ProviderPrivate.Builder |
Builder.
|
| ProviderPrivateAuthentication |
Private authentication information of the provider.
|
| ProviderPrivateAuthenticationBasicFlow |
The private data for basic authentication.
|
| ProviderPrivateAuthenticationBasicFlow.Builder |
Builder.
|
| ProviderPrivateAuthenticationBearerFlow |
The private data for bearer authentication.
|
| ProviderPrivateAuthenticationBearerFlow.Builder |
Builder.
|
| ProviderPrivateAuthenticationOAuth2Flow |
The private data for oauth2 authentication.
|
| ProviderPrivateAuthenticationOAuth2Flow.Builder |
Builder.
|
| ProviderPrivateAuthenticationOAuth2FlowFlows |
Scenarios performed by the API client to fetch an access token from the authorization server.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2AuthorizationCode |
Private authentication settings for client credentials flow.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2AuthorizationCode.Builder |
Builder.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2ClientCredentials |
ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2ClientCredentials.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2ClientCredentials.Builder |
Builder.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2Password |
Private authentication settings for resource owner password flow.
|
| ProviderPrivateAuthenticationOAuth2FlowFlowsProviderPrivateAuthenticationOAuth2Password.Builder |
Builder.
|
| ProviderPrivateAuthenticationOAuth2PasswordPassword |
The password for oauth2 authentication when the preferred flow is "password".
|
| ProviderPrivateAuthenticationOAuth2PasswordPassword.Builder |
Builder.
|
| ProviderResponse |
ProviderResponse.
|
| ProviderResponseSpecification |
The specification of the provider.
|
| ProviderResponseSpecificationComponents |
An object defining various reusable definitions of the provider.
|
| ProviderResponseSpecificationComponentsSecuritySchemes |
The definition of the security scheme for the provider.
|
| ProviderResponseSpecificationComponentsSecuritySchemesBasic |
Non-private settings for basic access authentication.
|
| ProviderResponseSpecificationServersItem |
ProviderResponseSpecificationServersItem.
|
| ProviderSpecification |
The specification of the provider.
|
| ProviderSpecification.Builder |
Builder.
|
| ProviderSpecificationComponents |
An object defining various reusable definitions of the provider.
|
| ProviderSpecificationComponents.Builder |
Builder.
|
| ProviderSpecificationComponentsSecuritySchemes |
The definition of the security scheme for the provider.
|
| ProviderSpecificationComponentsSecuritySchemes.Builder |
Builder.
|
| ProviderSpecificationComponentsSecuritySchemesBasic |
Non-private settings for basic access authentication.
|
| ProviderSpecificationComponentsSecuritySchemesBasic.Builder |
Builder.
|
| ProviderSpecificationServersItem |
ProviderSpecificationServersItem.
|
| ProviderSpecificationServersItem.Builder |
Builder.
|
| 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.
|
| ResponseGenericCitation |
ResponseGenericCitation.
|
| ResponseGenericCitationRangesItem |
ResponseGenericCitationRangesItem.
|
| ResponseGenericConfidenceScores |
The confidence scores for determining whether to show the generated response or an “I don't know”
response.
|
| 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.
|
| RuntimeResponseGenericRuntimeResponseTypeConversationalSearch |
RuntimeResponseGenericRuntimeResponseTypeConversationalSearch.
|
| 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.
|
| SearchResults |
SearchResults.
|
| SearchResultsResultMetadata |
The metadata of the search result.
|
| SearchSettings |
An object describing the search skill configuration.
|
| SearchSettings.Builder |
Builder.
|
| SearchSettingsClientSideSearch |
Configuration settings for the client-side search service or server-side search service used by
the search integration.
|
| SearchSettingsClientSideSearch.Builder |
Builder.
|
| SearchSettingsConversationalSearch |
Configuration settings for conversational search.
|
| SearchSettingsConversationalSearch.Builder |
Builder.
|
| SearchSettingsConversationalSearchResponseLength |
SearchSettingsConversationalSearchResponseLength.
|
| SearchSettingsConversationalSearchResponseLength.Builder |
Builder.
|
| SearchSettingsConversationalSearchSearchConfidence |
SearchSettingsConversationalSearchSearchConfidence.
|
| SearchSettingsConversationalSearchSearchConfidence.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.
|
| SearchSettingsElasticSearch |
Configuration settings for the Elasticsearch service used by the search integration.
|
| SearchSettingsElasticSearch.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.
|
| SearchSettingsServerSideSearch |
Configuration settings for the server-side search service used by the search integration.
|
| SearchSettingsServerSideSearch.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.
|
| StatelessFinalResponse |
Message final response content.
|
| StatelessFinalResponseOutput |
Assistant output to be rendered or processed by the client.
|
| 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.
|
| StatelessMessageStreamResponse |
A stateless streamed response form 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.
|
| TurnEventCalloutCalloutRequest |
TurnEventCalloutCalloutRequest.
|
| TurnEventCalloutCalloutResponse |
TurnEventCalloutCalloutResponse.
|
| TurnEventCalloutError |
TurnEventCalloutError.
|
| TurnEventGenerativeAICalledCallout |
TurnEventGenerativeAICalledCallout.
|
| TurnEventGenerativeAICalledCalloutLlm |
TurnEventGenerativeAICalledCalloutLlm.
|
| TurnEventGenerativeAICalledCalloutLlmResponse | |
| TurnEventGenerativeAICalledCalloutRequest |
TurnEventGenerativeAICalledCalloutRequest.
|
| TurnEventGenerativeAICalledCalloutResponse |
TurnEventGenerativeAICalledCalloutResponse.
|
| TurnEventGenerativeAICalledCalloutSearch |
TurnEventGenerativeAICalledCalloutSearch.
|
| TurnEventGenerativeAICalledMetrics |
TurnEventGenerativeAICalledMetrics.
|
| TurnEventNodeSource |
TurnEventNodeSource.
|
| TurnEventSearchError |
TurnEventSearchError.
|
| TurnEventStepSource |
TurnEventStepSource.
|
| UpdateEnvironmentOptions |
The updateEnvironment options.
|
| UpdateEnvironmentOptions.Builder |
Builder.
|
| UpdateEnvironmentOrchestration |
The search skill orchestration settings for the environment.
|
| UpdateEnvironmentOrchestration.Builder |
Builder.
|
| UpdateProviderOptions |
The updateProvider options.
|
| UpdateProviderOptions.Builder |
Builder.
|
| UpdateSkillOptions |
The updateSkill options.
|
| UpdateSkillOptions.Builder |
Builder.
|
Copyright © 2025 IBM Cloud. All rights reserved.