Package com.oracle.database.selectai.model

Class ProfileAttributes.Builder

java.lang.Object

com.oracle.database.selectai.model.ProfileAttributes.Builder

Enclosing class:

ProfileAttributes

public static final class ProfileAttributes.Builder
extends Object

Builder for ProfileAttributes.

Method Summary

Modifier and Type	Method	Description
ProfileAttributes.Builder	additionalInstructions(String additionalInstructions)	Sets additional instructions included in Select AI prompts.
ProfileAttributes.Builder	annotations(Boolean annotations)	Sets whether table/column annotations are included in metadata.
ProfileAttributes.Builder	azureDeploymentName(String azureDeploymentName)	Sets the Azure OpenAI deployment name for the generation model.
ProfileAttributes.Builder	azureEmbeddingDeploymentName(String azureEmbeddingDeploymentName)	Sets the Azure OpenAI deployment name for the embedding model.
ProfileAttributes.Builder	azureResourceName(String azureResourceName)	Sets the Azure OpenAI resource name.
ProfileAttributes	build()	Builds immutable profile attributes.
ProfileAttributes.Builder	caseSensitiveValues(Boolean caseSensitiveValues)	Sets whether generated SQL value matching is case-sensitive.
ProfileAttributes.Builder	comments(Boolean comments)	Sets whether table and column comments are included in metadata.
ProfileAttributes.Builder	constraints(Boolean constraints)	Sets whether referential constraints are included in metadata.
ProfileAttributes.Builder	conversation(Boolean conversation)	Sets whether conversation history is enabled for the profile.
ProfileAttributes.Builder	conversationLength(Integer conversationLength)	Sets how many conversation turns are retained for context.
ProfileAttributes.Builder	credentialName(String credentialName)	Sets the database credential used for provider API calls.
ProfileAttributes.Builder	customAttribute(String key, String value)	Accepts an unmodeled profile attribute for forward compatibility.
ProfileAttributes.Builder	embeddingModel(String embeddingModel)	Sets the embedding model name.
ProfileAttributes.Builder	enableCustomSourceUri(Boolean enableCustomSourceUri)	Sets whether custom source URI metadata is enabled.
ProfileAttributes.Builder	enforceObjectList(Boolean enforceObjectList)	Sets whether generated SQL is restricted to the object list.
ProfileAttributes.Builder	maxTokens(Integer maxTokens)	Sets the maximum generated output tokens.
ProfileAttributes.Builder	model(String model)	Sets the provider model identifier.
ProfileAttributes.Builder	objectList(String objectList)	Sets the object list JSON used to constrain metadata.
ProfileAttributes.Builder	objectListMode(ObjectListMode objectListMode)	Sets the object-list selection mode used for NL2SQL processing.
ProfileAttributes.Builder	objectListMode(String objectListMode)	Sets the object-list selection mode used for NL2SQL processing.
ProfileAttributes.Builder	ociApiformat(OciApiFormat ociApiFormat)	Sets the OCI Generative AI API format.
ProfileAttributes.Builder	ociApiformat(String ociApiformat)	Sets the OCI Generative AI API format.
ProfileAttributes.Builder	ociCompartmentId(String ociCompartmentId)	Sets the OCI compartment OCID.
ProfileAttributes.Builder	ociEndpointId(String ociEndpointId)	Sets the OCI dedicated endpoint OCID.
ProfileAttributes.Builder	ociRuntimetype(String ociRuntimetype)	Sets the OCI runtime type attribute.
ProfileAttributes.Builder	provider(String provider)	Sets the AI provider for the profile.
ProfileAttributes.Builder	providerEndpoint(String providerEndpoint)	Sets the provider endpoint host/path.
ProfileAttributes.Builder	providerProfile(ProviderProfile providerProfile)	Applies a provider profile shortcut to this builder.
ProfileAttributes.Builder	region(String region)	Sets the provider region.
ProfileAttributes.Builder	role(String role)	Sets the role prompt used by Select AI.
ProfileAttributes.Builder	seed(Long seed)	Sets the deterministic sampling seed.
ProfileAttributes.Builder	sourceLanguage(String sourceLanguage)	Sets the source language for translation.
ProfileAttributes.Builder	stopTokens(List<String> stopTokens)	Sets stop tokens that terminate generation.
ProfileAttributes.Builder	targetLanguage(String targetLanguage)	Sets the target language for translation.
ProfileAttributes.Builder	temperature(Double temperature)	Sets the provider sampling temperature.
ProfileAttributes.Builder	vectorIndexName(String vectorIndexName)	Sets the vector index name associated with the profile.

