assistantv1

package
v2.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package assistantv1 : Operations and models for the AssistantV1 service

Index

Constants

View Source 
const (
	CreateDialogNodeOptionsTypeEventHandlerConst      = "event_handler"
	CreateDialogNodeOptionsTypeFolderConst            = "folder"
	CreateDialogNodeOptionsTypeFrameConst             = "frame"
	CreateDialogNodeOptionsTypeResponseConditionConst = "response_condition"
	CreateDialogNodeOptionsTypeSlotConst              = "slot"
	CreateDialogNodeOptionsTypeStandardConst          = "standard"
)

Constants associated with the CreateDialogNodeOptions.Type property. How the dialog node is processed.

View Source 
const (
	CreateDialogNodeOptionsEventNameDigressionReturnPromptConst   = "digression_return_prompt"
	CreateDialogNodeOptionsEventNameFilledConst                   = "filled"
	CreateDialogNodeOptionsEventNameFilledMultipleConst           = "filled_multiple"
	CreateDialogNodeOptionsEventNameFocusConst                    = "focus"
	CreateDialogNodeOptionsEventNameGenericConst                  = "generic"
	CreateDialogNodeOptionsEventNameInputConst                    = "input"
	CreateDialogNodeOptionsEventNameNomatchConst                  = "nomatch"
	CreateDialogNodeOptionsEventNameNomatchResponsesDepletedConst = "nomatch_responses_depleted"
	CreateDialogNodeOptionsEventNameValidateConst                 = "validate"
)

Constants associated with the CreateDialogNodeOptions.EventName property. How an `event_handler` node is processed.

View Source 
const (
	CreateDialogNodeOptionsDigressInDoesNotReturnConst = "does_not_return"
	CreateDialogNodeOptionsDigressInNotAvailableConst  = "not_available"
	CreateDialogNodeOptionsDigressInReturnsConst       = "returns"
)

Constants associated with the CreateDialogNodeOptions.DigressIn property. Whether this top-level dialog node can be digressed into.

View Source 
const (
	CreateDialogNodeOptionsDigressOutAllowAllConst            = "allow_all"
	CreateDialogNodeOptionsDigressOutAllowAllNeverReturnConst = "allow_all_never_return"
	CreateDialogNodeOptionsDigressOutAllowReturningConst      = "allow_returning"
)

Constants associated with the CreateDialogNodeOptions.DigressOut property. Whether this dialog node can be returned to after a digression.

View Source 
const (
	CreateDialogNodeOptionsDigressOutSlotsAllowAllConst       = "allow_all"
	CreateDialogNodeOptionsDigressOutSlotsAllowReturningConst = "allow_returning"
	CreateDialogNodeOptionsDigressOutSlotsNotAllowedConst     = "not_allowed"
)

Constants associated with the CreateDialogNodeOptions.DigressOutSlots property. Whether the user can digress to top-level nodes while filling out slots.

View Source 
const (
	CreateValueTypePatternsConst = "patterns"
	CreateValueTypeSynonymsConst = "synonyms"
)

Constants associated with the CreateValue.Type property. Specifies the type of entity value.

View Source 
const (
	CreateValueOptionsTypePatternsConst = "patterns"
	CreateValueOptionsTypeSynonymsConst = "synonyms"
)

Constants associated with the CreateValueOptions.Type property. Specifies the type of entity value.

View Source 
const (
	DialogNodeTypeEventHandlerConst      = "event_handler"
	DialogNodeTypeFolderConst            = "folder"
	DialogNodeTypeFrameConst             = "frame"
	DialogNodeTypeResponseConditionConst = "response_condition"
	DialogNodeTypeSlotConst              = "slot"
	DialogNodeTypeStandardConst          = "standard"
)

Constants associated with the DialogNode.Type property. How the dialog node is processed.

View Source 
const (
	DialogNodeEventNameDigressionReturnPromptConst   = "digression_return_prompt"
	DialogNodeEventNameFilledConst                   = "filled"
	DialogNodeEventNameFilledMultipleConst           = "filled_multiple"
	DialogNodeEventNameFocusConst                    = "focus"
	DialogNodeEventNameGenericConst                  = "generic"
	DialogNodeEventNameInputConst                    = "input"
	DialogNodeEventNameNomatchConst                  = "nomatch"
	DialogNodeEventNameNomatchResponsesDepletedConst = "nomatch_responses_depleted"
	DialogNodeEventNameValidateConst                 = "validate"
)

Constants associated with the DialogNode.EventName property. How an `event_handler` node is processed.

View Source 
const (
	DialogNodeDigressInDoesNotReturnConst = "does_not_return"
	DialogNodeDigressInNotAvailableConst  = "not_available"
	DialogNodeDigressInReturnsConst       = "returns"
)

Constants associated with the DialogNode.DigressIn property. Whether this top-level dialog node can be digressed into.

View Source 
const (
	DialogNodeDigressOutAllowAllConst            = "allow_all"
	DialogNodeDigressOutAllowAllNeverReturnConst = "allow_all_never_return"
	DialogNodeDigressOutAllowReturningConst      = "allow_returning"
)

Constants associated with the DialogNode.DigressOut property. Whether this dialog node can be returned to after a digression.

View Source 
const (
	DialogNodeDigressOutSlotsAllowAllConst       = "allow_all"
	DialogNodeDigressOutSlotsAllowReturningConst = "allow_returning"
	DialogNodeDigressOutSlotsNotAllowedConst     = "not_allowed"
)

Constants associated with the DialogNode.DigressOutSlots property. Whether the user can digress to top-level nodes while filling out slots.

View Source 
const (
	DialogNodeActionTypeClientConst        = "client"
	DialogNodeActionTypeCloudFunctionConst = "cloud_function"
	DialogNodeActionTypeServerConst        = "server"
	DialogNodeActionTypeWebActionConst     = "web_action"
	DialogNodeActionTypeWebhookConst       = "webhook"
)

Constants associated with the DialogNodeAction.Type property. The type of action to invoke.

View Source 
const (
	DialogNodeNextStepBehaviorGetUserInputConst  = "get_user_input"
	DialogNodeNextStepBehaviorJumpToConst        = "jump_to"
	DialogNodeNextStepBehaviorRepromptConst      = "reprompt"
	DialogNodeNextStepBehaviorSkipAllSlotsConst  = "skip_all_slots"
	DialogNodeNextStepBehaviorSkipSlotConst      = "skip_slot"
	DialogNodeNextStepBehaviorSkipUserInputConst = "skip_user_input"
)

Constants associated with the DialogNodeNextStep.Behavior property. What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node:

  • `get_user_input`
  • `skip_user_input`
  • `jump_to`

- If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid:

  • if **event_name**=`filled` and the type of the parent node is `slot`:
  • `reprompt`
  • `skip_all_slots`

- if **event_name**=`nomatch` and the type of the parent node is `slot`:

  • `reprompt`
  • `skip_slot`
  • `skip_all_slots`

