Console
    Start free

    GeneratorSuggestion

    Suggestion generated using a Generator.

    JSON representation 
     { 
 "toolCallInfo" 
 : 
 [ 
 { 
 object (  ToolCallInfo 
 
) 
 } 
 ] 
 , 
 // Union field suggestion 
can be only one of the following: 
 "freeFormSuggestion" 
 : 
 { 
 object (  FreeFormSuggestion 
 
) 
 } 
 , 
 "summarySuggestion" 
 : 
 { 
 object (  SummarySuggestion 
 
) 
 } 
 , 
 "agentCoachingSuggestion" 
 : 
 { 
 object (  AgentCoachingSuggestion 
 
) 
 } 
 // End of list of possible types for union field suggestion 
. 
 }
    Fields
    toolCallInfo[]

    object ( ToolCallInfo )

    Optional. List of request and response for tool calls executed.

    Union field suggestion . The suggestion could be one of the many types suggestion can be only one of the following:
    freeFormSuggestion

    object ( FreeFormSuggestion )

    Optional. Free form suggestion.

    summarySuggestion

    object ( SummarySuggestion )

    Optional. Suggested summary.

    agentCoachingSuggestion

    object ( AgentCoachingSuggestion )

    Optional. Suggestion to coach the agent.

    FreeFormSuggestion

    Suggestion generated using free form generator.

    JSON representation 
     { 
 "response" 
 : 
 string 
 }
    Fields
    response

    string

    Required. Free form suggestion.

    SummarySuggestion

    Suggested summary of the conversation.

    JSON representation 
     { 
 "summarySections" 
 : 
 [ 
 { 
 object (  SummarySection 
 
) 
 } 
 ] 
 }
    Fields
    summarySections[]

    object ( SummarySection )

    Required. All the parts of generated summary.

    AgentCoachingSuggestion

    Suggestion for coaching agents.

    JSON representation 
     { 
 "applicableInstructions" 
 : 
 [ 
 { 
 object (  AgentCoachingInstruction 
 
) 
 } 
 ] 
 , 
 "agentActionSuggestions" 
 : 
 [ 
 { 
 object (  AgentActionSuggestion 
 
) 
 } 
 ] 
 , 
 "sampleResponses" 
 : 
 [ 
 { 
 object (  SampleResponse 
 
) 
 } 
 ] 
 }
    Fields
    applicableInstructions[]

    object ( AgentCoachingInstruction )

    Optional. Instructions applicable based on the current context.
    agentActionSuggestions[]

    object ( AgentActionSuggestion )

    Optional. Suggested actions for the agent to take.
    sampleResponses[]

    object ( SampleResponse )

    Optional. Sample response for the Agent.

    AgentActionSuggestion

    Actions suggested for the agent. This is based on applicable instructions.

    JSON representation 
     { 
 "agentAction" 
 : 
 string 
 , 
 "sources" 
 : 
 { 
 object (  Sources 
 
) 
 } 
 , 
 "duplicateCheckResult" 
 : 
 { 
 object (  DuplicateCheckResult 
 
) 
 } 
 }
    Fields
    agentAction

    string

    Optional. The suggested action for the agent.
    sources

    object ( Sources )

    Output only. Sources for the agent action suggestion.
    duplicateCheckResult

    object ( DuplicateCheckResult )

    Output only. Duplicate check result for the agent action suggestion.

    Sources

    Sources for the suggestion.

    JSON representation 
     { 
 "instructionIndexes" 
 : 
 [ 
 integer 
 ] 
 }
    Fields
    instructionIndexes[]

    integer

    Output only. Source instruction indexes for the suggestion. This is the index of the applicableInstructions field.

    DuplicateCheckResult

    Duplication check for the suggestion.

    JSON representation 
     { 
 "duplicateSuggestions" 
 : 
 [ 
 { 
 object (  DuplicateSuggestion 
 
) 
 } 
 ] 
 }
    Fields
    duplicateSuggestions[]

    object ( DuplicateSuggestion )

    Output only. The duplicate suggestions.

    DuplicateSuggestion

    The duplicate suggestion details. Keeping answerRecord and sources together as they are identifiers for duplicate suggestions.

    JSON representation 
     { 
 "answerRecord" 
 : 
 string 
 , 
 "sources" 
 : 
 { 
 object (  Sources 
 
) 
 } 
 , 
 "suggestionIndex" 
 : 
 integer 
 , 
 "similarityScore" 
 : 
 number 
 }
    Fields
    answerRecord

    string

    Output only. The answer record id of the past duplicate suggestion.
    sources

    object ( Sources )

    Output only. Sources for the suggestion.
    suggestionIndex

    integer

    Output only. The index of the duplicate suggestion in the past suggestion list.
    similarityScore

    number

    Output only. The similarity score of between the past and current suggestion.

    SampleResponse

    Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.

    JSON representation 
     { 
 "responseText" 
 : 
 string 
 , 
 "sources" 
 : 
 { 
 object (  Sources 
 
) 
 } 
 , 
 "duplicateCheckResult" 
 : 
 { 
 object (  DuplicateCheckResult 
 
) 
 } 
 }
    Fields
    responseText

    string

    Optional. Sample response for Agent in text.
    sources

    object ( Sources )

    Output only. Sources for the Sample Response.
    duplicateCheckResult

    object ( DuplicateCheckResult )

    Output only. Duplicate check result for the sample response.

    ToolCallInfo

    Request and response for a tool call.

    JSON representation 
     { 
 "toolCall" 
 : 
 { 
 object (  ToolCall 
 
) 
 } 
 , 
 "toolCallResult" 
 : 
 { 
 object (  ToolCallResult 
 
) 
 } 
 }
    Fields
    toolCall

    object ( ToolCall )

    Required. Request for a tool call.
    toolCallResult

    object ( ToolCallResult )

    Required. Response for a tool call.

    ToolCall

    Represents a call of a specific tool's action with the specified inputs.

    JSON representation 
     { 
 "toolDisplayName" 
 : 
 string 
 , 
 "toolDisplayDetails" 
 : 
 string 
 , 
 "action" 
 : 
 string 
 , 
 "inputParameters" 
 : 
 { 
 object 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "answerRecord" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 // Union field source 
can be only one of the following: 
 "tool" 
 : 
 string 
 // End of list of possible types for union field source 
. 
 }
    Fields
    toolDisplayName

    string

    Optional. A human readable short name of the tool, to be shown on the UI.

    toolDisplayDetails

    string

    Optional. A human readable description of the tool.

    action

    string

    Optional. The name of the tool's action associated with this call.

    inputParameters

    object ( Struct format)

    Optional. The action's input parameters.

    createTime

    string ( Timestamp format)

    Output only. Create time of the tool call.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    answerRecord

    string

    Optional. The answer record associated with this tool call.

    state

    enum ( State )

    Output only. State of the tool call

    Union field source . Specifies the source of this tool call. source can be only one of the following:
    tool

    string

    Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID> .

    State

    Tool call states.

    Enums
    STATE_UNSPECIFIED Default value.
    TRIGGERED The tool call has been triggered.
    NEEDS_CONFIRMATION The tool call requires confirmation from a human.

    ToolCallResult

    The result of calling a tool's action.

    JSON representation 
     { 
 "action" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "answerRecord" 
 : 
 string 
 , 
 // Union field source 
can be only one of the following: 
 "tool" 
 : 
 string 
 // End of list of possible types for union field source 
. 
 // Union field result 
can be only one of the following: 
 "error" 
 : 
 { 
 object (  Error 
 
) 
 } 
 , 
 "rawContent" 
 : 
 string 
 , 
 "content" 
 : 
 string 
 // End of list of possible types for union field result 
. 
 }
    Fields
    action

    string

    Optional. The name of the tool's action associated with this call.

    createTime

    string ( Timestamp format)

    Output only. Create time of the tool call result.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    answerRecord

    string

    Optional. The answer record associated with this tool call result.

    Union field source . Specifies the source of this tool call. source can be only one of the following:
    tool

    string

    Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID> .

    Union field result . The tool call's result. result can be only one of the following:
    error

    object ( Error )

    The tool call's error.

    rawContent

    string ( bytes format)

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

    A base64-encoded string.

    content

    string

    Only populated if the response content is utf-8 encoded.

    Error

    An error produced by the tool call.

    JSON representation 
     { 
 "message" 
 : 
 string 
 }
    Fields
    message

    string

    Optional. The error message of the function.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: