Class: Aws::QBusiness::EventStreams::ChatInputStream

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChatInputStream

Returns a new instance of ChatInputStream.



14
15
16
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 14

def initialize
  @event_emitter = Aws::EventEmitter.new
end

Instance Method Details

#signal_action_execution_event_event(params = {}) ⇒ Object

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :plugin_id (String) —

    The identifier of the plugin for which the action is being requested.

  • :payload (Hash<String, Types::ActionExecutionPayloadField>) —

    A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

  • :payload_field_name_separator (String) —

    A string used to retain information about the hierarchical contexts within a action execution event payload.



86
87
88
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 86

def signal_action_execution_event_event(params = {})
  @event_emitter.emit(:action_execution_event, params)
end

#signal_attachment_event_event(params = {}) ⇒ Object

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):



71
72
73
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 71

def signal_attachment_event_event(params = {})
  @event_emitter.emit(:attachment_event, params)
end

#signal_auth_challenge_response_event_event(params = {}) ⇒ Object

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :response_map (Hash<String, String>) —

    The mapping of key-value pairs in an authentication challenge response.



99
100
101
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 99

def signal_auth_challenge_response_event_event(params = {})
  @event_emitter.emit(:auth_challenge_response_event, params)
end

#signal_configuration_event_event(params = {}) ⇒ Object

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :chat_mode (String) —

    The chat modes available to an Amazon Q Business end user.

    • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

    • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

    • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

    For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

  • :chat_mode_configuration (Types::ChatModeConfiguration) —

    Configuration information for Amazon Q Business conversation modes.

    For more information, see Admin controls and guardrails and Conversation settings.

  • :attribute_filter (Types::AttributeFilter) —

    Enables filtering of responses based on document attributes or metadata fields.



57
58
59
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 57

def signal_configuration_event_event(params = {})
  @event_emitter.emit(:configuration_event, params)
end

#signal_end_of_input_event_event(params = {}) ⇒ Object

This event has no members



91
92
93
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 91

def signal_end_of_input_event_event(params = {})
  @event_emitter.emit(:end_of_input_event, params)
end

#signal_end_stream ⇒ Object 



103
104
105
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 103

def signal_end_stream
  @event_emitter.emit(:end_stream, {})
end

#signal_text_event_event(params = {}) ⇒ Object

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :user_message (String) —

    A user message in a text message input event.



64
65
66
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/event_streams.rb', line 64

def signal_text_event_event(params = {})
  @event_emitter.emit(:text_event, params)
end