Package com.oracle.database.selectai.model

Class VectorIndexAttributes.Builder

java.lang.Object

com.oracle.database.selectai.model.VectorIndexAttributes.Builder

Enclosing class:

VectorIndexAttributes

public static final class VectorIndexAttributes.Builder
extends Object

Builder for VectorIndexAttributes.

Method Summary

Modifier and Type	Method	Description
VectorIndexAttributes	build()	Builds the vector index attribute payload.
VectorIndexAttributes.Builder	chunkOverlap(Integer chunkOverlap)	Sets the overlap between text chunks.
VectorIndexAttributes.Builder	chunkSize(Integer chunkSize)	Sets the text chunk size.
VectorIndexAttributes.Builder	enableSources(Boolean enableSources)	Sets whether source citations are enabled.
VectorIndexAttributes.Builder	location(String location)	Sets the source document location.
VectorIndexAttributes.Builder	matchLimit(Integer matchLimit)	Sets the retrieval match limit.
VectorIndexAttributes.Builder	objectStorageCredentialName(String objectStorageCredentialName)	Sets the credential used to read object storage content.
VectorIndexAttributes.Builder	pipelineName(String pipelineName)	Sets the pipeline name for update payloads.
VectorIndexAttributes.Builder	profileName(String profileName)	Sets the Select AI profile used by the vector index.
VectorIndexAttributes.Builder	refreshRate(Integer refreshRate)	Sets the refresh interval in minutes.
VectorIndexAttributes.Builder	similarityThreshold(Double similarityThreshold)	Sets the retrieval similarity threshold.
VectorIndexAttributes.Builder	vectorDbProvider(String vectorDbProvider)	Sets the vector database provider.
VectorIndexAttributes.Builder	vectorDimension(Integer vectorDimension)	Sets the vector dimension.
VectorIndexAttributes.Builder	vectorDistanceMetric(String vectorDistanceMetric)	Sets the vector distance metric.
VectorIndexAttributes.Builder	vectorTableName(String vectorTableName)	Sets the backing vector table name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

chunkSize

public VectorIndexAttributes.Builder chunkSize(Integer chunkSize)

Sets the text chunk size.

Parameters:

chunkSize - chunk size

Returns:

this builder instance

chunkOverlap

public VectorIndexAttributes.Builder chunkOverlap(Integer chunkOverlap)

Sets the overlap between text chunks.

Parameters:

chunkOverlap - chunk overlap

Returns:

this builder instance

enableSources

public VectorIndexAttributes.Builder enableSources(Boolean enableSources)

Sets whether source citations are enabled.

Parameters:

enableSources - source citation flag

Returns:

this builder instance

location

public VectorIndexAttributes.Builder location(String location)

Sets the source document location.

Parameters:

location - object storage or file location

Returns:

this builder instance

matchLimit

public VectorIndexAttributes.Builder matchLimit(Integer matchLimit)

Sets the retrieval match limit.

Parameters:

matchLimit - match limit

Returns:

this builder instance

objectStorageCredentialName

public VectorIndexAttributes.Builder objectStorageCredentialName(String objectStorageCredentialName)

Sets the credential used to read object storage content.

Parameters:

objectStorageCredentialName - object storage credential name

Returns:

this builder instance

pipelineName

public VectorIndexAttributes.Builder pipelineName(String pipelineName)

Sets the pipeline name for update payloads.

pipeline_name is generated by the database during vector index creation and cannot be supplied in create payloads.

Parameters:

pipelineName - DBMS_CLOUD_PIPELINE pipeline name

Returns:

this builder instance

Throws:

IllegalArgumentException - when used with the create builder

profileName

public VectorIndexAttributes.Builder profileName(String profileName)

Sets the Select AI profile used by the vector index.

Parameters:

profileName - Select AI profile name

Returns:

this builder instance

refreshRate

public VectorIndexAttributes.Builder refreshRate(Integer refreshRate)

Sets the refresh interval in minutes.

Parameters:

refreshRate - refresh interval

Returns:

this builder instance

similarityThreshold

public VectorIndexAttributes.Builder similarityThreshold(Double similarityThreshold)

Sets the retrieval similarity threshold.

Parameters:

similarityThreshold - similarity threshold

Returns:

this builder instance

vectorDistanceMetric

public VectorIndexAttributes.Builder vectorDistanceMetric(String vectorDistanceMetric)

Sets the vector distance metric.

Parameters:

vectorDistanceMetric - distance metric name

Returns:

this builder instance

vectorDbProvider

public VectorIndexAttributes.Builder vectorDbProvider(String vectorDbProvider)

Sets the vector database provider.

Parameters:

vectorDbProvider - vector database provider name

Returns:

this builder instance

vectorDimension

public VectorIndexAttributes.Builder vectorDimension(Integer vectorDimension)

Sets the vector dimension.

Parameters:

vectorDimension - vector dimension

Returns:

this builder instance

vectorTableName

public VectorIndexAttributes.Builder vectorTableName(String vectorTableName)

Sets the backing vector table name.

Parameters:

vectorTableName - vector table name

Returns:

this builder instance

build

public VectorIndexAttributes build()

Builds the vector index attribute payload.

Returns:

immutable VectorIndexAttributes built from validated builder state