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

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

An example represents a sample conversation between the user and the agent(s).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Human-readable description of the example.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Human-readable description of the example.
Returns
  • (::String) — Optional. Human-readable description of the example.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. Display name of the example.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. Display name of the example.
Returns
  • (::String) — Required. Display name of the example.

#entry_agent

def entry_agent() -> ::String
Returns
  • (::String) — Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#entry_agent=

def entry_agent=(value) -> ::String
Parameter
  • value (::String) — Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
Returns
  • (::String) — Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

#etag

def etag() -> ::String
Returns
  • (::String) — Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
Returns
  • (::String) — Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

#invalid

def invalid() -> ::Boolean
Returns
  • (::Boolean) — Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.

#messages

def messages() -> ::Array<::Google::Cloud::Ces::V1::Message>
Returns

#messages=

def messages=(value) -> ::Array<::Google::Cloud::Ces::V1::Message>
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
Returns
  • (::String) — Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns