Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::SessionOutput (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::SessionOutput.

Output for the session.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audio

def audio() -> ::String
Returns
  • (::String) — Output audio from the CES agent.

    Note: The following fields are mutually exclusive: audio, text, tool_calls, citations, google_search_suggestions, end_session, payload. 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) — Output audio from the CES agent.

    Note: The following fields are mutually exclusive: audio, text, tool_calls, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Output audio from the CES agent.

    Note: The following fields are mutually exclusive: audio, text, tool_calls, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#citations

def citations() -> ::Google::Cloud::Ces::V1::Citations
Returns
  • (::Google::Cloud::Ces::V1::Citations) — Citations that provide the source information for the agent's generated text.

    Note: The following fields are mutually exclusive: citations, text, audio, tool_calls, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#citations=

def citations=(value) -> ::Google::Cloud::Ces::V1::Citations
Parameter
  • value (::Google::Cloud::Ces::V1::Citations) — Citations that provide the source information for the agent's generated text.

    Note: The following fields are mutually exclusive: citations, text, audio, tool_calls, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1::Citations) — Citations that provide the source information for the agent's generated text.

    Note: The following fields are mutually exclusive: citations, text, audio, tool_calls, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#diagnostic_info

def diagnostic_info() -> ::Google::Cloud::Ces::V1::SessionOutput::DiagnosticInfo
Returns

#diagnostic_info=

def diagnostic_info=(value) -> ::Google::Cloud::Ces::V1::SessionOutput::DiagnosticInfo
Parameter
Returns

#end_session

def end_session() -> ::Google::Cloud::Ces::V1::EndSession
Returns
  • (::Google::Cloud::Ces::V1::EndSession) — Indicates the session has ended.

    Note: The following fields are mutually exclusive: end_session, text, audio, tool_calls, citations, google_search_suggestions, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#end_session=

def end_session=(value) -> ::Google::Cloud::Ces::V1::EndSession
Parameter
  • value (::Google::Cloud::Ces::V1::EndSession) — Indicates the session has ended.

    Note: The following fields are mutually exclusive: end_session, text, audio, tool_calls, citations, google_search_suggestions, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1::EndSession) — Indicates the session has ended.

    Note: The following fields are mutually exclusive: end_session, text, audio, tool_calls, citations, google_search_suggestions, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#google_search_suggestions

def google_search_suggestions() -> ::Google::Cloud::Ces::V1::GoogleSearchSuggestions
Returns
  • (::Google::Cloud::Ces::V1::GoogleSearchSuggestions) — The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

    Note: The following fields are mutually exclusive: google_search_suggestions, text, audio, tool_calls, citations, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#google_search_suggestions=

def google_search_suggestions=(value) -> ::Google::Cloud::Ces::V1::GoogleSearchSuggestions
Parameter
  • value (::Google::Cloud::Ces::V1::GoogleSearchSuggestions) — The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

    Note: The following fields are mutually exclusive: google_search_suggestions, text, audio, tool_calls, citations, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1::GoogleSearchSuggestions) — The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

    Note: The following fields are mutually exclusive: google_search_suggestions, text, audio, tool_calls, citations, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#payload

def payload() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Custom payload with structured output from the CES agent.

    Note: The following fields are mutually exclusive: payload, text, audio, tool_calls, citations, google_search_suggestions, end_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#payload=

def payload=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Custom payload with structured output from the CES agent.

    Note: The following fields are mutually exclusive: payload, text, audio, tool_calls, citations, google_search_suggestions, end_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — Custom payload with structured output from the CES agent.

    Note: The following fields are mutually exclusive: payload, text, audio, tool_calls, citations, google_search_suggestions, end_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::String
Returns
  • (::String) — Output text from the CES agent.

    Note: The following fields are mutually exclusive: text, audio, tool_calls, citations, google_search_suggestions, end_session, payload. 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) — Output text from the CES agent.

    Note: The following fields are mutually exclusive: text, audio, tool_calls, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Output text from the CES agent.

    Note: The following fields are mutually exclusive: text, audio, tool_calls, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_calls

def tool_calls() -> ::Google::Cloud::Ces::V1::ToolCalls
Returns
  • (::Google::Cloud::Ces::V1::ToolCalls) — Request for the client to execute the tools.

    Note: The following fields are mutually exclusive: tool_calls, text, audio, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool_calls=

def tool_calls=(value) -> ::Google::Cloud::Ces::V1::ToolCalls
Parameter
  • value (::Google::Cloud::Ces::V1::ToolCalls) — Request for the client to execute the tools.

    Note: The following fields are mutually exclusive: tool_calls, text, audio, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1::ToolCalls) — Request for the client to execute the tools.

    Note: The following fields are mutually exclusive: tool_calls, text, audio, citations, google_search_suggestions, end_session, payload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#turn_completed

def turn_completed() -> ::Boolean
Returns
  • (::Boolean) — If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.

#turn_completed=

def turn_completed=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.
Returns
  • (::Boolean) — If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.

#turn_index

def turn_index() -> ::Integer
Returns
  • (::Integer) — Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.

#turn_index=

def turn_index=(value) -> ::Integer
Parameter
  • value (::Integer) — Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
Returns
  • (::Integer) — Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.