Class protos.google.ai.generativelanguage.v1beta.Candidate (2.3.0)

Represents a Candidate.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1beta.ICandidate);

Constructs a new Candidate.

Parameter
Name Description
properties ICandidate

Properties to set

Properties

_index

public _index?: "index";

Candidate _index.

citationMetadata

public citationMetadata?: (google.ai.generativelanguage.v1beta.ICitationMetadata|null);

Candidate citationMetadata.

content

public content?: (google.ai.generativelanguage.v1beta.IContent|null);

Candidate content.

finishReason

public finishReason: (google.ai.generativelanguage.v1beta.Candidate.FinishReason|keyof typeof google.ai.generativelanguage.v1beta.Candidate.FinishReason);

Candidate finishReason.

groundingAttributions

public groundingAttributions: google.ai.generativelanguage.v1beta.IGroundingAttribution[];

Candidate groundingAttributions.

index

public index?: (number|null);

Candidate index.

safetyRatings

public safetyRatings: google.ai.generativelanguage.v1beta.ISafetyRating[];

Candidate safetyRatings.

tokenCount

public tokenCount: number;

Candidate tokenCount.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.ICandidate): google.ai.generativelanguage.v1beta.Candidate;

Creates a new Candidate instance using the specified properties.

Parameter
Name Description
properties ICandidate

Properties to set

Returns
Type Description
Candidate

Candidate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.Candidate;

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

Candidate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.Candidate;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Candidate

Candidate

encode(message, writer)

public static encode(message: google.ai.generativelanguage.v1beta.ICandidate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Candidate message. Does not implicitly messages.

Parameters
Name Description
message ICandidate

Candidate 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.ai.generativelanguage.v1beta.ICandidate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICandidate

Candidate 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.ai.generativelanguage.v1beta.Candidate;

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

Candidate

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Candidate

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

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

JSON object

toObject(message, options)

public static toObject(message: google.ai.generativelanguage.v1beta.Candidate, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message Candidate

Candidate

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