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

Represents a Chunk.

Package

@google-cloud/ces

Constructors

(constructor)(properties)

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

Constructs a new Chunk.

Parameter
Name
Description
properties
IChunk

Properties to set

Properties

agentTransfer

  public 
  
 agentTransfer 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IAgentTransfer 
 | 
 null 
 ); 
 

Chunk agentTransfer.

blob

  public 
  
 blob 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IBlob 
 | 
 null 
 ); 
 

Chunk blob.

data

  public 
  
 data 
 ?: 
  
 ( 
 "text" 
 | 
 "transcript" 
 | 
 "blob" 
 | 
 "payload" 
 | 
 "image" 
 | 
 "toolCall" 
 | 
 "toolResponse" 
 | 
 "agentTransfer" 
 | 
 "updatedVariables" 
 | 
 "defaultVariables" 
 ); 
 

Chunk data.

defaultVariables

  public 
  
 defaultVariables 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 IStruct 
 | 
 null 
 ); 
 

Chunk defaultVariables.

image

  public 
  
 image 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IImage 
 | 
 null 
 ); 
 

Chunk image.

payload

  public 
  
 payload 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 IStruct 
 | 
 null 
 ); 
 

Chunk payload.

text

  public 
  
 text 
 ?: 
  
 ( 
 string 
 | 
 null 
 ); 
 

Chunk text.

toolCall

  public 
  
 toolCall 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IToolCall 
 | 
 null 
 ); 
 

Chunk toolCall.

toolResponse

  public 
  
 toolResponse 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IToolResponse 
 | 
 null 
 ); 
 

Chunk toolResponse.

transcript

  public 
  
 transcript 
 ?: 
  
 ( 
 string 
 | 
 null 
 ); 
 

Chunk transcript.

updatedVariables

  public 
  
 updatedVariables 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 IStruct 
 | 
 null 
 ); 
 

Chunk updatedVariables.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 IChunk 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 ces 
 . 
 v1 
 . 
 Chunk 
 ; 
 

Creates a new Chunk instance using the specified properties.

Parameter
Name
Description
properties
IChunk

Properties to set

Returns
Type
Description

Chunk instance

decode(reader, length)

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

Decodes a Chunk 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

Chunk

decodeDelimited(reader)

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

Decodes a Chunk message from the specified reader or buffer, length delimited.

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

Chunk

encode(message, writer)

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

Encodes the specified Chunk message. Does not implicitly messages.

Parameters
Name
Description
message
IChunk

Chunk 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 
 . 
 IChunk 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
IChunk

Chunk 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 
 . 
 Chunk 
 ; 
 

Creates a Chunk 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

Chunk

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Chunk

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 Chunk to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
Chunk

Chunk

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 a Chunk 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

Design a Mobile Site
View Site in Mobile | Classic
Share by: