Class protos.google.cloud.ces.v1beta.EvaluationResult.ScenarioExpectationOutcome (0.4.1)

Represents a ScenarioExpectationOutcome.

Package

@google-cloud/ces

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.ces.v1beta.EvaluationResult.IScenarioExpectationOutcome);

Constructs a new ScenarioExpectationOutcome.

Parameter
Name Description
properties IScenarioExpectationOutcome

Properties to set

Properties

expectation

public expectation?: (google.cloud.ces.v1beta.Evaluation.IScenarioExpectation|null);

ScenarioExpectationOutcome expectation.

observedAgentResponse

public observedAgentResponse?: (google.cloud.ces.v1beta.IMessage|null);

ScenarioExpectationOutcome observedAgentResponse.

observedToolCall

public observedToolCall?: (google.cloud.ces.v1beta.EvaluationResult.ScenarioExpectationOutcome.IObservedToolCall|null);

ScenarioExpectationOutcome observedToolCall.

outcome

public outcome: (google.cloud.ces.v1beta.EvaluationResult.Outcome|keyof typeof google.cloud.ces.v1beta.EvaluationResult.Outcome);

ScenarioExpectationOutcome outcome.

result

public result?: ("observedToolCall"|"observedAgentResponse");

ScenarioExpectationOutcome result.

Methods

create(properties)

public static create(properties?: google.cloud.ces.v1beta.EvaluationResult.IScenarioExpectationOutcome): google.cloud.ces.v1beta.EvaluationResult.ScenarioExpectationOutcome;

Creates a new ScenarioExpectationOutcome instance using the specified properties.

Parameter
Name Description
properties IScenarioExpectationOutcome

Properties to set

Returns
Type Description
ScenarioExpectationOutcome

ScenarioExpectationOutcome instance

decode(reader, length)

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

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

ScenarioExpectationOutcome

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.ces.v1beta.EvaluationResult.ScenarioExpectationOutcome;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ScenarioExpectationOutcome

ScenarioExpectationOutcome

encode(message, writer)

public static encode(message: google.cloud.ces.v1beta.EvaluationResult.IScenarioExpectationOutcome, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ScenarioExpectationOutcome message. Does not implicitly messages.

Parameters
Name Description
message IScenarioExpectationOutcome

ScenarioExpectationOutcome 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.EvaluationResult.IScenarioExpectationOutcome, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IScenarioExpectationOutcome

ScenarioExpectationOutcome 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.EvaluationResult.ScenarioExpectationOutcome;

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

ScenarioExpectationOutcome

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ScenarioExpectationOutcome

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ScenarioExpectationOutcome

ScenarioExpectationOutcome

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 ScenarioExpectationOutcome 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