- if **event_name**=`generic` and the type of the parent node is `frame`:

  • `reprompt`
  • `skip_slot`
  • `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property.
View Source 
const (
	DialogNodeNextStepSelectorBodyConst      = "body"
	DialogNodeNextStepSelectorClientConst    = "client"
	DialogNodeNextStepSelectorConditionConst = "condition"
	DialogNodeNextStepSelectorUserInputConst = "user_input"
)

Constants associated with the DialogNodeNextStep.Selector property. Which part of the dialog node to process next.

View Source 
const (
	DialogNodeOutputGenericSelectionPolicyMultilineConst  = "multiline"
	DialogNodeOutputGenericSelectionPolicyRandomConst     = "random"
	DialogNodeOutputGenericSelectionPolicySequentialConst = "sequential"
)

Constants associated with the DialogNodeOutputGeneric.SelectionPolicy property. How a response is selected from the list, if more than one response is specified.

View Source 
const (
	DialogNodeOutputGenericPreferenceButtonConst   = "button"
	DialogNodeOutputGenericPreferenceDropdownConst = "dropdown"
)

Constants associated with the DialogNodeOutputGeneric.Preference property. The preferred type of control to display, if supported by the channel.

View Source 
const (
	DialogNodeOutputGenericQueryTypeDiscoveryQueryLanguageConst = "discovery_query_language"
	DialogNodeOutputGenericQueryTypeNaturalLanguageConst        = "natural_language"
)

Constants associated with the DialogNodeOutputGeneric.QueryType property. The type of the search query.

View Source 
const (
	ListCounterexamplesOptionsSortTextConst    = "text"
	ListCounterexamplesOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListCounterexamplesOptions.Sort property. The attribute by which returned counterexamples will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListDialogNodesOptionsSortDialogNodeConst = "dialog_node"
	ListDialogNodesOptionsSortUpdatedConst    = "updated"
)

Constants associated with the ListDialogNodesOptions.Sort property. The attribute by which returned dialog nodes will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListEntitiesOptionsSortEntityConst  = "entity"
	ListEntitiesOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListEntitiesOptions.Sort property. The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListExamplesOptionsSortTextConst    = "text"
	ListExamplesOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListExamplesOptions.Sort property. The attribute by which returned examples will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListIntentsOptionsSortIntentConst  = "intent"
	ListIntentsOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListIntentsOptions.Sort property. The attribute by which returned intents will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListSynonymsOptionsSortSynonymConst = "synonym"
	ListSynonymsOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListSynonymsOptions.Sort property. The attribute by which returned entity value synonyms will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListValuesOptionsSortUpdatedConst = "updated"
	ListValuesOptionsSortValueConst   = "value"
)

Constants associated with the ListValuesOptions.Sort property. The attribute by which returned entity values will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	ListWorkspacesOptionsSortNameConst    = "name"
	ListWorkspacesOptionsSortUpdatedConst = "updated"
)

Constants associated with the ListWorkspacesOptions.Sort property. The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

View Source 
const (
	LogMessageLevelErrorConst = "error"
	LogMessageLevelInfoConst  = "info"
	LogMessageLevelWarnConst  = "warn"
)

Constants associated with the LogMessage.Level property. The severity of the log message.

View Source 
const (
	ResponseGenericChannelChannelChatConst           = "chat"
	ResponseGenericChannelChannelFacebookConst       = "facebook"
	ResponseGenericChannelChannelIntercomConst       = "intercom"
	ResponseGenericChannelChannelSlackConst          = "slack"
	ResponseGenericChannelChannelTextMessagingConst  = "text_messaging"
	ResponseGenericChannelChannelVoiceTelephonyConst = "voice_telephony"
	ResponseGenericChannelChannelWhatsappConst       = "whatsapp"
)

Constants associated with the ResponseGenericChannel.Channel property. A channel for which the response is intended.

View Source 
const (
	RuntimeEntityInterpretationGranularityDayConst       = "day"
	RuntimeEntityInterpretationGranularityFortnightConst = "fortnight"
	RuntimeEntityInterpretationGranularityHourConst      = "hour"
	RuntimeEntityInterpretationGranularityInstantConst   = "instant"
	RuntimeEntityInterpretationGranularityMinuteConst    = "minute"
	RuntimeEntityInterpretationGranularityMonthConst     = "month"
	RuntimeEntityInterpretationGranularityQuarterConst   = "quarter"
	RuntimeEntityInterpretationGranularitySecondConst    = "second"
	RuntimeEntityInterpretationGranularityWeekConst      = "week"
	RuntimeEntityInterpretationGranularityWeekendConst   = "weekend"
	RuntimeEntityInterpretationGranularityYearConst      = "year"
)

Constants associated with the RuntimeEntityInterpretation.Granularity property. The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.

View Source 
const (
	RuntimeEntityRoleTypeDateFromConst   = "date_from"
	RuntimeEntityRoleTypeDateToConst     = "date_to"
	RuntimeEntityRoleTypeNumberFromConst = "number_from"
	RuntimeEntityRoleTypeNumberToConst   = "number_to"
	RuntimeEntityRoleTypeTimeFromConst   = "time_from"
	RuntimeEntityRoleTypeTimeToConst     = "time_to"
)

Constants associated with the RuntimeEntityRole.Type property. The relationship of the entity to the range.

View Source 
const (
	RuntimeResponseGenericPreferenceButtonConst   = "button"
	RuntimeResponseGenericPreferenceDropdownConst = "dropdown"
)

Constants associated with the RuntimeResponseGeneric.Preference property. The preferred type of control to display.

View Source 
const (
	UpdateDialogNodeOptionsNewTypeEventHandlerConst      = "event_handler"
	UpdateDialogNodeOptionsNewTypeFolderConst            = "folder"
	UpdateDialogNodeOptionsNewTypeFrameConst             = "frame"
	UpdateDialogNodeOptionsNewTypeResponseConditionConst = "response_condition"
	UpdateDialogNodeOptionsNewTypeSlotConst              = "slot"
	UpdateDialogNodeOptionsNewTypeStandardConst          = "standard"
)

Constants associated with the UpdateDialogNodeOptions.NewType property. How the dialog node is processed.

View Source 
const (
	UpdateDialogNodeOptionsNewEventNameDigressionReturnPromptConst   = "digression_return_prompt"
	UpdateDialogNodeOptionsNewEventNameFilledConst                   = "filled"
	UpdateDialogNodeOptionsNewEventNameFilledMultipleConst           = "filled_multiple"
	UpdateDialogNodeOptionsNewEventNameFocusConst                    = "focus"
	UpdateDialogNodeOptionsNewEventNameGenericConst                  = "generic"
	UpdateDialogNodeOptionsNewEventNameInputConst                    = "input"
	UpdateDialogNodeOptionsNewEventNameNomatchConst                  = "nomatch"
	UpdateDialogNodeOptionsNewEventNameNomatchResponsesDepletedConst = "nomatch_responses_depleted"
	UpdateDialogNodeOptionsNewEventNameValidateConst                 = "validate"
)

Constants associated with the UpdateDialogNodeOptions.NewEventName property. How an `event_handler` node is processed.

View Source 
const (
	UpdateDialogNodeOptionsNewDigressInDoesNotReturnConst = "does_not_return"
	UpdateDialogNodeOptionsNewDigressInNotAvailableConst  = "not_available"
	UpdateDialogNodeOptionsNewDigressInReturnsConst       = "returns"
)

Constants associated with the UpdateDialogNodeOptions.NewDigressIn property. Whether this top-level dialog node can be digressed into.

View Source 
const (
	UpdateDialogNodeOptionsNewDigressOutAllowAllConst            = "allow_all"
	UpdateDialogNodeOptionsNewDigressOutAllowAllNeverReturnConst = "allow_all_never_return"
	UpdateDialogNodeOptionsNewDigressOutAllowReturningConst      = "allow_returning"
)

Constants associated with the UpdateDialogNodeOptions.NewDigressOut property. Whether this dialog node can be returned to after a digression.

View Source 
const (
	UpdateDialogNodeOptionsNewDigressOutSlotsAllowAllConst       = "allow_all"
	UpdateDialogNodeOptionsNewDigressOutSlotsAllowReturningConst = "allow_returning"
	UpdateDialogNodeOptionsNewDigressOutSlotsNotAllowedConst     = "not_allowed"
)

Constants associated with the UpdateDialogNodeOptions.NewDigressOutSlots property. Whether the user can digress to top-level nodes while filling out slots.

View Source 
const (
	UpdateValueOptionsNewTypePatternsConst = "patterns"
	UpdateValueOptionsNewTypeSynonymsConst = "synonyms"
)

Constants associated with the UpdateValueOptions.NewType property. Specifies the type of entity value.

View Source 
const (
	ValueTypePatternsConst = "patterns"
	ValueTypeSynonymsConst = "synonyms"
)

Constants associated with the Value.Type property. Specifies the type of entity value.

View Source 
const (
	WorkspaceStatusAvailableConst   = "Available"
	WorkspaceStatusFailedConst      = "Failed"
	WorkspaceStatusNonExistentConst = "Non Existent"
	WorkspaceStatusTrainingConst    = "Training"
	WorkspaceStatusUnavailableConst = "Unavailable"
)

Constants associated with the Workspace.Status property. The current status of the workspace.

View Source 
const (
	WorkspaceSystemSettingsDisambiguationSensitivityAutoConst       = "auto"
	WorkspaceSystemSettingsDisambiguationSensitivityHighConst       = "high"
	WorkspaceSystemSettingsDisambiguationSensitivityLowConst        = "low"
	WorkspaceSystemSettingsDisambiguationSensitivityMediumConst     = "medium"
	WorkspaceSystemSettingsDisambiguationSensitivityMediumHighConst = "medium_high"
	WorkspaceSystemSettingsDisambiguationSensitivityMediumLowConst  = "medium_low"
)

Constants associated with the WorkspaceSystemSettingsDisambiguation.Sensitivity property. The sensitivity of the disambiguation feature to intent detection uncertainty. Higher sensitivity means that the disambiguation feature is triggered more often and includes more choices.

View Source 
const (
	DialogNodeOutputGenericDialogNodeOutputResponseTypeOptionPreferenceButtonConst   = "button"
	DialogNodeOutputGenericDialogNodeOutputResponseTypeOptionPreferenceDropdownConst = "dropdown"
)

Constants associated with the DialogNodeOutputGenericDialogNodeOutputResponseTypeOption.Preference property. The preferred type of control to display, if supported by the channel.

View Source 
const (
	DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkillQueryTypeDiscoveryQueryLanguageConst = "discovery_query_language"
	DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkillQueryTypeNaturalLanguageConst        = "natural_language"
)

Constants associated with the DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill.QueryType property. The type of the search query.

View Source 
const (
	DialogNodeOutputGenericDialogNodeOutputResponseTypeTextSelectionPolicyMultilineConst  = "multiline"
	DialogNodeOutputGenericDialogNodeOutputResponseTypeTextSelectionPolicyRandomConst     = "random"
	DialogNodeOutputGenericDialogNodeOutputResponseTypeTextSelectionPolicySequentialConst = "sequential"
)

Constants associated with the DialogNodeOutputGenericDialogNodeOutputResponseTypeText.SelectionPolicy property. How a response is selected from the list, if more than one response is specified.

View Source 
const (
	RuntimeResponseGenericRuntimeResponseTypeOptionPreferenceButtonConst   = "button"
	RuntimeResponseGenericRuntimeResponseTypeOptionPreferenceDropdownConst = "dropdown"
)

Constants associated with the RuntimeResponseGenericRuntimeResponseTypeOption.Preference property. The preferred type of control to display.

View Source 
const DefaultServiceName = "conversation"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.us-south.assistant.watson.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	GetWorkspaceOptionsSortStableConst = "stable"
)

Constants associated with the GetWorkspaceOptions.Sort property. Indicates how the returned workspace data will be sorted. This parameter is valid only if **export**=`true`. Specify `sort=stable` to sort all workspace objects by unique identifier, in ascending alphabetical order.

View Source 
const (
	LogMessageSourceTypeDialogNodeConst = "dialog_node"
)

Constants associated with the LogMessageSource.Type property. A string that indicates the type of dialog element that generated the error message.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAgentAvailabilityMessage 

func UnmarshalAgentAvailabilityMessage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAgentAvailabilityMessage unmarshals an instance of AgentAvailabilityMessage from the specified map of raw messages.

func UnmarshalBulkClassifyOutput 

func UnmarshalBulkClassifyOutput(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkClassifyOutput unmarshals an instance of BulkClassifyOutput from the specified map of raw messages.

func UnmarshalBulkClassifyResponse 

func UnmarshalBulkClassifyResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkClassifyResponse unmarshals an instance of BulkClassifyResponse from the specified map of raw messages.

func UnmarshalBulkClassifyUtterance 

func UnmarshalBulkClassifyUtterance(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBulkClassifyUtterance unmarshals an instance of BulkClassifyUtterance from the specified map of raw messages.

func UnmarshalCaptureGroup 

func UnmarshalCaptureGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCaptureGroup unmarshals an instance of CaptureGroup from the specified map of raw messages.

func UnmarshalChannelTransferInfo added in v2.1.0 

func UnmarshalChannelTransferInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChannelTransferInfo unmarshals an instance of ChannelTransferInfo from the specified map of raw messages.

func UnmarshalChannelTransferTarget added in v2.1.0 

func UnmarshalChannelTransferTarget(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChannelTransferTarget unmarshals an instance of ChannelTransferTarget from the specified map of raw messages.

func UnmarshalChannelTransferTargetChat added in v2.1.0 

func UnmarshalChannelTransferTargetChat(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalChannelTransferTargetChat unmarshals an instance of ChannelTransferTargetChat from the specified map of raw messages.

func UnmarshalContext 

func UnmarshalContext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContext unmarshals an instance of Context from the specified map of raw messages.

func UnmarshalCounterexample 

func UnmarshalCounterexample(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCounterexample unmarshals an instance of Counterexample from the specified map of raw messages.

func UnmarshalCounterexampleCollection 

func UnmarshalCounterexampleCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCounterexampleCollection unmarshals an instance of CounterexampleCollection from the specified map of raw messages.

func UnmarshalCreateEntity 

func UnmarshalCreateEntity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateEntity unmarshals an instance of CreateEntity from the specified map of raw messages.

func UnmarshalCreateIntent 

func UnmarshalCreateIntent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateIntent unmarshals an instance of CreateIntent from the specified map of raw messages.

func UnmarshalCreateValue 

func UnmarshalCreateValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateValue unmarshals an instance of CreateValue from the specified map of raw messages.

func UnmarshalDialogNode 

func UnmarshalDialogNode(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNode unmarshals an instance of DialogNode from the specified map of raw messages.

func UnmarshalDialogNodeAction 

func UnmarshalDialogNodeAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeAction unmarshals an instance of DialogNodeAction from the specified map of raw messages.

func UnmarshalDialogNodeCollection 

func UnmarshalDialogNodeCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeCollection unmarshals an instance of DialogNodeCollection from the specified map of raw messages.

func UnmarshalDialogNodeContext 

func UnmarshalDialogNodeContext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeContext unmarshals an instance of DialogNodeContext from the specified map of raw messages.

func UnmarshalDialogNodeNextStep 

func UnmarshalDialogNodeNextStep(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeNextStep unmarshals an instance of DialogNodeNextStep from the specified map of raw messages.

func UnmarshalDialogNodeOutput 

func UnmarshalDialogNodeOutput(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutput unmarshals an instance of DialogNodeOutput from the specified map of raw messages.

func UnmarshalDialogNodeOutputConnectToAgentTransferInfo 

func UnmarshalDialogNodeOutputConnectToAgentTransferInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputConnectToAgentTransferInfo unmarshals an instance of DialogNodeOutputConnectToAgentTransferInfo from the specified map of raw messages.

func UnmarshalDialogNodeOutputGeneric 

func UnmarshalDialogNodeOutputGeneric(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGeneric unmarshals an instance of DialogNodeOutputGeneric from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer added in v2.1.0 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeImage 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeImage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeImage unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeImage from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeOption 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeOption(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeOption unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeOption from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypePause 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypePause(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypePause unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypePause from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeText 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeText(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeText unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeText from the specified map of raw messages.

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined added in v2.1.0 

func UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined unmarshals an instance of DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined from the specified map of raw messages.

func UnmarshalDialogNodeOutputModifiers 

func UnmarshalDialogNodeOutputModifiers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputModifiers unmarshals an instance of DialogNodeOutputModifiers from the specified map of raw messages.

func UnmarshalDialogNodeOutputOptionsElement 

func UnmarshalDialogNodeOutputOptionsElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputOptionsElement unmarshals an instance of DialogNodeOutputOptionsElement from the specified map of raw messages.

func UnmarshalDialogNodeOutputOptionsElementValue 

func UnmarshalDialogNodeOutputOptionsElementValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputOptionsElementValue unmarshals an instance of DialogNodeOutputOptionsElementValue from the specified map of raw messages.

func UnmarshalDialogNodeOutputTextValuesElement 

func UnmarshalDialogNodeOutputTextValuesElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeOutputTextValuesElement unmarshals an instance of DialogNodeOutputTextValuesElement from the specified map of raw messages.

func UnmarshalDialogNodeVisitedDetails 

func UnmarshalDialogNodeVisitedDetails(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogNodeVisitedDetails unmarshals an instance of DialogNodeVisitedDetails from the specified map of raw messages.

func UnmarshalDialogSuggestion 

func UnmarshalDialogSuggestion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogSuggestion unmarshals an instance of DialogSuggestion from the specified map of raw messages.

func UnmarshalDialogSuggestionValue 

func UnmarshalDialogSuggestionValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDialogSuggestionValue unmarshals an instance of DialogSuggestionValue from the specified map of raw messages.

func UnmarshalEntity 

func UnmarshalEntity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEntity unmarshals an instance of Entity from the specified map of raw messages.

func UnmarshalEntityCollection 

func UnmarshalEntityCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEntityCollection unmarshals an instance of EntityCollection from the specified map of raw messages.

func UnmarshalEntityMention 

func UnmarshalEntityMention(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEntityMention unmarshals an instance of EntityMention from the specified map of raw messages.

func UnmarshalEntityMentionCollection 

func UnmarshalEntityMentionCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEntityMentionCollection unmarshals an instance of EntityMentionCollection from the specified map of raw messages.

func UnmarshalExample 

func UnmarshalExample(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExample unmarshals an instance of Example from the specified map of raw messages.

func UnmarshalExampleCollection 

func UnmarshalExampleCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalExampleCollection unmarshals an instance of ExampleCollection from the specified map of raw messages.

func UnmarshalIntent 

func UnmarshalIntent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIntent unmarshals an instance of Intent from the specified map of raw messages.

func UnmarshalIntentCollection 

func UnmarshalIntentCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalIntentCollection unmarshals an instance of IntentCollection from the specified map of raw messages.

func UnmarshalLog 

func UnmarshalLog(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLog unmarshals an instance of Log from the specified map of raw messages.

func UnmarshalLogCollection 

func UnmarshalLogCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLogCollection unmarshals an instance of LogCollection from the specified map of raw messages.

func UnmarshalLogMessage 

func UnmarshalLogMessage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLogMessage unmarshals an instance of LogMessage from the specified map of raw messages.

func UnmarshalLogMessageSource added in v2.1.0 

func UnmarshalLogMessageSource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLogMessageSource unmarshals an instance of LogMessageSource from the specified map of raw messages.

func UnmarshalLogPagination 

func UnmarshalLogPagination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLogPagination unmarshals an instance of LogPagination from the specified map of raw messages.

func UnmarshalMention 

func UnmarshalMention(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMention unmarshals an instance of Mention from the specified map of raw messages.

func UnmarshalMessageContextMetadata 

func UnmarshalMessageContextMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessageContextMetadata unmarshals an instance of MessageContextMetadata from the specified map of raw messages.

func UnmarshalMessageInput 

func UnmarshalMessageInput(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessageInput unmarshals an instance of MessageInput from the specified map of raw messages.

func UnmarshalMessageRequest 

func UnmarshalMessageRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessageRequest unmarshals an instance of MessageRequest from the specified map of raw messages.

func UnmarshalMessageResponse 

func UnmarshalMessageResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMessageResponse unmarshals an instance of MessageResponse from the specified map of raw messages.

func UnmarshalOutputData 

func UnmarshalOutputData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOutputData unmarshals an instance of OutputData from the specified map of raw messages.

func UnmarshalPagination 

func UnmarshalPagination(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPagination unmarshals an instance of Pagination from the specified map of raw messages.

func UnmarshalResponseGenericChannel added in v2.1.0 

func UnmarshalResponseGenericChannel(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResponseGenericChannel unmarshals an instance of ResponseGenericChannel from the specified map of raw messages.

func UnmarshalRuntimeEntity 

func UnmarshalRuntimeEntity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeEntity unmarshals an instance of RuntimeEntity from the specified map of raw messages.

func UnmarshalRuntimeEntityAlternative 

func UnmarshalRuntimeEntityAlternative(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeEntityAlternative unmarshals an instance of RuntimeEntityAlternative from the specified map of raw messages.

func UnmarshalRuntimeEntityInterpretation 

func UnmarshalRuntimeEntityInterpretation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeEntityInterpretation unmarshals an instance of RuntimeEntityInterpretation from the specified map of raw messages.

func UnmarshalRuntimeEntityRole 

func UnmarshalRuntimeEntityRole(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeEntityRole unmarshals an instance of RuntimeEntityRole from the specified map of raw messages.

func UnmarshalRuntimeIntent 

func UnmarshalRuntimeIntent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeIntent unmarshals an instance of RuntimeIntent from the specified map of raw messages.

func UnmarshalRuntimeResponseGeneric 

func UnmarshalRuntimeResponseGeneric(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGeneric unmarshals an instance of RuntimeResponseGeneric from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeChannelTransfer added in v2.1.0 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeChannelTransfer(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeChannelTransfer unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeChannelTransfer from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeConnectToAgent 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeConnectToAgent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeConnectToAgent unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeConnectToAgent from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeImage 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeImage(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeImage unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeImage from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeOption 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeOption(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeOption unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeOption from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypePause 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypePause(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypePause unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypePause from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeSuggestion 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeSuggestion(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeSuggestion unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeSuggestion from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeText 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeText(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeText unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeText from the specified map of raw messages.

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeUserDefined added in v2.1.0 

func UnmarshalRuntimeResponseGenericRuntimeResponseTypeUserDefined(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuntimeResponseGenericRuntimeResponseTypeUserDefined unmarshals an instance of RuntimeResponseGenericRuntimeResponseTypeUserDefined from the specified map of raw messages.

func UnmarshalSynonym 

func UnmarshalSynonym(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSynonym unmarshals an instance of Synonym from the specified map of raw messages.

func UnmarshalSynonymCollection 

func UnmarshalSynonymCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSynonymCollection unmarshals an instance of SynonymCollection from the specified map of raw messages.

func UnmarshalValue 

func UnmarshalValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalValue unmarshals an instance of Value from the specified map of raw messages.

func UnmarshalValueCollection 

func UnmarshalValueCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalValueCollection unmarshals an instance of ValueCollection from the specified map of raw messages.

func UnmarshalWebhook 

func UnmarshalWebhook(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWebhook unmarshals an instance of Webhook from the specified map of raw messages.

func UnmarshalWebhookHeader 

func UnmarshalWebhookHeader(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWebhookHeader unmarshals an instance of WebhookHeader from the specified map of raw messages.

func UnmarshalWorkspace 

func UnmarshalWorkspace(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspace unmarshals an instance of Workspace from the specified map of raw messages.

func UnmarshalWorkspaceCollection 

func UnmarshalWorkspaceCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceCollection unmarshals an instance of WorkspaceCollection from the specified map of raw messages.

func UnmarshalWorkspaceSystemSettings 

func UnmarshalWorkspaceSystemSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceSystemSettings unmarshals an instance of WorkspaceSystemSettings from the specified map of raw messages.

func UnmarshalWorkspaceSystemSettingsDisambiguation 

func UnmarshalWorkspaceSystemSettingsDisambiguation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceSystemSettingsDisambiguation unmarshals an instance of WorkspaceSystemSettingsDisambiguation from the specified map of raw messages.

func UnmarshalWorkspaceSystemSettingsOffTopic 

func UnmarshalWorkspaceSystemSettingsOffTopic(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceSystemSettingsOffTopic unmarshals an instance of WorkspaceSystemSettingsOffTopic from the specified map of raw messages.

func UnmarshalWorkspaceSystemSettingsSystemEntities 

func UnmarshalWorkspaceSystemSettingsSystemEntities(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceSystemSettingsSystemEntities unmarshals an instance of WorkspaceSystemSettingsSystemEntities from the specified map of raw messages.

func UnmarshalWorkspaceSystemSettingsTooling 

func UnmarshalWorkspaceSystemSettingsTooling(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalWorkspaceSystemSettingsTooling unmarshals an instance of WorkspaceSystemSettingsTooling from the specified map of raw messages.

Types

type AgentAvailabilityMessage 

type AgentAvailabilityMessage struct {
	// The text of the message.
	Message *string `json:"message,omitempty"`
}

AgentAvailabilityMessage : AgentAvailabilityMessage struct

type AssistantV1 

type AssistantV1 struct {
	Service *core.BaseService

	// Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is
	// `2021-06-14`.
	Version *string
}

AssistantV1 : The IBM Watson™ Assistant service combines machine learning, natural language understanding, and an integrated dialog editor to create conversation flows between your apps and your users.

The Assistant v1 API provides authoring methods your application can use to create or update a workspace.

API Version: 1.0 See: https://cloud.ibm.com/docs/assistant

func NewAssistantV1 

func NewAssistantV1(options *AssistantV1Options) (service *AssistantV1, err error)

NewAssistantV1 : constructs an instance of AssistantV1 with passed in options.

func (*AssistantV1) BulkClassify 

func (assistant *AssistantV1) BulkClassify(bulkClassifyOptions *BulkClassifyOptions) (result *BulkClassifyResponse, response *core.DetailedResponse, err error)

BulkClassify : Identify intents and entities in multiple user utterances Send multiple user inputs to a workspace in a single request and receive information about the intents and entities recognized in each input. This method is useful for testing and comparing the performance of different workspaces.

This method is available only with Enterprise with Data Isolation plans.

func (*AssistantV1) BulkClassifyWithContext 

func (assistant *AssistantV1) BulkClassifyWithContext(ctx context.Context, bulkClassifyOptions *BulkClassifyOptions) (result *BulkClassifyResponse, response *core.DetailedResponse, err error)

BulkClassifyWithContext is an alternate form of the BulkClassify method which supports a Context parameter

func (*AssistantV1) Clone 

func (assistant *AssistantV1) Clone() *AssistantV1

Clone makes a copy of "assistant" suitable for processing requests.

func (*AssistantV1) CreateCounterexample 

func (assistant *AssistantV1) CreateCounterexample(createCounterexampleOptions *CreateCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

CreateCounterexample : Create counterexample Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input.

If you want to add multiple counterexamples with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) CreateCounterexampleWithContext 

func (assistant *AssistantV1) CreateCounterexampleWithContext(ctx context.Context, createCounterexampleOptions *CreateCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

CreateCounterexampleWithContext is an alternate form of the CreateCounterexample method which supports a Context parameter

func (*AssistantV1) CreateDialogNode 

func (assistant *AssistantV1) CreateDialogNode(createDialogNodeOptions *CreateDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

CreateDialogNode : Create dialog node Create a new dialog node.

If you want to create multiple dialog nodes with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) CreateDialogNodeWithContext 

func (assistant *AssistantV1) CreateDialogNodeWithContext(ctx context.Context, createDialogNodeOptions *CreateDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

CreateDialogNodeWithContext is an alternate form of the CreateDialogNode method which supports a Context parameter

func (*AssistantV1) CreateEntity 

func (assistant *AssistantV1) CreateEntity(createEntityOptions *CreateEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

CreateEntity : Create entity Create a new entity, or enable a system entity.

If you want to create multiple entities with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) CreateEntityWithContext 

func (assistant *AssistantV1) CreateEntityWithContext(ctx context.Context, createEntityOptions *CreateEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

CreateEntityWithContext is an alternate form of the CreateEntity method which supports a Context parameter

func (*AssistantV1) CreateExample 

func (assistant *AssistantV1) CreateExample(createExampleOptions *CreateExampleOptions) (result *Example, response *core.DetailedResponse, err error)

CreateExample : Create user input example Add a new user input example to an intent.

If you want to add multiple examples with a single API call, consider using the **[Update intent](#update-intent)** method instead.

func (*AssistantV1) CreateExampleWithContext 

func (assistant *AssistantV1) CreateExampleWithContext(ctx context.Context, createExampleOptions *CreateExampleOptions) (result *Example, response *core.DetailedResponse, err error)

CreateExampleWithContext is an alternate form of the CreateExample method which supports a Context parameter

func (*AssistantV1) CreateIntent 

func (assistant *AssistantV1) CreateIntent(createIntentOptions *CreateIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

CreateIntent : Create intent Create a new intent.

If you want to create multiple intents with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) CreateIntentWithContext 

func (assistant *AssistantV1) CreateIntentWithContext(ctx context.Context, createIntentOptions *CreateIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

CreateIntentWithContext is an alternate form of the CreateIntent method which supports a Context parameter

func (*AssistantV1) CreateSynonym 

func (assistant *AssistantV1) CreateSynonym(createSynonymOptions *CreateSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

CreateSynonym : Create entity value synonym Add a new synonym to an entity value.

If you want to create multiple synonyms with a single API call, consider using the **[Update entity](#update-entity)** or **[Update entity value](#update-entity-value)** method instead.

func (*AssistantV1) CreateSynonymWithContext 

func (assistant *AssistantV1) CreateSynonymWithContext(ctx context.Context, createSynonymOptions *CreateSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

CreateSynonymWithContext is an alternate form of the CreateSynonym method which supports a Context parameter

func (*AssistantV1) CreateValue 

func (assistant *AssistantV1) CreateValue(createValueOptions *CreateValueOptions) (result *Value, response *core.DetailedResponse, err error)

CreateValue : Create entity value Create a new value for an entity.

If you want to create multiple entity values with a single API call, consider using the **[Update entity](#update-entity)** method instead.

func (*AssistantV1) CreateValueWithContext 

func (assistant *AssistantV1) CreateValueWithContext(ctx context.Context, createValueOptions *CreateValueOptions) (result *Value, response *core.DetailedResponse, err error)

CreateValueWithContext is an alternate form of the CreateValue method which supports a Context parameter

func (*AssistantV1) CreateWorkspace 

func (assistant *AssistantV1) CreateWorkspace(createWorkspaceOptions *CreateWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

CreateWorkspace : Create workspace Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

func (*AssistantV1) CreateWorkspaceWithContext 

func (assistant *AssistantV1) CreateWorkspaceWithContext(ctx context.Context, createWorkspaceOptions *CreateWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

CreateWorkspaceWithContext is an alternate form of the CreateWorkspace method which supports a Context parameter

func (*AssistantV1) DeleteCounterexample 

func (assistant *AssistantV1) DeleteCounterexample(deleteCounterexampleOptions *DeleteCounterexampleOptions) (response *core.DetailedResponse, err error)

DeleteCounterexample : Delete counterexample Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input.

func (*AssistantV1) DeleteCounterexampleWithContext 

func (assistant *AssistantV1) DeleteCounterexampleWithContext(ctx context.Context, deleteCounterexampleOptions *DeleteCounterexampleOptions) (response *core.DetailedResponse, err error)

DeleteCounterexampleWithContext is an alternate form of the DeleteCounterexample method which supports a Context parameter

func (*AssistantV1) DeleteDialogNode 

func (assistant *AssistantV1) DeleteDialogNode(deleteDialogNodeOptions *DeleteDialogNodeOptions) (response *core.DetailedResponse, err error)

DeleteDialogNode : Delete dialog node Delete a dialog node from a workspace.

func (*AssistantV1) DeleteDialogNodeWithContext 

func (assistant *AssistantV1) DeleteDialogNodeWithContext(ctx context.Context, deleteDialogNodeOptions *DeleteDialogNodeOptions) (response *core.DetailedResponse, err error)

DeleteDialogNodeWithContext is an alternate form of the DeleteDialogNode method which supports a Context parameter

func (*AssistantV1) DeleteEntity 

func (assistant *AssistantV1) DeleteEntity(deleteEntityOptions *DeleteEntityOptions) (response *core.DetailedResponse, err error)

DeleteEntity : Delete entity Delete an entity from a workspace, or disable a system entity.

func (*AssistantV1) DeleteEntityWithContext 

func (assistant *AssistantV1) DeleteEntityWithContext(ctx context.Context, deleteEntityOptions *DeleteEntityOptions) (response *core.DetailedResponse, err error)

DeleteEntityWithContext is an alternate form of the DeleteEntity method which supports a Context parameter

func (*AssistantV1) DeleteExample 

func (assistant *AssistantV1) DeleteExample(deleteExampleOptions *DeleteExampleOptions) (response *core.DetailedResponse, err error)

DeleteExample : Delete user input example Delete a user input example from an intent.

func (*AssistantV1) DeleteExampleWithContext 

func (assistant *AssistantV1) DeleteExampleWithContext(ctx context.Context, deleteExampleOptions *DeleteExampleOptions) (response *core.DetailedResponse, err error)

DeleteExampleWithContext is an alternate form of the DeleteExample method which supports a Context parameter

func (*AssistantV1) DeleteIntent 

func (assistant *AssistantV1) DeleteIntent(deleteIntentOptions *DeleteIntentOptions) (response *core.DetailedResponse, err error)

DeleteIntent : Delete intent Delete an intent from a workspace.

func (*AssistantV1) DeleteIntentWithContext 

func (assistant *AssistantV1) DeleteIntentWithContext(ctx context.Context, deleteIntentOptions *DeleteIntentOptions) (response *core.DetailedResponse, err error)

DeleteIntentWithContext is an alternate form of the DeleteIntent method which supports a Context parameter

func (*AssistantV1) DeleteSynonym 

func (assistant *AssistantV1) DeleteSynonym(deleteSynonymOptions *DeleteSynonymOptions) (response *core.DetailedResponse, err error)

DeleteSynonym : Delete entity value synonym Delete a synonym from an entity value.

func (*AssistantV1) DeleteSynonymWithContext 

func (assistant *AssistantV1) DeleteSynonymWithContext(ctx context.Context, deleteSynonymOptions *DeleteSynonymOptions) (response *core.DetailedResponse, err error)

DeleteSynonymWithContext is an alternate form of the DeleteSynonym method which supports a Context parameter

func (*AssistantV1) DeleteUserData 

func (assistant *AssistantV1) DeleteUserData(deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)

DeleteUserData : Delete labeled data Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.

You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. For more information about personal data and customer IDs, see [Information security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).

**Note:** This operation is intended only for deleting data associated with a single specific customer, not for deleting data associated with multiple customers or for any other purpose. For more information, see [Labeling and deleting data in Watson Assistant](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security-gdpr-wa).

func (*AssistantV1) DeleteUserDataWithContext 

func (assistant *AssistantV1) DeleteUserDataWithContext(ctx context.Context, deleteUserDataOptions *DeleteUserDataOptions) (response *core.DetailedResponse, err error)

DeleteUserDataWithContext is an alternate form of the DeleteUserData method which supports a Context parameter

func (*AssistantV1) DeleteValue 

func (assistant *AssistantV1) DeleteValue(deleteValueOptions *DeleteValueOptions) (response *core.DetailedResponse, err error)

DeleteValue : Delete entity value Delete a value from an entity.

func (*AssistantV1) DeleteValueWithContext 

func (assistant *AssistantV1) DeleteValueWithContext(ctx context.Context, deleteValueOptions *DeleteValueOptions) (response *core.DetailedResponse, err error)

DeleteValueWithContext is an alternate form of the DeleteValue method which supports a Context parameter

func (*AssistantV1) DeleteWorkspace 

func (assistant *AssistantV1) DeleteWorkspace(deleteWorkspaceOptions *DeleteWorkspaceOptions) (response *core.DetailedResponse, err error)

DeleteWorkspace : Delete workspace Delete a workspace from the service instance.

func (*AssistantV1) DeleteWorkspaceWithContext 

func (assistant *AssistantV1) DeleteWorkspaceWithContext(ctx context.Context, deleteWorkspaceOptions *DeleteWorkspaceOptions) (response *core.DetailedResponse, err error)

DeleteWorkspaceWithContext is an alternate form of the DeleteWorkspace method which supports a Context parameter

func (*AssistantV1) DisableRetries 

func (assistant *AssistantV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*AssistantV1) DisableSSLVerification 

func (assistant *AssistantV1) DisableSSLVerification()

DisableSSLVerification bypasses verification of the server's SSL certificate

func (*AssistantV1) EnableRetries 

func (assistant *AssistantV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*AssistantV1) GetCounterexample 

func (assistant *AssistantV1) GetCounterexample(getCounterexampleOptions *GetCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

GetCounterexample : Get counterexample Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input.

func (*AssistantV1) GetCounterexampleWithContext 

func (assistant *AssistantV1) GetCounterexampleWithContext(ctx context.Context, getCounterexampleOptions *GetCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

GetCounterexampleWithContext is an alternate form of the GetCounterexample method which supports a Context parameter

func (*AssistantV1) GetDialogNode 

func (assistant *AssistantV1) GetDialogNode(getDialogNodeOptions *GetDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

GetDialogNode : Get dialog node Get information about a dialog node.

func (*AssistantV1) GetDialogNodeWithContext 

func (assistant *AssistantV1) GetDialogNodeWithContext(ctx context.Context, getDialogNodeOptions *GetDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

GetDialogNodeWithContext is an alternate form of the GetDialogNode method which supports a Context parameter

func (*AssistantV1) GetEnableGzipCompression 

func (assistant *AssistantV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*AssistantV1) GetEntity 

func (assistant *AssistantV1) GetEntity(getEntityOptions *GetEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

GetEntity : Get entity Get information about an entity, optionally including all entity content.

func (*AssistantV1) GetEntityWithContext 

func (assistant *AssistantV1) GetEntityWithContext(ctx context.Context, getEntityOptions *GetEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

GetEntityWithContext is an alternate form of the GetEntity method which supports a Context parameter

func (*AssistantV1) GetExample 

func (assistant *AssistantV1) GetExample(getExampleOptions *GetExampleOptions) (result *Example, response *core.DetailedResponse, err error)

GetExample : Get user input example Get information about a user input example.

func (*AssistantV1) GetExampleWithContext 

func (assistant *AssistantV1) GetExampleWithContext(ctx context.Context, getExampleOptions *GetExampleOptions) (result *Example, response *core.DetailedResponse, err error)

GetExampleWithContext is an alternate form of the GetExample method which supports a Context parameter

func (*AssistantV1) GetIntent 

func (assistant *AssistantV1) GetIntent(getIntentOptions *GetIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

GetIntent : Get intent Get information about an intent, optionally including all intent content.

func (*AssistantV1) GetIntentWithContext 

func (assistant *AssistantV1) GetIntentWithContext(ctx context.Context, getIntentOptions *GetIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

GetIntentWithContext is an alternate form of the GetIntent method which supports a Context parameter

func (*AssistantV1) GetServiceURL 

func (assistant *AssistantV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*AssistantV1) GetSynonym 

func (assistant *AssistantV1) GetSynonym(getSynonymOptions *GetSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

GetSynonym : Get entity value synonym Get information about a synonym of an entity value.

func (*AssistantV1) GetSynonymWithContext 

func (assistant *AssistantV1) GetSynonymWithContext(ctx context.Context, getSynonymOptions *GetSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

GetSynonymWithContext is an alternate form of the GetSynonym method which supports a Context parameter

func (*AssistantV1) GetValue 

func (assistant *AssistantV1) GetValue(getValueOptions *GetValueOptions) (result *Value, response *core.DetailedResponse, err error)

GetValue : Get entity value Get information about an entity value.

func (*AssistantV1) GetValueWithContext 

func (assistant *AssistantV1) GetValueWithContext(ctx context.Context, getValueOptions *GetValueOptions) (result *Value, response *core.DetailedResponse, err error)

GetValueWithContext is an alternate form of the GetValue method which supports a Context parameter

func (*AssistantV1) GetWorkspace 

func (assistant *AssistantV1) GetWorkspace(getWorkspaceOptions *GetWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

GetWorkspace : Get information about a workspace Get information about a workspace, optionally including all workspace content.

func (*AssistantV1) GetWorkspaceWithContext 

func (assistant *AssistantV1) GetWorkspaceWithContext(ctx context.Context, getWorkspaceOptions *GetWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

GetWorkspaceWithContext is an alternate form of the GetWorkspace method which supports a Context parameter

func (*AssistantV1) ListAllLogs 

func (assistant *AssistantV1) ListAllLogs(listAllLogsOptions *ListAllLogsOptions) (result *LogCollection, response *core.DetailedResponse, err error)

ListAllLogs : List log events in all workspaces List the events from the logs of all workspaces in the service instance.

func (*AssistantV1) ListAllLogsWithContext 

func (assistant *AssistantV1) ListAllLogsWithContext(ctx context.Context, listAllLogsOptions *ListAllLogsOptions) (result *LogCollection, response *core.DetailedResponse, err error)

ListAllLogsWithContext is an alternate form of the ListAllLogs method which supports a Context parameter

func (*AssistantV1) ListCounterexamples 

func (assistant *AssistantV1) ListCounterexamples(listCounterexamplesOptions *ListCounterexamplesOptions) (result *CounterexampleCollection, response *core.DetailedResponse, err error)

ListCounterexamples : List counterexamples List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input.

func (*AssistantV1) ListCounterexamplesWithContext 

func (assistant *AssistantV1) ListCounterexamplesWithContext(ctx context.Context, listCounterexamplesOptions *ListCounterexamplesOptions) (result *CounterexampleCollection, response *core.DetailedResponse, err error)

ListCounterexamplesWithContext is an alternate form of the ListCounterexamples method which supports a Context parameter

func (*AssistantV1) ListDialogNodes 

func (assistant *AssistantV1) ListDialogNodes(listDialogNodesOptions *ListDialogNodesOptions) (result *DialogNodeCollection, response *core.DetailedResponse, err error)

ListDialogNodes : List dialog nodes List the dialog nodes for a workspace.

func (*AssistantV1) ListDialogNodesWithContext 

func (assistant *AssistantV1) ListDialogNodesWithContext(ctx context.Context, listDialogNodesOptions *ListDialogNodesOptions) (result *DialogNodeCollection, response *core.DetailedResponse, err error)

ListDialogNodesWithContext is an alternate form of the ListDialogNodes method which supports a Context parameter

func (*AssistantV1) ListEntities 

func (assistant *AssistantV1) ListEntities(listEntitiesOptions *ListEntitiesOptions) (result *EntityCollection, response *core.DetailedResponse, err error)

ListEntities : List entities List the entities for a workspace.

func (*AssistantV1) ListEntitiesWithContext 

func (assistant *AssistantV1) ListEntitiesWithContext(ctx context.Context, listEntitiesOptions *ListEntitiesOptions) (result *EntityCollection, response *core.DetailedResponse, err error)

ListEntitiesWithContext is an alternate form of the ListEntities method which supports a Context parameter

func (*AssistantV1) ListExamples 

func (assistant *AssistantV1) ListExamples(listExamplesOptions *ListExamplesOptions) (result *ExampleCollection, response *core.DetailedResponse, err error)

ListExamples : List user input examples List the user input examples for an intent, optionally including contextual entity mentions.

func (*AssistantV1) ListExamplesWithContext 

func (assistant *AssistantV1) ListExamplesWithContext(ctx context.Context, listExamplesOptions *ListExamplesOptions) (result *ExampleCollection, response *core.DetailedResponse, err error)

ListExamplesWithContext is an alternate form of the ListExamples method which supports a Context parameter

func (*AssistantV1) ListIntents 

func (assistant *AssistantV1) ListIntents(listIntentsOptions *ListIntentsOptions) (result *IntentCollection, response *core.DetailedResponse, err error)

ListIntents : List intents List the intents for a workspace.

func (*AssistantV1) ListIntentsWithContext 

func (assistant *AssistantV1) ListIntentsWithContext(ctx context.Context, listIntentsOptions *ListIntentsOptions) (result *IntentCollection, response *core.DetailedResponse, err error)

ListIntentsWithContext is an alternate form of the ListIntents method which supports a Context parameter

func (*AssistantV1) ListLogs 

func (assistant *AssistantV1) ListLogs(listLogsOptions *ListLogsOptions) (result *LogCollection, response *core.DetailedResponse, err error)

ListLogs : List log events in a workspace List the events from the log of a specific workspace.

This method requires Manager access.

func (*AssistantV1) ListLogsWithContext 

func (assistant *AssistantV1) ListLogsWithContext(ctx context.Context, listLogsOptions *ListLogsOptions) (result *LogCollection, response *core.DetailedResponse, err error)

ListLogsWithContext is an alternate form of the ListLogs method which supports a Context parameter

func (*AssistantV1) ListMentions 

func (assistant *AssistantV1) ListMentions(listMentionsOptions *ListMentionsOptions) (result *EntityMentionCollection, response *core.DetailedResponse, err error)

ListMentions : List entity mentions List mentions for a contextual entity. An entity mention is an occurrence of a contextual entity in the context of an intent user input example.

func (*AssistantV1) ListMentionsWithContext 

func (assistant *AssistantV1) ListMentionsWithContext(ctx context.Context, listMentionsOptions *ListMentionsOptions) (result *EntityMentionCollection, response *core.DetailedResponse, err error)

ListMentionsWithContext is an alternate form of the ListMentions method which supports a Context parameter

func (*AssistantV1) ListSynonyms 

func (assistant *AssistantV1) ListSynonyms(listSynonymsOptions *ListSynonymsOptions) (result *SynonymCollection, response *core.DetailedResponse, err error)

ListSynonyms : List entity value synonyms List the synonyms for an entity value.

func (*AssistantV1) ListSynonymsWithContext 

func (assistant *AssistantV1) ListSynonymsWithContext(ctx context.Context, listSynonymsOptions *ListSynonymsOptions) (result *SynonymCollection, response *core.DetailedResponse, err error)

ListSynonymsWithContext is an alternate form of the ListSynonyms method which supports a Context parameter

func (*AssistantV1) ListValues 

func (assistant *AssistantV1) ListValues(listValuesOptions *ListValuesOptions) (result *ValueCollection, response *core.DetailedResponse, err error)

ListValues : List entity values List the values for an entity.

func (*AssistantV1) ListValuesWithContext 

func (assistant *AssistantV1) ListValuesWithContext(ctx context.Context, listValuesOptions *ListValuesOptions) (result *ValueCollection, response *core.DetailedResponse, err error)

ListValuesWithContext is an alternate form of the ListValues method which supports a Context parameter

func (*AssistantV1) ListWorkspaces 

func (assistant *AssistantV1) ListWorkspaces(listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceCollection, response *core.DetailedResponse, err error)

ListWorkspaces : List workspaces List the workspaces associated with a Watson Assistant service instance.

func (*AssistantV1) ListWorkspacesWithContext 

func (assistant *AssistantV1) ListWorkspacesWithContext(ctx context.Context, listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceCollection, response *core.DetailedResponse, err error)

ListWorkspacesWithContext is an alternate form of the ListWorkspaces method which supports a Context parameter

func (*AssistantV1) Message 

func (assistant *AssistantV1) Message(messageOptions *MessageOptions) (result *MessageResponse, response *core.DetailedResponse, err error)

Message : Get response to user input Send user input to a workspace and receive a response.

**Important:** This method has been superseded by the new v2 runtime API. The v2 API offers significant advantages, including ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-api-overview).

func (*AssistantV1) MessageWithContext 

func (assistant *AssistantV1) MessageWithContext(ctx context.Context, messageOptions *MessageOptions) (result *MessageResponse, response *core.DetailedResponse, err error)

MessageWithContext is an alternate form of the Message method which supports a Context parameter

func (*AssistantV1) NewBulkClassifyOptions 

func (*AssistantV1) NewBulkClassifyOptions(workspaceID string) *BulkClassifyOptions

NewBulkClassifyOptions : Instantiate BulkClassifyOptions

func (*AssistantV1) NewBulkClassifyUtterance 

func (*AssistantV1) NewBulkClassifyUtterance(text string) (_model *BulkClassifyUtterance, err error)

NewBulkClassifyUtterance : Instantiate BulkClassifyUtterance (Generic Model Constructor)

func (*AssistantV1) NewCaptureGroup 

func (*AssistantV1) NewCaptureGroup(group string) (_model *CaptureGroup, err error)

NewCaptureGroup : Instantiate CaptureGroup (Generic Model Constructor)

func (*AssistantV1) NewChannelTransferInfo added in v2.1.0 

func (*AssistantV1) NewChannelTransferInfo(target *ChannelTransferTarget) (_model *ChannelTransferInfo, err error)

NewChannelTransferInfo : Instantiate ChannelTransferInfo (Generic Model Constructor)

func (*AssistantV1) NewCounterexample 

func (*AssistantV1) NewCounterexample(text string) (_model *Counterexample, err error)

NewCounterexample : Instantiate Counterexample (Generic Model Constructor)

func (*AssistantV1) NewCreateCounterexampleOptions 

func (*AssistantV1) NewCreateCounterexampleOptions(workspaceID string, text string) *CreateCounterexampleOptions

NewCreateCounterexampleOptions : Instantiate CreateCounterexampleOptions

func (*AssistantV1) NewCreateDialogNodeOptions 

func (*AssistantV1) NewCreateDialogNodeOptions(workspaceID string, dialogNode string) *CreateDialogNodeOptions

NewCreateDialogNodeOptions : Instantiate CreateDialogNodeOptions

func (*AssistantV1) NewCreateEntity 

func (*AssistantV1) NewCreateEntity(entity string) (_model *CreateEntity, err error)

NewCreateEntity : Instantiate CreateEntity (Generic Model Constructor)

func (*AssistantV1) NewCreateEntityOptions 

func (*AssistantV1) NewCreateEntityOptions(workspaceID string, entity string) *CreateEntityOptions

NewCreateEntityOptions : Instantiate CreateEntityOptions

func (*AssistantV1) NewCreateExampleOptions 

func (*AssistantV1) NewCreateExampleOptions(workspaceID string, intent string, text string) *CreateExampleOptions

NewCreateExampleOptions : Instantiate CreateExampleOptions

func (*AssistantV1) NewCreateIntent 

func (*AssistantV1) NewCreateIntent(intent string) (_model *CreateIntent, err error)

NewCreateIntent : Instantiate CreateIntent (Generic Model Constructor)

func (*AssistantV1) NewCreateIntentOptions 

func (*AssistantV1) NewCreateIntentOptions(workspaceID string, intent string) *CreateIntentOptions

NewCreateIntentOptions : Instantiate CreateIntentOptions

func (*AssistantV1) NewCreateSynonymOptions 

func (*AssistantV1) NewCreateSynonymOptions(workspaceID string, entity string, value string, synonym string) *CreateSynonymOptions

NewCreateSynonymOptions : Instantiate CreateSynonymOptions

func (*AssistantV1) NewCreateValue 

func (*AssistantV1) NewCreateValue(value string) (_model *CreateValue, err error)

NewCreateValue : Instantiate CreateValue (Generic Model Constructor)

func (*AssistantV1) NewCreateValueOptions 

func (*AssistantV1) NewCreateValueOptions(workspaceID string, entity string, value string) *CreateValueOptions

NewCreateValueOptions : Instantiate CreateValueOptions

func (*AssistantV1) NewCreateWorkspaceOptions 

func (*AssistantV1) NewCreateWorkspaceOptions() *CreateWorkspaceOptions

NewCreateWorkspaceOptions : Instantiate CreateWorkspaceOptions

func (*AssistantV1) NewDeleteCounterexampleOptions 

func (*AssistantV1) NewDeleteCounterexampleOptions(workspaceID string, text string) *DeleteCounterexampleOptions

NewDeleteCounterexampleOptions : Instantiate DeleteCounterexampleOptions

func (*AssistantV1) NewDeleteDialogNodeOptions 

func (*AssistantV1) NewDeleteDialogNodeOptions(workspaceID string, dialogNode string) *DeleteDialogNodeOptions

NewDeleteDialogNodeOptions : Instantiate DeleteDialogNodeOptions

func (*AssistantV1) NewDeleteEntityOptions 

func (*AssistantV1) NewDeleteEntityOptions(workspaceID string, entity string) *DeleteEntityOptions

NewDeleteEntityOptions : Instantiate DeleteEntityOptions

func (*AssistantV1) NewDeleteExampleOptions 

func (*AssistantV1) NewDeleteExampleOptions(workspaceID string, intent string, text string) *DeleteExampleOptions

NewDeleteExampleOptions : Instantiate DeleteExampleOptions

func (*AssistantV1) NewDeleteIntentOptions 

func (*AssistantV1) NewDeleteIntentOptions(workspaceID string, intent string) *DeleteIntentOptions

NewDeleteIntentOptions : Instantiate DeleteIntentOptions

func (*AssistantV1) NewDeleteSynonymOptions 

func (*AssistantV1) NewDeleteSynonymOptions(workspaceID string, entity string, value string, synonym string) *DeleteSynonymOptions

NewDeleteSynonymOptions : Instantiate DeleteSynonymOptions

func (*AssistantV1) NewDeleteUserDataOptions 

func (*AssistantV1) NewDeleteUserDataOptions(customerID string) *DeleteUserDataOptions

NewDeleteUserDataOptions : Instantiate DeleteUserDataOptions

func (*AssistantV1) NewDeleteValueOptions 

func (*AssistantV1) NewDeleteValueOptions(workspaceID string, entity string, value string) *DeleteValueOptions

NewDeleteValueOptions : Instantiate DeleteValueOptions

func (*AssistantV1) NewDeleteWorkspaceOptions 

func (*AssistantV1) NewDeleteWorkspaceOptions(workspaceID string) *DeleteWorkspaceOptions

NewDeleteWorkspaceOptions : Instantiate DeleteWorkspaceOptions

func (*AssistantV1) NewDialogNode 

func (*AssistantV1) NewDialogNode(dialogNode string) (_model *DialogNode, err error)

NewDialogNode : Instantiate DialogNode (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeAction 

func (*AssistantV1) NewDialogNodeAction(name string, resultVariable string) (_model *DialogNodeAction, err error)

NewDialogNodeAction : Instantiate DialogNodeAction (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeNextStep 

func (*AssistantV1) NewDialogNodeNextStep(behavior string) (_model *DialogNodeNextStep, err error)

NewDialogNodeNextStep : Instantiate DialogNodeNextStep (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer added in v2.1.0 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer(responseType string, messageToUser string, transferInfo *ChannelTransferInfo) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent(responseType string) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeImage 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeImage(responseType string, source string) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeImage, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeImage : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeImage (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeOption 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeOption(responseType string, title string, options []DialogNodeOutputOptionsElement) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeOption, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeOption : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeOption (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypePause 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypePause(responseType string, time int64) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypePause, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypePause : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypePause (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill(responseType string, query string, queryType string) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeText 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeText(responseType string, values []DialogNodeOutputTextValuesElement) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeText, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeText : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeText (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined added in v2.1.0 

func (*AssistantV1) NewDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined(responseType string, userDefined map[string]interface{}) (_model *DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined, err error)

NewDialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined : Instantiate DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined (Generic Model Constructor)

func (*AssistantV1) NewDialogNodeOutputOptionsElement 

func (*AssistantV1) NewDialogNodeOutputOptionsElement(label string, value *DialogNodeOutputOptionsElementValue) (_model *DialogNodeOutputOptionsElement, err error)

NewDialogNodeOutputOptionsElement : Instantiate DialogNodeOutputOptionsElement (Generic Model Constructor)

func (*AssistantV1) NewDialogSuggestion 

func (*AssistantV1) NewDialogSuggestion(label string, value *DialogSuggestionValue) (_model *DialogSuggestion, err error)

NewDialogSuggestion : Instantiate DialogSuggestion (Generic Model Constructor)

func (*AssistantV1) NewExample 

func (*AssistantV1) NewExample(text string) (_model *Example, err error)

NewExample : Instantiate Example (Generic Model Constructor)

func (*AssistantV1) NewGetCounterexampleOptions 

func (*AssistantV1) NewGetCounterexampleOptions(workspaceID string, text string) *GetCounterexampleOptions

NewGetCounterexampleOptions : Instantiate GetCounterexampleOptions

func (*AssistantV1) NewGetDialogNodeOptions 

func (*AssistantV1) NewGetDialogNodeOptions(workspaceID string, dialogNode string) *GetDialogNodeOptions

NewGetDialogNodeOptions : Instantiate GetDialogNodeOptions

func (*AssistantV1) NewGetEntityOptions 

func (*AssistantV1) NewGetEntityOptions(workspaceID string, entity string) *GetEntityOptions

NewGetEntityOptions : Instantiate GetEntityOptions

func (*AssistantV1) NewGetExampleOptions 

func (*AssistantV1) NewGetExampleOptions(workspaceID string, intent string, text string) *GetExampleOptions

NewGetExampleOptions : Instantiate GetExampleOptions

func (*AssistantV1) NewGetIntentOptions 

func (*AssistantV1) NewGetIntentOptions(workspaceID string, intent string) *GetIntentOptions

NewGetIntentOptions : Instantiate GetIntentOptions

func (*AssistantV1) NewGetSynonymOptions 

func (*AssistantV1) NewGetSynonymOptions(workspaceID string, entity string, value string, synonym string) *GetSynonymOptions

NewGetSynonymOptions : Instantiate GetSynonymOptions

func (*AssistantV1) NewGetValueOptions 

func (*AssistantV1) NewGetValueOptions(workspaceID string, entity string, value string) *GetValueOptions

NewGetValueOptions : Instantiate GetValueOptions

func (*AssistantV1) NewGetWorkspaceOptions 

func (*AssistantV1) NewGetWorkspaceOptions(workspaceID string) *GetWorkspaceOptions

NewGetWorkspaceOptions : Instantiate GetWorkspaceOptions

func (*AssistantV1) NewListAllLogsOptions 

func (*AssistantV1) NewListAllLogsOptions(filter string) *ListAllLogsOptions

NewListAllLogsOptions : Instantiate ListAllLogsOptions

func (*AssistantV1) NewListCounterexamplesOptions 

func (*AssistantV1) NewListCounterexamplesOptions(workspaceID string) *ListCounterexamplesOptions

NewListCounterexamplesOptions : Instantiate ListCounterexamplesOptions

func (*AssistantV1) NewListDialogNodesOptions 

func (*AssistantV1) NewListDialogNodesOptions(workspaceID string) *ListDialogNodesOptions

NewListDialogNodesOptions : Instantiate ListDialogNodesOptions

func (*AssistantV1) NewListEntitiesOptions 

func (*AssistantV1) NewListEntitiesOptions(workspaceID string) *ListEntitiesOptions

NewListEntitiesOptions : Instantiate ListEntitiesOptions

func (*AssistantV1) NewListExamplesOptions 

func (*AssistantV1) NewListExamplesOptions(workspaceID string, intent string) *ListExamplesOptions

NewListExamplesOptions : Instantiate ListExamplesOptions

func (*AssistantV1) NewListIntentsOptions 

func (*AssistantV1) NewListIntentsOptions(workspaceID string) *ListIntentsOptions

NewListIntentsOptions : Instantiate ListIntentsOptions

func (*AssistantV1) NewListLogsOptions 

func (*AssistantV1) NewListLogsOptions(workspaceID string) *ListLogsOptions

NewListLogsOptions : Instantiate ListLogsOptions

func (*AssistantV1) NewListMentionsOptions 

func (*AssistantV1) NewListMentionsOptions(workspaceID string, entity string) *ListMentionsOptions

NewListMentionsOptions : Instantiate ListMentionsOptions

func (*AssistantV1) NewListSynonymsOptions 

func (*AssistantV1) NewListSynonymsOptions(workspaceID string, entity string, value string) *ListSynonymsOptions

NewListSynonymsOptions : Instantiate ListSynonymsOptions

func (*AssistantV1) NewListValuesOptions 

func (*AssistantV1) NewListValuesOptions(workspaceID string, entity string) *ListValuesOptions

NewListValuesOptions : Instantiate ListValuesOptions

func (*AssistantV1) NewListWorkspacesOptions 

func (*AssistantV1) NewListWorkspacesOptions() *ListWorkspacesOptions

NewListWorkspacesOptions : Instantiate ListWorkspacesOptions

func (*AssistantV1) NewLogMessage 

func (*AssistantV1) NewLogMessage(level string, msg string, code string) (_model *LogMessage, err error)

NewLogMessage : Instantiate LogMessage (Generic Model Constructor)

func (*AssistantV1) NewMention 

func (*AssistantV1) NewMention(entity string, location []int64) (_model *Mention, err error)

NewMention : Instantiate Mention (Generic Model Constructor)

func (*AssistantV1) NewMessageOptions 

func (*AssistantV1) NewMessageOptions(workspaceID string) *MessageOptions

NewMessageOptions : Instantiate MessageOptions

func (*AssistantV1) NewOutputData 

func (*AssistantV1) NewOutputData(logMessages []LogMessage, text []string) (_model *OutputData, err error)

NewOutputData : Instantiate OutputData (Generic Model Constructor)

func (*AssistantV1) NewRuntimeEntity 

func (*AssistantV1) NewRuntimeEntity(entity string, value string) (_model *RuntimeEntity, err error)

NewRuntimeEntity : Instantiate RuntimeEntity (Generic Model Constructor)

func (*AssistantV1) NewRuntimeIntent 

func (*AssistantV1) NewRuntimeIntent(intent string, confidence float64) (_model *RuntimeIntent, err error)

NewRuntimeIntent : Instantiate RuntimeIntent (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeChannelTransfer added in v2.1.0 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeChannelTransfer(responseType string, messageToUser string, transferInfo *ChannelTransferInfo) (_model *RuntimeResponseGenericRuntimeResponseTypeChannelTransfer, err error)

NewRuntimeResponseGenericRuntimeResponseTypeChannelTransfer : Instantiate RuntimeResponseGenericRuntimeResponseTypeChannelTransfer (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeConnectToAgent 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeConnectToAgent(responseType string) (_model *RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, err error)

NewRuntimeResponseGenericRuntimeResponseTypeConnectToAgent : Instantiate RuntimeResponseGenericRuntimeResponseTypeConnectToAgent (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeImage 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeImage(responseType string, source string) (_model *RuntimeResponseGenericRuntimeResponseTypeImage, err error)

NewRuntimeResponseGenericRuntimeResponseTypeImage : Instantiate RuntimeResponseGenericRuntimeResponseTypeImage (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeOption 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeOption(responseType string, title string, options []DialogNodeOutputOptionsElement) (_model *RuntimeResponseGenericRuntimeResponseTypeOption, err error)

NewRuntimeResponseGenericRuntimeResponseTypeOption : Instantiate RuntimeResponseGenericRuntimeResponseTypeOption (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypePause 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypePause(responseType string, time int64) (_model *RuntimeResponseGenericRuntimeResponseTypePause, err error)

NewRuntimeResponseGenericRuntimeResponseTypePause : Instantiate RuntimeResponseGenericRuntimeResponseTypePause (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeSuggestion 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeSuggestion(responseType string, title string, suggestions []DialogSuggestion) (_model *RuntimeResponseGenericRuntimeResponseTypeSuggestion, err error)

NewRuntimeResponseGenericRuntimeResponseTypeSuggestion : Instantiate RuntimeResponseGenericRuntimeResponseTypeSuggestion (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeText 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeText(responseType string, text string) (_model *RuntimeResponseGenericRuntimeResponseTypeText, err error)

NewRuntimeResponseGenericRuntimeResponseTypeText : Instantiate RuntimeResponseGenericRuntimeResponseTypeText (Generic Model Constructor)

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeUserDefined added in v2.1.0 

func (*AssistantV1) NewRuntimeResponseGenericRuntimeResponseTypeUserDefined(responseType string, userDefined map[string]interface{}) (_model *RuntimeResponseGenericRuntimeResponseTypeUserDefined, err error)

NewRuntimeResponseGenericRuntimeResponseTypeUserDefined : Instantiate RuntimeResponseGenericRuntimeResponseTypeUserDefined (Generic Model Constructor)

func (*AssistantV1) NewSynonym 

func (*AssistantV1) NewSynonym(synonym string) (_model *Synonym, err error)

NewSynonym : Instantiate Synonym (Generic Model Constructor)

func (*AssistantV1) NewUpdateCounterexampleOptions 

func (*AssistantV1) NewUpdateCounterexampleOptions(workspaceID string, text string) *UpdateCounterexampleOptions

NewUpdateCounterexampleOptions : Instantiate UpdateCounterexampleOptions

func (*AssistantV1) NewUpdateDialogNodeOptions 

func (*AssistantV1) NewUpdateDialogNodeOptions(workspaceID string, dialogNode string) *UpdateDialogNodeOptions

NewUpdateDialogNodeOptions : Instantiate UpdateDialogNodeOptions

func (*AssistantV1) NewUpdateEntityOptions 

func (*AssistantV1) NewUpdateEntityOptions(workspaceID string, entity string) *UpdateEntityOptions

NewUpdateEntityOptions : Instantiate UpdateEntityOptions

func (*AssistantV1) NewUpdateExampleOptions 

func (*AssistantV1) NewUpdateExampleOptions(workspaceID string, intent string, text string) *UpdateExampleOptions

NewUpdateExampleOptions : Instantiate UpdateExampleOptions

func (*AssistantV1) NewUpdateIntentOptions 

func (*AssistantV1) NewUpdateIntentOptions(workspaceID string, intent string) *UpdateIntentOptions

NewUpdateIntentOptions : Instantiate UpdateIntentOptions

func (*AssistantV1) NewUpdateSynonymOptions 

func (*AssistantV1) NewUpdateSynonymOptions(workspaceID string, entity string, value string, synonym string) *UpdateSynonymOptions

NewUpdateSynonymOptions : Instantiate UpdateSynonymOptions

func (*AssistantV1) NewUpdateValueOptions 

func (*AssistantV1) NewUpdateValueOptions(workspaceID string, entity string, value string) *UpdateValueOptions

NewUpdateValueOptions : Instantiate UpdateValueOptions

func (*AssistantV1) NewUpdateWorkspaceOptions 

func (*AssistantV1) NewUpdateWorkspaceOptions(workspaceID string) *UpdateWorkspaceOptions

NewUpdateWorkspaceOptions : Instantiate UpdateWorkspaceOptions

func (*AssistantV1) NewWebhook 

func (*AssistantV1) NewWebhook(url string, name string) (_model *Webhook, err error)

NewWebhook : Instantiate Webhook (Generic Model Constructor)

func (*AssistantV1) NewWebhookHeader 

func (*AssistantV1) NewWebhookHeader(name string, value string) (_model *WebhookHeader, err error)

NewWebhookHeader : Instantiate WebhookHeader (Generic Model Constructor)

func (*AssistantV1) SetDefaultHeaders 

func (assistant *AssistantV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*AssistantV1) SetEnableGzipCompression 

func (assistant *AssistantV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*AssistantV1) SetServiceURL 

func (assistant *AssistantV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*AssistantV1) UpdateCounterexample 

func (assistant *AssistantV1) UpdateCounterexample(updateCounterexampleOptions *UpdateCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

UpdateCounterexample : Update counterexample Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input.

func (*AssistantV1) UpdateCounterexampleWithContext 

func (assistant *AssistantV1) UpdateCounterexampleWithContext(ctx context.Context, updateCounterexampleOptions *UpdateCounterexampleOptions) (result *Counterexample, response *core.DetailedResponse, err error)

UpdateCounterexampleWithContext is an alternate form of the UpdateCounterexample method which supports a Context parameter

func (*AssistantV1) UpdateDialogNode 

func (assistant *AssistantV1) UpdateDialogNode(updateDialogNodeOptions *UpdateDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

UpdateDialogNode : Update dialog node Update an existing dialog node with new or modified data.

If you want to update multiple dialog nodes with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) UpdateDialogNodeWithContext 

func (assistant *AssistantV1) UpdateDialogNodeWithContext(ctx context.Context, updateDialogNodeOptions *UpdateDialogNodeOptions) (result *DialogNode, response *core.DetailedResponse, err error)

UpdateDialogNodeWithContext is an alternate form of the UpdateDialogNode method which supports a Context parameter

func (*AssistantV1) UpdateEntity 

func (assistant *AssistantV1) UpdateEntity(updateEntityOptions *UpdateEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

UpdateEntity : Update entity Update an existing entity with new or modified data. You must provide component objects defining the content of the updated entity.

If you want to update multiple entities with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) UpdateEntityWithContext 

func (assistant *AssistantV1) UpdateEntityWithContext(ctx context.Context, updateEntityOptions *UpdateEntityOptions) (result *Entity, response *core.DetailedResponse, err error)

UpdateEntityWithContext is an alternate form of the UpdateEntity method which supports a Context parameter

func (*AssistantV1) UpdateExample 

func (assistant *AssistantV1) UpdateExample(updateExampleOptions *UpdateExampleOptions) (result *Example, response *core.DetailedResponse, err error)

UpdateExample : Update user input example Update the text of a user input example.

If you want to update multiple examples with a single API call, consider using the **[Update intent](#update-intent)** method instead.

func (*AssistantV1) UpdateExampleWithContext 

func (assistant *AssistantV1) UpdateExampleWithContext(ctx context.Context, updateExampleOptions *UpdateExampleOptions) (result *Example, response *core.DetailedResponse, err error)

UpdateExampleWithContext is an alternate form of the UpdateExample method which supports a Context parameter

func (*AssistantV1) UpdateIntent 

func (assistant *AssistantV1) UpdateIntent(updateIntentOptions *UpdateIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

UpdateIntent : Update intent Update an existing intent with new or modified data. You must provide component objects defining the content of the updated intent.

If you want to update multiple intents with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

func (*AssistantV1) UpdateIntentWithContext 

func (assistant *AssistantV1) UpdateIntentWithContext(ctx context.Context, updateIntentOptions *UpdateIntentOptions) (result *Intent, response *core.DetailedResponse, err error)

UpdateIntentWithContext is an alternate form of the UpdateIntent method which supports a Context parameter

func (*AssistantV1) UpdateSynonym 

func (assistant *AssistantV1) UpdateSynonym(updateSynonymOptions *UpdateSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

UpdateSynonym : Update entity value synonym Update an existing entity value synonym with new text.

If you want to update multiple synonyms with a single API call, consider using the **[Update entity](#update-entity)** or **[Update entity value](#update-entity-value)** method instead.

func (*AssistantV1) UpdateSynonymWithContext 

func (assistant *AssistantV1) UpdateSynonymWithContext(ctx context.Context, updateSynonymOptions *UpdateSynonymOptions) (result *Synonym, response *core.DetailedResponse, err error)

UpdateSynonymWithContext is an alternate form of the UpdateSynonym method which supports a Context parameter

func (*AssistantV1) UpdateValue 

func (assistant *AssistantV1) UpdateValue(updateValueOptions *UpdateValueOptions) (result *Value, response *core.DetailedResponse, err error)

UpdateValue : Update entity value Update an existing entity value with new or modified data. You must provide component objects defining the content of the updated entity value.

If you want to update multiple entity values with a single API call, consider using the **[Update entity](#update-entity)** method instead.

func (*AssistantV1) UpdateValueWithContext 

func (assistant *AssistantV1) UpdateValueWithContext(ctx context.Context, updateValueOptions *UpdateValueOptions) (result *Value, response *core.DetailedResponse, err error)

UpdateValueWithContext is an alternate form of the UpdateValue method which supports a Context parameter

func (*AssistantV1) UpdateWorkspace 

func (assistant *AssistantV1) UpdateWorkspace(updateWorkspaceOptions *UpdateWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

UpdateWorkspace : Update workspace Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace.

func (*AssistantV1) UpdateWorkspaceWithContext 

func (assistant *AssistantV1) UpdateWorkspaceWithContext(ctx context.Context, updateWorkspaceOptions *UpdateWorkspaceOptions) (result *Workspace, response *core.DetailedResponse, err error)

UpdateWorkspaceWithContext is an alternate form of the UpdateWorkspace method which supports a Context parameter

type AssistantV1Options 

type AssistantV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is
	// `2021-06-14`.
	Version *string `validate:"required"`
}

AssistantV1Options : Service options

type BulkClassifyOptions 

type BulkClassifyOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// An array of input utterances to classify.
	Input []BulkClassifyUtterance `json:"input,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

