Google Cloud Ai Platform V1 Client - Class ExamplesOverride (0.28.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ExamplesOverride.

Overrides for example-based explanations.

Generated from protobuf message google.cloud.aiplatform.v1.ExamplesOverride

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ neighbor_count int

The number of neighbors to return.

↳ crowding_count int

The number of neighbors to return that have the same crowding tag.

↳ restrictions array<Google\Cloud\AIPlatform\V1\ExamplesRestrictionsNamespace>

Restrict the resulting nearest neighbors to respect these constraints.

↳ return_embeddings bool

If true, return the embeddings instead of neighbors.

↳ data_format int

The format of the data being provided with each call.

getNeighborCount

The number of neighbors to return.

Returns
TypeDescription
int

setNeighborCount

The number of neighbors to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCrowdingCount

The number of neighbors to return that have the same crowding tag.

Returns
TypeDescription
int

setCrowdingCount

The number of neighbors to return that have the same crowding tag.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRestrictions

Restrict the resulting nearest neighbors to respect these constraints.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRestrictions

Restrict the resulting nearest neighbors to respect these constraints.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\ExamplesRestrictionsNamespace>
Returns
TypeDescription
$this

getReturnEmbeddings

If true, return the embeddings instead of neighbors.

Returns
TypeDescription
bool

setReturnEmbeddings

If true, return the embeddings instead of neighbors.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDataFormat

The format of the data being provided with each call.

Returns
TypeDescription
int

setDataFormat

The format of the data being provided with each call.

Parameter
NameDescription
var int
Returns
TypeDescription
$this