Interface ExamplesOverrideOrBuilder (3.23.0)

public interface ExamplesOverrideOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCrowdingCount()

public abstract int getCrowdingCount()

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

int32 crowding_count = 2;

Returns
TypeDescription
int

The crowdingCount.

getDataFormat()

public abstract ExamplesOverride.DataFormat getDataFormat()

The format of the data being provided with each call.

.google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
TypeDescription
ExamplesOverride.DataFormat

The dataFormat.

getDataFormatValue()

public abstract int getDataFormatValue()

The format of the data being provided with each call.

.google.cloud.aiplatform.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for dataFormat.

getNeighborCount()

public abstract int getNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
TypeDescription
int

The neighborCount.

getRestrictions(int index)

public abstract ExamplesRestrictionsNamespace getRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespace

getRestrictionsCount()

public abstract int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
int

getRestrictionsList()

public abstract List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
List<ExamplesRestrictionsNamespace>

getRestrictionsOrBuilder(int index)

public abstract ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespaceOrBuilder

getRestrictionsOrBuilderList()

public abstract List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.ExamplesRestrictionsNamespaceOrBuilder>

getReturnEmbeddings()

public abstract boolean getReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
TypeDescription
boolean

The returnEmbeddings.