Structures

The following structures are available globally.

  • AgentAvailabilityMessage.

    See more

    Declaration

    Swift

    public struct AgentAvailabilityMessage : Codable, Equatable

  • BulkClassifyOutput.

    See more

    Declaration

    Swift

    public struct BulkClassifyOutput : Codable, Equatable

  • BulkClassifyResponse.

    See more

    Declaration

    Swift

    public struct BulkClassifyResponse : Codable, Equatable

  • The user input utterance to classify.

    See more

    Declaration

    Swift

    public struct BulkClassifyUtterance : Codable, Equatable

  • A recognized capture group for a pattern-based entity.

    See more

    Declaration

    Swift

    public struct CaptureGroup : Codable, Equatable

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

    See more

    Declaration

    Swift

    public struct ChannelTransferInfo : Codable, Equatable

  • 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.

    See more

    Declaration

    Swift

    public struct ChannelTransferTarget : Codable, Equatable

  • Information for transferring to the web chat integration.

    See more

    Declaration

    Swift

    public struct ChannelTransferTargetChat : Codable, Equatable

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

    See more

    Declaration

    Swift

    public struct Context : Codable, Equatable

  • Counterexample.

    See more

    Declaration

    Swift

    public struct Counterexample : Codable, Equatable

  • CounterexampleCollection.

    See more

    Declaration

    Swift

    public struct CounterexampleCollection : Codable, Equatable

  • CreateEntity.

    See more

    Declaration

    Swift

    public struct CreateEntity : Codable, Equatable

  • CreateIntent.

    See more

    Declaration

    Swift

    public struct CreateIntent : Codable, Equatable

  • CreateValue.

    See more

    Declaration

    Swift

    public struct CreateValue : Codable, Equatable

  • DialogNode.

    See more

    Declaration

    Swift

    public struct DialogNode : Codable, Equatable

  • DialogNodeAction.

    See more

    Declaration

    Swift

    public struct DialogNodeAction : Codable, Equatable

  • An array of dialog nodes.

    See more

    Declaration

    Swift

    public struct DialogNodeCollection : Codable, Equatable

  • The context for the dialog node.

    See more

    Declaration

    Swift

    public struct DialogNodeContext : Codable, Equatable

  • The next step to execute following this dialog node.

    See more

    Declaration

    Swift

    public struct DialogNodeNextStep : Codable, Equatable

  • The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

    See more

    Declaration

    Swift

    public struct DialogNodeOutput : Codable, Equatable

  • Routing or other contextual information to be used by target service desk systems.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputConnectToAgentTransferInfo : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeImage: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeImage : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeOption.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeOption: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeOption : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypePause.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypePause: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypePause : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeText.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeText: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeText : Codable, Equatable

  • DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined.

    Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined: DialogNodeOutputGeneric

    See more

    Declaration

    Swift

    public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined : Codable, Equatable

  • Options that modify how specified output is handled.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputModifiers : Codable, Equatable

  • DialogNodeOutputOptionsElement.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputOptionsElement : Codable, Equatable

  • An object defining the message input to be sent to the Watson Assistant service if the user selects the corresponding option.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputOptionsElementValue : Codable, Equatable

  • DialogNodeOutputTextValuesElement.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputTextValuesElement : Codable, Equatable

  • DialogNodeVisitedDetails.

    See more

    Declaration

    Swift

    public struct DialogNodeVisitedDetails : Codable, Equatable

  • DialogSuggestion.

    See more

    Declaration

    Swift

    public struct DialogSuggestion : Codable, Equatable

  • 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.

    See more

    Declaration

    Swift

    public struct DialogSuggestionValue : Codable, Equatable

  • Entity.

    See more

    Declaration

    Swift

    public struct Entity : Codable, Equatable

  • An array of objects describing the entities for the workspace.

    See more

    Declaration

    Swift

    public struct EntityCollection : Codable, Equatable

  • An object describing a contextual entity mention.

    See more

    Declaration

    Swift

    public struct EntityMention : Codable, Equatable

  • EntityMentionCollection.

    See more

    Declaration

    Swift

    public struct EntityMentionCollection : Codable, Equatable

  • Example.

    See more

    Declaration

    Swift

    public struct Example : Codable, Equatable

  • ExampleCollection.

    See more

    Declaration

    Swift

    public struct ExampleCollection : Codable, Equatable

  • Intent.

    See more

    Declaration

    Swift

    public struct Intent : Codable, Equatable

  • IntentCollection.

    See more

    Declaration

    Swift

    public struct IntentCollection : Codable, Equatable
  • Log

    Log.

    See more

    Declaration

    Swift

    public struct Log : Codable, Equatable

  • LogCollection.

    See more

    Declaration

    Swift

    public struct LogCollection : Codable, Equatable

  • Log message details.

    See more

    Declaration

    Swift

    public struct LogMessage : Codable, Equatable

  • An object that identifies the dialog element that generated the error message.

    See more

    Declaration

    Swift

    public struct LogMessageSource : Codable, Equatable

  • The pagination data for the returned objects.

    See more

    Declaration

    Swift

    public struct LogPagination : Codable, Equatable

  • A mention of a contextual entity.

    See more

    Declaration

    Swift

    public struct Mention : Codable, Equatable

  • Metadata related to the message.

    See more

    Declaration

    Swift

    public struct MessageContextMetadata : Codable, Equatable

  • An input object that includes the input text.

    See more

    Declaration

    Swift

    public struct MessageInput : Codable, Equatable

  • A request sent to the workspace, including the user input and context.

    See more

    Declaration

    Swift

    public struct MessageRequest : Codable, Equatable

  • The response sent by the workspace, including the output text, detected intents and entities, and context.

    See more

    Declaration

    Swift

    public struct MessageResponse : Codable, Equatable

  • An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

    See more

    Declaration

    Swift

    public struct OutputData : Codable, Equatable

  • The pagination data for the returned objects.

    See more

    Declaration

    Swift

    public struct Pagination : Codable, Equatable

  • ResponseGenericChannel.

    See more

    Declaration

    Swift

    public struct ResponseGenericChannel : Codable, Equatable

  • A term from the request that was identified as an entity.

    See more

    Declaration

    Swift

    public struct RuntimeEntity : Codable, Equatable

  • An alternative value for the recognized entity.

    See more

    Declaration

    Swift

    public struct RuntimeEntityAlternative : Codable, Equatable

  • RuntimeEntityInterpretation.

    See more

    Declaration

    Swift

    public struct RuntimeEntityInterpretation : Codable, Equatable

  • 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.

    See more

    Declaration

    Swift

    public struct RuntimeEntityRole : Codable, Equatable

  • An intent identified in the user input.

    See more

    Declaration

    Swift

    public struct RuntimeIntent : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeChannelTransfer: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeChannelTransfer : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeConnectToAgent: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeConnectToAgent : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeImage.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeImage: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeImage : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeOption.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeOption: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeOption : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypePause.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypePause: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypePause : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeSuggestion.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeSuggestion: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeSuggestion : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeText.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeText: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeText : Codable, Equatable

  • RuntimeResponseGenericRuntimeResponseTypeUserDefined.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeUserDefined: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeUserDefined : Codable, Equatable

  • Synonym.

    See more

    Declaration

    Swift

    public struct Synonym : Codable, Equatable

  • SynonymCollection.

    See more

    Declaration

    Swift

    public struct SynonymCollection : Codable, Equatable

  • Value.

    See more

    Declaration

    Swift

    public struct Value : Codable, Equatable

  • ValueCollection.

    See more

    Declaration

    Swift

    public struct ValueCollection : Codable, Equatable

  • 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.

    See more

    Declaration

    Swift

    public struct Webhook : Codable, Equatable

  • A key/value pair defining an HTTP header and a value.

    See more

    Declaration

    Swift

    public struct WebhookHeader : Codable, Equatable

  • Workspace.

    See more

    Declaration

    Swift

    public struct Workspace : Codable, Equatable

  • WorkspaceCollection.

    See more

    Declaration

    Swift

    public struct WorkspaceCollection : Codable, Equatable

  • Global settings for the workspace.

    See more

    Declaration

    Swift

    public struct WorkspaceSystemSettings : Codable, Equatable

  • Workspace settings related to the disambiguation feature.

    See more

    Declaration

    Swift

    public struct WorkspaceSystemSettingsDisambiguation : Codable, Equatable

  • Workspace settings related to detection of irrelevant input.

    See more

    Declaration

    Swift

    public struct WorkspaceSystemSettingsOffTopic : Codable, Equatable

  • Workspace settings related to the behavior of system entities.

    See more

    Declaration

    Swift

    public struct WorkspaceSystemSettingsSystemEntities : Codable, Equatable

  • Workspace settings related to the Watson Assistant user interface.

    See more

    Declaration

    Swift

    public struct WorkspaceSystemSettingsTooling : Codable, Equatable