Represents a SessionOutput.
Package
@google-cloud/cesConstructors
(constructor)(properties)
constructor(properties?: google.cloud.ces.v1beta.ISessionOutput);Constructs a new SessionOutput.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISessionOutput
Properties to set |
Properties
audio
public audio?: (Uint8Array|Buffer|string|null);SessionOutput audio.
citations
public citations?: (google.cloud.ces.v1beta.ICitations|null);SessionOutput citations.
diagnosticInfo
public diagnosticInfo?: (google.cloud.ces.v1beta.SessionOutput.IDiagnosticInfo|null);SessionOutput diagnosticInfo.
endSession
public endSession?: (google.cloud.ces.v1beta.IEndSession|null);SessionOutput endSession.
googleSearchSuggestions
public googleSearchSuggestions?: (google.cloud.ces.v1beta.IGoogleSearchSuggestions|null);SessionOutput googleSearchSuggestions.
outputType
public outputType?: ("text"|"audio"|"toolCalls"|"citations"|"googleSearchSuggestions"|"endSession"|"payload");SessionOutput outputType.
payload
public payload?: (google.protobuf.IStruct|null);SessionOutput payload.
text
public text?: (string|null);SessionOutput text.
toolCalls
public toolCalls?: (google.cloud.ces.v1beta.IToolCalls|null);SessionOutput toolCalls.
turnCompleted
public turnCompleted: boolean;SessionOutput turnCompleted.
turnIndex
public turnIndex: number;SessionOutput turnIndex.
Methods
create(properties)
public static create(properties?: google.cloud.ces.v1beta.ISessionOutput): google.cloud.ces.v1beta.SessionOutput;Creates a new SessionOutput instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISessionOutput
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SessionOutput |
SessionOutput instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.ces.v1beta.SessionOutput;Decodes a SessionOutput 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 |
SessionOutput |
SessionOutput |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.ces.v1beta.SessionOutput;Decodes a SessionOutput message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SessionOutput |
SessionOutput |
encode(message, writer)
public static encode(message: google.cloud.ces.v1beta.ISessionOutput, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SessionOutput message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISessionOutput
SessionOutput 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.v1beta.ISessionOutput, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SessionOutput message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISessionOutput
SessionOutput 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.v1beta.SessionOutput;Creates a SessionOutput 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 |
SessionOutput |
SessionOutput |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SessionOutput
| 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 SessionOutput to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.ces.v1beta.SessionOutput, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SessionOutput message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SessionOutput
SessionOutput |
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 SessionOutput message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|