Class protos.google.cloud.ces.v1.Agent (0.3.0)

Represents an Agent.

Package

@google-cloud/ces

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IAgent 
 ); 
 

Constructs a new Agent.

Parameter
Name
Description
properties
IAgent

Properties to set

Properties

afterAgentCallbacks

  public 
  
 afterAgentCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent afterAgentCallbacks.

afterModelCallbacks

  public 
  
 afterModelCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent afterModelCallbacks.

afterToolCallbacks

  public 
  
 afterToolCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent afterToolCallbacks.

agentType

  public 
  
 agentType 
 ?: 
  
 ( 
 "llmAgent" 
 | 
 "remoteDialogflowAgent" 
 ); 
 

Agent agentType.

beforeAgentCallbacks

  public 
  
 beforeAgentCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent beforeAgentCallbacks.

beforeModelCallbacks

  public 
  
 beforeModelCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent beforeModelCallbacks.

beforeToolCallbacks

  public 
  
 beforeToolCallbacks 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ICallback 
 []; 
 

Agent beforeToolCallbacks.

childAgents

  public 
  
 childAgents 
 : 
  
 string 
 []; 
 

Agent childAgents.

createTime

  public 
  
 createTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Agent createTime.

description

  public 
  
 description 
 : 
  
 string 
 ; 
 

Agent description.

displayName

  public 
  
 displayName 
 : 
  
 string 
 ; 
 

Agent displayName.

etag

  public 
  
 etag 
 : 
  
 string 
 ; 
 

Agent etag.

generatedSummary

  public 
  
 generatedSummary 
 : 
  
 string 
 ; 
 

Agent generatedSummary.

guardrails

  public 
  
 guardrails 
 : 
  
 string 
 []; 
 

Agent guardrails.

instruction

  public 
  
 instruction 
 : 
  
 string 
 ; 
 

Agent instruction.

llmAgent

  public 
  
 llmAgent 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 . 
 ILlmAgent 
 | 
 null 
 ); 
 

Agent llmAgent.

modelSettings

  public 
  
 modelSettings 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IModelSettings 
 | 
 null 
 ); 
 

Agent modelSettings.

name

  public 
  
 name 
 : 
  
 string 
 ; 
 

Agent name.

remoteDialogflowAgent

  public 
  
 remoteDialogflowAgent 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 . 
 IRemoteDialogflowAgent 
 | 
 null 
 ); 
 

Agent remoteDialogflowAgent.

tools

  public 
  
 tools 
 : 
  
 string 
 []; 
 

Agent tools.

toolsets

  public 
  
 toolsets 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 . 
 IAgentToolset 
 []; 
 

Agent toolsets.

transferRules

  public 
  
 transferRules 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 ITransferRule 
 []; 
 

Agent transferRules.

updateTime

  public 
  
 updateTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Agent updateTime.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IAgent 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 ; 
 

Creates a new Agent instance using the specified properties.

Parameter
Name
Description
properties
IAgent

Properties to set

Returns
Type
Description

Agent instance

decode(reader, length)

  public 
  
 static 
  
 decode 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 ), 
  
 length 
 ?: 
  
 number 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 ; 
 

Decodes an Agent message from the specified reader or buffer.

Parameters
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

length
number

Message length if known beforehand

Returns
Type
Description

Agent

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 )) 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 ; 
 

Decodes an Agent message from the specified reader or buffer, length delimited.

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

Agent

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IAgent 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified Agent message. Does not implicitly messages.

Parameters
Name
Description
message
IAgent

Agent message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

  public 
  
 static 
  
 encodeDelimited 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IAgent 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified Agent message, length delimited. Does not implicitly messages.

Parameters
Name
Description
message
IAgent

Agent message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

fromObject(object)

  public 
  
 static 
  
 fromObject 
 ( 
 object 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }) 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 ; 
 

Creates an Agent message from a plain object. Also converts values to their respective internal types.

Parameter
Name
Description
object
{ [k: string]: any }

Plain object

Returns
Type
Description

Agent

getTypeUrl(typeUrlPrefix)

  public 
  
 static 
  
 getTypeUrl 
 ( 
 typeUrlPrefix 
 ?: 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Gets the default type url for Agent

Parameter
Name
Description
typeUrlPrefix
string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type
Description
string

The default type url

toJSON()

  public 
  
 toJSON 
 () 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }; 
 

Converts this Agent to JSON.

Returns
Type
Description
{ [k: string]: any }

JSON object

toObject(message, options)

  public 
  
 static 
  
 toObject 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Agent 
 , 
  
 options 
 ?: 
  
 $protobuf 
 . 
 IConversionOptions 
 ) 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }; 
 

Creates a plain object from an Agent message. Also converts values to other types if specified.

Parameters
Name
Description
message
Agent

Agent

options
$protobuf.IConversionOptions

Conversion options

Returns
Type
Description
{ [k: string]: any }

Plain object

verify(message)

  public 
  
 static 
  
 verify 
 ( 
 message 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }) 
 : 
  
 ( 
 string 
 | 
 null 
 ); 
 

Verifies an Agent message.

Parameter
Name
Description
message
{ [k: string]: any }

Plain object to verify

Returns
Type
Description
(string|null)

null if valid, otherwise the reason why it is not

Create a Mobile Website
View Site in Mobile | Classic
Share by: