Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ToolCallResult (v1.15.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ToolCallResult.

The result of calling a tool's action.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String
Returns
  • (::String) — Optional. The name of the tool's action associated with this call.

#action=

def action=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the tool's action associated with this call.
Returns
  • (::String) — Optional. The name of the tool's action associated with this call.

#answer_record

def answer_record() -> ::String
Returns
  • (::String) — Optional. The answer record associated with this tool call result.

#answer_record=

def answer_record=(value) -> ::String
Parameter
  • value (::String) — Optional. The answer record associated with this tool call result.
Returns
  • (::String) — Optional. The answer record associated with this tool call result.

#ces_app

def ces_app() -> ::String
Returns
  • (::String) — Optional. CES app name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>.

    Note: The following fields are mutually exclusive: ces_app, tool, ces_toolset, ces_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ces_app=

def ces_app=(value) -> ::String
Parameter
  • value (::String) — Optional. CES app name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>.

    Note: The following fields are mutually exclusive: ces_app, tool, ces_toolset, ces_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. CES app name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>.

    Note: The following fields are mutually exclusive: ces_app, tool, ces_toolset, ces_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ces_tool

def ces_tool() -> ::String
Returns
  • (::String) — Optional. CES tool name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: ces_tool, tool, ces_toolset, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ces_tool=

def ces_tool=(value) -> ::String
Parameter
  • value (::String) — Optional. CES tool name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: ces_tool, tool, ces_toolset, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. CES tool name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: ces_tool, tool, ces_toolset, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ces_toolset

def ces_toolset() -> ::String
Returns
  • (::String) — Optional. CES toolset name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>.

    Note: The following fields are mutually exclusive: ces_toolset, tool, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ces_toolset=

def ces_toolset=(value) -> ::String
Parameter
  • value (::String) — Optional. CES toolset name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>.

    Note: The following fields are mutually exclusive: ces_toolset, tool, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. CES toolset name for this call. Format: projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>.

    Note: The following fields are mutually exclusive: ces_toolset, tool, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

#content

def content() -> ::String
Returns
  • (::String) — Only populated if the response content is utf-8 encoded.

    Note: The following fields are mutually exclusive: content, error, raw_content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#content=

def content=(value) -> ::String
Parameter
  • value (::String) — Only populated if the response content is utf-8 encoded.

    Note: The following fields are mutually exclusive: content, error, raw_content. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Only populated if the response content is utf-8 encoded.

    Note: The following fields are mutually exclusive: content, error, raw_content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_time

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

#error

def error() -> ::Google::Cloud::Dialogflow::V2::ToolCallResult::Error
Returns

#error=

def error=(value) -> ::Google::Cloud::Dialogflow::V2::ToolCallResult::Error
Parameter
Returns

#raw_content

def raw_content() -> ::String
Returns
  • (::String) — Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).

    Note: The following fields are mutually exclusive: raw_content, error, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#raw_content=

def raw_content=(value) -> ::String
Parameter
  • value (::String) — Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).

    Note: The following fields are mutually exclusive: raw_content, error, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).

    Note: The following fields are mutually exclusive: raw_content, error, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool

def tool() -> ::String
Returns
  • (::String) — Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: tool, ces_toolset, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool=

def tool=(value) -> ::String
Parameter
  • value (::String) — Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: tool, ces_toolset, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>.

    Note: The following fields are mutually exclusive: tool, ces_toolset, ces_tool, ces_app. If a field in that set is populated, all other fields in the set will automatically be cleared.