Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::SessionInput (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::SessionInput.

Input for the session.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audio

def audio() -> ::String
Returns
  • (::String) — Optional. Audio data from the end user.

    Note: The following fields are mutually exclusive: audio, text, dtmf, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#audio=

def audio=(value) -> ::String
Parameter
  • value (::String) — Optional. Audio data from the end user.

    Note: The following fields are mutually exclusive: audio, text, dtmf, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Audio data from the end user.

    Note: The following fields are mutually exclusive: audio, text, dtmf, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#blob

def blob() -> ::Google::Cloud::Ces::V1beta::Blob
Returns
  • (::Google::Cloud::Ces::V1beta::Blob) — Optional. Blob data from the end user.

    Note: The following fields are mutually exclusive: blob, text, dtmf, audio, tool_responses, image, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#blob=

def blob=(value) -> ::Google::Cloud::Ces::V1beta::Blob
Parameter
  • value (::Google::Cloud::Ces::V1beta::Blob) — Optional. Blob data from the end user.

    Note: The following fields are mutually exclusive: blob, text, dtmf, audio, tool_responses, image, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::Blob) — Optional. Blob data from the end user.

    Note: The following fields are mutually exclusive: blob, text, dtmf, audio, tool_responses, image, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dtmf

def dtmf() -> ::String
Returns
  • (::String) — Optional. DTMF digits from the end user.

    Note: The following fields are mutually exclusive: dtmf, text, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dtmf=

def dtmf=(value) -> ::String
Parameter
  • value (::String) — Optional. DTMF digits from the end user.

    Note: The following fields are mutually exclusive: dtmf, text, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. DTMF digits from the end user.

    Note: The following fields are mutually exclusive: dtmf, text, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#event

def event() -> ::Google::Cloud::Ces::V1beta::Event
Returns
  • (::Google::Cloud::Ces::V1beta::Event) — Optional. Event input.

    Note: The following fields are mutually exclusive: event, text, dtmf, audio, tool_responses, image, blob, variables. If a field in that set is populated, all other fields in the set will automatically be cleared.

#event=

def event=(value) -> ::Google::Cloud::Ces::V1beta::Event
Parameter
  • value (::Google::Cloud::Ces::V1beta::Event) — Optional. Event input.

    Note: The following fields are mutually exclusive: event, text, dtmf, audio, tool_responses, image, blob, variables. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::Event) — Optional. Event input.

    Note: The following fields are mutually exclusive: event, text, dtmf, audio, tool_responses, image, blob, variables. If a field in that set is populated, all other fields in the set will automatically be cleared.

#image

def image() -> ::Google::Cloud::Ces::V1beta::Image
Returns
  • (::Google::Cloud::Ces::V1beta::Image) — Optional. Image data from the end user.

    Note: The following fields are mutually exclusive: image, text, dtmf, audio, tool_responses, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#image=

def image=(value) -> ::Google::Cloud::Ces::V1beta::Image
Parameter
  • value (::Google::Cloud::Ces::V1beta::Image) — Optional. Image data from the end user.

    Note: The following fields are mutually exclusive: image, text, dtmf, audio, tool_responses, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::Image) — Optional. Image data from the end user.

    Note: The following fields are mutually exclusive: image, text, dtmf, audio, tool_responses, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::String
Returns
  • (::String) — Optional. Text data from the end user.

    Note: The following fields are mutually exclusive: text, dtmf, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text=

def text=(value) -> ::String
Parameter
  • value (::String) — Optional. Text data from the end user.

    Note: The following fields are mutually exclusive: text, dtmf, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. Text data from the end user.

    Note: The following fields are mutually exclusive: text, dtmf, audio, tool_responses, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_responses

def tool_responses() -> ::Google::Cloud::Ces::V1beta::ToolResponses
Returns
  • (::Google::Cloud::Ces::V1beta::ToolResponses) — Optional. Execution results for the tool calls from the client.

    Note: The following fields are mutually exclusive: tool_responses, text, dtmf, audio, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_responses=

def tool_responses=(value) -> ::Google::Cloud::Ces::V1beta::ToolResponses
Parameter
  • value (::Google::Cloud::Ces::V1beta::ToolResponses) — Optional. Execution results for the tool calls from the client.

    Note: The following fields are mutually exclusive: tool_responses, text, dtmf, audio, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::ToolResponses) — Optional. Execution results for the tool calls from the client.

    Note: The following fields are mutually exclusive: tool_responses, text, dtmf, audio, image, blob, variables, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#variables

def variables() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

    Unrecognized variables will still be sent to the [Dialogflow agent][Agent.RemoteDialogflowAgent] as additional session parameters.

    Note: The following fields are mutually exclusive: variables, text, dtmf, audio, tool_responses, image, blob, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#variables=

def variables=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

    Unrecognized variables will still be sent to the [Dialogflow agent][Agent.RemoteDialogflowAgent] as additional session parameters.

    Note: The following fields are mutually exclusive: variables, text, dtmf, audio, tool_responses, image, blob, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

    Unrecognized variables will still be sent to the [Dialogflow agent][Agent.RemoteDialogflowAgent] as additional session parameters.

    Note: The following fields are mutually exclusive: variables, text, dtmf, audio, tool_responses, image, blob, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#will_continue

def will_continue() -> ::Boolean
Returns
  • (::Boolean) — Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session.

    When set to true, the agent defers processing until it receives a subsequent message where will_continue is false, or until the system detects an endpoint in the audio input.

    NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.

#will_continue=

def will_continue=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session.

    When set to true, the agent defers processing until it receives a subsequent message where will_continue is false, or until the system detects an endpoint in the audio input.

    NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.

Returns
  • (::Boolean) — Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session.

    When set to true, the agent defers processing until it receives a subsequent message where will_continue is false, or until the system detects an endpoint in the audio input.

    NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.