BulkClassifyOptions : The BulkClassify options.

func (*BulkClassifyOptions) SetHeaders 

func (options *BulkClassifyOptions) SetHeaders(param map[string]string) *BulkClassifyOptions

SetHeaders : Allow user to set Headers

func (*BulkClassifyOptions) SetInput 

func (_options *BulkClassifyOptions) SetInput(input []BulkClassifyUtterance) *BulkClassifyOptions

SetInput : Allow user to set Input

func (*BulkClassifyOptions) SetWorkspaceID 

func (_options *BulkClassifyOptions) SetWorkspaceID(workspaceID string) *BulkClassifyOptions

SetWorkspaceID : Allow user to set WorkspaceID

type BulkClassifyOutput 

type BulkClassifyOutput struct {
	// The user input utterance to classify.
	Input *BulkClassifyUtterance `json:"input,omitempty"`

	// An array of entities identified in the utterance.
	Entities []RuntimeEntity `json:"entities,omitempty"`

	// An array of intents recognized in the utterance.
	Intents []RuntimeIntent `json:"intents,omitempty"`
}

BulkClassifyOutput : BulkClassifyOutput struct

type BulkClassifyResponse 

type BulkClassifyResponse struct {
	// An array of objects that contain classification information for the submitted input utterances.
	Output []BulkClassifyOutput `json:"output,omitempty"`
}

