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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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.
Generated from protobuf field int32 neighbor_count = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setNeighborCount
The number of neighbors to return.
Generated from protobuf field int32 neighbor_count = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCrowdingCount
The number of neighbors to return that have the same crowding tag.
Generated from protobuf field int32 crowding_count = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setCrowdingCount
The number of neighbors to return that have the same crowding tag.
Generated from protobuf field int32 crowding_count = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRestrictions
Restrict the resulting nearest neighbors to respect these constraints.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRestrictions
Restrict the resulting nearest neighbors to respect these constraints.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\ExamplesRestrictionsNamespace>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReturnEmbeddings
If true, return the embeddings instead of neighbors.
Generated from protobuf field bool return_embeddings = 4;
| Returns | |
|---|---|
| Type | Description |
bool | |
setReturnEmbeddings
If true, return the embeddings instead of neighbors.
Generated from protobuf field bool return_embeddings = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataFormat
The format of the data being provided with each call.
Generated from protobuf field .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
| Returns | |
|---|---|
| Type | Description |
int | |
setDataFormat
The format of the data being provided with each call.
Generated from protobuf field .google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |