The identity and technical contract details declared by the specification.
Dataset
object
The dataset used to fine-tune the model. Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the d…
1 property
1 required
ConversationConfig
object
Holds configuration related to conversation retention
2 properties
InboundAuthConfig
object
The client-side inbound authentication configuration for the Hosted Application. Defines the network access rules. When unspecified, the service applies the de…
2 properties
1 required
VectorStoreConnector
object
A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data from external systems into the VectorStore at scale. I…
16 properties
11 required
ModelConfig
object
Base model configuration shared across GenAI Project memory.
2 properties
2 required
UpdateApiKeyDetails
object
The data to update an API key.
4 properties
OutboundNetworkingConfig
object
Outbound Networking configuration.
3 properties
1 required
WorkRequestSummary
object
Summary information about an asynchronous work request.
9 properties
7 required
Model
object
You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a cust…
23 properties
6 required
LongTermMemoryConfig
object
Configuration settings for long-term memory behavior.
1 property
SemanticStoreSummary
object
Summary information for a SemanticStore.
14 properties
11 required
EndpointSummary
object
Summary information for an endpoint resource.
17 properties
6 required
CreateSemanticStoreDetails
object
The data to create a SemanticStore.
8 properties
4 required
ModelDataSource
object
Defines the source location and method used to import the model. Supports importing from Hugging Face, an Object Storage location, or by referencing an already…
1 property
CreateHostedApplicationBaseDetails
object
Common creation properties shared by HostedApplication and HostedApplicationIam.
9 properties
2 required
ModelMetrics
object
Model metrics during the creation of a new model.
1 property
1 required
HostedDeploymentSummary
object
Summary information about a hosted deployment.
10 properties
2 required
DedicatedAiClusterCapacity
object
The total capacity for a dedicated AI cluster.
1 property
1 required
UpdateEndpointDetails
object
The data to update an endpoint.
8 properties
CreateGenerativeAiProjectDetails
object
The data to create a GenerativeAiProject.
8 properties
1 required
Artifact
object
Container/artifact configuration for the deployment.
6 properties
Endpoint
object
To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING. To use any of the API operations, you must b…
18 properties
6 required
CreateVectorStoreConnectorDetails
object
The data to create a VectorStoreConnector.
9 properties
4 required
CreateGenerativeAiPrivateEndpointDetails
object
The details required to create a Generative AI private endpoint.
11 properties
3 required
NetworkingConfig
object
Networking configuration.
2 properties
2 required
WorkRequestSummaryCollection
object
A list of work requests. Can contain work requests and other information such as metadata.
1 property
1 required
CreateEndpointDetails
object
The data to create an endpoint.
11 properties
3 required
CreateArtifactDetails
object
Artifact configuration input for the deployment.
2 properties
CreateDataSourceDetails
object
Defines the data source that the semantic model connects to.
1 property
1 required
GenerativeAiProjectSummary
object
Summary information for a GenerativeAiProject.
11 properties
7 required
HostedApplication
Hosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application. To use any of the API operations, you…
HostedDeploymentCollection
object
Results of a dedicate hosted deployment search. Contains Hosted Deployment Summary items and other information such as metadata.
1 property
1 required
HostedApplicationStorageCollection
object
Results of a dedicate hosted application search. Contains HostedApplicationStorageSummary items and other information such as metadata.
1 property
1 required
ExtractionConfig
object
Configuration for information extraction from conversation content.
ChangeGenerativeAiPrivateEndpointCompartmentDetails
object
The details required to change a private endpoint compartment.
1 property
1 required
PiiDetectionConfig
object
The configuration details for personally identifiable information (PII) detection, in prompts and responses.
3 properties
1 required
HostedApplicationBase
object
Common properties shared by HostedApplication and HostedApplicationIam.
15 properties
3 required
CreateHostedDeploymentDetails
object
The data to create a hosted deployment. Exactly one of hostedApplicationId or hostedApplicationIamId must be provided.
6 properties
1 required
VectorStoreConnectorStats
object
File synchronization statistics for a VectorStoreConnector.
12 properties
1 required
GenerativeAiPrivateEndpoint
object
Generative AI private endpoint.
19 properties
7 required
ImportedModel
object
Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage. To use any of the API operations, you mus…
16 properties
5 required
WorkRequestErrorCollection
object
A list of work request errors. Can contain errors and other information such as metadata.
1 property
1 required
VectorStoreConnectorCollection
object
Results of a VectorStoreConnector search. Contains VectorStoreConnectorSummary items.
1 property
1 required
UpdateHostedDeploymentDetails
object
The data to update a hosted deployment.
3 properties
1 required
UpdateImportedModelDetails
object
The data to update an imported model.
6 properties
WorkRequestError
object
An error encountered while performing an operation that is tracked by this work request.
3 properties
3 required
DataSourceDetails
object
Defines the data source that the semantic model connects to.
1 property
1 required
ScalingConfig
object
The auto scaling configuration for the Hosted Application. Defines the minimum and maximum number of replicas. When unspecified, the service applies service-de…
7 properties
1 required
EmbeddingConfig
object
Configuration for generating embeddings from extracted information.
ChangeGenerativeAiProjectCompartmentDetails
object
The details to move a GenerativeAiProject to another compartment.
1 property
1 required
StorageConfig
object
The type of service-managed storage.
2 properties
2 required
CreateVectorStoreConnectorFileSyncDetails
object
The data to create a VectorStoreConnectorFileSync.
4 properties
1 required
VectorStoreConnectorFileSyncCollection
object
Results of a VectorStoreConnectorFileSync search.
1 property
1 required
CondenserConfig
object
Configuration for condensing conversation content.
CreateHostedApplicationDetails
The details required to create a hosted application.
GenerativeAiProject
object
A GenerativeAiProject is a logical container that stores conversation, file and containers. To use any of the API operations, you must be authorized in an IAM…
14 properties
7 required
DedicatedAiClusterSummary
object
Summary information about a dedicated AI cluster.
15 properties
7 required
UpdateHostedApplicationIamDetails
The data to update a hosted application.
UpdateDedicatedAiClusterDetails
object
The data to update a dedicated AI cluster.
5 properties
SchemasDetails
object
Array of database schemas or other database objects to include in enrichment pipeline.
1 property
1 required
WorkRequestLogEntry
object
The log message from performing an operation that is tracked by this work request.
2 properties
2 required
GenerativeAiPrivateEndpointSummary
object
List of Generative AI private endpoints.
17 properties
7 required
ApiKeySummary
object
Summary of the API key.
12 properties
6 required
FileSyncStatistics
object
Synchronization Statistics for a VectorStore File Sync operation or for a VectorStore Connector
2 properties
EnvironmentVariable
object
The environment variables for the Hosted Application
3 properties
3 required
SemanticStoreCollection
object
Results of a SemanticStore list. Contains SemanticStoreSummary items and other information such as metadata.
1 property
1 required
ImportedModelSummary
object
Summary of the importedModel.
15 properties
5 required
SingleDockerArtifact
Container/artifact configuration for the deployment.
ChangeSemanticStoreCompartmentDetails
object
The details to move a SemanticStore to another compartment.
1 property
1 required
EndpointCollection
object
Results of an endpoint search. Contains EndpointSummary items and other information such as metadata.
1 property
1 required
WorkRequest
object
An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operatio…
9 properties
7 required
ChangeHostedApplicationCompartmentDetails
object
The details to move a hosted application to another compartment.
1 property
1 required
StandardLongTermMemoryStrategy
object
Standard strategy settings for long-term memory.
3 properties
1 required
UpdateVectorStoreConnectorDetails
object
The data to update a VectorStoreConnector.
6 properties
AddArtifactDetails
object
new artifact details.
3 properties
1 required
ConnectorConfiguration
object
Datasource configuration for the connector.
1 property
1 required
GenerativeAiProjectCollection
object
Results of a GenerativeAiProject search. Contains GenerativeAiProjectSummary items and other information such as metadata.
1 property
1 required
CreateApiKeyDetails
object
The data to create an API key.
6 properties
3 required
VectorStoreConnectorIngestionLogs
object
A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector
10 properties
3 required
FileSyncIngestionLogs
object
A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector
9 properties
3 required
IdcsAuthConfig
object
Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCSAUTHCONFIG. This object must be specified when inboundAuthConf…
3 properties
2 required
ImportedModelCollection
object
Represents the result of a list operation for imported models.
1 property
1 required
ModelSummary
object
Summary of the model.
20 properties
6 required
ChangeHostedApplicationStorageCompartmentDetails
object
The details to move a hosted application storage to another compartment.
1 property
1 required
ApiKeyItem
object
The ApiKey item.
10 properties
5 required
DedicatedAiCluster
object
Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicat…
16 properties
7 required
DedicatedAiClusterCollection
object
Results of a dedicate AI cluster search. Contains DedicatedAiClusterSummary items and other information such as metadata.
1 property
1 required
VectorStoreConnectorSummary
object
Summary information for a VectorStoreConnector
15 properties
11 required
WorkRequestResource
object
The resource created or operated on by a work request.
5 properties
3 required
LlmSelection
object
LLM selection configuration.
1 property
1 required
CreateSchemasDetails
object
Array of database schemas or other database objects to include in enrichment pipeline.
1 property
1 required
CreateModelDetails
object
The data to create a custom model.
9 properties
3 required
ModelCollection
object
Results of a model search. Contains ModelSummary items and other information such as metadata.
1 property
1 required
RenewApiKeyDetails
object
The data to renew an API key item.
3 properties
1 required
FineTuneDetails
object
Details about fine-tuning a custom model.
3 properties
2 required
UpdateGenerativeAiPrivateEndpointDetails
object
The details required to update a Generative AI private endpoint.
8 properties
InboundNetworkingConfig
object
Inbound Networking configuration.
2 properties
1 required
UpdateGenerativeAiProjectDetails
object
The data to update a GenerativeAiProject.
7 properties
HostedApplicationStorageSummary
object
Summary information about a hosted application storage.
11 properties
3 required
SemanticStore
object
A Semantic Store is a container resource of semantic records, with controllable enrichment refresh and synchronization policy. To use any of the API operations…
14 properties
11 required
RefreshScheduleDetails
object
Specifies a refresh schedule. Null represents no automated synchronization schedule.
1 property
1 required
ApiKeyCollection
object
Results of a ApiKey search.
1 property
1 required
GenerativeAiPrivateEndpointCollection
object
Collection of GenerativeAiPrivateEndpointSummary
1 property
1 required
ScheduleConfig
object
The Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation.
4 properties
1 required
ShortTermMemoryOptimizationConfig
object
Configuration settings for short-term memory optimization.
2 properties
1 required
FileSyncIngestionLogsCollection
object
Results of a VectorStoreConnector Ingestion Log search.
1 property
1 required
HostedApplicationStorage
object
defines a physical storage (database or cache) managed by service. Each application can choose one or two storages for certain purpose such as agent memory. To…
13 properties
6 required
WorkRequestLogEntryCollection
object
A list of work request logs. Can contain logs and other information such as metadata.
1 property
1 required
UpdateHostedApplicationDetails
The data to update a hosted application.
PromptInjectionConfig
object
The configuration details for prompt injection (PI) detection. This is for input only.
3 properties
1 required
ContentModerationConfig
object
The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses.
3 properties
1 required
CreateHostedApplicationStorageDetails
object
The data to create a hosted application storage.
6 properties
3 required
VectorStoreConnectorIngestionLogsCollection
object
Results of a VectorStoreConnector Ingestion Log search.
1 property
1 required
ChangeModelCompartmentDetails
object
The details to move a custom model to another compartment.
1 property
1 required
HostedApplicationIam
Hosted Application IAM, defines shared configurations that apply across multiple deployments of the Agent or MCP application. To use any of the API operations,…
SetApiKeyStateDetails
object
The data to set the state of an API key item.
4 properties
2 required
HostedApplicationSummary
object
Summary information about a hosted application.
10 properties
3 required
UpdateSemanticStoreDetails
object
The data to update a SemanticStore.
6 properties
ApiKey
object
ApiKeys are resources used to access GenAI models. You must be authorized through an IAM policy to use any API operations. If you're not authorized, contact an…
12 properties
6 required
ChangeApiKeyCompartmentDetails
object
The details to move an APIKey to another compartment.
1 property
1 required
TrainingConfig
object
The fine-tuning method and hyperparameters used for fine-tuning a custom model.
7 properties
1 required
ChangeEndpointCompartmentDetails
object
The details to move an endpoint to another compartment.
1 property
1 required
HostedApplicationCollection
object
Results of a dedicate hosted application search. Contains HostedApplicationSummary items and other information such as metadata.
1 property
1 required
Error
object
Error information.
2 properties
2 required
VectorStoreConnectorFileSyncSummary
object
Summary information for a VectorStoreConnectorFileSync
16 properties
11 required
ChangeDedicatedAiClusterCompartmentDetails
object
The details to move a dedicated AI cluster to another compartment.
1 property
1 required
KeyDetails
object
The data to create/renew an API key item.
2 properties
2 required
UpdateHostedApplicationBaseDetails
object
Common update properties shared by HostedApplication and HostedApplicationIam.
6 properties
HostedDeployment
object
Hosted deployment is designed to support the full spectrum of agent use cases from lightweight, employee-facing assistants and internal workflow automation, to…
12 properties
4 required
CreateDedicatedAiClusterDetails
object
The data to create a dedicated AI cluster.
8 properties
4 required
ChangeImportedModelCompartmentDetails
object
The details to move an imported model to another compartment.
1 property
1 required
CreateHostedApplicationIamDetails
The details required to create a hosted application.
CreateImportedModelDetails
object
The data to import a model.
9 properties
2 required
UpdateModelDetails
object
The data to update a custom model.
6 properties
VectorStoreConnectorFileSync
object
The VectorStoreConnectorFileSync is an operation that carries out the data sync operation between the datasource and the VectorStore. The FileSync can be trigg…
16 properties
11 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.