Class protos.google.cloud.aiplatform.v1.NearestNeighborQuery (3.13.0)

Represents a NearestNeighborQuery.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.INearestNeighborQuery);

Constructs a new NearestNeighborQuery.

Parameter
NameDescription
properties INearestNeighborQuery

Properties to set

Properties

embedding

public embedding?: (google.cloud.aiplatform.v1.NearestNeighborQuery.IEmbedding|null);

NearestNeighborQuery embedding.

entityId

public entityId?: (string|null);

NearestNeighborQuery entityId.

instance

public instance?: ("entityId"|"embedding");

NearestNeighborQuery instance.

neighborCount

public neighborCount: number;

NearestNeighborQuery neighborCount.

parameters

public parameters?: (google.cloud.aiplatform.v1.NearestNeighborQuery.IParameters|null);

NearestNeighborQuery parameters.

perCrowdingAttributeNeighborCount

public perCrowdingAttributeNeighborCount: number;

NearestNeighborQuery perCrowdingAttributeNeighborCount.

stringFilters

public stringFilters: google.cloud.aiplatform.v1.NearestNeighborQuery.IStringFilter[];

NearestNeighborQuery stringFilters.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.INearestNeighborQuery): google.cloud.aiplatform.v1.NearestNeighborQuery;

Creates a new NearestNeighborQuery instance using the specified properties.

Parameter
NameDescription
properties INearestNeighborQuery

Properties to set

Returns
TypeDescription
NearestNeighborQuery

NearestNeighborQuery instance

decode(reader, length)

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

Decodes a NearestNeighborQuery message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
NearestNeighborQuery

NearestNeighborQuery

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
NearestNeighborQuery

NearestNeighborQuery

encode(message, writer)

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

Encodes the specified NearestNeighborQuery message. Does not implicitly messages.

Parameters
NameDescription
message INearestNeighborQuery

NearestNeighborQuery message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1.INearestNeighborQuery, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message INearestNeighborQuery

NearestNeighborQuery message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.NearestNeighborQuery;

Creates a NearestNeighborQuery message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
NearestNeighborQuery

NearestNeighborQuery

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for NearestNeighborQuery

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this NearestNeighborQuery to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message NearestNeighborQuery

NearestNeighborQuery

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a NearestNeighborQuery message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not