Methods inherited from class java.lang.Object

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

Method Details

annotations

public ProfileAttributes.Builder annotations(Boolean annotations)

Sets whether table/column annotations are included in metadata.

Parameters:

annotations - annotation metadata flag

Returns:

this builder instance

additionalInstructions

public ProfileAttributes.Builder additionalInstructions(String additionalInstructions)

Sets additional instructions included in Select AI prompts.

Parameters:

additionalInstructions - additional prompt instructions

Returns:

this builder instance

azureDeploymentName

public ProfileAttributes.Builder azureDeploymentName(String azureDeploymentName)

Sets the Azure OpenAI deployment name for the generation model.

Parameters:

azureDeploymentName - Azure deployment name

Returns:

this builder instance

azureEmbeddingDeploymentName

public ProfileAttributes.Builder azureEmbeddingDeploymentName(String azureEmbeddingDeploymentName)

Sets the Azure OpenAI deployment name for the embedding model.

Parameters:

azureEmbeddingDeploymentName - Azure embedding deployment name

Returns:

this builder instance

azureResourceName

public ProfileAttributes.Builder azureResourceName(String azureResourceName)

Sets the Azure OpenAI resource name.

Parameters:

azureResourceName - Azure resource name

Returns:

this builder instance

caseSensitiveValues

public ProfileAttributes.Builder caseSensitiveValues(Boolean caseSensitiveValues)

Sets whether generated SQL value matching is case-sensitive.

Parameters:

caseSensitiveValues - case-sensitive values flag

Returns:

this builder instance

comments

public ProfileAttributes.Builder comments(Boolean comments)

Sets whether table and column comments are included in metadata.

Parameters:

comments - comments metadata flag

Returns:

this builder instance

constraints

public ProfileAttributes.Builder constraints(Boolean constraints)

Sets whether referential constraints are included in metadata.

Parameters:

constraints - constraints metadata flag

Returns:

this builder instance

conversation

public ProfileAttributes.Builder conversation(Boolean conversation)

Sets whether conversation history is enabled for the profile.

Parameters:

conversation - conversation flag

Returns:

this builder instance

conversationLength

public ProfileAttributes.Builder conversationLength(Integer conversationLength)

Sets how many conversation turns are retained for context.

Parameters:

conversationLength - positive conversation context length

Returns:

this builder instance

credentialName

public ProfileAttributes.Builder credentialName(String credentialName)

Sets the database credential used for provider API calls.

Parameters:

credentialName - credential name

Returns:

this builder instance

embeddingModel

public ProfileAttributes.Builder embeddingModel(String embeddingModel)

Sets the embedding model name.

Parameters:

embeddingModel - embedding model name

Returns:

this builder instance

enableCustomSourceUri

public ProfileAttributes.Builder enableCustomSourceUri(Boolean enableCustomSourceUri)

Sets whether custom source URI metadata is enabled.

Parameters:

enableCustomSourceUri - custom source URI flag

Returns:

this builder instance

enforceObjectList

public ProfileAttributes.Builder enforceObjectList(Boolean enforceObjectList)

Sets whether generated SQL is restricted to the object list.

Parameters:

enforceObjectList - object list enforcement flag

Returns:

this builder instance

maxTokens

public ProfileAttributes.Builder maxTokens(Integer maxTokens)

Sets the maximum generated output tokens.

Parameters:

maxTokens - positive token limit

Returns:

this builder instance

model

public ProfileAttributes.Builder model(String model)

Sets the provider model identifier.

Parameters:

model - provider model identifier

Returns:

this builder instance

objectList

public ProfileAttributes.Builder objectList(String objectList)

Sets the object list JSON used to constrain metadata.

Parameters:

objectList - JSON array containing object descriptors

Returns:

this builder instance

objectListMode

public ProfileAttributes.Builder objectListMode(String objectListMode)

Sets the object-list selection mode used for NL2SQL processing.

A null value leaves the object-list mode unset. A non-null value must correspond to an object-list mode supported by the SDK; otherwise, this method throws an IllegalArgumentException.

Parameters:

objectListMode - object-list mode, or null to leave the mode unset

Returns:

this builder instance

Throws:

