Class GenerativeAiClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.generativeai.GenerativeAiClient
-
- All Implemented Interfaces:
GenerativeAi,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20231130") public class GenerativeAiClient extends BaseSyncClient implements GenerativeAi
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGenerativeAiClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for GenerativeAi.
-
Constructor Summary
Constructors Constructor Description GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.generativeai.GenerativeAi
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
GenerativeAiClient
@Deprecated public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-GenerativeAiClient.Builder.executorService
-
-
Method Detail
-
builder
public static GenerativeAiClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:GenerativeAiSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceGenerativeAi- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:GenerativeAiSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceGenerativeAi- Parameters:
regionId- The public region ID.
-
addArtifact
public AddArtifactResponse addArtifact(AddArtifactRequest request)
Description copied from interface:GenerativeAiadd image with isAutoDeploy flag.- Specified by:
addArtifactin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelVectorStoreConnectorFileSync
public CancelVectorStoreConnectorFileSyncResponse cancelVectorStoreConnectorFileSync(CancelVectorStoreConnectorFileSyncRequest request)
Description copied from interface:GenerativeAiCancels a vectorStoreConnectorFileSync.- Specified by:
cancelVectorStoreConnectorFileSyncin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeApiKeyCompartment
public ChangeApiKeyCompartmentResponse changeApiKeyCompartment(ChangeApiKeyCompartmentRequest request)
Description copied from interface:GenerativeAiMoves an API key into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeApiKeyCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDedicatedAiClusterCompartment
public ChangeDedicatedAiClusterCompartmentResponse changeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a dedicated AI cluster into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeDedicatedAiClusterCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeEndpointCompartment
public ChangeEndpointCompartmentResponse changeEndpointCompartment(ChangeEndpointCompartmentRequest request)
Description copied from interface:GenerativeAiMoves an endpoint into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeEndpointCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeGenerativeAiPrivateEndpointCompartment
public ChangeGenerativeAiPrivateEndpointCompartmentResponse changeGenerativeAiPrivateEndpointCompartment(ChangeGenerativeAiPrivateEndpointCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a Generative AI private endpoint into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeGenerativeAiPrivateEndpointCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeGenerativeAiProjectCompartment
public ChangeGenerativeAiProjectCompartmentResponse changeGenerativeAiProjectCompartment(ChangeGenerativeAiProjectCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a generativeAiProject into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeGenerativeAiProjectCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeHostedApplicationCompartment
public ChangeHostedApplicationCompartmentResponse changeHostedApplicationCompartment(ChangeHostedApplicationCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a hosted application into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeHostedApplicationCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeHostedApplicationStorageCompartment
public ChangeHostedApplicationStorageCompartmentResponse changeHostedApplicationStorageCompartment(ChangeHostedApplicationStorageCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a hosted application storage into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeHostedApplicationStorageCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeImportedModelCompartment
public ChangeImportedModelCompartmentResponse changeImportedModelCompartment(ChangeImportedModelCompartmentRequest request)
Description copied from interface:GenerativeAiMoves an imported model into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeImportedModelCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeModelCompartment
public ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a custom model into a different compartment.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeModelCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSemanticStoreCompartment
public ChangeSemanticStoreCompartmentResponse changeSemanticStoreCompartment(ChangeSemanticStoreCompartmentRequest request)
Description copied from interface:GenerativeAiMoves a SemanticStore into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeSemanticStoreCompartmentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createApiKey
public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request)
Description copied from interface:GenerativeAiCreates a new API key in the specified compartment.- Specified by:
createApiKeyin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDedicatedAiCluster
public CreateDedicatedAiClusterResponse createDedicatedAiCluster(CreateDedicatedAiClusterRequest request)
Description copied from interface:GenerativeAiCreates a dedicated AI cluster.- Specified by:
createDedicatedAiClusterin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createEndpoint
public CreateEndpointResponse createEndpoint(CreateEndpointRequest request)
Description copied from interface:GenerativeAiCreates an endpoint.The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.
- Specified by:
createEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createGenerativeAiPrivateEndpoint
public CreateGenerativeAiPrivateEndpointResponse createGenerativeAiPrivateEndpoint(CreateGenerativeAiPrivateEndpointRequest request)
Description copied from interface:GenerativeAiCreates a Generative AI private endpoint.- Specified by:
createGenerativeAiPrivateEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createGenerativeAiProject
public CreateGenerativeAiProjectResponse createGenerativeAiProject(CreateGenerativeAiProjectRequest request)
Description copied from interface:GenerativeAiCreates a GenerativeAiProject.The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress.
- Specified by:
createGenerativeAiProjectin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createHostedApplication
public CreateHostedApplicationResponse createHostedApplication(CreateHostedApplicationRequest request)
Description copied from interface:GenerativeAiCreates a hosted application.- Specified by:
createHostedApplicationin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createHostedApplicationStorage
public CreateHostedApplicationStorageResponse createHostedApplicationStorage(CreateHostedApplicationStorageRequest request)
Description copied from interface:GenerativeAiCreates a hosted application storage.- Specified by:
createHostedApplicationStoragein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createHostedDeployment
public CreateHostedDeploymentResponse createHostedDeployment(CreateHostedDeploymentRequest request)
Description copied from interface:GenerativeAiCreates a hosted deployment.- Specified by:
createHostedDeploymentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createImportedModel
public CreateImportedModelResponse createImportedModel(CreateImportedModelRequest request)
Description copied from interface:GenerativeAiImport a model from ModelDataSource.The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress.
- Specified by:
createImportedModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createModel
public CreateModelResponse createModel(CreateModelRequest request)
Description copied from interface:GenerativeAiCreates a custom model by fine-tuning a base model with your own dataset.You can create a new custom models or create a new version of existing custom model..
The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.
- Specified by:
createModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSemanticStore
public CreateSemanticStoreResponse createSemanticStore(CreateSemanticStoreRequest request)
Description copied from interface:GenerativeAiCreates a SemanticStore.- Specified by:
createSemanticStorein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createVectorStoreConnector
public CreateVectorStoreConnectorResponse createVectorStoreConnector(CreateVectorStoreConnectorRequest request)
Description copied from interface:GenerativeAiCreates a VectorStoreConnector.The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress.
- Specified by:
createVectorStoreConnectorin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createVectorStoreConnectorFileSync
public CreateVectorStoreConnectorFileSyncResponse createVectorStoreConnectorFileSync(CreateVectorStoreConnectorFileSyncRequest request)
Description copied from interface:GenerativeAiCreates a File Sync operation for a VectorStoreConnector.The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress.
- Specified by:
createVectorStoreConnectorFileSyncin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteApiKey
public DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest request)
Description copied from interface:GenerativeAiDeletes an API key.- Specified by:
deleteApiKeyin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDedicatedAiCluster
public DeleteDedicatedAiClusterResponse deleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request)
Description copied from interface:GenerativeAiDeletes a dedicated AI cluster.You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.
- Specified by:
deleteDedicatedAiClusterin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteEndpoint
public DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest request)
Description copied from interface:GenerativeAiDeletes an endpoint.- Specified by:
deleteEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteGenerativeAiPrivateEndpoint
public DeleteGenerativeAiPrivateEndpointResponse deleteGenerativeAiPrivateEndpoint(DeleteGenerativeAiPrivateEndpointRequest request)
Description copied from interface:GenerativeAiDeletes a Generative AI private endpoint usingprivateEndpointId.- Specified by:
deleteGenerativeAiPrivateEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteGenerativeAiProject
public DeleteGenerativeAiProjectResponse deleteGenerativeAiProject(DeleteGenerativeAiProjectRequest request)
Description copied from interface:GenerativeAiDeletes a generativeAiProject.- Specified by:
deleteGenerativeAiProjectin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHostedApplication
public DeleteHostedApplicationResponse deleteHostedApplication(DeleteHostedApplicationRequest request)
Description copied from interface:GenerativeAiDeletes a hosted application.You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can’t be undone.
- Specified by:
deleteHostedApplicationin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHostedApplicationStorage
public DeleteHostedApplicationStorageResponse deleteHostedApplicationStorage(DeleteHostedApplicationStorageRequest request)
Description copied from interface:GenerativeAiDeletes a hosted application.You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can’t be undone.
- Specified by:
deleteHostedApplicationStoragein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHostedDeployment
public DeleteHostedDeploymentResponse deleteHostedDeployment(DeleteHostedDeploymentRequest request)
Description copied from interface:GenerativeAiDeletes a hosted deployment.You can only delete hosted deployment without attached resources. Before you delete a hosting hosted deployment, you must delete the endpoints associated to that deployment. Before you delete a fine-tuning hosted deployment, you must delete the custom model on that deployment. The delete action permanently deletes the cluster. This action can’t be undone.
- Specified by:
deleteHostedDeploymentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHostedDeploymentArtifact
public DeleteHostedDeploymentArtifactResponse deleteHostedDeploymentArtifact(DeleteHostedDeploymentArtifactRequest request)
Description copied from interface:GenerativeAidelete artifact.- Specified by:
deleteHostedDeploymentArtifactin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteImportedModel
public DeleteImportedModelResponse deleteImportedModel(DeleteImportedModelRequest request)
Description copied from interface:GenerativeAiDeletes an imported model.An imported model shouldn’t be deleted if there’s one or more active endpoints associated with that imported model.
- Specified by:
deleteImportedModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteModel
public DeleteModelResponse deleteModel(DeleteModelRequest request)
Description copied from interface:GenerativeAiDeletes a custom model.A model shouldn’t be deleted if there’s one or more active endpoints associated with that model.
- Specified by:
deleteModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSemanticStore
public DeleteSemanticStoreResponse deleteSemanticStore(DeleteSemanticStoreRequest request)
Description copied from interface:GenerativeAiDeletes a semanticStore.- Specified by:
deleteSemanticStorein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteVectorStoreConnector
public DeleteVectorStoreConnectorResponse deleteVectorStoreConnector(DeleteVectorStoreConnectorRequest request)
Description copied from interface:GenerativeAiDeletes a vectorStoreConnector.- Specified by:
deleteVectorStoreConnectorin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApiKey
public GetApiKeyResponse getApiKey(GetApiKeyRequest request)
Description copied from interface:GenerativeAiGets information about an API key.- Specified by:
getApiKeyin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDedicatedAiCluster
public GetDedicatedAiClusterResponse getDedicatedAiCluster(GetDedicatedAiClusterRequest request)
Description copied from interface:GenerativeAiGets information about a dedicated AI cluster.- Specified by:
getDedicatedAiClusterin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getEndpoint
public GetEndpointResponse getEndpoint(GetEndpointRequest request)
Description copied from interface:GenerativeAiGets information about an endpoint.- Specified by:
getEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getGenerativeAiPrivateEndpoint
public GetGenerativeAiPrivateEndpointResponse getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointRequest request)
Description copied from interface:GenerativeAiRetrieves an Generative AI private endpoint using aprivateEndpointId.- Specified by:
getGenerativeAiPrivateEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getGenerativeAiProject
public GetGenerativeAiProjectResponse getGenerativeAiProject(GetGenerativeAiProjectRequest request)
Description copied from interface:GenerativeAiGets information about a generativeAiProject.- Specified by:
getGenerativeAiProjectin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHostedApplication
public GetHostedApplicationResponse getHostedApplication(GetHostedApplicationRequest request)
Description copied from interface:GenerativeAiGets information about a hosted application.- Specified by:
getHostedApplicationin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHostedApplicationStorage
public GetHostedApplicationStorageResponse getHostedApplicationStorage(GetHostedApplicationStorageRequest request)
Description copied from interface:GenerativeAiGets information about a hosted application storage.- Specified by:
getHostedApplicationStoragein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHostedDeployment
public GetHostedDeploymentResponse getHostedDeployment(GetHostedDeploymentRequest request)
Description copied from interface:GenerativeAiGets information about a hosted deployment.- Specified by:
getHostedDeploymentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getImportedModel
public GetImportedModelResponse getImportedModel(GetImportedModelRequest request)
Description copied from interface:GenerativeAiGets information about an imported model.- Specified by:
getImportedModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getModel
public GetModelResponse getModel(GetModelRequest request)
Description copied from interface:GenerativeAiGets information about a custom model.- Specified by:
getModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSemanticStore
public GetSemanticStoreResponse getSemanticStore(GetSemanticStoreRequest request)
Description copied from interface:GenerativeAiGets information about a semanticStore.- Specified by:
getSemanticStorein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVectorStoreConnector
public GetVectorStoreConnectorResponse getVectorStoreConnector(GetVectorStoreConnectorRequest request)
Description copied from interface:GenerativeAiGets information about a vectorStoreConnector.- Specified by:
getVectorStoreConnectorin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVectorStoreConnectorFileSync
public GetVectorStoreConnectorFileSyncResponse getVectorStoreConnectorFileSync(GetVectorStoreConnectorFileSyncRequest request)
Description copied from interface:GenerativeAiGets information about a vectorStoreConnectorFileSync.- Specified by:
getVectorStoreConnectorFileSyncin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVectorStoreConnectorStats
public GetVectorStoreConnectorStatsResponse getVectorStoreConnectorStats(GetVectorStoreConnectorStatsRequest request)
Description copied from interface:GenerativeAiGets Sync statistics from a vectorStoreConnector.- Specified by:
getVectorStoreConnectorStatsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:GenerativeAiGets the details of a work request.- Specified by:
getWorkRequestin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listApiKeys
public ListApiKeysResponse listApiKeys(ListApiKeysRequest request)
Description copied from interface:GenerativeAiLists the ApiKeys of a specific compartment.- Specified by:
listApiKeysin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDedicatedAiClusters
public ListDedicatedAiClustersResponse listDedicatedAiClusters(ListDedicatedAiClustersRequest request)
Description copied from interface:GenerativeAiLists the dedicated AI clusters in a specific compartment.- Specified by:
listDedicatedAiClustersin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEndpoints
public ListEndpointsResponse listEndpoints(ListEndpointsRequest request)
Description copied from interface:GenerativeAiLists the endpoints of a specific compartment.- Specified by:
listEndpointsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGenerativeAiPrivateEndpoints
public ListGenerativeAiPrivateEndpointsResponse listGenerativeAiPrivateEndpoints(ListGenerativeAiPrivateEndpointsRequest request)
Description copied from interface:GenerativeAiLists all Generative AI private endpoints in the specified compartment.- Specified by:
listGenerativeAiPrivateEndpointsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGenerativeAiProjects
public ListGenerativeAiProjectsResponse listGenerativeAiProjects(ListGenerativeAiProjectsRequest request)
Description copied from interface:GenerativeAiLists the generativeAiProjects of a specific compartment.- Specified by:
listGenerativeAiProjectsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHostedApplicationStorages
public ListHostedApplicationStoragesResponse listHostedApplicationStorages(ListHostedApplicationStoragesRequest request)
Description copied from interface:GenerativeAiLists the hosted application storage in a specific compartment.- Specified by:
listHostedApplicationStoragesin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHostedApplications
public ListHostedApplicationsResponse listHostedApplications(ListHostedApplicationsRequest request)
Description copied from interface:GenerativeAiLists the hosted applications in a specific compartment.- Specified by:
listHostedApplicationsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHostedDeployments
public ListHostedDeploymentsResponse listHostedDeployments(ListHostedDeploymentsRequest request)
Description copied from interface:GenerativeAiLists the hosted applications in a specific compartment.- Specified by:
listHostedDeploymentsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listImportedModels
public ListImportedModelsResponse listImportedModels(ListImportedModelsRequest request)
Description copied from interface:GenerativeAiLists imported models in a specific compartment.- Specified by:
listImportedModelsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listModels
public ListModelsResponse listModels(ListModelsRequest request)
Description copied from interface:GenerativeAiLists the models in a specific compartment.Includes pretrained base models and fine-tuned custom models.
- Specified by:
listModelsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSemanticStores
public ListSemanticStoresResponse listSemanticStores(ListSemanticStoresRequest request)
Description copied from interface:GenerativeAiLists the SemanticStores given specific filter.- Specified by:
listSemanticStoresin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVectorStoreConnectorFileSyncIngestionLogs
public ListVectorStoreConnectorFileSyncIngestionLogsResponse listVectorStoreConnectorFileSyncIngestionLogs(ListVectorStoreConnectorFileSyncIngestionLogsRequest request)
Description copied from interface:GenerativeAiGets Ingestion logs for a vectorStoreConnectorFileSync operation.- Specified by:
listVectorStoreConnectorFileSyncIngestionLogsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVectorStoreConnectorFileSyncs
public ListVectorStoreConnectorFileSyncsResponse listVectorStoreConnectorFileSyncs(ListVectorStoreConnectorFileSyncsRequest request)
Description copied from interface:GenerativeAiLists the vectorStoreConnectorFileSyncs of a specific compartment.- Specified by:
listVectorStoreConnectorFileSyncsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVectorStoreConnectorIngestionLogs
public ListVectorStoreConnectorIngestionLogsResponse listVectorStoreConnectorIngestionLogs(ListVectorStoreConnectorIngestionLogsRequest request)
Description copied from interface:GenerativeAiGets Ingestion logs for a vectorStoreConnector.- Specified by:
listVectorStoreConnectorIngestionLogsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVectorStoreConnectors
public ListVectorStoreConnectorsResponse listVectorStoreConnectors(ListVectorStoreConnectorsRequest request)
Description copied from interface:GenerativeAiLists the vectorStoreConnectors of a specific compartment.- Specified by:
listVectorStoreConnectorsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:GenerativeAiLists the errors for a work request.- Specified by:
listWorkRequestErrorsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:GenerativeAiLists the logs for a work request.- Specified by:
listWorkRequestLogsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:GenerativeAiLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
renewApiKey
public RenewApiKeyResponse renewApiKey(RenewApiKeyRequest request)
Description copied from interface:GenerativeAiRenew the primary or secondary key.- Specified by:
renewApiKeyin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
setApiKeyState
public SetApiKeyStateResponse setApiKeyState(SetApiKeyStateRequest request)
Description copied from interface:GenerativeAiSet state of the key.- Specified by:
setApiKeyStatein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateApiKey
public UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest request)
Description copied from interface:GenerativeAiUpdates the properties of an apiKey.- Specified by:
updateApiKeyin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDedicatedAiCluster
public UpdateDedicatedAiClusterResponse updateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request)
Description copied from interface:GenerativeAiUpdates a dedicated AI cluster.- Specified by:
updateDedicatedAiClusterin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateEndpoint
public UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest request)
Description copied from interface:GenerativeAiUpdates the properties of an endpoint.- Specified by:
updateEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateGenerativeAiPrivateEndpoint
public UpdateGenerativeAiPrivateEndpointResponse updateGenerativeAiPrivateEndpoint(UpdateGenerativeAiPrivateEndpointRequest request)
Description copied from interface:GenerativeAiUpdates a Generative AI private endpoint using aprivateEndpointId.- Specified by:
updateGenerativeAiPrivateEndpointin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateGenerativeAiProject
public UpdateGenerativeAiProjectResponse updateGenerativeAiProject(UpdateGenerativeAiProjectRequest request)
Description copied from interface:GenerativeAiUpdates the properties of a generativeAiProject.- Specified by:
updateGenerativeAiProjectin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateHostedApplication
public UpdateHostedApplicationResponse updateHostedApplication(UpdateHostedApplicationRequest request)
Description copied from interface:GenerativeAiUpdates a hosted application.- Specified by:
updateHostedApplicationin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateHostedDeployment
public UpdateHostedDeploymentResponse updateHostedDeployment(UpdateHostedDeploymentRequest request)
Description copied from interface:GenerativeAiUpdates a hosted deployment.- Specified by:
updateHostedDeploymentin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateImportedModel
public UpdateImportedModelResponse updateImportedModel(UpdateImportedModelRequest request)
Description copied from interface:GenerativeAiUpdates the properties of an imported model such as name, description, freeform tags, and defined tags.- Specified by:
updateImportedModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateModel
public UpdateModelResponse updateModel(UpdateModelRequest request)
Description copied from interface:GenerativeAiUpdates the properties of a custom model such as name, description, version, freeform tags, and defined tags.- Specified by:
updateModelin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSemanticStore
public UpdateSemanticStoreResponse updateSemanticStore(UpdateSemanticStoreRequest request)
Description copied from interface:GenerativeAiUpdates the properties of a SemanticStore.- Specified by:
updateSemanticStorein interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateVectorStoreConnector
public UpdateVectorStoreConnectorResponse updateVectorStoreConnector(UpdateVectorStoreConnectorRequest request)
Description copied from interface:GenerativeAiUpdates the properties of a vectorStoreConnector.- Specified by:
updateVectorStoreConnectorin interfaceGenerativeAi- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public GenerativeAiWaiters getWaiters()
Description copied from interface:GenerativeAiGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceGenerativeAi- Returns:
- The service waiters.
-
getPaginators
public GenerativeAiPaginators getPaginators()
Description copied from interface:GenerativeAiGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceGenerativeAi- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-