BulkClassifyResponse : BulkClassifyResponse struct

type BulkClassifyUtterance 

type BulkClassifyUtterance struct {
	// The text of the input utterance.
	Text *string `json:"text" validate:"required"`
}

BulkClassifyUtterance : The user input utterance to classify.

type CaptureGroup 

type CaptureGroup struct {
	// A recognized capture group for the entity.
	Group *string `json:"group" validate:"required"`

	// Zero-based character offsets that indicate where the entity value begins and ends in the input text.
	Location []int64 `json:"location,omitempty"`
}

CaptureGroup : A recognized capture group for a pattern-based entity.

type ChannelTransferInfo added in v2.1.0 

type ChannelTransferInfo struct {
	// An object specifying target channels available for the transfer. Each property of this object represents an
	// available transfer target. Currently, the only supported property is **chat**, representing the web chat
	// integration.
	Target *ChannelTransferTarget `json:"target" validate:"required"`
}

ChannelTransferInfo : Information used by an integration to transfer the conversation to a different channel.

type ChannelTransferTarget added in v2.1.0 

type ChannelTransferTarget struct {
	// Information for transferring to the web chat integration.
	Chat *ChannelTransferTargetChat `json:"chat,omitempty"`
}

ChannelTransferTarget : An object specifying target channels available for the transfer. Each property of this object represents an available transfer target. Currently, the only supported property is **chat**, representing the web chat integration.

type ChannelTransferTargetChat added in v2.1.0 

type ChannelTransferTargetChat struct {
	// The URL of the target web chat.
	URL *string `json:"url,omitempty"`
}

ChannelTransferTargetChat : Information for transferring to the web chat integration.

type Context 

type Context struct {
	// The unique identifier of the conversation.
	ConversationID *string `json:"conversation_id,omitempty"`

	// For internal use only.
	System map[string]interface{} `json:"system,omitempty"`

	// Metadata related to the message.
	Metadata *MessageContextMetadata `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Context : State information for the conversation. To maintain state, include the context from the previous response.

func (*Context) GetProperties 

func (o *Context) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Context

func (*Context) GetProperty 

func (o *Context) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of Context

func (*Context) MarshalJSON 

func (o *Context) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of Context

func (*Context) SetProperties added in v2.2.0 

func (o *Context) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of Context

func (*Context) SetProperty 

func (o *Context) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of Context

type Counterexample 

type Counterexample struct {
	// The text of a user input marked as irrelevant input. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Text *string `json:"text" validate:"required"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

Counterexample : Counterexample struct

type CounterexampleCollection 

type CounterexampleCollection struct {
	// An array of objects describing the examples marked as irrelevant input.
	Counterexamples []Counterexample `json:"counterexamples" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

CounterexampleCollection : CounterexampleCollection struct

type CreateCounterexampleOptions 

type CreateCounterexampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The text of a user input marked as irrelevant input. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Text *string `json:"text" validate:"required"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateCounterexampleOptions : The CreateCounterexample options.

func (*CreateCounterexampleOptions) SetHeaders 

func (options *CreateCounterexampleOptions) SetHeaders(param map[string]string) *CreateCounterexampleOptions

SetHeaders : Allow user to set Headers

func (*CreateCounterexampleOptions) SetIncludeAudit 

func (_options *CreateCounterexampleOptions) SetIncludeAudit(includeAudit bool) *CreateCounterexampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateCounterexampleOptions) SetText 

func (_options *CreateCounterexampleOptions) SetText(text string) *CreateCounterexampleOptions

SetText : Allow user to set Text

func (*CreateCounterexampleOptions) SetWorkspaceID 

func (_options *CreateCounterexampleOptions) SetWorkspaceID(workspaceID string) *CreateCounterexampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateDialogNodeOptions 

type CreateDialogNodeOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog
	// nodes and in the diagnostic information included with message responses.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	DialogNode *string `json:"dialog_node" validate:"required"`

	// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab
	// characters.
	Conditions *string `json:"conditions,omitempty"`

	// The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.
	Parent *string `json:"parent,omitempty"`

	// The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous
	// sibling.
	PreviousSibling *string `json:"previous_sibling,omitempty"`

	// The output of the dialog node. For more information about how to specify dialog node output, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
	Output *DialogNodeOutput `json:"output,omitempty"`

	// The context for the dialog node.
	Context *DialogNodeContext `json:"context,omitempty"`

	// The metadata for the dialog node.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The next step to execute following this dialog node.
	NextStep *DialogNodeNextStep `json:"next_step,omitempty"`

	// A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate
	// the **label** property of the corresponding suggestion in the `suggestion` response type (unless it is overridden by
	// the **user_label** property). The title is also used to populate the **topic** property in the `connect_to_agent`
	// response type.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	Title *string `json:"title,omitempty"`

	// How the dialog node is processed.
	Type *string `json:"type,omitempty"`

	// How an `event_handler` node is processed.
	EventName *string `json:"event_name,omitempty"`

	// The location in the dialog context where output is stored.
	Variable *string `json:"variable,omitempty"`

	// An array of objects describing any actions to be invoked by the dialog node.
	Actions []DialogNodeAction `json:"actions,omitempty"`

	// Whether this top-level dialog node can be digressed into.
	DigressIn *string `json:"digress_in,omitempty"`

	// Whether this dialog node can be returned to after a digression.
	DigressOut *string `json:"digress_out,omitempty"`

	// Whether the user can digress to top-level nodes while filling out slots.
	DigressOutSlots *string `json:"digress_out_slots,omitempty"`

	// A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to
	// identify the node in disambiguation responses (overriding the value of the **title** property).
	UserLabel *string `json:"user_label,omitempty"`

	// Whether the dialog node should be excluded from disambiguation suggestions. Valid only when **type**=`standard` or
	// `frame`.
	DisambiguationOptOut *bool `json:"disambiguation_opt_out,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateDialogNodeOptions : The CreateDialogNode options.

func (*CreateDialogNodeOptions) SetActions 

func (_options *CreateDialogNodeOptions) SetActions(actions []DialogNodeAction) *CreateDialogNodeOptions

SetActions : Allow user to set Actions

func (*CreateDialogNodeOptions) SetConditions 

func (_options *CreateDialogNodeOptions) SetConditions(conditions string) *CreateDialogNodeOptions

SetConditions : Allow user to set Conditions

func (*CreateDialogNodeOptions) SetContext 

func (_options *CreateDialogNodeOptions) SetContext(context *DialogNodeContext) *CreateDialogNodeOptions

SetContext : Allow user to set Context

func (*CreateDialogNodeOptions) SetDescription 

func (_options *CreateDialogNodeOptions) SetDescription(description string) *CreateDialogNodeOptions

SetDescription : Allow user to set Description

func (*CreateDialogNodeOptions) SetDialogNode 

func (_options *CreateDialogNodeOptions) SetDialogNode(dialogNode string) *CreateDialogNodeOptions

SetDialogNode : Allow user to set DialogNode

func (*CreateDialogNodeOptions) SetDigressIn 

func (_options *CreateDialogNodeOptions) SetDigressIn(digressIn string) *CreateDialogNodeOptions

SetDigressIn : Allow user to set DigressIn

func (*CreateDialogNodeOptions) SetDigressOut 

func (_options *CreateDialogNodeOptions) SetDigressOut(digressOut string) *CreateDialogNodeOptions

SetDigressOut : Allow user to set DigressOut

func (*CreateDialogNodeOptions) SetDigressOutSlots 

func (_options *CreateDialogNodeOptions) SetDigressOutSlots(digressOutSlots string) *CreateDialogNodeOptions

SetDigressOutSlots : Allow user to set DigressOutSlots

func (*CreateDialogNodeOptions) SetDisambiguationOptOut 

func (_options *CreateDialogNodeOptions) SetDisambiguationOptOut(disambiguationOptOut bool) *CreateDialogNodeOptions

SetDisambiguationOptOut : Allow user to set DisambiguationOptOut

func (*CreateDialogNodeOptions) SetEventName 

func (_options *CreateDialogNodeOptions) SetEventName(eventName string) *CreateDialogNodeOptions

SetEventName : Allow user to set EventName

func (*CreateDialogNodeOptions) SetHeaders 

func (options *CreateDialogNodeOptions) SetHeaders(param map[string]string) *CreateDialogNodeOptions

SetHeaders : Allow user to set Headers

func (*CreateDialogNodeOptions) SetIncludeAudit 

func (_options *CreateDialogNodeOptions) SetIncludeAudit(includeAudit bool) *CreateDialogNodeOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateDialogNodeOptions) SetMetadata 

func (_options *CreateDialogNodeOptions) SetMetadata(metadata map[string]interface{}) *CreateDialogNodeOptions

SetMetadata : Allow user to set Metadata

func (*CreateDialogNodeOptions) SetNextStep 

func (_options *CreateDialogNodeOptions) SetNextStep(nextStep *DialogNodeNextStep) *CreateDialogNodeOptions

SetNextStep : Allow user to set NextStep

func (*CreateDialogNodeOptions) SetOutput 

func (_options *CreateDialogNodeOptions) SetOutput(output *DialogNodeOutput) *CreateDialogNodeOptions

SetOutput : Allow user to set Output

func (*CreateDialogNodeOptions) SetParent 

func (_options *CreateDialogNodeOptions) SetParent(parent string) *CreateDialogNodeOptions

SetParent : Allow user to set Parent

func (*CreateDialogNodeOptions) SetPreviousSibling 

func (_options *CreateDialogNodeOptions) SetPreviousSibling(previousSibling string) *CreateDialogNodeOptions

SetPreviousSibling : Allow user to set PreviousSibling

func (*CreateDialogNodeOptions) SetTitle 

func (_options *CreateDialogNodeOptions) SetTitle(title string) *CreateDialogNodeOptions

SetTitle : Allow user to set Title

func (*CreateDialogNodeOptions) SetType 

func (_options *CreateDialogNodeOptions) SetType(typeVar string) *CreateDialogNodeOptions

SetType : Allow user to set Type

func (*CreateDialogNodeOptions) SetUserLabel 

func (_options *CreateDialogNodeOptions) SetUserLabel(userLabel string) *CreateDialogNodeOptions

SetUserLabel : Allow user to set UserLabel

func (*CreateDialogNodeOptions) SetVariable 

func (_options *CreateDialogNodeOptions) SetVariable(variable string) *CreateDialogNodeOptions

SetVariable : Allow user to set Variable

func (*CreateDialogNodeOptions) SetWorkspaceID 

func (_options *CreateDialogNodeOptions) SetWorkspaceID(workspaceID string) *CreateDialogNodeOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateEntity 

type CreateEntity struct {
	// The name of the entity. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, and hyphen characters.
	// - If you specify an entity name beginning with the reserved prefix `sys-`, it must be the name of a system entity
	// that you want to enable. (Any entity content specified with the request is ignored.).
	Entity *string `json:"entity" validate:"required"`

	// The description of the entity. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// Any metadata related to the entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether to use fuzzy matching for the entity.
	FuzzyMatch *bool `json:"fuzzy_match,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// An array of objects describing the entity values.
	Values []CreateValue `json:"values,omitempty"`
}

CreateEntity : CreateEntity struct

type CreateEntityOptions 

type CreateEntityOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, and hyphen characters.
	// - If you specify an entity name beginning with the reserved prefix `sys-`, it must be the name of a system entity
	// that you want to enable. (Any entity content specified with the request is ignored.).
	Entity *string `json:"entity" validate:"required"`

	// The description of the entity. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// Any metadata related to the entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether to use fuzzy matching for the entity.
	FuzzyMatch *bool `json:"fuzzy_match,omitempty"`

	// An array of objects describing the entity values.
	Values []CreateValue `json:"values,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateEntityOptions : The CreateEntity options.

func (*CreateEntityOptions) SetDescription 

func (_options *CreateEntityOptions) SetDescription(description string) *CreateEntityOptions

SetDescription : Allow user to set Description

func (*CreateEntityOptions) SetEntity 

func (_options *CreateEntityOptions) SetEntity(entity string) *CreateEntityOptions

SetEntity : Allow user to set Entity

func (*CreateEntityOptions) SetFuzzyMatch 

func (_options *CreateEntityOptions) SetFuzzyMatch(fuzzyMatch bool) *CreateEntityOptions

SetFuzzyMatch : Allow user to set FuzzyMatch

func (*CreateEntityOptions) SetHeaders 

func (options *CreateEntityOptions) SetHeaders(param map[string]string) *CreateEntityOptions

SetHeaders : Allow user to set Headers

func (*CreateEntityOptions) SetIncludeAudit 

func (_options *CreateEntityOptions) SetIncludeAudit(includeAudit bool) *CreateEntityOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateEntityOptions) SetMetadata 

func (_options *CreateEntityOptions) SetMetadata(metadata map[string]interface{}) *CreateEntityOptions

SetMetadata : Allow user to set Metadata

func (*CreateEntityOptions) SetValues 

func (_options *CreateEntityOptions) SetValues(values []CreateValue) *CreateEntityOptions

SetValues : Allow user to set Values

func (*CreateEntityOptions) SetWorkspaceID 

func (_options *CreateEntityOptions) SetWorkspaceID(workspaceID string) *CreateEntityOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateExampleOptions 

type CreateExampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The text of a user input example. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Text *string `json:"text" validate:"required"`

	// An array of contextual entity mentions.
	Mentions []Mention `json:"mentions,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateExampleOptions : The CreateExample options.

func (*CreateExampleOptions) SetHeaders 

func (options *CreateExampleOptions) SetHeaders(param map[string]string) *CreateExampleOptions

SetHeaders : Allow user to set Headers

func (*CreateExampleOptions) SetIncludeAudit 

func (_options *CreateExampleOptions) SetIncludeAudit(includeAudit bool) *CreateExampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateExampleOptions) SetIntent 

func (_options *CreateExampleOptions) SetIntent(intent string) *CreateExampleOptions

SetIntent : Allow user to set Intent

func (*CreateExampleOptions) SetMentions 

func (_options *CreateExampleOptions) SetMentions(mentions []Mention) *CreateExampleOptions

SetMentions : Allow user to set Mentions

func (*CreateExampleOptions) SetText 

func (_options *CreateExampleOptions) SetText(text string) *CreateExampleOptions

SetText : Allow user to set Text

func (*CreateExampleOptions) SetWorkspaceID 

func (_options *CreateExampleOptions) SetWorkspaceID(workspaceID string) *CreateExampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateIntent 

type CreateIntent struct {
	// The name of the intent. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
	// - It cannot begin with the reserved prefix `sys-`.
	Intent *string `json:"intent" validate:"required"`

	// The description of the intent. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// An array of user input examples for the intent.
	Examples []Example `json:"examples,omitempty"`
}

CreateIntent : CreateIntent struct

type CreateIntentOptions 

type CreateIntentOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the intent. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
	// - It cannot begin with the reserved prefix `sys-`.
	Intent *string `json:"intent" validate:"required"`

	// The description of the intent. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// An array of user input examples for the intent.
	Examples []Example `json:"examples,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateIntentOptions : The CreateIntent options.

func (*CreateIntentOptions) SetDescription 

func (_options *CreateIntentOptions) SetDescription(description string) *CreateIntentOptions

SetDescription : Allow user to set Description

func (*CreateIntentOptions) SetExamples 

func (_options *CreateIntentOptions) SetExamples(examples []Example) *CreateIntentOptions

SetExamples : Allow user to set Examples

func (*CreateIntentOptions) SetHeaders 

func (options *CreateIntentOptions) SetHeaders(param map[string]string) *CreateIntentOptions

SetHeaders : Allow user to set Headers

func (*CreateIntentOptions) SetIncludeAudit 

func (_options *CreateIntentOptions) SetIncludeAudit(includeAudit bool) *CreateIntentOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateIntentOptions) SetIntent 

func (_options *CreateIntentOptions) SetIntent(intent string) *CreateIntentOptions

SetIntent : Allow user to set Intent

func (*CreateIntentOptions) SetWorkspaceID 

func (_options *CreateIntentOptions) SetWorkspaceID(workspaceID string) *CreateIntentOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateSynonymOptions 

type CreateSynonymOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The text of the synonym. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Synonym *string `json:"synonym" validate:"required"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSynonymOptions : The CreateSynonym options.

func (*CreateSynonymOptions) SetEntity 

func (_options *CreateSynonymOptions) SetEntity(entity string) *CreateSynonymOptions

SetEntity : Allow user to set Entity

func (*CreateSynonymOptions) SetHeaders 

func (options *CreateSynonymOptions) SetHeaders(param map[string]string) *CreateSynonymOptions

SetHeaders : Allow user to set Headers

func (*CreateSynonymOptions) SetIncludeAudit 

func (_options *CreateSynonymOptions) SetIncludeAudit(includeAudit bool) *CreateSynonymOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateSynonymOptions) SetSynonym 

func (_options *CreateSynonymOptions) SetSynonym(synonym string) *CreateSynonymOptions

SetSynonym : Allow user to set Synonym

func (*CreateSynonymOptions) SetValue 

func (_options *CreateSynonymOptions) SetValue(value string) *CreateSynonymOptions

SetValue : Allow user to set Value

func (*CreateSynonymOptions) SetWorkspaceID 

func (_options *CreateSynonymOptions) SetWorkspaceID(workspaceID string) *CreateSynonymOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateValue 

type CreateValue struct {
	// The text of the entity value. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Value *string `json:"value" validate:"required"`

	// Any metadata related to the entity value.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Specifies the type of entity value.
	Type *string `json:"type,omitempty"`

	// An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A synonym must conform to the following resrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Synonyms []string `json:"synonyms,omitempty"`

	// An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).
	Patterns []string `json:"patterns,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

CreateValue : CreateValue struct

type CreateValueOptions 

type CreateValueOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Value *string `json:"value" validate:"required"`

	// Any metadata related to the entity value.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Specifies the type of entity value.
	Type *string `json:"type,omitempty"`

	// An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A synonym must conform to the following resrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Synonyms []string `json:"synonyms,omitempty"`

	// An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).
	Patterns []string `json:"patterns,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateValueOptions : The CreateValue options.

func (*CreateValueOptions) SetEntity 

func (_options *CreateValueOptions) SetEntity(entity string) *CreateValueOptions

SetEntity : Allow user to set Entity

func (*CreateValueOptions) SetHeaders 

func (options *CreateValueOptions) SetHeaders(param map[string]string) *CreateValueOptions

SetHeaders : Allow user to set Headers

func (*CreateValueOptions) SetIncludeAudit 

func (_options *CreateValueOptions) SetIncludeAudit(includeAudit bool) *CreateValueOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateValueOptions) SetMetadata 

func (_options *CreateValueOptions) SetMetadata(metadata map[string]interface{}) *CreateValueOptions

SetMetadata : Allow user to set Metadata

func (*CreateValueOptions) SetPatterns 

func (_options *CreateValueOptions) SetPatterns(patterns []string) *CreateValueOptions

SetPatterns : Allow user to set Patterns

func (*CreateValueOptions) SetSynonyms 

func (_options *CreateValueOptions) SetSynonyms(synonyms []string) *CreateValueOptions

SetSynonyms : Allow user to set Synonyms

func (*CreateValueOptions) SetType 

func (_options *CreateValueOptions) SetType(typeVar string) *CreateValueOptions

SetType : Allow user to set Type

func (*CreateValueOptions) SetValue 

func (_options *CreateValueOptions) SetValue(value string) *CreateValueOptions

SetValue : Allow user to set Value

func (*CreateValueOptions) SetWorkspaceID 

func (_options *CreateValueOptions) SetWorkspaceID(workspaceID string) *CreateValueOptions

SetWorkspaceID : Allow user to set WorkspaceID

type CreateWorkspaceOptions 