IllegalArgumentException - if objectListMode is non-null and does not correspond to a supported object-list mode

objectListMode

public ProfileAttributes.Builder objectListMode(ObjectListMode objectListMode)

Sets the object-list selection mode used for NL2SQL processing.

Parameters:

objectListMode - object-list mode

Returns:

this builder instance

ociApiformat

public ProfileAttributes.Builder ociApiformat(String ociApiformat)

Sets the OCI Generative AI API format.

Parameters:

ociApiformat - OCI API format, such as COHERE or GENERIC

Returns:

this builder instance

ociApiformat

public ProfileAttributes.Builder ociApiformat(OciApiFormat ociApiFormat)

Sets the OCI Generative AI API format.

Parameters:

ociApiFormat - OCI API format

Returns:

this builder instance

ociCompartmentId

public ProfileAttributes.Builder ociCompartmentId(String ociCompartmentId)

Sets the OCI compartment OCID.

Parameters:

ociCompartmentId - OCI compartment OCID

Returns:

this builder instance

ociEndpointId

public ProfileAttributes.Builder ociEndpointId(String ociEndpointId)

Sets the OCI dedicated endpoint OCID.

Parameters:

ociEndpointId - OCI endpoint OCID

Returns:

this builder instance

ociRuntimetype

public ProfileAttributes.Builder ociRuntimetype(String ociRuntimetype)

Sets the OCI runtime type attribute.

Parameters:

ociRuntimetype - OCI runtime type

Returns:

this builder instance

provider

public ProfileAttributes.Builder provider(String provider)

Sets the AI provider for the profile.

A null value leaves the provider unset. A non-null value must correspond to a provider supported by the SDK; otherwise, this method throws an IllegalArgumentException.

Parameters:

provider - provider name, or null to leave the provider unset

Returns:

this builder instance

Throws:

IllegalArgumentException - if provider is non-null and does not correspond to a supported provider

providerEndpoint

public ProfileAttributes.Builder providerEndpoint(String providerEndpoint)

Sets the provider endpoint host/path.

Parameters:

providerEndpoint - provider endpoint

Returns:

this builder instance

region

public ProfileAttributes.Builder region(String region)

Sets the provider region.

Parameters:

region - provider region

Returns:

this builder instance

role

public ProfileAttributes.Builder role(String role)

Sets the role prompt used by Select AI.

Parameters:

role - role prompt

Returns:

this builder instance

seed

public ProfileAttributes.Builder seed(Long seed)

Sets the deterministic sampling seed.

Parameters:

seed - sampling seed

Returns:

this builder instance

stopTokens

public ProfileAttributes.Builder stopTokens(List<String> stopTokens)

Sets stop tokens that terminate generation.

Parameters:

stopTokens - stop token list

Returns:

this builder instance

temperature

public ProfileAttributes.Builder temperature(Double temperature)

Sets the provider sampling temperature.

Parameters:

temperature - non-negative temperature

Returns:

this builder instance

vectorIndexName

public ProfileAttributes.Builder vectorIndexName(String vectorIndexName)

Sets the vector index name associated with the profile.

Parameters:

vectorIndexName - Oracle SQL identifier for the vector index

Returns:

this builder instance

sourceLanguage

public ProfileAttributes.Builder sourceLanguage(String sourceLanguage)

Sets the source language for translation.

Parameters:

sourceLanguage - source language name or code

Returns:

this builder instance

targetLanguage

public ProfileAttributes.Builder targetLanguage(String targetLanguage)

Sets the target language for translation.

Parameters:

targetLanguage - target language name or code

Returns:

this builder instance

providerProfile

public ProfileAttributes.Builder providerProfile(ProviderProfile providerProfile)

Applies a provider profile shortcut to this builder.

Parameters:

providerProfile - provider profile to apply

Returns:

this builder instance

customAttribute

public ProfileAttributes.Builder customAttribute(String key,
 String value)

Accepts an unmodeled profile attribute for forward compatibility.

Current typed JSON serialization only emits attributes represented by this SDK. This method prevents unknown database attributes from failing a read/round-trip through ProfileAttributes.fromAttributeMap(Map).

Parameters:

key - DBMS_CLOUD_AI attribute name

value - attribute value

Returns:

this builder instance

build

public ProfileAttributes build()

Builds immutable profile attributes.

Returns:

immutable ProfileAttributes instance built from current builder state