Class protos.google.cloud.discoveryengine.v1.CheckGroundingResponse (1.14.0)

Represents a CheckGroundingResponse.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1.ICheckGroundingResponse);

Constructs a new CheckGroundingResponse.

Parameter
Name Description
properties ICheckGroundingResponse

Properties to set

Properties

_supportScore

public _supportScore?: "supportScore";

CheckGroundingResponse _supportScore.

citedChunks

public citedChunks: google.cloud.discoveryengine.v1.IFactChunk[];

CheckGroundingResponse citedChunks.

claims

public claims: google.cloud.discoveryengine.v1.CheckGroundingResponse.IClaim[];

CheckGroundingResponse claims.

supportScore

public supportScore?: (number|null);

CheckGroundingResponse supportScore.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1.ICheckGroundingResponse): google.cloud.discoveryengine.v1.CheckGroundingResponse;

Creates a new CheckGroundingResponse instance using the specified properties.

Parameter
Name Description
properties ICheckGroundingResponse

Properties to set

Returns
Type Description
CheckGroundingResponse

CheckGroundingResponse instance

decode(reader, length)

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

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

CheckGroundingResponse

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CheckGroundingResponse

CheckGroundingResponse

encode(message, writer)

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

Encodes the specified CheckGroundingResponse message. Does not implicitly messages.

Parameters
Name Description
message ICheckGroundingResponse

CheckGroundingResponse 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.discoveryengine.v1.ICheckGroundingResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICheckGroundingResponse

CheckGroundingResponse 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.discoveryengine.v1.CheckGroundingResponse;

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

CheckGroundingResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CheckGroundingResponse

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CheckGroundingResponse

CheckGroundingResponse

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