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

  • CaptureGroup.

    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

  • Dialog log message details.

    See more

    Declaration

    Swift

    public struct DialogLogMessage : Codable, Equatable

  • DialogNodeAction.

    See more

    Declaration

    Swift

    public struct DialogNodeAction : Codable, Equatable

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

    See more

    Declaration

    Swift

    public struct DialogNodeOutputConnectToAgentTransferInfo : Codable, Equatable

  • DialogNodeOutputOptionsElement.

    See more

    Declaration

    Swift

    public struct DialogNodeOutputOptionsElement : Codable, Equatable

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

    See more

    Declaration

    Swift

    public struct DialogNodeOutputOptionsElementValue : Codable, Equatable

  • DialogNodesVisited.

    See more

    Declaration

    Swift

    public struct DialogNodesVisited : Codable, Equatable

  • DialogSuggestion.

    See more

    Declaration

    Swift

    public struct DialogSuggestion : Codable, Equatable

  • An object defining the message input to be sent to the assistant if the user selects the corresponding disambiguation option.

    See more

    Declaration

    Swift

    public struct DialogSuggestionValue : Codable, Equatable
  • Log

    Log.

    See more

    Declaration

    Swift

    public struct Log : Codable, Equatable

  • LogCollection.

    See more

    Declaration

    Swift

    public struct LogCollection : Codable, Equatable

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

    Enums with an associated value of LogMessageSourceAction: LogMessageSource

    See more

    Declaration

    Swift

    public struct LogMessageSourceAction : Codable, Equatable

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

    Enums with an associated value of LogMessageSourceDialogNode: LogMessageSource

    See more

    Declaration

    Swift

    public struct LogMessageSourceDialogNode : Codable, Equatable

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

    Enums with an associated value of LogMessageSourceHandler: LogMessageSource

    See more

    Declaration

    Swift

    public struct LogMessageSourceHandler : Codable, Equatable

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

    Enums with an associated value of LogMessageSourceStep: LogMessageSource

    See more

    Declaration

    Swift

    public struct LogMessageSourceStep : Codable, Equatable

  • The pagination data for the returned objects.

    See more

    Declaration

    Swift

    public struct LogPagination : Codable, Equatable

  • MessageContext.

    See more

    Declaration

    Swift

    public struct MessageContext : Codable, Equatable

  • Session context data that is shared by all skills used by the Assistant.

    See more

    Declaration

    Swift

    public struct MessageContextGlobal : Codable, Equatable

  • Session context data that is shared by all skills used by the Assistant.

    See more

    Declaration

    Swift

    public struct MessageContextGlobalStateless : Codable, Equatable

  • Built-in system properties that apply to all skills used by the assistant.

    See more

    Declaration

    Swift

    public struct MessageContextGlobalSystem : Codable, Equatable

  • Contains information specific to a particular skill used by the Assistant. The property name must be the same as the name of the skill (for example, main skill).

    See more

    Declaration

    Swift

    public struct MessageContextSkill : Codable, Equatable

  • System context data used by the skill.

    See more

    Declaration

    Swift

    public struct MessageContextSkillSystem : Codable, Equatable

  • MessageContextStateless.

    See more

    Declaration

    Swift

    public struct MessageContextStateless : Codable, Equatable

  • An input object that includes the input text.

    See more

    Declaration

    Swift

    public struct MessageInput : Codable, Equatable

  • Optional properties that control how the assistant responds.

    See more

    Declaration

    Swift

    public struct MessageInputOptions : Codable, Equatable

  • Spelling correction options for the message. Any options specified on an individual message override the settings configured for the skill.

    See more

    Declaration

    Swift

    public struct MessageInputOptionsSpelling : Codable, Equatable

  • Optional properties that control how the assistant responds.

    See more

    Declaration

    Swift

    public struct MessageInputOptionsStateless : Codable, Equatable

  • An input object that includes the input text.

    See more

    Declaration

    Swift

    public struct MessageInputStateless : Codable, Equatable

  • Assistant output to be rendered or processed by the client.

    See more

    Declaration

    Swift

    public struct MessageOutput : Codable, Equatable

  • Additional detailed information about a message response and how it was generated.

    See more

    Declaration

    Swift

    public struct MessageOutputDebug : Codable, Equatable

  • Properties describing any spelling corrections in the user input that was received.

    See more

    Declaration

    Swift

    public struct MessageOutputSpelling : Codable, Equatable

  • A stateful message request formatted for the Watson Assistant service.

    See more

    Declaration

    Swift

    public struct MessageRequest : Codable, Equatable

  • A response from the Watson Assistant service.

    See more

    Declaration

    Swift

    public struct MessageResponse : Codable, Equatable

  • A stateless response from the Watson Assistant service.

    See more

    Declaration

    Swift

    public struct MessageResponseStateless : Codable, Equatable

  • ResponseGenericChannel.

    See more

    Declaration

    Swift

    public struct ResponseGenericChannel : Codable, Equatable

  • The entity value that was recognized in the user input.

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

    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

  • RuntimeResponseGenericRuntimeResponseTypeSearch.

    Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeSearch: RuntimeResponseGeneric

    See more

    Declaration

    Swift

    public struct RuntimeResponseGenericRuntimeResponseTypeSearch : 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

  • SearchResult.

    See more

    Declaration

    Swift

    public struct SearchResult : Codable, Equatable

  • An object specifing a segment of text that was identified as a direct answer to the search query.

    See more

    Declaration

    Swift

    public struct SearchResultAnswer : Codable, Equatable

  • An object containing segments of text from search results with query-matching text highlighted using HTML <em> tags.

    See more

    Declaration

    Swift

    public struct SearchResultHighlight : Codable, Equatable

  • An object containing search result metadata from the Discovery service.

    See more

    Declaration

    Swift

    public struct SearchResultMetadata : Codable, Equatable

  • SessionResponse.

    See more

    Declaration

    Swift

    public struct SessionResponse : Codable, Equatable