Google Cloud Ai Platform V1 Client - Class Examples (0.30.0)

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

Example-based explainability that returns the nearest neighbors from the provided dataset.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ example_gcs_source Google\Cloud\AIPlatform\V1\Examples\ExampleGcsSource

The Cloud Storage input instances.

↳ nearest_neighbor_search_config Google\Protobuf\Value

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

↳ presets Google\Cloud\AIPlatform\V1\Presets

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

↳ neighbor_count int

The number of neighbors to return when querying for examples.

getExampleGcsSource

The Cloud Storage input instances.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Examples\ExampleGcsSource|null

hasExampleGcsSource

setExampleGcsSource

The Cloud Storage input instances.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\Examples\ExampleGcsSource
Returns
TypeDescription
$this

getNearestNeighborSearchConfig

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

Returns
TypeDescription
Google\Protobuf\Value|null

hasNearestNeighborSearchConfig

setNearestNeighborSearchConfig

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

Parameter
NameDescription
var Google\Protobuf\Value
Returns
TypeDescription
$this

getPresets

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Presets|null

hasPresets

setPresets

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\Presets
Returns
TypeDescription
$this

getNeighborCount

The number of neighbors to return when querying for examples.

Returns
TypeDescription
int

setNeighborCount

The number of neighbors to return when querying for examples.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string

getConfig

Returns
TypeDescription
string