Share via

CosmosVectorEmbedding Class

Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.76.0
  • java.lang.Object
    • com.azure.cosmos.models.CosmosVectorEmbedding

public final class CosmosVectorEmbedding

Embedding settings within CosmosVectorEmbeddingPolicy

Constructor Summary

Constructor Description
CosmosVectorEmbedding()

Constructor

Method Summary

Modifier and Type Method and Description
CosmosVectorDataType getDataType()

Gets the data type for the cosmosVectorEmbedding.
Long getDimensions()

Deprecated

Gets the dimensions for the cosmosVectorEmbedding.
CosmosVectorDistanceFunction getDistanceFunction()

Gets the distanceFunction for the cosmosVectorEmbedding.
Integer getEmbeddingDimensions()

Gets the dimensions for the cosmosVectorEmbedding.
String getPath()

Gets the path for the cosmosVectorEmbedding.
CosmosVectorEmbedding setDataType(CosmosVectorDataType dataType)

Sets the data type for the cosmosVectorEmbedding.
CosmosVectorEmbedding setDimensions(Long dimensions)

Deprecated

Sets the dimensions for the cosmosVectorEmbedding.
CosmosVectorEmbedding setDistanceFunction(CosmosVectorDistanceFunction distanceFunction)

Sets the distanceFunction for the cosmosVectorEmbedding.
CosmosVectorEmbedding setEmbeddingDimensions(Integer dimensions)

Sets the dimensions for the cosmosVectorEmbedding.
CosmosVectorEmbedding setPath(String path)

Sets the path for the cosmosVectorEmbedding.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosVectorEmbedding

public CosmosVectorEmbedding()

Constructor

Method Details

getDataType

public CosmosVectorDataType getDataType()

Gets the data type for the cosmosVectorEmbedding.

Returns:

dataType

getDimensions

@Deprecated
public Long getDimensions()

Deprecated

Gets the dimensions for the cosmosVectorEmbedding.

Returns:

dimensions

getDistanceFunction

public CosmosVectorDistanceFunction getDistanceFunction()

Gets the distanceFunction for the cosmosVectorEmbedding.

Returns:

distanceFunction

getEmbeddingDimensions

public Integer getEmbeddingDimensions()

Gets the dimensions for the cosmosVectorEmbedding.

Returns:

dimensions

getPath

public String getPath()

Gets the path for the cosmosVectorEmbedding.

Returns:

path

setDataType

public CosmosVectorEmbedding setDataType(CosmosVectorDataType dataType)

Sets the data type for the cosmosVectorEmbedding.

Parameters:

dataType - the data type for the cosmosVectorEmbedding

Returns:

CosmosVectorEmbedding

setDimensions

@Deprecated
public CosmosVectorEmbedding setDimensions(Long dimensions)

Deprecated

Sets the dimensions for the cosmosVectorEmbedding.

Parameters:

dimensions - the dimensions for the cosmosVectorEmbedding

Returns:

CosmosVectorEmbedding

setDistanceFunction

public CosmosVectorEmbedding setDistanceFunction(CosmosVectorDistanceFunction distanceFunction)

Sets the distanceFunction for the cosmosVectorEmbedding.

Parameters:

distanceFunction - the distanceFunction for the cosmosVectorEmbedding

Returns:

CosmosVectorEmbedding

setEmbeddingDimensions

public CosmosVectorEmbedding setEmbeddingDimensions(Integer dimensions)

Sets the dimensions for the cosmosVectorEmbedding.

Parameters:

dimensions - the dimensions for the cosmosVectorEmbedding

Returns:

CosmosVectorEmbedding

setPath

public CosmosVectorEmbedding setPath(String path)

Sets the path for the cosmosVectorEmbedding.

Parameters:

path - the path for the cosmosVectorEmbedding

Returns:

CosmosVectorEmbedding

Applies to