Generative Ai

oci.generative_ai.GenerativeAiClient

OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.

oci.generative_ai.GenerativeAiClientCompositeOperations

This class provides a wrapper around GenerativeAiClient and offers convenience methods for operations that would otherwise need to be chained together.

Models

oci.generative_ai.models.AddArtifactDetails

new artifact details.

oci.generative_ai.models.AllocatableGpuCollection

Results of an allocatable GPU search for launching dedicated AI clusters.

oci.generative_ai.models.AllocatableGpuSummary

Information about allocatable GPUs that can be used to launch dedicated AI clusters.

oci.generative_ai.models.AllowedDomain

Hostnames and ports allowed by a sandbox network policy.

oci.generative_ai.models.ApiKey

ApiKeys are resources used to access GenAI models.

oci.generative_ai.models.ApiKeyCollection

Results of a ApiKey search.

oci.generative_ai.models.ApiKeyItem

The ApiKey item.

oci.generative_ai.models.ApiKeySummary

Summary of the API key.

oci.generative_ai.models.Artifact

Container/artifact configuration for the deployment.

oci.generative_ai.models.Availability

Describes where and how a model is deployed

oci.generative_ai.models.ChangeApiKeyCompartmentDetails

The details to move an APIKey to another compartment.

oci.generative_ai.models.ChangeDedicatedAiClusterCompartmentDetails

The details to move a dedicated AI cluster to another compartment.

oci.generative_ai.models.ChangeEndpointCompartmentDetails

The details to move an endpoint to another compartment.

oci.generative_ai.models.ChangeGenerativeAiPrivateEndpointCompartmentDetails

The details required to change a private endpoint compartment.

oci.generative_ai.models.ChangeGenerativeAiProjectCompartmentDetails

The details to move a GenerativeAiProject to another compartment.

oci.generative_ai.models.ChangeHostedApplicationCompartmentDetails

The details to move a hosted application to another compartment.

oci.generative_ai.models.ChangeHostedApplicationStorageCompartmentDetails

The details to move a hosted application storage to another compartment.

oci.generative_ai.models.ChangeImportedModelCompartmentDetails

The details to move an imported model to another compartment.

oci.generative_ai.models.ChangeModelCompartmentDetails

The details to move a custom model to another compartment.

oci.generative_ai.models.ChangeRoutingProfileCompartmentDetails

The details to move a routing profile to another compartment.

oci.generative_ai.models.ChangeSemanticStoreCompartmentDetails

The details to move a SemanticStore to another compartment.

oci.generative_ai.models.ChatModelMetrics

The chat model metrics of the fine-tuning process.

oci.generative_ai.models.ComputeCapacityReservation

The compute capacity reservation in customer tenancy.

oci.generative_ai.models.CondenserConfig

Configuration for condensing conversation content.

oci.generative_ai.models.ConnectorConfiguration

Datasource configuration for the connector.

oci.generative_ai.models.ContentModerationConfig

The configuration details, whether to add the content moderation feature to the model.

oci.generative_ai.models.ConversationConfig

Holds configuration related to conversation retention

oci.generative_ai.models.CreateApiKeyDetails

The data to create an API key.

oci.generative_ai.models.CreateArtifactDetails

Artifact configuration input for the deployment.

oci.generative_ai.models.CreateDataSourceDatabaseToolsConnectionDetails

Defines the OCI Database Tools Connection data source that the semantic model connects to.

oci.generative_ai.models.CreateDataSourceDetails

Defines the data source that the semantic model connects to.

oci.generative_ai.models.CreateDedicatedAiClusterDetails

The data to create a dedicated AI cluster.

oci.generative_ai.models.CreateEndpointDetails

The data to create an endpoint.

oci.generative_ai.models.CreateGenerativeAiPrivateEndpointDetails

The details required to create a Generative AI private endpoint.

oci.generative_ai.models.CreateGenerativeAiProjectDetails

The data to create a GenerativeAiProject.

oci.generative_ai.models.CreateHostedApplicationBaseDetails

Common creation properties shared by HostedApplication and HostedApplicationIam.

oci.generative_ai.models.CreateHostedApplicationDetails

The details required to create a hosted application.

oci.generative_ai.models.CreateHostedApplicationIamDetails

