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 \ V1Methods
__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<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 | |
|---|---|
| Type | Description |
int |
|
setNeighborCount
The number of neighbors to return.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrowdingCount
The number of neighbors to return that have the same crowding tag.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCrowdingCount
The number of neighbors to return that have the same crowding tag.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRestrictions
Restrict the resulting nearest neighbors to respect these constraints.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ExamplesRestrictionsNamespace> |
|
setRestrictions
Restrict the resulting nearest neighbors to respect these constraints.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ExamplesRestrictionsNamespace>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReturnEmbeddings
If true, return the embeddings instead of neighbors.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReturnEmbeddings
If true, return the embeddings instead of neighbors.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataFormat
The format of the data being provided with each call.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DataFormat. |
setDataFormat
The format of the data being provided with each call.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DataFormat. |
| Returns | |
|---|---|
| Type | Description |
$this |
|