type CreateWorkspaceOptions struct {
	// The name of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Name *string `json:"name,omitempty"`

	// The description of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The language of the workspace.
	Language *string `json:"language,omitempty"`

	// An array of objects describing the dialog nodes in the workspace.
	DialogNodes []DialogNode `json:"dialog_nodes,omitempty"`

	// An array of objects defining input examples that have been marked as irrelevant input.
	Counterexamples []Counterexample `json:"counterexamples,omitempty"`

	// Any metadata related to the workspace.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for
	// general service improvements. `true` indicates that workspace training data is not to be used.
	LearningOptOut *bool `json:"learning_opt_out,omitempty"`

	// Global settings for the workspace.
	SystemSettings *WorkspaceSystemSettings `json:"system_settings,omitempty"`

	Webhooks []Webhook `json:"webhooks,omitempty"`

	// An array of objects defining the intents for the workspace.
	Intents []CreateIntent `json:"intents,omitempty"`

	// An array of objects describing the entities for the workspace.
	Entities []CreateEntity `json:"entities,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateWorkspaceOptions : The CreateWorkspace options.

func (*CreateWorkspaceOptions) SetCounterexamples 

func (_options *CreateWorkspaceOptions) SetCounterexamples(counterexamples []Counterexample) *CreateWorkspaceOptions

SetCounterexamples : Allow user to set Counterexamples

func (*CreateWorkspaceOptions) SetDescription 

func (_options *CreateWorkspaceOptions) SetDescription(description string) *CreateWorkspaceOptions

SetDescription : Allow user to set Description

func (*CreateWorkspaceOptions) SetDialogNodes 

func (_options *CreateWorkspaceOptions) SetDialogNodes(dialogNodes []DialogNode) *CreateWorkspaceOptions

SetDialogNodes : Allow user to set DialogNodes

func (*CreateWorkspaceOptions) SetEntities 

func (_options *CreateWorkspaceOptions) SetEntities(entities []CreateEntity) *CreateWorkspaceOptions

SetEntities : Allow user to set Entities

func (*CreateWorkspaceOptions) SetHeaders 

func (options *CreateWorkspaceOptions) SetHeaders(param map[string]string) *CreateWorkspaceOptions

SetHeaders : Allow user to set Headers

func (*CreateWorkspaceOptions) SetIncludeAudit 

func (_options *CreateWorkspaceOptions) SetIncludeAudit(includeAudit bool) *CreateWorkspaceOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*CreateWorkspaceOptions) SetIntents 

func (_options *CreateWorkspaceOptions) SetIntents(intents []CreateIntent) *CreateWorkspaceOptions

SetIntents : Allow user to set Intents

func (*CreateWorkspaceOptions) SetLanguage 

func (_options *CreateWorkspaceOptions) SetLanguage(language string) *CreateWorkspaceOptions

SetLanguage : Allow user to set Language

func (*CreateWorkspaceOptions) SetLearningOptOut 

func (_options *CreateWorkspaceOptions) SetLearningOptOut(learningOptOut bool) *CreateWorkspaceOptions

SetLearningOptOut : Allow user to set LearningOptOut

func (*CreateWorkspaceOptions) SetMetadata 

func (_options *CreateWorkspaceOptions) SetMetadata(metadata map[string]interface{}) *CreateWorkspaceOptions

SetMetadata : Allow user to set Metadata

func (*CreateWorkspaceOptions) SetName 

func (_options *CreateWorkspaceOptions) SetName(name string) *CreateWorkspaceOptions

SetName : Allow user to set Name

func (*CreateWorkspaceOptions) SetSystemSettings 

func (_options *CreateWorkspaceOptions) SetSystemSettings(systemSettings *WorkspaceSystemSettings) *CreateWorkspaceOptions

SetSystemSettings : Allow user to set SystemSettings

func (*CreateWorkspaceOptions) SetWebhooks 

func (_options *CreateWorkspaceOptions) SetWebhooks(webhooks []Webhook) *CreateWorkspaceOptions

SetWebhooks : Allow user to set Webhooks

type DeleteCounterexampleOptions 

type DeleteCounterexampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The text of a user input counterexample (for example, `What are you wearing?`).
	Text *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteCounterexampleOptions : The DeleteCounterexample options.

func (*DeleteCounterexampleOptions) SetHeaders 

func (options *DeleteCounterexampleOptions) SetHeaders(param map[string]string) *DeleteCounterexampleOptions

SetHeaders : Allow user to set Headers

func (*DeleteCounterexampleOptions) SetText 

func (_options *DeleteCounterexampleOptions) SetText(text string) *DeleteCounterexampleOptions

SetText : Allow user to set Text

func (*DeleteCounterexampleOptions) SetWorkspaceID 

func (_options *DeleteCounterexampleOptions) SetWorkspaceID(workspaceID string) *DeleteCounterexampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteDialogNodeOptions 

type DeleteDialogNodeOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The dialog node ID (for example, `node_1_1479323581900`).
	DialogNode *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDialogNodeOptions : The DeleteDialogNode options.

func (*DeleteDialogNodeOptions) SetDialogNode 

func (_options *DeleteDialogNodeOptions) SetDialogNode(dialogNode string) *DeleteDialogNodeOptions

SetDialogNode : Allow user to set DialogNode

func (*DeleteDialogNodeOptions) SetHeaders 

func (options *DeleteDialogNodeOptions) SetHeaders(param map[string]string) *DeleteDialogNodeOptions

SetHeaders : Allow user to set Headers

func (*DeleteDialogNodeOptions) SetWorkspaceID 

func (_options *DeleteDialogNodeOptions) SetWorkspaceID(workspaceID string) *DeleteDialogNodeOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteEntityOptions 

type DeleteEntityOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteEntityOptions : The DeleteEntity options.

func (*DeleteEntityOptions) SetEntity 

func (_options *DeleteEntityOptions) SetEntity(entity string) *DeleteEntityOptions

SetEntity : Allow user to set Entity

func (*DeleteEntityOptions) SetHeaders 

func (options *DeleteEntityOptions) SetHeaders(param map[string]string) *DeleteEntityOptions

SetHeaders : Allow user to set Headers

func (*DeleteEntityOptions) SetWorkspaceID 

func (_options *DeleteEntityOptions) SetWorkspaceID(workspaceID string) *DeleteEntityOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteExampleOptions 

type DeleteExampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The text of the user input example.
	Text *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteExampleOptions : The DeleteExample options.

func (*DeleteExampleOptions) SetHeaders 

func (options *DeleteExampleOptions) SetHeaders(param map[string]string) *DeleteExampleOptions

SetHeaders : Allow user to set Headers

func (*DeleteExampleOptions) SetIntent 

func (_options *DeleteExampleOptions) SetIntent(intent string) *DeleteExampleOptions

SetIntent : Allow user to set Intent

func (*DeleteExampleOptions) SetText 

func (_options *DeleteExampleOptions) SetText(text string) *DeleteExampleOptions

SetText : Allow user to set Text

func (*DeleteExampleOptions) SetWorkspaceID 

func (_options *DeleteExampleOptions) SetWorkspaceID(workspaceID string) *DeleteExampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteIntentOptions 

type DeleteIntentOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteIntentOptions : The DeleteIntent options.

func (*DeleteIntentOptions) SetHeaders 

func (options *DeleteIntentOptions) SetHeaders(param map[string]string) *DeleteIntentOptions

SetHeaders : Allow user to set Headers

func (*DeleteIntentOptions) SetIntent 

func (_options *DeleteIntentOptions) SetIntent(intent string) *DeleteIntentOptions

SetIntent : Allow user to set Intent

func (*DeleteIntentOptions) SetWorkspaceID 

func (_options *DeleteIntentOptions) SetWorkspaceID(workspaceID string) *DeleteIntentOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteSynonymOptions 

type DeleteSynonymOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The text of the synonym.
	Synonym *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSynonymOptions : The DeleteSynonym options.

func (*DeleteSynonymOptions) SetEntity 

func (_options *DeleteSynonymOptions) SetEntity(entity string) *DeleteSynonymOptions

SetEntity : Allow user to set Entity

func (*DeleteSynonymOptions) SetHeaders 

func (options *DeleteSynonymOptions) SetHeaders(param map[string]string) *DeleteSynonymOptions

SetHeaders : Allow user to set Headers

func (*DeleteSynonymOptions) SetSynonym 

func (_options *DeleteSynonymOptions) SetSynonym(synonym string) *DeleteSynonymOptions

SetSynonym : Allow user to set Synonym

func (*DeleteSynonymOptions) SetValue 

func (_options *DeleteSynonymOptions) SetValue(value string) *DeleteSynonymOptions

SetValue : Allow user to set Value

func (*DeleteSynonymOptions) SetWorkspaceID 

func (_options *DeleteSynonymOptions) SetWorkspaceID(workspaceID string) *DeleteSynonymOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteUserDataOptions 

type DeleteUserDataOptions struct {
	// The customer ID for which all data is to be deleted.
	CustomerID *string `json:"-" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteUserDataOptions : The DeleteUserData options.

func (*DeleteUserDataOptions) SetCustomerID 

func (_options *DeleteUserDataOptions) SetCustomerID(customerID string) *DeleteUserDataOptions

SetCustomerID : Allow user to set CustomerID

func (*DeleteUserDataOptions) SetHeaders 

func (options *DeleteUserDataOptions) SetHeaders(param map[string]string) *DeleteUserDataOptions

SetHeaders : Allow user to set Headers

type DeleteValueOptions 

type DeleteValueOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteValueOptions : The DeleteValue options.

func (*DeleteValueOptions) SetEntity 

func (_options *DeleteValueOptions) SetEntity(entity string) *DeleteValueOptions

SetEntity : Allow user to set Entity

func (*DeleteValueOptions) SetHeaders 

func (options *DeleteValueOptions) SetHeaders(param map[string]string) *DeleteValueOptions

SetHeaders : Allow user to set Headers

func (*DeleteValueOptions) SetValue 

func (_options *DeleteValueOptions) SetValue(value string) *DeleteValueOptions

SetValue : Allow user to set Value

func (*DeleteValueOptions) SetWorkspaceID 

func (_options *DeleteValueOptions) SetWorkspaceID(workspaceID string) *DeleteValueOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DeleteWorkspaceOptions 

type DeleteWorkspaceOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteWorkspaceOptions : The DeleteWorkspace options.

func (*DeleteWorkspaceOptions) SetHeaders 

func (options *DeleteWorkspaceOptions) SetHeaders(param map[string]string) *DeleteWorkspaceOptions

SetHeaders : Allow user to set Headers

func (*DeleteWorkspaceOptions) SetWorkspaceID 

func (_options *DeleteWorkspaceOptions) SetWorkspaceID(workspaceID string) *DeleteWorkspaceOptions

SetWorkspaceID : Allow user to set WorkspaceID

type DialogNode 

type DialogNode struct {
	// The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog
	// nodes and in the diagnostic information included with message responses.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	DialogNode *string `json:"dialog_node" validate:"required"`

	// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab
	// characters.
	Conditions *string `json:"conditions,omitempty"`

	// The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.
	Parent *string `json:"parent,omitempty"`

	// The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous
	// sibling.
	PreviousSibling *string `json:"previous_sibling,omitempty"`

	// The output of the dialog node. For more information about how to specify dialog node output, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
	Output *DialogNodeOutput `json:"output,omitempty"`

	// The context for the dialog node.
	Context *DialogNodeContext `json:"context,omitempty"`

	// The metadata for the dialog node.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The next step to execute following this dialog node.
	NextStep *DialogNodeNextStep `json:"next_step,omitempty"`

	// A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate
	// the **label** property of the corresponding suggestion in the `suggestion` response type (unless it is overridden by
	// the **user_label** property). The title is also used to populate the **topic** property in the `connect_to_agent`
	// response type.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	Title *string `json:"title,omitempty"`

	// How the dialog node is processed.
	Type *string `json:"type,omitempty"`

	// How an `event_handler` node is processed.
	EventName *string `json:"event_name,omitempty"`

	// The location in the dialog context where output is stored.
	Variable *string `json:"variable,omitempty"`

	// An array of objects describing any actions to be invoked by the dialog node.
	Actions []DialogNodeAction `json:"actions,omitempty"`

	// Whether this top-level dialog node can be digressed into.
	DigressIn *string `json:"digress_in,omitempty"`

	// Whether this dialog node can be returned to after a digression.
	DigressOut *string `json:"digress_out,omitempty"`

	// Whether the user can digress to top-level nodes while filling out slots.
	DigressOutSlots *string `json:"digress_out_slots,omitempty"`

	// A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to
	// identify the node in disambiguation responses (overriding the value of the **title** property).
	UserLabel *string `json:"user_label,omitempty"`

	// Whether the dialog node should be excluded from disambiguation suggestions. Valid only when **type**=`standard` or
	// `frame`.
	DisambiguationOptOut *bool `json:"disambiguation_opt_out,omitempty"`

	// For internal use only.
	Disabled *bool `json:"disabled,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

DialogNode : DialogNode struct

type DialogNodeAction 

type DialogNodeAction struct {
	// The name of the action.
	Name *string `json:"name" validate:"required"`

	// The type of action to invoke.
	Type *string `json:"type,omitempty"`

	// A map of key/value pairs to be provided to the action.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// The location in the dialog context where the result of the action is stored.
	ResultVariable *string `json:"result_variable" validate:"required"`

	// The name of the context variable that the client application will use to pass in credentials for the action.
	Credentials *string `json:"credentials,omitempty"`
}

DialogNodeAction : DialogNodeAction struct

type DialogNodeCollection 

type DialogNodeCollection struct {
	// An array of objects describing the dialog nodes defined for the workspace.
	DialogNodes []DialogNode `json:"dialog_nodes" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

DialogNodeCollection : An array of dialog nodes.

type DialogNodeContext 

type DialogNodeContext struct {
	// Context data intended for specific integrations.
	Integrations map[string]map[string]interface{} `json:"integrations,omitempty"`
	// contains filtered or unexported fields
}

DialogNodeContext : The context for the dialog node.

func (*DialogNodeContext) GetProperties 

func (o *DialogNodeContext) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of DialogNodeContext

func (*DialogNodeContext) GetProperty 

func (o *DialogNodeContext) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of DialogNodeContext

func (*DialogNodeContext) MarshalJSON 

func (o *DialogNodeContext) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of DialogNodeContext

func (*DialogNodeContext) SetProperties added in v2.2.0 

func (o *DialogNodeContext) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of DialogNodeContext

func (*DialogNodeContext) SetProperty 

func (o *DialogNodeContext) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of DialogNodeContext

type DialogNodeNextStep 

type DialogNodeNextStep struct {
	// What happens after the dialog node completes. The valid values depend on the node type:
	// - The following values are valid for any node:
	//   - `get_user_input`
	//   - `skip_user_input`
	//   - `jump_to`
	// - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are
	// also valid:
	//   - if **event_name**=`filled` and the type of the parent node is `slot`:
	//     - `reprompt`
	//     - `skip_all_slots`
	// - if **event_name**=`nomatch` and the type of the parent node is `slot`:
	//     - `reprompt`
	//     - `skip_slot`
	//     - `skip_all_slots`
	// - if **event_name**=`generic` and the type of the parent node is `frame`:
	//     - `reprompt`
	//     - `skip_slot`
	//     - `skip_all_slots`
	//      If you specify `jump_to`, then you must also specify a value for the `dialog_node` property.
	Behavior *string `json:"behavior" validate:"required"`

	// The unique ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`.
	DialogNode *string `json:"dialog_node,omitempty"`

	// Which part of the dialog node to process next.
	Selector *string `json:"selector,omitempty"`
}

DialogNodeNextStep : The next step to execute following this dialog node.

type DialogNodeOutput 

type DialogNodeOutput struct {
	// An array of objects describing the output defined for the dialog node.
	Generic []DialogNodeOutputGenericIntf `json:"generic,omitempty"`

	// Output intended for specific integrations. For more information, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-responses-json).
	Integrations map[string]map[string]interface{} `json:"integrations,omitempty"`

	// Options that modify how specified output is handled.
	Modifiers *DialogNodeOutputModifiers `json:"modifiers,omitempty"`
	// contains filtered or unexported fields
}

DialogNodeOutput : The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).

func (*DialogNodeOutput) GetProperties 

func (o *DialogNodeOutput) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of DialogNodeOutput

func (*DialogNodeOutput) GetProperty 

func (o *DialogNodeOutput) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of DialogNodeOutput

func (*DialogNodeOutput) MarshalJSON 

func (o *DialogNodeOutput) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of DialogNodeOutput

func (*DialogNodeOutput) SetProperties added in v2.2.0 

func (o *DialogNodeOutput) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of DialogNodeOutput

func (*DialogNodeOutput) SetProperty 

func (o *DialogNodeOutput) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of DialogNodeOutput

type DialogNodeOutputConnectToAgentTransferInfo 

type DialogNodeOutputConnectToAgentTransferInfo struct {
	Target map[string]map[string]interface{} `json:"target,omitempty"`
}

DialogNodeOutputConnectToAgentTransferInfo : Routing or other contextual information to be used by target service desk systems.

type DialogNodeOutputGeneric 

type DialogNodeOutputGeneric struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type,omitempty"`

	// A list of one or more objects defining text responses.
	Values []DialogNodeOutputTextValuesElement `json:"values,omitempty"`

	// How a response is selected from the list, if more than one response is specified.
	SelectionPolicy *string `json:"selection_policy,omitempty"`

	// The delimiter to use as a separator between responses when `selection_policy`=`multiline`.
	Delimiter *string `json:"delimiter,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`

	// How long to pause, in milliseconds. The valid values are from 0 to 10000.
	Time *int64 `json:"time,omitempty"`

	// Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this event.
	Typing *bool `json:"typing,omitempty"`

	// The `https:` URL of the image.
	Source *string `json:"source,omitempty"`

	// An optional title to show before the response.
	Title *string `json:"title,omitempty"`

	// An optional description to show with the response.
	Description *string `json:"description,omitempty"`

	// Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
	AltText *string `json:"alt_text,omitempty"`

	// The preferred type of control to display, if supported by the channel.
	Preference *string `json:"preference,omitempty"`

	// An array of objects describing the options from which the user can choose. You can include up to 20 options.
	Options []DialogNodeOutputOptionsElement `json:"options,omitempty"`

	// An optional message to be sent to the human agent who will be taking over the conversation.
	MessageToHumanAgent *string `json:"message_to_human_agent,omitempty"`

	// An optional message to be displayed to the user to indicate that the conversation will be transferred to the next
	// available agent.
	AgentAvailable *AgentAvailabilityMessage `json:"agent_available,omitempty"`

	// An optional message to be displayed to the user to indicate that no online agent is available to take over the
	// conversation.
	AgentUnavailable *AgentAvailabilityMessage `json:"agent_unavailable,omitempty"`

	// Routing or other contextual information to be used by target service desk systems.
	TransferInfo *DialogNodeOutputConnectToAgentTransferInfo `json:"transfer_info,omitempty"`

	// The text of the search query. This can be either a natural-language query or a query that uses the Discovery query
	// language syntax, depending on the value of the **query_type** property. For more information, see the [Discovery
	// service documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-operators#query-operators).
	Query *string `json:"query,omitempty"`

	// The type of the search query.
	QueryType *string `json:"query_type,omitempty"`

	// An optional filter that narrows the set of documents to be searched. For more information, see the [Discovery
	// service documentation]([Discovery service
	// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-parameters#filter).
	Filter *string `json:"filter,omitempty"`

	// The version of the Discovery service API to use for the query.
	DiscoveryVersion *string `json:"discovery_version,omitempty"`

	// The message to display to the user when initiating a channel transfer.
	MessageToUser *string `json:"message_to_user,omitempty"`

	// An object containing any properties for the user-defined response type. The total size of this object cannot exceed
	// 5000 bytes.
	UserDefined map[string]interface{} `json:"user_defined,omitempty"`
}

DialogNodeOutputGeneric : DialogNodeOutputGeneric struct Models which "extend" this model: - DialogNodeOutputGenericDialogNodeOutputResponseTypeText - DialogNodeOutputGenericDialogNodeOutputResponseTypePause - DialogNodeOutputGenericDialogNodeOutputResponseTypeImage - DialogNodeOutputGenericDialogNodeOutputResponseTypeOption - DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent - DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill - DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer - DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined

type DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer added in v2.1.0 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The message to display to the user when initiating a channel transfer.
	MessageToUser *string `json:"message_to_user" validate:"required"`

	// Information used by an integration to transfer the conversation to a different channel.
	TransferInfo *ChannelTransferInfo `json:"transfer_info" validate:"required"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer : DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// An optional message to be sent to the human agent who will be taking over the conversation.
	MessageToHumanAgent *string `json:"message_to_human_agent,omitempty"`

	// An optional message to be displayed to the user to indicate that the conversation will be transferred to the next
	// available agent.
	AgentAvailable *AgentAvailabilityMessage `json:"agent_available,omitempty"`

	// An optional message to be displayed to the user to indicate that no online agent is available to take over the
	// conversation.
	AgentUnavailable *AgentAvailabilityMessage `json:"agent_unavailable,omitempty"`

	// Routing or other contextual information to be used by target service desk systems.
	TransferInfo *DialogNodeOutputConnectToAgentTransferInfo `json:"transfer_info,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent : DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeImage 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeImage struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The `https:` URL of the image.
	Source *string `json:"source" validate:"required"`

	// An optional title to show before the response.
	Title *string `json:"title,omitempty"`

	// An optional description to show with the response.
	Description *string `json:"description,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`

	// Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
	AltText *string `json:"alt_text,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeImage : DialogNodeOutputGenericDialogNodeOutputResponseTypeImage struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeOption 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeOption struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// An optional title to show before the response.
	Title *string `json:"title" validate:"required"`

	// An optional description to show with the response.
	Description *string `json:"description,omitempty"`

	// The preferred type of control to display, if supported by the channel.
	Preference *string `json:"preference,omitempty"`

	// An array of objects describing the options from which the user can choose. You can include up to 20 options.
	Options []DialogNodeOutputOptionsElement `json:"options" validate:"required"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeOption : DialogNodeOutputGenericDialogNodeOutputResponseTypeOption struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypePause 

type DialogNodeOutputGenericDialogNodeOutputResponseTypePause struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// How long to pause, in milliseconds. The valid values are from 0 to 10000.
	Time *int64 `json:"time" validate:"required"`

	// Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this event.
	Typing *bool `json:"typing,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypePause : DialogNodeOutputGenericDialogNodeOutputResponseTypePause struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	//
	// **Note:** The **search_skill** response type is used only by the v2 runtime API.
	ResponseType *string `json:"response_type" validate:"required"`

	// The text of the search query. This can be either a natural-language query or a query that uses the Discovery query
	// language syntax, depending on the value of the **query_type** property. For more information, see the [Discovery
	// service documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-operators#query-operators).
	Query *string `json:"query" validate:"required"`

	// The type of the search query.
	QueryType *string `json:"query_type" validate:"required"`

	// An optional filter that narrows the set of documents to be searched. For more information, see the [Discovery
	// service documentation]([Discovery service
	// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-parameters#filter).
	Filter *string `json:"filter,omitempty"`

	// The version of the Discovery service API to use for the query.
	DiscoveryVersion *string `json:"discovery_version,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill : DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeText 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeText struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// A list of one or more objects defining text responses.
	Values []DialogNodeOutputTextValuesElement `json:"values" validate:"required"`

	// How a response is selected from the list, if more than one response is specified.
	SelectionPolicy *string `json:"selection_policy,omitempty"`

	// The delimiter to use as a separator between responses when `selection_policy`=`multiline`.
	Delimiter *string `json:"delimiter,omitempty"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeText : DialogNodeOutputGenericDialogNodeOutputResponseTypeText struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined added in v2.1.0 

type DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// An object containing any properties for the user-defined response type. The total size of this object cannot exceed
	// 5000 bytes.
	UserDefined map[string]interface{} `json:"user_defined" validate:"required"`

	// An array of objects specifying channels for which the response is intended.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined : DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined struct This model "extends" DialogNodeOutputGeneric

type DialogNodeOutputGenericIntf 

type DialogNodeOutputGenericIntf interface {
	// contains filtered or unexported methods
}

type DialogNodeOutputModifiers 

type DialogNodeOutputModifiers struct {
	// Whether values in the output will overwrite output values in an array specified by previously executed dialog nodes.
	// If this option is set to `false`, new values will be appended to previously specified values.
	Overwrite *bool `json:"overwrite,omitempty"`
}

DialogNodeOutputModifiers : Options that modify how specified output is handled.

type DialogNodeOutputOptionsElement 

type DialogNodeOutputOptionsElement struct {
	// The user-facing label for the option.
	Label *string `json:"label" validate:"required"`

	// An object defining the message input to be sent to the Watson Assistant service if the user selects the
	// corresponding option.
	Value *DialogNodeOutputOptionsElementValue `json:"value" validate:"required"`
}

DialogNodeOutputOptionsElement : DialogNodeOutputOptionsElement struct

type DialogNodeOutputOptionsElementValue 

type DialogNodeOutputOptionsElementValue struct {
	// An input object that includes the input text.
	Input *MessageInput `json:"input,omitempty"`

	// An array of intents to be used while processing the input.
	//
	// **Note:** This property is supported for backward compatibility with applications that use the v1 **Get response to
	// user input** method.
	Intents []RuntimeIntent `json:"intents,omitempty"`

	// An array of entities to be used while processing the user input.
	//
	// **Note:** This property is supported for backward compatibility with applications that use the v1 **Get response to
	// user input** method.
	Entities []RuntimeEntity `json:"entities,omitempty"`
}

DialogNodeOutputOptionsElementValue : An object defining the message input to be sent to the Watson Assistant service if the user selects the corresponding option.

type DialogNodeOutputTextValuesElement 

type DialogNodeOutputTextValuesElement struct {
	// The text of a response. This string can include newline characters (`\n`), Markdown tagging, or other special
	// characters, if supported by the channel.
	Text *string `json:"text,omitempty"`
}

DialogNodeOutputTextValuesElement : DialogNodeOutputTextValuesElement struct

type DialogNodeVisitedDetails 

type DialogNodeVisitedDetails struct {
	// The unique ID of a dialog node that was triggered during processing of the input message.
	DialogNode *string `json:"dialog_node,omitempty"`

	// The title of the dialog node.
	Title *string `json:"title,omitempty"`

	// The conditions that trigger the dialog node.
	Conditions *string `json:"conditions,omitempty"`
}

DialogNodeVisitedDetails : DialogNodeVisitedDetails struct

type DialogSuggestion 

type DialogSuggestion struct {
	// The user-facing label for the disambiguation option. This label is taken from the **title** or **user_label**
	// property of the corresponding dialog node.
	Label *string `json:"label" validate:"required"`

	// An object defining the message input, intents, and entities to be sent to the Watson Assistant service if the user
	// selects the corresponding disambiguation option.
	Value *DialogSuggestionValue `json:"value" validate:"required"`

	// The dialog output that will be returned from the Watson Assistant service if the user selects the corresponding
	// option.
	Output map[string]interface{} `json:"output,omitempty"`

	// The unique ID of the dialog node that the **label** property is taken from. The **label** property is populated
	// using the value of the dialog node's **title** or **user_label** property.
	DialogNode *string `json:"dialog_node,omitempty"`
}

DialogSuggestion : DialogSuggestion struct

type DialogSuggestionValue 

type DialogSuggestionValue struct {
	// An input object that includes the input text.
	Input *MessageInput `json:"input,omitempty"`

	// An array of intents to be sent along with the user input.
	Intents []RuntimeIntent `json:"intents,omitempty"`

	// An array of entities to be sent along with the user input.
	Entities []RuntimeEntity `json:"entities,omitempty"`
}

DialogSuggestionValue : An object defining the message input, intents, and entities to be sent to the Watson Assistant service if the user selects the corresponding disambiguation option.

type Entity 

type Entity struct {
	// The name of the entity. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, and hyphen characters.
	// - If you specify an entity name beginning with the reserved prefix `sys-`, it must be the name of a system entity
	// that you want to enable. (Any entity content specified with the request is ignored.).
	Entity *string `json:"entity" validate:"required"`

	// The description of the entity. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// Any metadata related to the entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether to use fuzzy matching for the entity.
	FuzzyMatch *bool `json:"fuzzy_match,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// An array of objects describing the entity values.
	Values []Value `json:"values,omitempty"`
}

Entity : Entity struct

type EntityCollection 

type EntityCollection struct {
	// An array of objects describing the entities defined for the workspace.
	Entities []Entity `json:"entities" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

EntityCollection : An array of objects describing the entities for the workspace.

type EntityMention 

type EntityMention struct {
	// The text of the user input example.
	Text *string `json:"text" validate:"required"`

	// The name of the intent.
	Intent *string `json:"intent" validate:"required"`

	// An array of zero-based character offsets that indicate where the entity mentions begin and end in the input text.
	Location []int64 `json:"location" validate:"required"`
}

EntityMention : An object describing a contextual entity mention.

type EntityMentionCollection 

type EntityMentionCollection struct {
	// An array of objects describing the entity mentions defined for an entity.
	Examples []EntityMention `json:"examples" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

EntityMentionCollection : EntityMentionCollection struct

type Example 

type Example struct {
	// The text of a user input example. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Text *string `json:"text" validate:"required"`

	// An array of contextual entity mentions.
	Mentions []Mention `json:"mentions,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

Example : Example struct

type ExampleCollection 

type ExampleCollection struct {
	// An array of objects describing the examples defined for the intent.
	Examples []Example `json:"examples" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

ExampleCollection : ExampleCollection struct

type GetCounterexampleOptions 

type GetCounterexampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The text of a user input counterexample (for example, `What are you wearing?`).
	Text *string `json:"-" validate:"required,ne="`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCounterexampleOptions : The GetCounterexample options.

func (*GetCounterexampleOptions) SetHeaders 

func (options *GetCounterexampleOptions) SetHeaders(param map[string]string) *GetCounterexampleOptions

SetHeaders : Allow user to set Headers

func (*GetCounterexampleOptions) SetIncludeAudit 

func (_options *GetCounterexampleOptions) SetIncludeAudit(includeAudit bool) *GetCounterexampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetCounterexampleOptions) SetText 

func (_options *GetCounterexampleOptions) SetText(text string) *GetCounterexampleOptions

SetText : Allow user to set Text

func (*GetCounterexampleOptions) SetWorkspaceID 

func (_options *GetCounterexampleOptions) SetWorkspaceID(workspaceID string) *GetCounterexampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetDialogNodeOptions 

type GetDialogNodeOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The dialog node ID (for example, `node_1_1479323581900`).
	DialogNode *string `json:"-" validate:"required,ne="`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDialogNodeOptions : The GetDialogNode options.

func (*GetDialogNodeOptions) SetDialogNode 

func (_options *GetDialogNodeOptions) SetDialogNode(dialogNode string) *GetDialogNodeOptions

SetDialogNode : Allow user to set DialogNode

func (*GetDialogNodeOptions) SetHeaders 

func (options *GetDialogNodeOptions) SetHeaders(param map[string]string) *GetDialogNodeOptions

SetHeaders : Allow user to set Headers

func (*GetDialogNodeOptions) SetIncludeAudit 

func (_options *GetDialogNodeOptions) SetIncludeAudit(includeAudit bool) *GetDialogNodeOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetDialogNodeOptions) SetWorkspaceID 

func (_options *GetDialogNodeOptions) SetWorkspaceID(workspaceID string) *GetDialogNodeOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetEntityOptions 

type GetEntityOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetEntityOptions : The GetEntity options.

func (*GetEntityOptions) SetEntity 

func (_options *GetEntityOptions) SetEntity(entity string) *GetEntityOptions

SetEntity : Allow user to set Entity

func (*GetEntityOptions) SetExport 

func (_options *GetEntityOptions) SetExport(export bool) *GetEntityOptions

SetExport : Allow user to set Export

func (*GetEntityOptions) SetHeaders 

func (options *GetEntityOptions) SetHeaders(param map[string]string) *GetEntityOptions

SetHeaders : Allow user to set Headers

func (*GetEntityOptions) SetIncludeAudit 

func (_options *GetEntityOptions) SetIncludeAudit(includeAudit bool) *GetEntityOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetEntityOptions) SetWorkspaceID 

func (_options *GetEntityOptions) SetWorkspaceID(workspaceID string) *GetEntityOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetExampleOptions 

type GetExampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The text of the user input example.
	Text *string `json:"-" validate:"required,ne="`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetExampleOptions : The GetExample options.

func (*GetExampleOptions) SetHeaders 

func (options *GetExampleOptions) SetHeaders(param map[string]string) *GetExampleOptions

SetHeaders : Allow user to set Headers

func (*GetExampleOptions) SetIncludeAudit 

func (_options *GetExampleOptions) SetIncludeAudit(includeAudit bool) *GetExampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetExampleOptions) SetIntent 

func (_options *GetExampleOptions) SetIntent(intent string) *GetExampleOptions

SetIntent : Allow user to set Intent

func (*GetExampleOptions) SetText 

func (_options *GetExampleOptions) SetText(text string) *GetExampleOptions

SetText : Allow user to set Text

func (*GetExampleOptions) SetWorkspaceID 

func (_options *GetExampleOptions) SetWorkspaceID(workspaceID string) *GetExampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetIntentOptions 

type GetIntentOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetIntentOptions : The GetIntent options.

func (*GetIntentOptions) SetExport 

func (_options *GetIntentOptions) SetExport(export bool) *GetIntentOptions

SetExport : Allow user to set Export

func (*GetIntentOptions) SetHeaders 

func (options *GetIntentOptions) SetHeaders(param map[string]string) *GetIntentOptions

SetHeaders : Allow user to set Headers

func (*GetIntentOptions) SetIncludeAudit 

func (_options *GetIntentOptions) SetIncludeAudit(includeAudit bool) *GetIntentOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetIntentOptions) SetIntent 

func (_options *GetIntentOptions) SetIntent(intent string) *GetIntentOptions

SetIntent : Allow user to set Intent

func (*GetIntentOptions) SetWorkspaceID 

func (_options *GetIntentOptions) SetWorkspaceID(workspaceID string) *GetIntentOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetSynonymOptions 

type GetSynonymOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The text of the synonym.
	Synonym *string `json:"-" validate:"required,ne="`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSynonymOptions : The GetSynonym options.

func (*GetSynonymOptions) SetEntity 

func (_options *GetSynonymOptions) SetEntity(entity string) *GetSynonymOptions

SetEntity : Allow user to set Entity

func (*GetSynonymOptions) SetHeaders 

func (options *GetSynonymOptions) SetHeaders(param map[string]string) *GetSynonymOptions

SetHeaders : Allow user to set Headers

func (*GetSynonymOptions) SetIncludeAudit 

func (_options *GetSynonymOptions) SetIncludeAudit(includeAudit bool) *GetSynonymOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetSynonymOptions) SetSynonym 

func (_options *GetSynonymOptions) SetSynonym(synonym string) *GetSynonymOptions

SetSynonym : Allow user to set Synonym

func (*GetSynonymOptions) SetValue 

func (_options *GetSynonymOptions) SetValue(value string) *GetSynonymOptions

SetValue : Allow user to set Value

func (*GetSynonymOptions) SetWorkspaceID 

func (_options *GetSynonymOptions) SetWorkspaceID(workspaceID string) *GetSynonymOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetValueOptions 

type GetValueOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetValueOptions : The GetValue options.

func (*GetValueOptions) SetEntity 

func (_options *GetValueOptions) SetEntity(entity string) *GetValueOptions

SetEntity : Allow user to set Entity

func (*GetValueOptions) SetExport 

func (_options *GetValueOptions) SetExport(export bool) *GetValueOptions

SetExport : Allow user to set Export

func (*GetValueOptions) SetHeaders 

func (options *GetValueOptions) SetHeaders(param map[string]string) *GetValueOptions

SetHeaders : Allow user to set Headers

func (*GetValueOptions) SetIncludeAudit 

func (_options *GetValueOptions) SetIncludeAudit(includeAudit bool) *GetValueOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetValueOptions) SetValue 

func (_options *GetValueOptions) SetValue(value string) *GetValueOptions

SetValue : Allow user to set Value

func (*GetValueOptions) SetWorkspaceID 

func (_options *GetValueOptions) SetWorkspaceID(workspaceID string) *GetValueOptions

SetWorkspaceID : Allow user to set WorkspaceID

type GetWorkspaceOptions 

type GetWorkspaceOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Indicates how the returned workspace data will be sorted. This parameter is valid only if **export**=`true`. Specify
	// `sort=stable` to sort all workspace objects by unique identifier, in ascending alphabetical order.
	Sort *string `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetWorkspaceOptions : The GetWorkspace options.

func (*GetWorkspaceOptions) SetExport 

func (_options *GetWorkspaceOptions) SetExport(export bool) *GetWorkspaceOptions

SetExport : Allow user to set Export

func (*GetWorkspaceOptions) SetHeaders 

func (options *GetWorkspaceOptions) SetHeaders(param map[string]string) *GetWorkspaceOptions

SetHeaders : Allow user to set Headers

func (*GetWorkspaceOptions) SetIncludeAudit 

func (_options *GetWorkspaceOptions) SetIncludeAudit(includeAudit bool) *GetWorkspaceOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*GetWorkspaceOptions) SetSort 

func (_options *GetWorkspaceOptions) SetSort(sort string) *GetWorkspaceOptions

SetSort : Allow user to set Sort

func (*GetWorkspaceOptions) SetWorkspaceID 

func (_options *GetWorkspaceOptions) SetWorkspaceID(workspaceID string) *GetWorkspaceOptions

SetWorkspaceID : Allow user to set WorkspaceID

type Intent 

type Intent struct {
	// The name of the intent. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
	// - It cannot begin with the reserved prefix `sys-`.
	Intent *string `json:"intent" validate:"required"`

	// The description of the intent. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// An array of user input examples for the intent.
	Examples []Example `json:"examples,omitempty"`
}

Intent : Intent struct

type IntentCollection 

type IntentCollection struct {
	// An array of objects describing the intents defined for the workspace.
	Intents []Intent `json:"intents" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

IntentCollection : IntentCollection struct

type ListAllLogsOptions 

type ListAllLogsOptions struct {
	// A cacheable parameter that limits the results to those matching the specified filter. You must specify a filter
	// query that includes a value for `language`, as well as a value for `request.context.system.assistant_id`,
	// `workspace_id`, or `request.context.metadata.deployment`. These required filters must be specified using the exact
	// match (`::`) operator. For more information, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
	Filter *string `json:"-" validate:"required"`

	// How to sort the returned log events. You can sort by **request_timestamp**. To reverse the sort order, prefix the
	// parameter value with a minus sign (`-`).
	Sort *string `json:"-"`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAllLogsOptions : The ListAllLogs options.

func (*ListAllLogsOptions) SetCursor 

func (_options *ListAllLogsOptions) SetCursor(cursor string) *ListAllLogsOptions

SetCursor : Allow user to set Cursor

func (*ListAllLogsOptions) SetFilter 

func (_options *ListAllLogsOptions) SetFilter(filter string) *ListAllLogsOptions

SetFilter : Allow user to set Filter

func (*ListAllLogsOptions) SetHeaders 

func (options *ListAllLogsOptions) SetHeaders(param map[string]string) *ListAllLogsOptions

SetHeaders : Allow user to set Headers

func (*ListAllLogsOptions) SetPageLimit 

func (_options *ListAllLogsOptions) SetPageLimit(pageLimit int64) *ListAllLogsOptions

SetPageLimit : Allow user to set PageLimit

func (*ListAllLogsOptions) SetSort 

func (_options *ListAllLogsOptions) SetSort(sort string) *ListAllLogsOptions

SetSort : Allow user to set Sort

type ListCounterexamplesOptions 

type ListCounterexamplesOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned counterexamples will be sorted. To reverse the sort order, prefix the value with a
	// minus sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListCounterexamplesOptions : The ListCounterexamples options.

func (*ListCounterexamplesOptions) SetCursor 

func (_options *ListCounterexamplesOptions) SetCursor(cursor string) *ListCounterexamplesOptions

SetCursor : Allow user to set Cursor

func (*ListCounterexamplesOptions) SetHeaders 

func (options *ListCounterexamplesOptions) SetHeaders(param map[string]string) *ListCounterexamplesOptions

SetHeaders : Allow user to set Headers

func (*ListCounterexamplesOptions) SetIncludeAudit 

func (_options *ListCounterexamplesOptions) SetIncludeAudit(includeAudit bool) *ListCounterexamplesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListCounterexamplesOptions) SetIncludeCount 

func (_options *ListCounterexamplesOptions) SetIncludeCount(includeCount bool) *ListCounterexamplesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListCounterexamplesOptions) SetPageLimit 

func (_options *ListCounterexamplesOptions) SetPageLimit(pageLimit int64) *ListCounterexamplesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListCounterexamplesOptions) SetSort 

func (_options *ListCounterexamplesOptions) SetSort(sort string) *ListCounterexamplesOptions

SetSort : Allow user to set Sort

func (*ListCounterexamplesOptions) SetWorkspaceID 

func (_options *ListCounterexamplesOptions) SetWorkspaceID(workspaceID string) *ListCounterexamplesOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListDialogNodesOptions 

type ListDialogNodesOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned dialog nodes will be sorted. To reverse the sort order, prefix the value with a
	// minus sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDialogNodesOptions : The ListDialogNodes options.

func (*ListDialogNodesOptions) SetCursor 

func (_options *ListDialogNodesOptions) SetCursor(cursor string) *ListDialogNodesOptions

SetCursor : Allow user to set Cursor

func (*ListDialogNodesOptions) SetHeaders 

func (options *ListDialogNodesOptions) SetHeaders(param map[string]string) *ListDialogNodesOptions

SetHeaders : Allow user to set Headers

func (*ListDialogNodesOptions) SetIncludeAudit 

func (_options *ListDialogNodesOptions) SetIncludeAudit(includeAudit bool) *ListDialogNodesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListDialogNodesOptions) SetIncludeCount 

func (_options *ListDialogNodesOptions) SetIncludeCount(includeCount bool) *ListDialogNodesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListDialogNodesOptions) SetPageLimit 

func (_options *ListDialogNodesOptions) SetPageLimit(pageLimit int64) *ListDialogNodesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListDialogNodesOptions) SetSort 

func (_options *ListDialogNodesOptions) SetSort(sort string) *ListDialogNodesOptions

SetSort : Allow user to set Sort

func (*ListDialogNodesOptions) SetWorkspaceID 

func (_options *ListDialogNodesOptions) SetWorkspaceID(workspaceID string) *ListDialogNodesOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListEntitiesOptions 

type ListEntitiesOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus
	// sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListEntitiesOptions : The ListEntities options.

func (*ListEntitiesOptions) SetCursor 

func (_options *ListEntitiesOptions) SetCursor(cursor string) *ListEntitiesOptions

SetCursor : Allow user to set Cursor

func (*ListEntitiesOptions) SetExport 

func (_options *ListEntitiesOptions) SetExport(export bool) *ListEntitiesOptions

SetExport : Allow user to set Export

func (*ListEntitiesOptions) SetHeaders 

func (options *ListEntitiesOptions) SetHeaders(param map[string]string) *ListEntitiesOptions

SetHeaders : Allow user to set Headers

func (*ListEntitiesOptions) SetIncludeAudit 

func (_options *ListEntitiesOptions) SetIncludeAudit(includeAudit bool) *ListEntitiesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListEntitiesOptions) SetIncludeCount 

func (_options *ListEntitiesOptions) SetIncludeCount(includeCount bool) *ListEntitiesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListEntitiesOptions) SetPageLimit 

func (_options *ListEntitiesOptions) SetPageLimit(pageLimit int64) *ListEntitiesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListEntitiesOptions) SetSort 

func (_options *ListEntitiesOptions) SetSort(sort string) *ListEntitiesOptions

SetSort : Allow user to set Sort

func (*ListEntitiesOptions) SetWorkspaceID 

func (_options *ListEntitiesOptions) SetWorkspaceID(workspaceID string) *ListEntitiesOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListExamplesOptions 

type ListExamplesOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned examples will be sorted. To reverse the sort order, prefix the value with a minus
	// sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListExamplesOptions : The ListExamples options.

func (*ListExamplesOptions) SetCursor 

func (_options *ListExamplesOptions) SetCursor(cursor string) *ListExamplesOptions

SetCursor : Allow user to set Cursor

func (*ListExamplesOptions) SetHeaders 

func (options *ListExamplesOptions) SetHeaders(param map[string]string) *ListExamplesOptions

SetHeaders : Allow user to set Headers

func (*ListExamplesOptions) SetIncludeAudit 

func (_options *ListExamplesOptions) SetIncludeAudit(includeAudit bool) *ListExamplesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListExamplesOptions) SetIncludeCount 

func (_options *ListExamplesOptions) SetIncludeCount(includeCount bool) *ListExamplesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListExamplesOptions) SetIntent 

func (_options *ListExamplesOptions) SetIntent(intent string) *ListExamplesOptions

SetIntent : Allow user to set Intent

func (*ListExamplesOptions) SetPageLimit 

func (_options *ListExamplesOptions) SetPageLimit(pageLimit int64) *ListExamplesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListExamplesOptions) SetSort 

func (_options *ListExamplesOptions) SetSort(sort string) *ListExamplesOptions

SetSort : Allow user to set Sort

func (*ListExamplesOptions) SetWorkspaceID 

func (_options *ListExamplesOptions) SetWorkspaceID(workspaceID string) *ListExamplesOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListIntentsOptions 

type ListIntentsOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned intents will be sorted. To reverse the sort order, prefix the value with a minus
	// sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListIntentsOptions : The ListIntents options.

func (*ListIntentsOptions) SetCursor 

func (_options *ListIntentsOptions) SetCursor(cursor string) *ListIntentsOptions

SetCursor : Allow user to set Cursor

func (*ListIntentsOptions) SetExport 

func (_options *ListIntentsOptions) SetExport(export bool) *ListIntentsOptions

SetExport : Allow user to set Export

func (*ListIntentsOptions) SetHeaders 

func (options *ListIntentsOptions) SetHeaders(param map[string]string) *ListIntentsOptions

SetHeaders : Allow user to set Headers

func (*ListIntentsOptions) SetIncludeAudit 

func (_options *ListIntentsOptions) SetIncludeAudit(includeAudit bool) *ListIntentsOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListIntentsOptions) SetIncludeCount 

func (_options *ListIntentsOptions) SetIncludeCount(includeCount bool) *ListIntentsOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListIntentsOptions) SetPageLimit 

func (_options *ListIntentsOptions) SetPageLimit(pageLimit int64) *ListIntentsOptions

SetPageLimit : Allow user to set PageLimit

func (*ListIntentsOptions) SetSort 

func (_options *ListIntentsOptions) SetSort(sort string) *ListIntentsOptions

SetSort : Allow user to set Sort

func (*ListIntentsOptions) SetWorkspaceID 

func (_options *ListIntentsOptions) SetWorkspaceID(workspaceID string) *ListIntentsOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListLogsOptions 

type ListLogsOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// How to sort the returned log events. You can sort by **request_timestamp**. To reverse the sort order, prefix the
	// parameter value with a minus sign (`-`).
	Sort *string `json:"-"`

	// A cacheable parameter that limits the results to those matching the specified filter. For more information, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
	Filter *string `json:"-"`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListLogsOptions : The ListLogs options.

func (*ListLogsOptions) SetCursor 

func (_options *ListLogsOptions) SetCursor(cursor string) *ListLogsOptions

SetCursor : Allow user to set Cursor

func (*ListLogsOptions) SetFilter 

func (_options *ListLogsOptions) SetFilter(filter string) *ListLogsOptions

SetFilter : Allow user to set Filter

func (*ListLogsOptions) SetHeaders 

func (options *ListLogsOptions) SetHeaders(param map[string]string) *ListLogsOptions

SetHeaders : Allow user to set Headers

func (*ListLogsOptions) SetPageLimit 

func (_options *ListLogsOptions) SetPageLimit(pageLimit int64) *ListLogsOptions

SetPageLimit : Allow user to set PageLimit

func (*ListLogsOptions) SetSort 

func (_options *ListLogsOptions) SetSort(sort string) *ListLogsOptions

SetSort : Allow user to set Sort

func (*ListLogsOptions) SetWorkspaceID 

func (_options *ListLogsOptions) SetWorkspaceID(workspaceID string) *ListLogsOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListMentionsOptions 

type ListMentionsOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListMentionsOptions : The ListMentions options.

func (*ListMentionsOptions) SetEntity 

func (_options *ListMentionsOptions) SetEntity(entity string) *ListMentionsOptions

SetEntity : Allow user to set Entity

func (*ListMentionsOptions) SetExport 

func (_options *ListMentionsOptions) SetExport(export bool) *ListMentionsOptions

SetExport : Allow user to set Export

func (*ListMentionsOptions) SetHeaders 

func (options *ListMentionsOptions) SetHeaders(param map[string]string) *ListMentionsOptions

SetHeaders : Allow user to set Headers

func (*ListMentionsOptions) SetIncludeAudit 

func (_options *ListMentionsOptions) SetIncludeAudit(includeAudit bool) *ListMentionsOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListMentionsOptions) SetWorkspaceID 

func (_options *ListMentionsOptions) SetWorkspaceID(workspaceID string) *ListMentionsOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListSynonymsOptions 

type ListSynonymsOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned entity value synonyms will be sorted. To reverse the sort order, prefix the value
	// with a minus sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSynonymsOptions : The ListSynonyms options.

func (*ListSynonymsOptions) SetCursor 

func (_options *ListSynonymsOptions) SetCursor(cursor string) *ListSynonymsOptions

SetCursor : Allow user to set Cursor

func (*ListSynonymsOptions) SetEntity 

func (_options *ListSynonymsOptions) SetEntity(entity string) *ListSynonymsOptions

SetEntity : Allow user to set Entity

func (*ListSynonymsOptions) SetHeaders 

func (options *ListSynonymsOptions) SetHeaders(param map[string]string) *ListSynonymsOptions

SetHeaders : Allow user to set Headers

func (*ListSynonymsOptions) SetIncludeAudit 

func (_options *ListSynonymsOptions) SetIncludeAudit(includeAudit bool) *ListSynonymsOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListSynonymsOptions) SetIncludeCount 

func (_options *ListSynonymsOptions) SetIncludeCount(includeCount bool) *ListSynonymsOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListSynonymsOptions) SetPageLimit 

func (_options *ListSynonymsOptions) SetPageLimit(pageLimit int64) *ListSynonymsOptions

SetPageLimit : Allow user to set PageLimit

func (*ListSynonymsOptions) SetSort 

func (_options *ListSynonymsOptions) SetSort(sort string) *ListSynonymsOptions

SetSort : Allow user to set Sort

func (*ListSynonymsOptions) SetValue 

func (_options *ListSynonymsOptions) SetValue(value string) *ListSynonymsOptions

SetValue : Allow user to set Value

func (*ListSynonymsOptions) SetWorkspaceID 

func (_options *ListSynonymsOptions) SetWorkspaceID(workspaceID string) *ListSynonymsOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListValuesOptions 

type ListValuesOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only
	// information about the element itself. If **export**=`true`, all content, including subelements, is included.
	Export *bool `json:"-"`

	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned entity values will be sorted. To reverse the sort order, prefix the value with a
	// minus sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListValuesOptions : The ListValues options.

func (*ListValuesOptions) SetCursor 

func (_options *ListValuesOptions) SetCursor(cursor string) *ListValuesOptions

SetCursor : Allow user to set Cursor

func (*ListValuesOptions) SetEntity 

func (_options *ListValuesOptions) SetEntity(entity string) *ListValuesOptions

SetEntity : Allow user to set Entity

func (*ListValuesOptions) SetExport 

func (_options *ListValuesOptions) SetExport(export bool) *ListValuesOptions

SetExport : Allow user to set Export

func (*ListValuesOptions) SetHeaders 

func (options *ListValuesOptions) SetHeaders(param map[string]string) *ListValuesOptions

SetHeaders : Allow user to set Headers

func (*ListValuesOptions) SetIncludeAudit 

func (_options *ListValuesOptions) SetIncludeAudit(includeAudit bool) *ListValuesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListValuesOptions) SetIncludeCount 

func (_options *ListValuesOptions) SetIncludeCount(includeCount bool) *ListValuesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListValuesOptions) SetPageLimit 

func (_options *ListValuesOptions) SetPageLimit(pageLimit int64) *ListValuesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListValuesOptions) SetSort 

func (_options *ListValuesOptions) SetSort(sort string) *ListValuesOptions

SetSort : Allow user to set Sort

func (*ListValuesOptions) SetWorkspaceID 

func (_options *ListValuesOptions) SetWorkspaceID(workspaceID string) *ListValuesOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListWorkspacesOptions 

type ListWorkspacesOptions struct {
	// The number of records to return in each page of results.
	PageLimit *int64 `json:"-"`

	// Whether to include information about the number of records that satisfy the request, regardless of the page limit.
	// If this parameter is `true`, the `pagination` object in the response includes the `total` property.
	IncludeCount *bool `json:"-"`

	// The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus
	// sign (`-`).
	Sort *string `json:"-"`

	// A token identifying the page of results to retrieve.
	Cursor *string `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListWorkspacesOptions : The ListWorkspaces options.

func (*ListWorkspacesOptions) SetCursor 

func (_options *ListWorkspacesOptions) SetCursor(cursor string) *ListWorkspacesOptions

SetCursor : Allow user to set Cursor

func (*ListWorkspacesOptions) SetHeaders 

func (options *ListWorkspacesOptions) SetHeaders(param map[string]string) *ListWorkspacesOptions

SetHeaders : Allow user to set Headers

func (*ListWorkspacesOptions) SetIncludeAudit 

func (_options *ListWorkspacesOptions) SetIncludeAudit(includeAudit bool) *ListWorkspacesOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*ListWorkspacesOptions) SetIncludeCount 

func (_options *ListWorkspacesOptions) SetIncludeCount(includeCount bool) *ListWorkspacesOptions

SetIncludeCount : Allow user to set IncludeCount

func (*ListWorkspacesOptions) SetPageLimit 

func (_options *ListWorkspacesOptions) SetPageLimit(pageLimit int64) *ListWorkspacesOptions

SetPageLimit : Allow user to set PageLimit

func (*ListWorkspacesOptions) SetSort 

func (_options *ListWorkspacesOptions) SetSort(sort string) *ListWorkspacesOptions

SetSort : Allow user to set Sort

type Log 

type Log struct {
	// A request sent to the workspace, including the user input and context.
	Request *MessageRequest `json:"request" validate:"required"`

	// The response sent by the workspace, including the output text, detected intents and entities, and context.
	Response *MessageResponse `json:"response" validate:"required"`

	// A unique identifier for the logged event.
	LogID *string `json:"log_id" validate:"required"`

	// The timestamp for receipt of the message.
	RequestTimestamp *string `json:"request_timestamp" validate:"required"`

	// The timestamp for the system response to the message.
	ResponseTimestamp *string `json:"response_timestamp" validate:"required"`

	// The unique identifier of the workspace where the request was made.
	WorkspaceID *string `json:"workspace_id" validate:"required"`

	// The language of the workspace where the message request was made.
	Language *string `json:"language" validate:"required"`
}

Log : Log struct

type LogCollection 

type LogCollection struct {
	// An array of objects describing log events.
	Logs []Log `json:"logs" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *LogPagination `json:"pagination" validate:"required"`
}

LogCollection : LogCollection struct

type LogMessage 

type LogMessage struct {
	// The severity of the log message.
	Level *string `json:"level" validate:"required"`

	// The text of the log message.
	Msg *string `json:"msg" validate:"required"`

	// A code that indicates the category to which the error message belongs.
	Code *string `json:"code" validate:"required"`

	// An object that identifies the dialog element that generated the error message.
	Source *LogMessageSource `json:"source,omitempty"`
}

LogMessage : Log message details.

type LogMessageSource added in v2.1.0 

type LogMessageSource struct {
	// A string that indicates the type of dialog element that generated the error message.
	Type *string `json:"type,omitempty"`

	// The unique identifier of the dialog node that generated the error message.
	DialogNode *string `json:"dialog_node,omitempty"`
}

LogMessageSource : An object that identifies the dialog element that generated the error message.

type LogPagination 

type LogPagination struct {
	// The URL that will return the next page of results, if any.
	NextURL *string `json:"next_url,omitempty"`

	// Reserved for future use.
	Matched *int64 `json:"matched,omitempty"`

	// A token identifying the next page of results.
	NextCursor *string `json:"next_cursor,omitempty"`
}

LogPagination : The pagination data for the returned objects.

type Mention 

type Mention struct {
	// The name of the entity.
	Entity *string `json:"entity" validate:"required"`

	// An array of zero-based character offsets that indicate where the entity mentions begin and end in the input text.
	Location []int64 `json:"location" validate:"required"`
}

Mention : A mention of a contextual entity.

type MessageContextMetadata 

type MessageContextMetadata struct {
	// A label identifying the deployment environment, used for filtering log data. This string cannot contain carriage
	// return, newline, or tab characters.
	Deployment *string `json:"deployment,omitempty"`

	// A string value that identifies the user who is interacting with the workspace. The client must provide a unique
	// identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to
	// identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters.
	// If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.
	//
	// **Note:** This property is the same as the **user_id** property at the root of the message body. If **user_id** is
	// specified in both locations in a message request, the value specified at the root is used.
	UserID *string `json:"user_id,omitempty"`
}

MessageContextMetadata : Metadata related to the message.

type MessageInput 

type MessageInput struct {
	// The text of the user input. This string cannot contain carriage return, newline, or tab characters.
	Text *string `json:"text,omitempty"`

	// Whether to use spelling correction when processing the input. This property overrides the value of the
	// **spelling_suggestions** property in the workspace settings.
	SpellingSuggestions *bool `json:"spelling_suggestions,omitempty"`

	// Whether to use autocorrection when processing the input. If spelling correction is used and this property is
	// `false`, any suggested corrections are returned in the **suggested_text** property of the message response. If this
	// property is `true`, any corrections are automatically applied to the user input, and the original text is returned
	// in the **original_text** property of the message response. This property overrides the value of the
	// **spelling_auto_correct** property in the workspace settings.
	SpellingAutoCorrect *bool `json:"spelling_auto_correct,omitempty"`

	// Any suggested corrections of the input text. This property is returned only if spelling correction is enabled and
	// autocorrection is disabled.
	SuggestedText *string `json:"suggested_text,omitempty"`

	// The original user input text. This property is returned only if autocorrection is enabled and the user input was
	// corrected.
	OriginalText *string `json:"original_text,omitempty"`
	// contains filtered or unexported fields
}

MessageInput : An input object that includes the input text.

func (*MessageInput) GetProperties 

func (o *MessageInput) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of MessageInput

func (*MessageInput) GetProperty 

func (o *MessageInput) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of MessageInput

func (*MessageInput) MarshalJSON 

func (o *MessageInput) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of MessageInput

func (*MessageInput) SetProperties added in v2.2.0 

func (o *MessageInput) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of MessageInput

func (*MessageInput) SetProperty 

func (o *MessageInput) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of MessageInput

type MessageOptions 

type MessageOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// An input object that includes the input text.
	Input *MessageInput `json:"input,omitempty"`

	// Intents to use when evaluating the user input. Include intents from the previous response to continue using those
	// intents rather than trying to recognize intents in the new input.
	Intents []RuntimeIntent `json:"intents,omitempty"`

	// Entities to use when evaluating the message. Include entities from the previous response to continue using those
	// entities rather than detecting entities in the new input.
	Entities []RuntimeEntity `json:"entities,omitempty"`

	// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.
	AlternateIntents *bool `json:"alternate_intents,omitempty"`

	// State information for the conversation. To maintain state, include the context from the previous response.
	Context *Context `json:"context,omitempty"`

	// An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the
	// log.
	Output *OutputData `json:"output,omitempty"`

	// A string value that identifies the user who is interacting with the workspace. The client must provide a unique
	// identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to
	// identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters.
	// If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.
	//
	// **Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is specified
	// in both locations in a message request, the value specified at the root is used.
	UserID *string `json:"user_id,omitempty"`

	// Whether to include additional diagnostic information about the dialog nodes that were visited during processing of
	// the message.
	NodesVisitedDetails *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

MessageOptions : The Message options.

func (*MessageOptions) SetAlternateIntents 

func (_options *MessageOptions) SetAlternateIntents(alternateIntents bool) *MessageOptions

SetAlternateIntents : Allow user to set AlternateIntents

func (*MessageOptions) SetContext 

func (_options *MessageOptions) SetContext(context *Context) *MessageOptions

SetContext : Allow user to set Context

func (*MessageOptions) SetEntities 

func (_options *MessageOptions) SetEntities(entities []RuntimeEntity) *MessageOptions

SetEntities : Allow user to set Entities

func (*MessageOptions) SetHeaders 

func (options *MessageOptions) SetHeaders(param map[string]string) *MessageOptions

SetHeaders : Allow user to set Headers

func (*MessageOptions) SetInput 

func (_options *MessageOptions) SetInput(input *MessageInput) *MessageOptions

SetInput : Allow user to set Input

func (*MessageOptions) SetIntents 

func (_options *MessageOptions) SetIntents(intents []RuntimeIntent) *MessageOptions

SetIntents : Allow user to set Intents

func (*MessageOptions) SetNodesVisitedDetails 

func (_options *MessageOptions) SetNodesVisitedDetails(nodesVisitedDetails bool) *MessageOptions

SetNodesVisitedDetails : Allow user to set NodesVisitedDetails

func (*MessageOptions) SetOutput 

func (_options *MessageOptions) SetOutput(output *OutputData) *MessageOptions

SetOutput : Allow user to set Output

func (*MessageOptions) SetUserID added in v2.1.0 

func (_options *MessageOptions) SetUserID(userID string) *MessageOptions

SetUserID : Allow user to set UserID

func (*MessageOptions) SetWorkspaceID 

func (_options *MessageOptions) SetWorkspaceID(workspaceID string) *MessageOptions

SetWorkspaceID : Allow user to set WorkspaceID

type MessageRequest 

type MessageRequest struct {
	// An input object that includes the input text.
	Input *MessageInput `json:"input,omitempty"`

	// Intents to use when evaluating the user input. Include intents from the previous response to continue using those
	// intents rather than trying to recognize intents in the new input.
	Intents []RuntimeIntent `json:"intents,omitempty"`

	// Entities to use when evaluating the message. Include entities from the previous response to continue using those
	// entities rather than detecting entities in the new input.
	Entities []RuntimeEntity `json:"entities,omitempty"`

	// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.
	AlternateIntents *bool `json:"alternate_intents,omitempty"`

	// State information for the conversation. To maintain state, include the context from the previous response.
	Context *Context `json:"context,omitempty"`

	// An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the
	// log.
	Output *OutputData `json:"output,omitempty"`

	// An array of objects describing any actions requested by the dialog node.
	Actions []DialogNodeAction `json:"actions,omitempty"`

	// A string value that identifies the user who is interacting with the workspace. The client must provide a unique
	// identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to
	// identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters.
	// If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.
	//
	// **Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is specified
	// in both locations in a message request, the value specified at the root is used.
	UserID *string `json:"user_id,omitempty"`
}

MessageRequest : A request sent to the workspace, including the user input and context.

type MessageResponse 

type MessageResponse struct {
	// An input object that includes the input text.
	Input *MessageInput `json:"input" validate:"required"`

	// An array of intents recognized in the user input, sorted in descending order of confidence.
	Intents []RuntimeIntent `json:"intents" validate:"required"`

	// An array of entities identified in the user input.
	Entities []RuntimeEntity `json:"entities" validate:"required"`

	// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.
	AlternateIntents *bool `json:"alternate_intents,omitempty"`

	// State information for the conversation. To maintain state, include the context from the previous response.
	Context *Context `json:"context" validate:"required"`

	// An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the
	// log.
	Output *OutputData `json:"output" validate:"required"`

	// An array of objects describing any actions requested by the dialog node.
	Actions []DialogNodeAction `json:"actions,omitempty"`

	// A string value that identifies the user who is interacting with the workspace. The client must provide a unique
	// identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to
	// identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters.
	// If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.
	//
	// **Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is specified
	// in both locations in a message request, the value specified at the root is used.
	UserID *string `json:"user_id" validate:"required"`
}

MessageResponse : The response sent by the workspace, including the output text, detected intents and entities, and context.

type OutputData 

type OutputData struct {
	// An array of the nodes that were triggered to create the response, in the order in which they were visited. This
	// information is useful for debugging and for tracing the path taken through the node tree.
	NodesVisited []string `json:"nodes_visited,omitempty"`

	// An array of objects containing detailed diagnostic information about the nodes that were triggered during processing
	// of the input message. Included only if **nodes_visited_details** is set to `true` in the message request.
	NodesVisitedDetails []DialogNodeVisitedDetails `json:"nodes_visited_details,omitempty"`

	// An array of up to 50 messages logged with the request.
	LogMessages []LogMessage `json:"log_messages" validate:"required"`

	// An array of responses to the user.
	Text []string `json:"text" validate:"required"`

	// Output intended for any channel. It is the responsibility of the client application to implement the supported
	// response types.
	Generic []RuntimeResponseGenericIntf `json:"generic,omitempty"`
	// contains filtered or unexported fields
}

OutputData : An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

func (*OutputData) GetProperties 

func (o *OutputData) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of OutputData

func (*OutputData) GetProperty 

func (o *OutputData) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of OutputData

func (*OutputData) MarshalJSON 

func (o *OutputData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of OutputData

func (*OutputData) SetProperties added in v2.2.0 

func (o *OutputData) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of OutputData

func (*OutputData) SetProperty 

func (o *OutputData) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of OutputData

type Pagination 

type Pagination struct {
	// The URL that will return the same page of results.
	RefreshURL *string `json:"refresh_url" validate:"required"`

	// The URL that will return the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// The total number of objects that satisfy the request. This total includes all results, not just those included in
	// the current page.
	Total *int64 `json:"total,omitempty"`

	// Reserved for future use.
	Matched *int64 `json:"matched,omitempty"`

	// A token identifying the current page of results.
	RefreshCursor *string `json:"refresh_cursor,omitempty"`

	// A token identifying the next page of results.
	NextCursor *string `json:"next_cursor,omitempty"`
}

Pagination : The pagination data for the returned objects.

type ResponseGenericChannel added in v2.1.0 

type ResponseGenericChannel struct {
	// A channel for which the response is intended.
	Channel *string `json:"channel,omitempty"`
}

ResponseGenericChannel : ResponseGenericChannel struct

type RuntimeEntity 

type RuntimeEntity struct {
	// An entity detected in the input.
	Entity *string `json:"entity" validate:"required"`

	// An array of zero-based character offsets that indicate where the detected entity values begin and end in the input
	// text.
	Location []int64 `json:"location,omitempty"`

	// The entity value that was recognized in the user input.
	Value *string `json:"value" validate:"required"`

	// A decimal percentage that represents Watson's confidence in the recognized entity.
	Confidence *float64 `json:"confidence,omitempty"`

	// **Deprecated.** Any metadata for the entity.
	//
	// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information about
	// system entities recognized in the user input, see the `interpretation` property.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// The recognized capture groups for the entity, as defined by the entity pattern.
	Groups []CaptureGroup `json:"groups,omitempty"`

	// An object containing detailed information about the entity recognized in the user input.
	//
	// For more information about how system entities are interpreted, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities).
	Interpretation *RuntimeEntityInterpretation `json:"interpretation,omitempty"`

	// An array of possible alternative values that the user might have intended instead of the value returned in the
	// **value** property. This property is returned only for `@sys-time` and `@sys-date` entities when the user's input is
	// ambiguous.
	//
	// This property is included only if the new system entities are enabled for the workspace.
	Alternatives []RuntimeEntityAlternative `json:"alternatives,omitempty"`

	// 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. This property is included only if the new system entities are enabled for the workspace.
	Role *RuntimeEntityRole `json:"role,omitempty"`
}

RuntimeEntity : A term from the request that was identified as an entity.

type RuntimeEntityAlternative 

type RuntimeEntityAlternative struct {
	// The entity value that was recognized in the user input.
	Value *string `json:"value,omitempty"`

	// A decimal percentage that represents Watson's confidence in the recognized entity.
	Confidence *float64 `json:"confidence,omitempty"`
}

RuntimeEntityAlternative : An alternative value for the recognized entity.

type RuntimeEntityInterpretation 

type RuntimeEntityInterpretation struct {
	// The calendar used to represent a recognized date (for example, `Gregorian`).
	CalendarType *string `json:"calendar_type,omitempty"`

	// A unique identifier used to associate a recognized time and date. If the user input contains a date and time that
	// are mentioned together (for example, `Today at 5`, the same **datetime_link** value is returned for both the
	// `@sys-date` and `@sys-time` entities).
	DatetimeLink *string `json:"datetime_link,omitempty"`

	// A locale-specific holiday name (such as `thanksgiving` or `christmas`). This property is included when a `@sys-date`
	// entity is recognized based on a holiday name in the user input.
	Festival *string `json:"festival,omitempty"`

	// The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.
	Granularity *string `json:"granularity,omitempty"`

	// A unique identifier used to associate multiple recognized `@sys-date`, `@sys-time`, or `@sys-number` entities that
	// are recognized as a range of values in the user's input (for example, `from July 4 until July 14` or `from 20 to
	// 25`).
	RangeLink *string `json:"range_link,omitempty"`

	// The word in the user input that indicates that a `sys-date` or `sys-time` entity is part of an implied range where
	// only one date or time is specified (for example, `since` or `until`).
	RangeModifier *string `json:"range_modifier,omitempty"`

	// A recognized mention of a relative day, represented numerically as an offset from the current date (for example,
	// `-1` for `yesterday` or `10` for `in ten days`).
	RelativeDay *float64 `json:"relative_day,omitempty"`

	// A recognized mention of a relative month, represented numerically as an offset from the current month (for example,
	// `1` for `next month` or `-3` for `three months ago`).
	RelativeMonth *float64 `json:"relative_month,omitempty"`

	// A recognized mention of a relative week, represented numerically as an offset from the current week (for example,
	// `2` for `in two weeks` or `-1` for `last week).
	RelativeWeek *float64 `json:"relative_week,omitempty"`

	// A recognized mention of a relative date range for a weekend, represented numerically as an offset from the current
	// weekend (for example, `0` for `this weekend` or `-1` for `last weekend`).
	RelativeWeekend *float64 `json:"relative_weekend,omitempty"`

	// A recognized mention of a relative year, represented numerically as an offset from the current year (for example,
	// `1` for `next year` or `-5` for `five years ago`).
	RelativeYear *float64 `json:"relative_year,omitempty"`

	// A recognized mention of a specific date, represented numerically as the date within the month (for example, `30` for
	// `June 30`.).
	SpecificDay *float64 `json:"specific_day,omitempty"`

	// A recognized mention of a specific day of the week as a lowercase string (for example, `monday`).
	SpecificDayOfWeek *string `json:"specific_day_of_week,omitempty"`

	// A recognized mention of a specific month, represented numerically (for example, `7` for `July`).
	SpecificMonth *float64 `json:"specific_month,omitempty"`

	// A recognized mention of a specific quarter, represented numerically (for example, `3` for `the third quarter`).
	SpecificQuarter *float64 `json:"specific_quarter,omitempty"`

	// A recognized mention of a specific year (for example, `2016`).
	SpecificYear *float64 `json:"specific_year,omitempty"`

	// A recognized numeric value, represented as an integer or double.
	NumericValue *float64 `json:"numeric_value,omitempty"`

	// The type of numeric value recognized in the user input (`integer` or `rational`).
	Subtype *string `json:"subtype,omitempty"`

	// A recognized term for a time that was mentioned as a part of the day in the user's input (for example, `morning` or
	// `afternoon`).
	PartOfDay *string `json:"part_of_day,omitempty"`

	// A recognized mention of a relative hour, represented numerically as an offset from the current hour (for example,
	// `3` for `in three hours` or `-1` for `an hour ago`).
	RelativeHour *float64 `json:"relative_hour,omitempty"`

	// A recognized mention of a relative time, represented numerically as an offset in minutes from the current time (for
	// example, `5` for `in five minutes` or `-15` for `fifteen minutes ago`).
	RelativeMinute *float64 `json:"relative_minute,omitempty"`

	// A recognized mention of a relative time, represented numerically as an offset in seconds from the current time (for
	// example, `10` for `in ten seconds` or `-30` for `thirty seconds ago`).
	RelativeSecond *float64 `json:"relative_second,omitempty"`

	// A recognized specific hour mentioned as part of a time value (for example, `10` for `10:15 AM`.).
	SpecificHour *float64 `json:"specific_hour,omitempty"`

	// A recognized specific minute mentioned as part of a time value (for example, `15` for `10:15 AM`.).
	SpecificMinute *float64 `json:"specific_minute,omitempty"`

	// A recognized specific second mentioned as part of a time value (for example, `30` for `10:15:30 AM`.).
	SpecificSecond *float64 `json:"specific_second,omitempty"`

	// A recognized time zone mentioned as part of a time value (for example, `EST`).
	Timezone *string `json:"timezone,omitempty"`
}

RuntimeEntityInterpretation : RuntimeEntityInterpretation struct

type RuntimeEntityRole 

type RuntimeEntityRole struct {
	// The relationship of the entity to the range.
	Type *string `json:"type,omitempty"`
}

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. This property is included only if the new system entities are enabled for the workspace.

type RuntimeIntent 

type RuntimeIntent struct {
	// The name of the recognized intent.
	Intent *string `json:"intent" validate:"required"`

	// A decimal percentage that represents Watson's confidence in the intent.
	Confidence *float64 `json:"confidence" validate:"required"`
}

RuntimeIntent : An intent identified in the user input.

type RuntimeResponseGeneric 

type RuntimeResponseGeneric struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type,omitempty"`

	// The text of the response.
	Text *string `json:"text,omitempty"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`

	// How long to pause, in milliseconds.
	Time *int64 `json:"time,omitempty"`

	// Whether to send a "user is typing" event during the pause.
	Typing *bool `json:"typing,omitempty"`

	// The `https:` URL of the image.
	Source *string `json:"source,omitempty"`

	// The title or introductory text to show before the response.
	Title *string `json:"title,omitempty"`

	// The description to show with the the response.
	Description *string `json:"description,omitempty"`

	// Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
	AltText *string `json:"alt_text,omitempty"`

	// The preferred type of control to display.
	Preference *string `json:"preference,omitempty"`

	// An array of objects describing the options from which the user can choose.
	Options []DialogNodeOutputOptionsElement `json:"options,omitempty"`

	// A message to be sent to the human agent who will be taking over the conversation.
	MessageToHumanAgent *string `json:"message_to_human_agent,omitempty"`

	// An optional message to be displayed to the user to indicate that the conversation will be transferred to the next
	// available agent.
	AgentAvailable *AgentAvailabilityMessage `json:"agent_available,omitempty"`

	// An optional message to be displayed to the user to indicate that no online agent is available to take over the
	// conversation.
	AgentUnavailable *AgentAvailabilityMessage `json:"agent_unavailable,omitempty"`

	// Routing or other contextual information to be used by target service desk systems.
	TransferInfo *DialogNodeOutputConnectToAgentTransferInfo `json:"transfer_info,omitempty"`

	// A label identifying the topic of the conversation, derived from the **title** property of the relevant node or the
	// **topic** property of the dialog node response.
	Topic *string `json:"topic,omitempty"`

	// The unique ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
	// using the value of the dialog node's **title** property.
	DialogNode *string `json:"dialog_node,omitempty"`

	// An array of objects describing the possible matching dialog nodes from which the user can choose.
	Suggestions []DialogSuggestion `json:"suggestions,omitempty"`

	// The message to display to the user when initiating a channel transfer.
	MessageToUser *string `json:"message_to_user,omitempty"`

	// An object containing any properties for the user-defined response type.
	UserDefined map[string]interface{} `json:"user_defined,omitempty"`
}

RuntimeResponseGeneric : RuntimeResponseGeneric struct Models which "extend" this model: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion - RuntimeResponseGenericRuntimeResponseTypeChannelTransfer - RuntimeResponseGenericRuntimeResponseTypeUserDefined

type RuntimeResponseGenericIntf 

type RuntimeResponseGenericIntf interface {
	// contains filtered or unexported methods
}

type RuntimeResponseGenericRuntimeResponseTypeChannelTransfer added in v2.1.0 

type RuntimeResponseGenericRuntimeResponseTypeChannelTransfer struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The message to display to the user when initiating a channel transfer.
	MessageToUser *string `json:"message_to_user" validate:"required"`

	// Information used by an integration to transfer the conversation to a different channel.
	TransferInfo *ChannelTransferInfo `json:"transfer_info" validate:"required"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended only for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeChannelTransfer : RuntimeResponseGenericRuntimeResponseTypeChannelTransfer struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeConnectToAgent 

type RuntimeResponseGenericRuntimeResponseTypeConnectToAgent struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// A message to be sent to the human agent who will be taking over the conversation.
	MessageToHumanAgent *string `json:"message_to_human_agent,omitempty"`

	// An optional message to be displayed to the user to indicate that the conversation will be transferred to the next
	// available agent.
	AgentAvailable *AgentAvailabilityMessage `json:"agent_available,omitempty"`

	// An optional message to be displayed to the user to indicate that no online agent is available to take over the
	// conversation.
	AgentUnavailable *AgentAvailabilityMessage `json:"agent_unavailable,omitempty"`

	// Routing or other contextual information to be used by target service desk systems.
	TransferInfo *DialogNodeOutputConnectToAgentTransferInfo `json:"transfer_info,omitempty"`

	// A label identifying the topic of the conversation, derived from the **title** property of the relevant node or the
	// **topic** property of the dialog node response.
	Topic *string `json:"topic,omitempty"`

	// The unique ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
	// using the value of the dialog node's **title** property.
	DialogNode *string `json:"dialog_node,omitempty"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeConnectToAgent : RuntimeResponseGenericRuntimeResponseTypeConnectToAgent struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeImage 

type RuntimeResponseGenericRuntimeResponseTypeImage struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The `https:` URL of the image.
	Source *string `json:"source" validate:"required"`

	// The title or introductory text to show before the response.
	Title *string `json:"title,omitempty"`

	// The description to show with the the response.
	Description *string `json:"description,omitempty"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`

	// Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
	AltText *string `json:"alt_text,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeImage : RuntimeResponseGenericRuntimeResponseTypeImage struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeOption 

type RuntimeResponseGenericRuntimeResponseTypeOption struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The title or introductory text to show before the response.
	Title *string `json:"title" validate:"required"`

	// The description to show with the the response.
	Description *string `json:"description,omitempty"`

	// The preferred type of control to display.
	Preference *string `json:"preference,omitempty"`

	// An array of objects describing the options from which the user can choose.
	Options []DialogNodeOutputOptionsElement `json:"options" validate:"required"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeOption : RuntimeResponseGenericRuntimeResponseTypeOption struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypePause 

type RuntimeResponseGenericRuntimeResponseTypePause struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// How long to pause, in milliseconds.
	Time *int64 `json:"time" validate:"required"`

	// Whether to send a "user is typing" event during the pause.
	Typing *bool `json:"typing,omitempty"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypePause : RuntimeResponseGenericRuntimeResponseTypePause struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeSuggestion 

type RuntimeResponseGenericRuntimeResponseTypeSuggestion struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The title or introductory text to show before the response.
	Title *string `json:"title" validate:"required"`

	// An array of objects describing the possible matching dialog nodes from which the user can choose.
	Suggestions []DialogSuggestion `json:"suggestions" validate:"required"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeSuggestion : RuntimeResponseGenericRuntimeResponseTypeSuggestion struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeText 

type RuntimeResponseGenericRuntimeResponseTypeText struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// The text of the response.
	Text *string `json:"text" validate:"required"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeText : RuntimeResponseGenericRuntimeResponseTypeText struct This model "extends" RuntimeResponseGeneric

type RuntimeResponseGenericRuntimeResponseTypeUserDefined added in v2.1.0 

type RuntimeResponseGenericRuntimeResponseTypeUserDefined struct {
	// The type of response returned by the dialog node. The specified response type must be supported by the client
	// application or channel.
	ResponseType *string `json:"response_type" validate:"required"`

	// An object containing any properties for the user-defined response type.
	UserDefined map[string]interface{} `json:"user_defined" validate:"required"`

	// An array of objects specifying channels for which the response is intended. If **channels** is present, the response
	// is intended for a built-in integration and should not be handled by an API client.
	Channels []ResponseGenericChannel `json:"channels,omitempty"`
}

RuntimeResponseGenericRuntimeResponseTypeUserDefined : RuntimeResponseGenericRuntimeResponseTypeUserDefined struct This model "extends" RuntimeResponseGeneric

type Synonym 

type Synonym struct {
	// The text of the synonym. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Synonym *string `json:"synonym" validate:"required"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

Synonym : Synonym struct

type SynonymCollection 

type SynonymCollection struct {
	// An array of synonyms.
	Synonyms []Synonym `json:"synonyms" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

SynonymCollection : SynonymCollection struct

type UpdateCounterexampleOptions 

type UpdateCounterexampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The text of a user input counterexample (for example, `What are you wearing?`).
	Text *string `json:"-" validate:"required,ne="`

	// The text of a user input marked as irrelevant input. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	NewText *string `json:"text,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateCounterexampleOptions : The UpdateCounterexample options.

func (*UpdateCounterexampleOptions) SetHeaders 

func (options *UpdateCounterexampleOptions) SetHeaders(param map[string]string) *UpdateCounterexampleOptions

SetHeaders : Allow user to set Headers

func (*UpdateCounterexampleOptions) SetIncludeAudit 

func (_options *UpdateCounterexampleOptions) SetIncludeAudit(includeAudit bool) *UpdateCounterexampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateCounterexampleOptions) SetNewText 

func (_options *UpdateCounterexampleOptions) SetNewText(newText string) *UpdateCounterexampleOptions

SetNewText : Allow user to set NewText

func (*UpdateCounterexampleOptions) SetText 

func (_options *UpdateCounterexampleOptions) SetText(text string) *UpdateCounterexampleOptions

SetText : Allow user to set Text

func (*UpdateCounterexampleOptions) SetWorkspaceID 

func (_options *UpdateCounterexampleOptions) SetWorkspaceID(workspaceID string) *UpdateCounterexampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateDialogNodeOptions 

type UpdateDialogNodeOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The dialog node ID (for example, `node_1_1479323581900`).
	DialogNode *string `json:"-" validate:"required,ne="`

	// The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog
	// nodes and in the diagnostic information included with message responses.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	NewDialogNode *string `json:"dialog_node,omitempty"`

	// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters.
	NewDescription *string `json:"description,omitempty"`

	// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab
	// characters.
	NewConditions *string `json:"conditions,omitempty"`

	// The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.
	NewParent *string `json:"parent,omitempty"`

	// The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous
	// sibling.
	NewPreviousSibling *string `json:"previous_sibling,omitempty"`

	// The output of the dialog node. For more information about how to specify dialog node output, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
	NewOutput *DialogNodeOutput `json:"output,omitempty"`

	// The context for the dialog node.
	NewContext *DialogNodeContext `json:"context,omitempty"`

	// The metadata for the dialog node.
	NewMetadata map[string]interface{} `json:"metadata,omitempty"`

	// The next step to execute following this dialog node.
	NewNextStep *DialogNodeNextStep `json:"next_step,omitempty"`

	// A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate
	// the **label** property of the corresponding suggestion in the `suggestion` response type (unless it is overridden by
	// the **user_label** property). The title is also used to populate the **topic** property in the `connect_to_agent`
	// response type.
	//
	// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
	NewTitle *string `json:"title,omitempty"`

	// How the dialog node is processed.
	NewType *string `json:"type,omitempty"`

	// How an `event_handler` node is processed.
	NewEventName *string `json:"event_name,omitempty"`

	// The location in the dialog context where output is stored.
	NewVariable *string `json:"variable,omitempty"`

	// An array of objects describing any actions to be invoked by the dialog node.
	NewActions []DialogNodeAction `json:"actions,omitempty"`

	// Whether this top-level dialog node can be digressed into.
	NewDigressIn *string `json:"digress_in,omitempty"`

	// Whether this dialog node can be returned to after a digression.
	NewDigressOut *string `json:"digress_out,omitempty"`

	// Whether the user can digress to top-level nodes while filling out slots.
	NewDigressOutSlots *string `json:"digress_out_slots,omitempty"`

	// A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to
	// identify the node in disambiguation responses (overriding the value of the **title** property).
	NewUserLabel *string `json:"user_label,omitempty"`

	// Whether the dialog node should be excluded from disambiguation suggestions. Valid only when **type**=`standard` or
	// `frame`.
	NewDisambiguationOptOut *bool `json:"disambiguation_opt_out,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateDialogNodeOptions : The UpdateDialogNode options.

func (*UpdateDialogNodeOptions) SetDialogNode 

func (_options *UpdateDialogNodeOptions) SetDialogNode(dialogNode string) *UpdateDialogNodeOptions

SetDialogNode : Allow user to set DialogNode

func (*UpdateDialogNodeOptions) SetHeaders 

func (options *UpdateDialogNodeOptions) SetHeaders(param map[string]string) *UpdateDialogNodeOptions

SetHeaders : Allow user to set Headers

func (*UpdateDialogNodeOptions) SetIncludeAudit 

func (_options *UpdateDialogNodeOptions) SetIncludeAudit(includeAudit bool) *UpdateDialogNodeOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateDialogNodeOptions) SetNewActions 

func (_options *UpdateDialogNodeOptions) SetNewActions(newActions []DialogNodeAction) *UpdateDialogNodeOptions

SetNewActions : Allow user to set NewActions

func (*UpdateDialogNodeOptions) SetNewConditions 

func (_options *UpdateDialogNodeOptions) SetNewConditions(newConditions string) *UpdateDialogNodeOptions

SetNewConditions : Allow user to set NewConditions

func (*UpdateDialogNodeOptions) SetNewContext 

func (_options *UpdateDialogNodeOptions) SetNewContext(newContext *DialogNodeContext) *UpdateDialogNodeOptions

SetNewContext : Allow user to set NewContext

func (*UpdateDialogNodeOptions) SetNewDescription 

func (_options *UpdateDialogNodeOptions) SetNewDescription(newDescription string) *UpdateDialogNodeOptions

SetNewDescription : Allow user to set NewDescription

func (*UpdateDialogNodeOptions) SetNewDialogNode 

func (_options *UpdateDialogNodeOptions) SetNewDialogNode(newDialogNode string) *UpdateDialogNodeOptions

SetNewDialogNode : Allow user to set NewDialogNode

func (*UpdateDialogNodeOptions) SetNewDigressIn 

func (_options *UpdateDialogNodeOptions) SetNewDigressIn(newDigressIn string) *UpdateDialogNodeOptions

SetNewDigressIn : Allow user to set NewDigressIn

func (*UpdateDialogNodeOptions) SetNewDigressOut 

func (_options *UpdateDialogNodeOptions) SetNewDigressOut(newDigressOut string) *UpdateDialogNodeOptions

SetNewDigressOut : Allow user to set NewDigressOut

func (*UpdateDialogNodeOptions) SetNewDigressOutSlots 

func (_options *UpdateDialogNodeOptions) SetNewDigressOutSlots(newDigressOutSlots string) *UpdateDialogNodeOptions

SetNewDigressOutSlots : Allow user to set NewDigressOutSlots

func (*UpdateDialogNodeOptions) SetNewDisambiguationOptOut 

func (_options *UpdateDialogNodeOptions) SetNewDisambiguationOptOut(newDisambiguationOptOut bool) *UpdateDialogNodeOptions

SetNewDisambiguationOptOut : Allow user to set NewDisambiguationOptOut

func (*UpdateDialogNodeOptions) SetNewEventName 

func (_options *UpdateDialogNodeOptions) SetNewEventName(newEventName string) *UpdateDialogNodeOptions

SetNewEventName : Allow user to set NewEventName

func (*UpdateDialogNodeOptions) SetNewMetadata 

func (_options *UpdateDialogNodeOptions) SetNewMetadata(newMetadata map[string]interface{}) *UpdateDialogNodeOptions

SetNewMetadata : Allow user to set NewMetadata

func (*UpdateDialogNodeOptions) SetNewNextStep 

func (_options *UpdateDialogNodeOptions) SetNewNextStep(newNextStep *DialogNodeNextStep) *UpdateDialogNodeOptions

SetNewNextStep : Allow user to set NewNextStep

func (*UpdateDialogNodeOptions) SetNewOutput 

func (_options *UpdateDialogNodeOptions) SetNewOutput(newOutput *DialogNodeOutput) *UpdateDialogNodeOptions

SetNewOutput : Allow user to set NewOutput

func (*UpdateDialogNodeOptions) SetNewParent 

func (_options *UpdateDialogNodeOptions) SetNewParent(newParent string) *UpdateDialogNodeOptions

SetNewParent : Allow user to set NewParent

func (*UpdateDialogNodeOptions) SetNewPreviousSibling 

func (_options *UpdateDialogNodeOptions) SetNewPreviousSibling(newPreviousSibling string) *UpdateDialogNodeOptions

SetNewPreviousSibling : Allow user to set NewPreviousSibling

func (*UpdateDialogNodeOptions) SetNewTitle 

func (_options *UpdateDialogNodeOptions) SetNewTitle(newTitle string) *UpdateDialogNodeOptions

SetNewTitle : Allow user to set NewTitle

func (*UpdateDialogNodeOptions) SetNewType 

func (_options *UpdateDialogNodeOptions) SetNewType(newType string) *UpdateDialogNodeOptions

SetNewType : Allow user to set NewType

func (*UpdateDialogNodeOptions) SetNewUserLabel 

func (_options *UpdateDialogNodeOptions) SetNewUserLabel(newUserLabel string) *UpdateDialogNodeOptions

SetNewUserLabel : Allow user to set NewUserLabel

func (*UpdateDialogNodeOptions) SetNewVariable 

func (_options *UpdateDialogNodeOptions) SetNewVariable(newVariable string) *UpdateDialogNodeOptions

SetNewVariable : Allow user to set NewVariable

func (*UpdateDialogNodeOptions) SetWorkspaceID 

func (_options *UpdateDialogNodeOptions) SetWorkspaceID(workspaceID string) *UpdateDialogNodeOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateEntityOptions 

type UpdateEntityOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The name of the entity. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, and hyphen characters.
	// - It cannot begin with the reserved prefix `sys-`.
	NewEntity *string `json:"entity,omitempty"`

	// The description of the entity. This string cannot contain carriage return, newline, or tab characters.
	NewDescription *string `json:"description,omitempty"`

	// Any metadata related to the entity.
	NewMetadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether to use fuzzy matching for the entity.
	NewFuzzyMatch *bool `json:"fuzzy_match,omitempty"`

	// An array of objects describing the entity values.
	NewValues []CreateValue `json:"values,omitempty"`

	// Whether the new data is to be appended to the existing data in the entity. If **append**=`false`, elements included
	// in the new data completely replace the corresponding existing elements, including all subelements. For example, if
	// the new data for the entity includes **values** and **append**=`false`, all existing values for the entity are
	// discarded and replaced with the new values.
	//
	// If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new
	// data collide with existing elements, the update request fails.
	Append *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateEntityOptions : The UpdateEntity options.

func (*UpdateEntityOptions) SetAppend 

func (_options *UpdateEntityOptions) SetAppend(append bool) *UpdateEntityOptions

SetAppend : Allow user to set Append

func (*UpdateEntityOptions) SetEntity 

func (_options *UpdateEntityOptions) SetEntity(entity string) *UpdateEntityOptions

SetEntity : Allow user to set Entity

func (*UpdateEntityOptions) SetHeaders 

func (options *UpdateEntityOptions) SetHeaders(param map[string]string) *UpdateEntityOptions

SetHeaders : Allow user to set Headers

func (*UpdateEntityOptions) SetIncludeAudit 

func (_options *UpdateEntityOptions) SetIncludeAudit(includeAudit bool) *UpdateEntityOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateEntityOptions) SetNewDescription 

func (_options *UpdateEntityOptions) SetNewDescription(newDescription string) *UpdateEntityOptions

SetNewDescription : Allow user to set NewDescription

func (*UpdateEntityOptions) SetNewEntity 

func (_options *UpdateEntityOptions) SetNewEntity(newEntity string) *UpdateEntityOptions

SetNewEntity : Allow user to set NewEntity

func (*UpdateEntityOptions) SetNewFuzzyMatch 

func (_options *UpdateEntityOptions) SetNewFuzzyMatch(newFuzzyMatch bool) *UpdateEntityOptions

SetNewFuzzyMatch : Allow user to set NewFuzzyMatch

func (*UpdateEntityOptions) SetNewMetadata 

func (_options *UpdateEntityOptions) SetNewMetadata(newMetadata map[string]interface{}) *UpdateEntityOptions

SetNewMetadata : Allow user to set NewMetadata

func (*UpdateEntityOptions) SetNewValues 

func (_options *UpdateEntityOptions) SetNewValues(newValues []CreateValue) *UpdateEntityOptions

SetNewValues : Allow user to set NewValues

func (*UpdateEntityOptions) SetWorkspaceID 

func (_options *UpdateEntityOptions) SetWorkspaceID(workspaceID string) *UpdateEntityOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateExampleOptions 

type UpdateExampleOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The text of the user input example.
	Text *string `json:"-" validate:"required,ne="`

	// The text of the user input example. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	NewText *string `json:"text,omitempty"`

	// An array of contextual entity mentions.
	NewMentions []Mention `json:"mentions,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateExampleOptions : The UpdateExample options.

func (*UpdateExampleOptions) SetHeaders 

func (options *UpdateExampleOptions) SetHeaders(param map[string]string) *UpdateExampleOptions

SetHeaders : Allow user to set Headers

func (*UpdateExampleOptions) SetIncludeAudit 

func (_options *UpdateExampleOptions) SetIncludeAudit(includeAudit bool) *UpdateExampleOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateExampleOptions) SetIntent 

func (_options *UpdateExampleOptions) SetIntent(intent string) *UpdateExampleOptions

SetIntent : Allow user to set Intent

func (*UpdateExampleOptions) SetNewMentions 

func (_options *UpdateExampleOptions) SetNewMentions(newMentions []Mention) *UpdateExampleOptions

SetNewMentions : Allow user to set NewMentions

func (*UpdateExampleOptions) SetNewText 

func (_options *UpdateExampleOptions) SetNewText(newText string) *UpdateExampleOptions

SetNewText : Allow user to set NewText

func (*UpdateExampleOptions) SetText 

func (_options *UpdateExampleOptions) SetText(text string) *UpdateExampleOptions

SetText : Allow user to set Text

func (*UpdateExampleOptions) SetWorkspaceID 

func (_options *UpdateExampleOptions) SetWorkspaceID(workspaceID string) *UpdateExampleOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateIntentOptions 

type UpdateIntentOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The intent name.
	Intent *string `json:"-" validate:"required,ne="`

	// The name of the intent. This string must conform to the following restrictions:
	// - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
	// - It cannot begin with the reserved prefix `sys-`.
	NewIntent *string `json:"intent,omitempty"`

	// The description of the intent. This string cannot contain carriage return, newline, or tab characters.
	NewDescription *string `json:"description,omitempty"`

	// An array of user input examples for the intent.
	NewExamples []Example `json:"examples,omitempty"`

	// Whether the new data is to be appended to the existing data in the object. If **append**=`false`, elements included
	// in the new data completely replace the corresponding existing elements, including all subelements. For example, if
	// the new data for the intent includes **examples** and **append**=`false`, all existing examples for the intent are
	// discarded and replaced with the new examples.
	//
	// If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new
	// data collide with existing elements, the update request fails.
	Append *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateIntentOptions : The UpdateIntent options.

func (*UpdateIntentOptions) SetAppend 

func (_options *UpdateIntentOptions) SetAppend(append bool) *UpdateIntentOptions

SetAppend : Allow user to set Append

func (*UpdateIntentOptions) SetHeaders 

func (options *UpdateIntentOptions) SetHeaders(param map[string]string) *UpdateIntentOptions

SetHeaders : Allow user to set Headers

func (*UpdateIntentOptions) SetIncludeAudit 

func (_options *UpdateIntentOptions) SetIncludeAudit(includeAudit bool) *UpdateIntentOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateIntentOptions) SetIntent 

func (_options *UpdateIntentOptions) SetIntent(intent string) *UpdateIntentOptions

SetIntent : Allow user to set Intent

func (*UpdateIntentOptions) SetNewDescription 

func (_options *UpdateIntentOptions) SetNewDescription(newDescription string) *UpdateIntentOptions

SetNewDescription : Allow user to set NewDescription

func (*UpdateIntentOptions) SetNewExamples 

func (_options *UpdateIntentOptions) SetNewExamples(newExamples []Example) *UpdateIntentOptions

SetNewExamples : Allow user to set NewExamples

func (*UpdateIntentOptions) SetNewIntent 

func (_options *UpdateIntentOptions) SetNewIntent(newIntent string) *UpdateIntentOptions

SetNewIntent : Allow user to set NewIntent

func (*UpdateIntentOptions) SetWorkspaceID 

func (_options *UpdateIntentOptions) SetWorkspaceID(workspaceID string) *UpdateIntentOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateSynonymOptions 

type UpdateSynonymOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The text of the synonym.
	Synonym *string `json:"-" validate:"required,ne="`

	// The text of the synonym. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	NewSynonym *string `json:"synonym,omitempty"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSynonymOptions : The UpdateSynonym options.

func (*UpdateSynonymOptions) SetEntity 

func (_options *UpdateSynonymOptions) SetEntity(entity string) *UpdateSynonymOptions

SetEntity : Allow user to set Entity

func (*UpdateSynonymOptions) SetHeaders 

func (options *UpdateSynonymOptions) SetHeaders(param map[string]string) *UpdateSynonymOptions

SetHeaders : Allow user to set Headers

func (*UpdateSynonymOptions) SetIncludeAudit 

func (_options *UpdateSynonymOptions) SetIncludeAudit(includeAudit bool) *UpdateSynonymOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateSynonymOptions) SetNewSynonym 

func (_options *UpdateSynonymOptions) SetNewSynonym(newSynonym string) *UpdateSynonymOptions

SetNewSynonym : Allow user to set NewSynonym

func (*UpdateSynonymOptions) SetSynonym 

func (_options *UpdateSynonymOptions) SetSynonym(synonym string) *UpdateSynonymOptions

SetSynonym : Allow user to set Synonym

func (*UpdateSynonymOptions) SetValue 

func (_options *UpdateSynonymOptions) SetValue(value string) *UpdateSynonymOptions

SetValue : Allow user to set Value

func (*UpdateSynonymOptions) SetWorkspaceID 

func (_options *UpdateSynonymOptions) SetWorkspaceID(workspaceID string) *UpdateSynonymOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateValueOptions 

type UpdateValueOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the entity.
	Entity *string `json:"-" validate:"required,ne="`

	// The text of the entity value.
	Value *string `json:"-" validate:"required,ne="`

	// The text of the entity value. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	NewValue *string `json:"value,omitempty"`

	// Any metadata related to the entity value.
	NewMetadata map[string]interface{} `json:"metadata,omitempty"`

	// Specifies the type of entity value.
	NewType *string `json:"type,omitempty"`

	// An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A synonym must conform to the following resrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	NewSynonyms []string `json:"synonyms,omitempty"`

	// An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).
	NewPatterns []string `json:"patterns,omitempty"`

	// Whether the new data is to be appended to the existing data in the entity value. If **append**=`false`, elements
	// included in the new data completely replace the corresponding existing elements, including all subelements. For
	// example, if the new data for the entity value includes **synonyms** and **append**=`false`, all existing synonyms
	// for the entity value are discarded and replaced with the new synonyms.
	//
	// If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new
	// data collide with existing elements, the update request fails.
	Append *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateValueOptions : The UpdateValue options.

func (*UpdateValueOptions) SetAppend 

func (_options *UpdateValueOptions) SetAppend(append bool) *UpdateValueOptions

SetAppend : Allow user to set Append

func (*UpdateValueOptions) SetEntity 

func (_options *UpdateValueOptions) SetEntity(entity string) *UpdateValueOptions

SetEntity : Allow user to set Entity

func (*UpdateValueOptions) SetHeaders 

func (options *UpdateValueOptions) SetHeaders(param map[string]string) *UpdateValueOptions

SetHeaders : Allow user to set Headers

func (*UpdateValueOptions) SetIncludeAudit 

func (_options *UpdateValueOptions) SetIncludeAudit(includeAudit bool) *UpdateValueOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateValueOptions) SetNewMetadata 

func (_options *UpdateValueOptions) SetNewMetadata(newMetadata map[string]interface{}) *UpdateValueOptions

SetNewMetadata : Allow user to set NewMetadata

func (*UpdateValueOptions) SetNewPatterns 

func (_options *UpdateValueOptions) SetNewPatterns(newPatterns []string) *UpdateValueOptions

SetNewPatterns : Allow user to set NewPatterns

func (*UpdateValueOptions) SetNewSynonyms 

func (_options *UpdateValueOptions) SetNewSynonyms(newSynonyms []string) *UpdateValueOptions

SetNewSynonyms : Allow user to set NewSynonyms

func (*UpdateValueOptions) SetNewType 

func (_options *UpdateValueOptions) SetNewType(newType string) *UpdateValueOptions

SetNewType : Allow user to set NewType

func (*UpdateValueOptions) SetNewValue 

func (_options *UpdateValueOptions) SetNewValue(newValue string) *UpdateValueOptions

SetNewValue : Allow user to set NewValue

func (*UpdateValueOptions) SetValue 

func (_options *UpdateValueOptions) SetValue(value string) *UpdateValueOptions

SetValue : Allow user to set Value

func (*UpdateValueOptions) SetWorkspaceID 

func (_options *UpdateValueOptions) SetWorkspaceID(workspaceID string) *UpdateValueOptions

SetWorkspaceID : Allow user to set WorkspaceID

type UpdateWorkspaceOptions 

type UpdateWorkspaceOptions struct {
	// Unique identifier of the workspace.
	WorkspaceID *string `json:"-" validate:"required,ne="`

	// The name of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Name *string `json:"name,omitempty"`

	// The description of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The language of the workspace.
	Language *string `json:"language,omitempty"`

	// An array of objects describing the dialog nodes in the workspace.
	DialogNodes []DialogNode `json:"dialog_nodes,omitempty"`

	// An array of objects defining input examples that have been marked as irrelevant input.
	Counterexamples []Counterexample `json:"counterexamples,omitempty"`

	// Any metadata related to the workspace.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for
	// general service improvements. `true` indicates that workspace training data is not to be used.
	LearningOptOut *bool `json:"learning_opt_out,omitempty"`

	// Global settings for the workspace.
	SystemSettings *WorkspaceSystemSettings `json:"system_settings,omitempty"`

	Webhooks []Webhook `json:"webhooks,omitempty"`

	// An array of objects defining the intents for the workspace.
	Intents []CreateIntent `json:"intents,omitempty"`

	// An array of objects describing the entities for the workspace.
	Entities []CreateEntity `json:"entities,omitempty"`

	// Whether the new data is to be appended to the existing data in the object. If **append**=`false`, elements included
	// in the new data completely replace the corresponding existing elements, including all subelements. For example, if
	// the new data for a workspace includes **entities** and **append**=`false`, all existing entities in the workspace
	// are discarded and replaced with the new entities.
	//
	// If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new
	// data collide with existing elements, the update request fails.
	Append *bool `json:"-"`

	// Whether to include the audit properties (`created` and `updated` timestamps) in the response.
	IncludeAudit *bool `json:"-"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateWorkspaceOptions : The UpdateWorkspace options.

func (*UpdateWorkspaceOptions) SetAppend 

func (_options *UpdateWorkspaceOptions) SetAppend(append bool) *UpdateWorkspaceOptions

SetAppend : Allow user to set Append

func (*UpdateWorkspaceOptions) SetCounterexamples 

func (_options *UpdateWorkspaceOptions) SetCounterexamples(counterexamples []Counterexample) *UpdateWorkspaceOptions

SetCounterexamples : Allow user to set Counterexamples

func (*UpdateWorkspaceOptions) SetDescription 

func (_options *UpdateWorkspaceOptions) SetDescription(description string) *UpdateWorkspaceOptions

SetDescription : Allow user to set Description

func (*UpdateWorkspaceOptions) SetDialogNodes 

func (_options *UpdateWorkspaceOptions) SetDialogNodes(dialogNodes []DialogNode) *UpdateWorkspaceOptions

SetDialogNodes : Allow user to set DialogNodes

func (*UpdateWorkspaceOptions) SetEntities 

func (_options *UpdateWorkspaceOptions) SetEntities(entities []CreateEntity) *UpdateWorkspaceOptions

SetEntities : Allow user to set Entities

func (*UpdateWorkspaceOptions) SetHeaders 

func (options *UpdateWorkspaceOptions) SetHeaders(param map[string]string) *UpdateWorkspaceOptions

SetHeaders : Allow user to set Headers

func (*UpdateWorkspaceOptions) SetIncludeAudit 

func (_options *UpdateWorkspaceOptions) SetIncludeAudit(includeAudit bool) *UpdateWorkspaceOptions

SetIncludeAudit : Allow user to set IncludeAudit

func (*UpdateWorkspaceOptions) SetIntents 

func (_options *UpdateWorkspaceOptions) SetIntents(intents []CreateIntent) *UpdateWorkspaceOptions

SetIntents : Allow user to set Intents

func (*UpdateWorkspaceOptions) SetLanguage 

func (_options *UpdateWorkspaceOptions) SetLanguage(language string) *UpdateWorkspaceOptions

SetLanguage : Allow user to set Language

func (*UpdateWorkspaceOptions) SetLearningOptOut 

func (_options *UpdateWorkspaceOptions) SetLearningOptOut(learningOptOut bool) *UpdateWorkspaceOptions

SetLearningOptOut : Allow user to set LearningOptOut

func (*UpdateWorkspaceOptions) SetMetadata 

func (_options *UpdateWorkspaceOptions) SetMetadata(metadata map[string]interface{}) *UpdateWorkspaceOptions

SetMetadata : Allow user to set Metadata

func (*UpdateWorkspaceOptions) SetName 

func (_options *UpdateWorkspaceOptions) SetName(name string) *UpdateWorkspaceOptions

SetName : Allow user to set Name

func (*UpdateWorkspaceOptions) SetSystemSettings 

func (_options *UpdateWorkspaceOptions) SetSystemSettings(systemSettings *WorkspaceSystemSettings) *UpdateWorkspaceOptions

SetSystemSettings : Allow user to set SystemSettings

func (*UpdateWorkspaceOptions) SetWebhooks 

func (_options *UpdateWorkspaceOptions) SetWebhooks(webhooks []Webhook) *UpdateWorkspaceOptions

SetWebhooks : Allow user to set Webhooks

func (*UpdateWorkspaceOptions) SetWorkspaceID 

func (_options *UpdateWorkspaceOptions) SetWorkspaceID(workspaceID string) *UpdateWorkspaceOptions

SetWorkspaceID : Allow user to set WorkspaceID

type Value 

type Value struct {
	// The text of the entity value. This string must conform to the following restrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Value *string `json:"value" validate:"required"`

	// Any metadata related to the entity value.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Specifies the type of entity value.
	Type *string `json:"type" validate:"required"`

	// An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A synonym must conform to the following resrictions:
	// - It cannot contain carriage return, newline, or tab characters.
	// - It cannot consist of only whitespace characters.
	Synonyms []string `json:"synonyms,omitempty"`

	// An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value
	// type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the
	// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).
	Patterns []string `json:"patterns,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

Value : Value struct

type ValueCollection 

type ValueCollection struct {
	// An array of entity values.
	Values []Value `json:"values" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

ValueCollection : ValueCollection struct

type Webhook 

type Webhook struct {
	// The URL for the external service or application to which you want to send HTTP POST requests.
	URL *string `json:"url" validate:"required"`

	// The name of the webhook. Currently, `main_webhook` is the only supported value.
	Name *string `json:"name" validate:"required"`

	// An optional array of HTTP headers to pass with the HTTP request.
	HeadersVar []WebhookHeader `json:"headers,omitempty"`
}

Webhook : A webhook that can be used by dialog nodes to make programmatic calls to an external function.

**Note:** Currently, only a single webhook named `main_webhook` is supported.

type WebhookHeader 

type WebhookHeader struct {
	// The name of an HTTP header (for example, `Authorization`).
	Name *string `json:"name" validate:"required"`

	// The value of an HTTP header.
	Value *string `json:"value" validate:"required"`
}

WebhookHeader : A key/value pair defining an HTTP header and a value.

type Workspace 

type Workspace struct {
	// The name of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Name *string `json:"name" validate:"required"`

	// The description of the workspace. This string cannot contain carriage return, newline, or tab characters.
	Description *string `json:"description,omitempty"`

	// The language of the workspace.
	Language *string `json:"language" validate:"required"`

	// The workspace ID of the workspace.
	WorkspaceID *string `json:"workspace_id" validate:"required"`

	// An array of objects describing the dialog nodes in the workspace.
	DialogNodes []DialogNode `json:"dialog_nodes,omitempty"`

	// An array of objects defining input examples that have been marked as irrelevant input.
	Counterexamples []Counterexample `json:"counterexamples,omitempty"`

	// The timestamp for creation of the object.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The timestamp for the most recent update to the object.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// Any metadata related to the workspace.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for
	// general service improvements. `true` indicates that workspace training data is not to be used.
	LearningOptOut *bool `json:"learning_opt_out" validate:"required"`

	// Global settings for the workspace.
	SystemSettings *WorkspaceSystemSettings `json:"system_settings,omitempty"`

	// The current status of the workspace.
	Status *string `json:"status,omitempty"`

	Webhooks []Webhook `json:"webhooks,omitempty"`

	// An array of intents.
	Intents []Intent `json:"intents,omitempty"`

	// An array of objects describing the entities for the workspace.
	Entities []Entity `json:"entities,omitempty"`
}

Workspace : Workspace struct

type WorkspaceCollection 

type WorkspaceCollection struct {
	// An array of objects describing the workspaces associated with the service instance.
	Workspaces []Workspace `json:"workspaces" validate:"required"`

	// The pagination data for the returned objects.
	Pagination *Pagination `json:"pagination" validate:"required"`
}

WorkspaceCollection : WorkspaceCollection struct

type WorkspaceSystemSettings 

type WorkspaceSystemSettings struct {
	// Workspace settings related to the Watson Assistant user interface.
	Tooling *WorkspaceSystemSettingsTooling `json:"tooling,omitempty"`

	// Workspace settings related to the disambiguation feature.
	Disambiguation *WorkspaceSystemSettingsDisambiguation `json:"disambiguation,omitempty"`

	// For internal use only.
	HumanAgentAssist map[string]interface{} `json:"human_agent_assist,omitempty"`

	// Whether spelling correction is enabled for the workspace.
	SpellingSuggestions *bool `json:"spelling_suggestions,omitempty"`

	// Whether autocorrection is enabled for the workspace. If spelling correction is enabled and this property is `false`,
	// any suggested corrections are returned in the **suggested_text** property of the message response. If this property
	// is `true`, any corrections are automatically applied to the user input, and the original text is returned in the
	// **original_text** property of the message response.
	SpellingAutoCorrect *bool `json:"spelling_auto_correct,omitempty"`

	// Workspace settings related to the behavior of system entities.
	SystemEntities *WorkspaceSystemSettingsSystemEntities `json:"system_entities,omitempty"`

	// Workspace settings related to detection of irrelevant input.
	OffTopic *WorkspaceSystemSettingsOffTopic `json:"off_topic,omitempty"`
}

WorkspaceSystemSettings : Global settings for the workspace.

type WorkspaceSystemSettingsDisambiguation 

type WorkspaceSystemSettingsDisambiguation struct {
	// The text of the introductory prompt that accompanies disambiguation options presented to the user.
	Prompt *string `json:"prompt,omitempty"`

	// The user-facing label for the option users can select if none of the suggested options is correct. If no value is
	// specified for this property, this option does not appear.
	NoneOfTheAbovePrompt *string `json:"none_of_the_above_prompt,omitempty"`

	// Whether the disambiguation feature is enabled for the workspace.
	Enabled *bool `json:"enabled,omitempty"`

	// The sensitivity of the disambiguation feature to intent detection uncertainty. Higher sensitivity means that the
	// disambiguation feature is triggered more often and includes more choices.
	Sensitivity *string `json:"sensitivity,omitempty"`

	// Whether the order in which disambiguation suggestions are presented should be randomized (but still influenced by
	// relative confidence).
	Randomize *bool `json:"randomize,omitempty"`

	// The maximum number of disambigation suggestions that can be included in a `suggestion` response.
	MaxSuggestions *int64 `json:"max_suggestions,omitempty"`

	// For internal use only.
	SuggestionTextPolicy *string `json:"suggestion_text_policy,omitempty"`
}

WorkspaceSystemSettingsDisambiguation : Workspace settings related to the disambiguation feature.

type WorkspaceSystemSettingsOffTopic 

type WorkspaceSystemSettingsOffTopic struct {
	// Whether enhanced irrelevance detection is enabled for the workspace.
	Enabled *bool `json:"enabled,omitempty"`
}

WorkspaceSystemSettingsOffTopic : Workspace settings related to detection of irrelevant input.

type WorkspaceSystemSettingsSystemEntities 

type WorkspaceSystemSettingsSystemEntities struct {
	// Whether the new system entities are enabled for the workspace.
	Enabled *bool `json:"enabled,omitempty"`
}

WorkspaceSystemSettingsSystemEntities : Workspace settings related to the behavior of system entities.

type WorkspaceSystemSettingsTooling 

type WorkspaceSystemSettingsTooling struct {
	// Whether the dialog JSON editor displays text responses within the `output.generic` object.
	StoreGenericResponses *bool `json:"store_generic_responses,omitempty"`
}

WorkspaceSystemSettingsTooling : Workspace settings related to the Watson Assistant user interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.