Google Cloud Ai Platform V1 Client - Class Examples (1.12.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
Name Description
data array

Optional. Data for populating the Message object.

↳ example_gcs_source 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 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
Type Description
Examples\ExampleGcsSource|null

hasExampleGcsSource

setExampleGcsSource

The Cloud Storage input instances.

Parameter
Name Description
var Examples\ExampleGcsSource
Returns
Type Description
$this

getNearestNeighborSearchConfig

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

Returns
Type Description
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
Name Description
var Google\Protobuf\Value
Returns
Type Description
$this

getPresets

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

Returns
Type Description
Presets|null

hasPresets

setPresets

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

Parameter
Name Description
var Presets
Returns
Type Description
$this

getNeighborCount

The number of neighbors to return when querying for examples.

Returns
Type Description
int

setNeighborCount

The number of neighbors to return when querying for examples.

Parameter
Name Description
var int
Returns
Type Description
$this

getSource

Returns
Type Description
string

getConfig

Returns
Type Description
string