The details required to create a hosted application.

oci.generative_ai.models.CreateHostedApplicationStorageDetails

The data to create a hosted application storage.

oci.generative_ai.models.CreateHostedDeploymentDetails

The data to create a hosted deployment.

oci.generative_ai.models.CreateImportedModelDetails

The data to import a model.

oci.generative_ai.models.CreateModelDetails

The data to create a custom model.

oci.generative_ai.models.CreateRoutingProfileDetails

The data to create a routing profile.

oci.generative_ai.models.CreateSandboxWarmPoolDetails

Create Sandbox Warm Pool Details.

oci.generative_ai.models.CreateSchemasDatabaseToolsConnectionDetails

Array of database schemas or database objects included in the enrichment pipeline for data sources connected via an OCI Database Tools connection.

oci.generative_ai.models.CreateSchemasDetails

Array of database schemas or other database objects to include in enrichment pipeline.

oci.generative_ai.models.CreateSemanticStoreDetails

The data to create a SemanticStore.

oci.generative_ai.models.CreateSingleDockerArtifactDetails

CreateSingleDockerArtifactDetails model.

oci.generative_ai.models.CreateVectorStoreConnectorDetails

The data to create a VectorStoreConnector.

oci.generative_ai.models.CreateVectorStoreConnectorFileSyncDetails

The data to create a VectorStoreConnectorFileSync.

oci.generative_ai.models.CustomSandboxOutboundNetworkingConfig

Outbound networking configuration that uses a customer subnet for sandboxes in this project.

oci.generative_ai.models.CustomSemanticStoreModelSelection

Uses a customer-selected generative AI model for SemanticStore enrichment.

oci.generative_ai.models.DataSourceDatabaseToolsConnectionDetails

Defines the OCI Database Tools Connection data source that the semantic model connects to.

oci.generative_ai.models.DataSourceDetails

Defines the data source that the semantic model connects to.

oci.generative_ai.models.DatabaseToolsConnection

DatabaseToolsConnection model.

oci.generative_ai.models.Dataset

The dataset used to fine-tune the model.

oci.generative_ai.models.DedicatedAiCluster

Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models.

oci.generative_ai.models.DedicatedAiClusterCapacity

The total capacity for a dedicated AI cluster.

oci.generative_ai.models.DedicatedAiClusterCollection

Results of a dedicate AI cluster search.

oci.generative_ai.models.DedicatedAiClusterHostingCapacity

The capacity of a hosting type dedicated AI cluster.

oci.generative_ai.models.DedicatedAiClusterSummary

Summary information about a dedicated AI cluster.

oci.generative_ai.models.DefaultSemanticStoreModelSelection

Uses the service default generative AI model for SemanticStore enrichment.

oci.generative_ai.models.EmbeddingConfig

Configuration for generating embeddings from extracted information.

oci.generative_ai.models.Endpoint

To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING.

oci.generative_ai.models.EndpointCollection

Results of an endpoint search.

oci.generative_ai.models.EndpointSummary

Summary information for an endpoint resource.

oci.generative_ai.models.EnvironmentVariable

The environment variables for the Hosted Application

oci.generative_ai.models.ExtractionConfig

Configuration for information extraction from conversation content.

oci.generative_ai.models.FileSyncIngestionLogs

A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector

oci.generative_ai.models.FileSyncIngestionLogsCollection

Results of a VectorStoreConnector Ingestion Log search.

oci.generative_ai.models.FileSyncStatistics

Synchronization Statistics for a VectorStore File Sync operation or for a VectorStore Connector

oci.generative_ai.models.FineTuneDetails

Details about fine-tuning a custom model.

oci.generative_ai.models.GenAiModelLlmSelection

LLM selection with specific Gen AI model.

oci.generative_ai.models.GenerativeAiPrivateEndpoint

Generative AI private endpoint.

oci.generative_ai.models.GenerativeAiPrivateEndpointCollection

Collection of GenerativeAiPrivateEndpointSummary

oci.generative_ai.models.GenerativeAiPrivateEndpointSummary

List of Generative AI private endpoints.

oci.generative_ai.models.GenerativeAiProject

A GenerativeAiProject is a logical container that stores conversation, file and containers.

oci.generative_ai.models.GenerativeAiProjectCollection

Results of a GenerativeAiProject search.

oci.generative_ai.models.GenerativeAiProjectSummary

Summary information for a GenerativeAiProject.

oci.generative_ai.models.GpuAllocation

GPU allocation details for an underlying capacity allocation.

oci.generative_ai.models.HostedApplication

Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application.

oci.generative_ai.models.HostedApplicationBase

Common properties shared by HostedApplication and HostedApplicationIam.

oci.generative_ai.models.HostedApplicationCollection

Results of a dedicate hosted application search.

oci.generative_ai.models.HostedApplicationIam

Hosted Application IAM, defines shared configurations that apply across multiple deployments of the Agent or MCP application.

oci.generative_ai.models.HostedApplicationStorage

Represents managed storage for an application.

oci.generative_ai.models.HostedApplicationStorageCollection

Results of a dedicate hosted application search.

oci.generative_ai.models.HostedApplicationStorageSummary

Summary information about a hosted application storage.

oci.generative_ai.models.HostedApplicationSummary

Summary information about a hosted application.

oci.generative_ai.models.HostedDeployment

Hosted deployment is designed to support the full spectrum of agent use cases from lightweight, employee-facing assistants and internal workflow automation, to enterprise-grade, large-scale customer-facing workloads.

oci.generative_ai.models.HostedDeploymentCollection

Results of a dedicate hosted deployment search.

oci.generative_ai.models.HostedDeploymentSummary

Summary information about a hosted deployment.

oci.generative_ai.models.HuggingFaceModel

Configuration for importing a model from Hugging Face.

oci.generative_ai.models.IdcsAuthConfig

Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG or IDCS_SESSION_AUTH_CONFIG.

oci.generative_ai.models.ImportedModel

Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage.

oci.generative_ai.models.ImportedModelCollection

Represents the result of a list operation for imported models.

oci.generative_ai.models.ImportedModelSummary

Summary of the importedModel.

oci.generative_ai.models.InboundAuthConfig

The inbound authentication configuration for the Hosted Application.

oci.generative_ai.models.InboundNetworkingConfig

Inbound Networking configuration.

oci.generative_ai.models.KeyDetails

The data to create/renew an API key item.

oci.generative_ai.models.LlmSelection

LLM selection configuration.

oci.generative_ai.models.LongTermMemoryConfig

Configuration settings for long-term memory behavior.

oci.generative_ai.models.LoraTrainingConfig

The Lora training method hyperparameters.

oci.generative_ai.models.ManagedSandboxOutboundNetworkingConfig

Outbound networking configuration that uses Oracle-managed networking for sandboxes in this project.

oci.generative_ai.models.Model

You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model.

oci.generative_ai.models.ModelCollection

Results of a model search.

oci.generative_ai.models.ModelConfig

Base model configuration shared across GenAI Project memory.

oci.generative_ai.models.ModelDataSource

Defines the source location and method used to import the model.

oci.generative_ai.models.ModelDiscovery

Metadata describing a specific model

oci.generative_ai.models.ModelDiscoveryCollection

A paginated collection of model discovery results.

oci.generative_ai.models.ModelMetrics

Model metrics during the creation of a new model.

oci.generative_ai.models.ModelModalitySupport

A supported input-to-output modality transformation for a model.

oci.generative_ai.models.ModelRoutingPolicy

The model routing policy for the routing profile.

oci.generative_ai.models.ModelSummary

Summary of the model.

oci.generative_ai.models.NetworkingConfig

Networking configuration.

oci.generative_ai.models.ObjectStorageConfig

OCI Object storage configuration details.

oci.generative_ai.models.ObjectStorageDataset

The dataset is stored in an OCI Object Storage bucket.

oci.generative_ai.models.ObjectStorageObject

Details about the object storage location.

oci.generative_ai.models.OciObjectStorageConfiguration

The OCI Object Storage namespace and bucket details of the datasource

oci.generative_ai.models.OutboundNetworkingConfig

Outbound Networking configuration.

oci.generative_ai.models.Parameter

Defines a configurable parameter supported by a model.

oci.generative_ai.models.PiiDetectionConfig

The configuration details for personally identifiable information (PII) detection, in prompts and responses.

oci.generative_ai.models.PreviousRoutingProfileState

A bounded snapshot of the previous state of a routing profile.

oci.generative_ai.models.PromptInjectionConfig

The configuration details for prompt injection (PI) detection.

oci.generative_ai.models.RefreshScheduleDetails

Specifies a refresh schedule.

oci.generative_ai.models.RefreshScheduleIntervalDetails

Defines the refresh schedule by specifying the interval between each refresh.

oci.generative_ai.models.RefreshScheduleNoneDetails

Allows user to opt out of automated synchronization schedule.

oci.generative_ai.models.RefreshScheduleOnCreateDetails

Only trigger the enrichment at the creation time.

oci.generative_ai.models.RegionRoutingPolicy

The cross-region routing policy for the routing profile.

oci.generative_ai.models.RenewApiKeyDetails

The data to renew an API key item.

oci.generative_ai.models.RoutingProfile

A routing profile is a reusable set of policies that controls how Smart Router selects a target region and model for inference traffic.

oci.generative_ai.models.RoutingProfileCollection

Results of a routing profile search.

oci.generative_ai.models.RoutingProfileSummary

Summary information for a routing profile resource.

oci.generative_ai.models.SandboxAllowAllNetworkPolicy

Network policy that allows all network access for sandboxes in this project.

oci.generative_ai.models.SandboxAllowNetworkPolicy

Network policy that allows access only to specified domains for sandboxes in this project.

oci.generative_ai.models.SandboxConfig

Sandbox configuration under a project.

oci.generative_ai.models.SandboxCredentialInjectionHeader

The HTTP request header and OCI Vault secret used by a credential injection rule.

oci.generative_ai.models.SandboxCredentialInjectionRule

Base type for a credential injection rule.

oci.generative_ai.models.SandboxCredentialProfile

A named Project-local credential profile selected explicitly when a Sandbox is created.

oci.generative_ai.models.SandboxDenyAllNetworkPolicy

Network policy that denies all network access for sandboxes in this project.

oci.generative_ai.models.SandboxHttpHeaderCredentialInjectionRule

An HTTP_HEADER rule that binds one exact HTTPS host on port 443 to exactly one injected HTTP request header and one OCI Vault secret.

oci.generative_ai.models.SandboxNetworkPolicy

Base network policy for sandboxes in a project using Oracle-managed outbound networking.

oci.generative_ai.models.SandboxOutboundNetworkingConfig

Base outbound networking configuration for sandboxes in a project.

oci.generative_ai.models.SandboxWarmPool

CP-owned configuration and management lifecycle of a Project-owned Sandbox warm pool.

oci.generative_ai.models.SandboxWarmPoolCollection

Sandbox Warm Pool Collection.

oci.generative_ai.models.SandboxWarmPoolConfig

Read-only default warm-pool capacities for managed-runtime sandboxes.

oci.generative_ai.models.SandboxWarmPoolRuntimeStatus

Best-effort runtime observations returned by GetSandboxWarmPool.

oci.generative_ai.models.SandboxWarmPoolSummary

CP-owned configuration and management lifecycle summary.

oci.generative_ai.models.ScalingConfig

The auto scaling configuration for the Hosted Application.

oci.generative_ai.models.ScheduleConfig

The Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation.

oci.generative_ai.models.ScheduleCronConfig

The scheduled UNIX cron definition.

oci.generative_ai.models.ScheduleIntervalConfig

The interval schedule config.

oci.generative_ai.models.SchemaItem

Represents a database schema identified by name.

oci.generative_ai.models.SchemasDatabaseToolsConnectionDetails

Array of database schemas or database objects included in the enrichment pipeline for data sources connected via an OCI Database Tools connection.

oci.generative_ai.models.SchemasDetails

Array of database schemas or other database objects to include in enrichment pipeline.

oci.generative_ai.models.SemanticStore

A Semantic Store is a container resource of semantic records, with controllable enrichment refresh and synchronization policy.

oci.generative_ai.models.SemanticStoreCollection

Results of a SemanticStore list.

oci.generative_ai.models.SemanticStoreModelSelection

Model selection configuration for SemanticStore enrichment.

oci.generative_ai.models.SemanticStoreSummary

Summary information for a SemanticStore.

oci.generative_ai.models.SetApiKeyStateDetails

The data to set the state of an API key item.

oci.generative_ai.models.ShortTermMemoryOptimizationConfig

Configuration settings for short-term memory optimization.

oci.generative_ai.models.SingleDockerArtifact

Container/artifact configuration for the deployment.

oci.generative_ai.models.StandardLongTermMemoryStrategy

Standard strategy settings for long-term memory.

oci.generative_ai.models.StorageConfig

The type of service-managed storage.

oci.generative_ai.models.TFewTrainingConfig

The TFEW training method hyperparameters.

oci.generative_ai.models.TextGenerationModelMetrics

The text generation model metrics of the fine-tuning process.

oci.generative_ai.models.TrainingConfig

The fine-tuning method and hyperparameters used for fine-tuning a custom model.

oci.generative_ai.models.UpdateApiKeyDetails

The data to update an API key.

oci.generative_ai.models.UpdateDedicatedAiClusterDetails

The data to update a dedicated AI cluster.

oci.generative_ai.models.UpdateEndpointDetails

The data to update an endpoint.

oci.generative_ai.models.UpdateGenerativeAiPrivateEndpointDetails

The details required to update a Generative AI private endpoint.

oci.generative_ai.models.UpdateGenerativeAiProjectDetails

The data to update a GenerativeAiProject.

oci.generative_ai.models.UpdateHostedApplicationBaseDetails

Common update properties shared by HostedApplication and HostedApplicationIam.

oci.generative_ai.models.UpdateHostedApplicationDetails

The data to update a hosted application.

oci.generative_ai.models.UpdateHostedApplicationIamDetails

The data to update a hosted application.

oci.generative_ai.models.UpdateHostedDeploymentDetails

The data to update a hosted deployment.

oci.generative_ai.models.UpdateImportedModelDetails

The data to update an imported model.

oci.generative_ai.models.UpdateModelDetails

The data to update a custom model.

oci.generative_ai.models.UpdateRoutingProfileDetails

The data to update a routing profile.

oci.generative_ai.models.UpdateSandboxWarmPoolDetails

Update Sandbox Warm Pool Details.

oci.generative_ai.models.UpdateSemanticStoreDetails

The data to update a SemanticStore.

oci.generative_ai.models.UpdateVectorStoreConnectorDetails

The data to update a VectorStoreConnector.

oci.generative_ai.models.VanillaTrainingConfig

The Vanilla training method hyperparameters.

oci.generative_ai.models.VectorStoreConnector

A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data from external systems into the VectorStore at scale.

oci.generative_ai.models.VectorStoreConnectorCollection

Results of a VectorStoreConnector search.

oci.generative_ai.models.VectorStoreConnectorFileSync

The VectorStoreConnectorFileSync is an operation that carries out the data sync operation between the datasource and the VectorStore.

oci.generative_ai.models.VectorStoreConnectorFileSyncCollection

Results of a VectorStoreConnectorFileSync search.

oci.generative_ai.models.VectorStoreConnectorFileSyncSummary

Summary information for a VectorStoreConnectorFileSync

oci.generative_ai.models.VectorStoreConnectorIngestionLogs

A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector

oci.generative_ai.models.VectorStoreConnectorIngestionLogsCollection

Results of a VectorStoreConnector Ingestion Log search.

oci.generative_ai.models.VectorStoreConnectorStats

File synchronization statistics for a VectorStoreConnector.

oci.generative_ai.models.VectorStoreConnectorSummary

Summary information for a VectorStoreConnector

oci.generative_ai.models.WorkRequest

An asynchronous work request.

oci.generative_ai.models.WorkRequestError

An error encountered while performing an operation that is tracked by this work request.

oci.generative_ai.models.WorkRequestErrorCollection

A list of work request errors.

oci.generative_ai.models.WorkRequestLogEntry

The log message from performing an operation that is tracked by this work request.

oci.generative_ai.models.WorkRequestLogEntryCollection

A list of work request logs.

oci.generative_ai.models.WorkRequestResource

The resource created or operated on by a work request.

oci.generative_ai.models.WorkRequestSummary

Summary information about an asynchronous work request.

oci.generative_ai.models.WorkRequestSummaryCollection

A list of work requests.