GenerativeAiClientCompositeOperations¶
- class oci.generative_ai.GenerativeAiClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
GenerativeAiClientand offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods:
__init__(client, **kwargs)Creates a new GenerativeAiClientCompositeOperations object
add_artifact_and_wait_for_state(...[, ...])Calls
add_artifact()and waits for theWorkRequestto enter the given state(s).cancel_vector_store_connector_file_sync_and_wait_for_state(...)Calls
cancel_vector_store_connector_file_sync()and waits for theWorkRequestto enter the given state(s).change_generative_ai_private_endpoint_compartment_and_wait_for_state(...)Calls
change_generative_ai_private_endpoint_compartment()and waits for theWorkRequestto enter the given state(s).Calls
change_semantic_store_compartment()and waits for theWorkRequestto enter the given state(s).create_api_key_and_wait_for_state(...[, ...])Calls
create_api_key()and waits for theApiKeyacted upon to enter the given state(s).Calls
create_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).create_endpoint_and_wait_for_state(...[, ...])Calls
create_endpoint()and waits for theWorkRequestto enter the given state(s).create_generative_ai_private_endpoint_and_wait_for_state(...)Calls
create_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).Calls
create_generative_ai_project()and waits for theWorkRequestto enter the given state(s).Calls
create_hosted_application()and waits for theWorkRequestto enter the given state(s).Calls
create_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).Calls
create_hosted_application_storage()and waits for theWorkRequestto enter the given state(s).Calls
create_hosted_deployment()and waits for theWorkRequestto enter the given state(s).Calls
create_imported_model()and waits for theWorkRequestto enter the given state(s).create_model_and_wait_for_state(...[, ...])Calls
create_model()and waits for theWorkRequestto enter the given state(s).Calls
create_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).Calls
create_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).Calls
create_semantic_store()and waits for theWorkRequestto enter the given state(s).Calls
create_vector_store_connector()and waits for theWorkRequestto enter the given state(s).create_vector_store_connector_file_sync_and_wait_for_state(...)Calls
create_vector_store_connector_file_sync()and waits for theWorkRequestto enter the given state(s).delete_api_key_and_wait_for_state(api_key_id)Calls
delete_api_key()and waits for theApiKeyacted upon to enter the given state(s).Calls
delete_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).delete_endpoint_and_wait_for_state(endpoint_id)Calls
delete_endpoint()and waits for theWorkRequestto enter the given state(s).delete_generative_ai_private_endpoint_and_wait_for_state(...)Calls
delete_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).Calls
delete_generative_ai_project()and waits for theWorkRequestto enter the given state(s).Calls
delete_hosted_application()and waits for theWorkRequestto enter the given state(s).Calls
delete_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).Calls
delete_hosted_application_storage()and waits for theWorkRequestto enter the given state(s).Calls
delete_hosted_deployment()and waits for theWorkRequestto enter the given state(s).Calls
delete_hosted_deployment_artifact()and waits for theWorkRequestto enter the given state(s).Calls
delete_imported_model()and waits for theWorkRequestto enter the given state(s).delete_model_and_wait_for_state(model_id[, ...])Calls
delete_model()and waits for theWorkRequestto enter the given state(s).Calls
delete_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).Calls
delete_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).Calls
delete_semantic_store()and waits for theWorkRequestto enter the given state(s).Calls
delete_vector_store_connector()and waits for theWorkRequestto enter the given state(s).renew_api_key_and_wait_for_state(api_key_id, ...)Calls
renew_api_key()and waits for theApiKeyacted upon to enter the given state(s).set_api_key_state_and_wait_for_state(...[, ...])Calls
set_api_key_state()and waits for theApiKeyacted upon to enter the given state(s).update_api_key_and_wait_for_state(...[, ...])Calls
update_api_key()and waits for theApiKeyacted upon to enter the given state(s).Calls
update_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).update_endpoint_and_wait_for_state(...[, ...])Calls
update_endpoint()and waits for theWorkRequestto enter the given state(s).update_generative_ai_private_endpoint_and_wait_for_state(...)Calls
update_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).Calls
update_generative_ai_project()and waits for theWorkRequestto enter the given state(s).Calls
update_hosted_application()and waits for theWorkRequestto enter the given state(s).Calls
update_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).Calls
update_hosted_deployment()and waits for theWorkRequestto enter the given state(s).Calls
update_imported_model()and waits for theWorkRequestto enter the given state(s).update_model_and_wait_for_state(model_id, ...)Calls
update_model()and waits for theModelacted upon to enter the given state(s).Calls
update_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).Calls
update_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).Calls
update_semantic_store()and waits for theSemanticStoreacted upon to enter the given state(s).Calls
update_vector_store_connector()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new GenerativeAiClientCompositeOperations object
- Parameters
client (GenerativeAiClient) – The service client which will be wrapped by this object
- add_artifact_and_wait_for_state(add_artifact_details, hosted_deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
add_artifact()and waits for theWorkRequestto enter the given state(s).- Parameters
add_artifact_details (oci.generative_ai.models.AddArtifactDetails) – (required) Details for the new artifact.
hosted_deployment_id (str) –
(required) The OCID of the hosted deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
add_artifact()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- cancel_vector_store_connector_file_sync_and_wait_for_state(vector_store_connector_file_sync_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_vector_store_connector_file_sync()and waits for theWorkRequestto enter the given state(s).- Parameters
vector_store_connector_file_sync_id (str) –
(required) The OCID of the vectorStoreConnectorFileSync.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_vector_store_connector_file_sync()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- change_generative_ai_private_endpoint_compartment_and_wait_for_state(generative_ai_private_endpoint_id, change_generative_ai_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_generative_ai_private_endpoint_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.
change_generative_ai_private_endpoint_compartment_details (oci.generative_ai.models.ChangeGenerativeAiPrivateEndpointCompartmentDetails) – (required) Details for changing a Generative AI private endpoint’s compartment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_generative_ai_private_endpoint_compartment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- change_semantic_store_compartment_and_wait_for_state(semantic_store_id, change_semantic_store_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_semantic_store_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
semantic_store_id (str) –
(required) The OCID of the SemanticStore.
change_semantic_store_compartment_details (oci.generative_ai.models.ChangeSemanticStoreCompartmentDetails) – (required) The SemanticStore information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_semantic_store_compartment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_api_key_and_wait_for_state(create_api_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_api_key()and waits for theApiKeyacted upon to enter the given state(s).- Parameters
create_api_key_details (oci.generative_ai.models.CreateApiKeyDetails) – (required) Details for the new apiKey.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_api_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_dedicated_ai_cluster_and_wait_for_state(create_dedicated_ai_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
create_dedicated_ai_cluster_details (oci.generative_ai.models.CreateDedicatedAiClusterDetails) – (required) Details for the new dedicated AI cluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_dedicated_ai_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_endpoint_and_wait_for_state(create_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
create_endpoint_details (oci.generative_ai.models.CreateEndpointDetails) – (required) Details for the new endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_generative_ai_private_endpoint_and_wait_for_state(create_generative_ai_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
create_generative_ai_private_endpoint_details (oci.generative_ai.models.CreateGenerativeAiPrivateEndpointDetails) – (required) The parameters required to create a private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_generative_ai_private_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_generative_ai_project_and_wait_for_state(create_generative_ai_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_generative_ai_project()and waits for theWorkRequestto enter the given state(s).- Parameters
create_generative_ai_project_details (oci.generative_ai.models.CreateGenerativeAiProjectDetails) – (required) Details for the new generativeAiProject.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_generative_ai_project()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_hosted_application_and_wait_for_state(create_hosted_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_hosted_application()and waits for theWorkRequestto enter the given state(s).- Parameters
create_hosted_application_details (oci.generative_ai.models.CreateHostedApplicationDetails) – (required) Details for the new hosted application.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_hosted_application()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_hosted_application_iam_and_wait_for_state(create_hosted_application_iam_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).- Parameters
create_hosted_application_iam_details (oci.generative_ai.models.CreateHostedApplicationIamDetails) – (required) Details for the new hosted application.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_hosted_application_iam()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_hosted_application_storage_and_wait_for_state(create_hosted_application_storage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_hosted_application_storage()and waits for theWorkRequestto enter the given state(s).- Parameters
create_hosted_application_storage_details (oci.generative_ai.models.CreateHostedApplicationStorageDetails) – (required) Details for the new hosted application storage.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_hosted_application_storage()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_hosted_deployment_and_wait_for_state(create_hosted_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_hosted_deployment()and waits for theWorkRequestto enter the given state(s).- Parameters
create_hosted_deployment_details (oci.generative_ai.models.CreateHostedDeploymentDetails) – (required) Details for the new hosted deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_hosted_deployment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_imported_model_and_wait_for_state(create_imported_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_imported_model()and waits for theWorkRequestto enter the given state(s).- Parameters
create_imported_model_details (oci.generative_ai.models.CreateImportedModelDetails) – (required) Details for importing a model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_imported_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_model_and_wait_for_state(create_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_model()and waits for theWorkRequestto enter the given state(s).- Parameters
create_model_details (oci.generative_ai.models.CreateModelDetails) – (required) Details for the new model.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_routing_profile_and_wait_for_state(create_routing_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).- Parameters
create_routing_profile_details (oci.generative_ai.models.CreateRoutingProfileDetails) – (required) Details for the new routing profile.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_routing_profile()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_sandbox_warm_pool_and_wait_for_state(project_id, create_sandbox_warm_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.
create_sandbox_warm_pool_details (oci.generative_ai.models.CreateSandboxWarmPoolDetails) – (required) Desired warm-pool configuration to persist.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_sandbox_warm_pool()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_semantic_store_and_wait_for_state(create_semantic_store_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_semantic_store()and waits for theWorkRequestto enter the given state(s).- Parameters
create_semantic_store_details (oci.generative_ai.models.CreateSemanticStoreDetails) – (required) Details for the new SemanticStore.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_semantic_store()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_vector_store_connector_and_wait_for_state(create_vector_store_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_vector_store_connector()and waits for theWorkRequestto enter the given state(s).- Parameters
create_vector_store_connector_details (oci.generative_ai.models.CreateVectorStoreConnectorDetails) – (required) Details for the new vectorStoreConnector.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_vector_store_connector()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_vector_store_connector_file_sync_and_wait_for_state(create_vector_store_connector_file_sync_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_vector_store_connector_file_sync()and waits for theWorkRequestto enter the given state(s).- Parameters
create_vector_store_connector_file_sync_details (oci.generative_ai.models.CreateVectorStoreConnectorFileSyncDetails) – (required) Details for the new vectorStoreConnectorFileSync.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_vector_store_connector_file_sync()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_api_key_and_wait_for_state(api_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_api_key()and waits for theApiKeyacted upon to enter the given state(s).- Parameters
api_key_id (str) –
(required) The OCID of the APIKey.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_api_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_dedicated_ai_cluster_and_wait_for_state(dedicated_ai_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
dedicated_ai_cluster_id (str) –
(required) The OCID of the dedicated AI cluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_dedicated_ai_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_endpoint_and_wait_for_state(endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
endpoint_id (str) –
(required) The OCID of the endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_generative_ai_private_endpoint_and_wait_for_state(generative_ai_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_generative_ai_private_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_generative_ai_project_and_wait_for_state(generative_ai_project_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_generative_ai_project()and waits for theWorkRequestto enter the given state(s).- Parameters
generative_ai_project_id (str) –
(required) The OCID of the generativeAiProject.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_generative_ai_project()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_hosted_application_and_wait_for_state(hosted_application_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_hosted_application()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_application_id (str) –
(required) The OCID of the hosted application.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_hosted_application()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_hosted_application_iam_and_wait_for_state(hosted_application_iam_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_application_iam_id (str) –
(required) The OCID of the hosted application.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_hosted_application_iam()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_hosted_application_storage_and_wait_for_state(hosted_application_storage_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_hosted_application_storage()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_application_storage_id (str) –
(required) The OCID of the hosted application storage.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_hosted_application_storage()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_hosted_deployment_and_wait_for_state(hosted_deployment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_hosted_deployment()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_deployment_id (str) –
(required) The OCID of the hosted deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_hosted_deployment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_hosted_deployment_artifact_and_wait_for_state(hosted_deployment_id, artifact_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_hosted_deployment_artifact()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_deployment_id (str) –
(required) The OCID of the hosted deployment.
artifact_id (str) – (required) The id of the artifact.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_hosted_deployment_artifact()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_imported_model_and_wait_for_state(imported_model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_imported_model()and waits for theWorkRequestto enter the given state(s).- Parameters
imported_model_id (str) – (required) The importedModel OCID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_imported_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_model()and waits for theWorkRequestto enter the given state(s).- Parameters
model_id (str) – (required) The model OCID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_routing_profile_and_wait_for_state(routing_profile_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).- Parameters
routing_profile_id (str) –
(required) The OCID of the routing profile.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_routing_profile()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_sandbox_warm_pool_and_wait_for_state(project_id, name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.
name (str) – (required) Immutable name within the Project.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_sandbox_warm_pool()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_semantic_store_and_wait_for_state(semantic_store_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_semantic_store()and waits for theWorkRequestto enter the given state(s).- Parameters
semantic_store_id (str) –
(required) The OCID of the SemanticStore.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_semantic_store()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_vector_store_connector_and_wait_for_state(vector_store_connector_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_vector_store_connector()and waits for theWorkRequestto enter the given state(s).- Parameters
vector_store_connector_id (str) –
(required) The OCID of the VectorStoreConnector.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_vector_store_connector()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- renew_api_key_and_wait_for_state(api_key_id, renew_api_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
renew_api_key()and waits for theApiKeyacted upon to enter the given state(s).- Parameters
api_key_id (str) –
(required) The OCID of the APIKey.
renew_api_key_details (oci.generative_ai.models.RenewApiKeyDetails) – (required) The information to be renewed.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
renew_api_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- set_api_key_state_and_wait_for_state(api_key_id, set_api_key_state_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
set_api_key_state()and waits for theApiKeyacted upon to enter the given state(s).- Parameters
api_key_id (str) –
(required) The OCID of the APIKey.
set_api_key_state_details (oci.generative_ai.models.SetApiKeyStateDetails) – (required) The information for setting key state.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
set_api_key_state()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_api_key_and_wait_for_state(api_key_id, update_api_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_api_key()and waits for theApiKeyacted upon to enter the given state(s).- Parameters
api_key_id (str) –
(required) The OCID of the APIKey.
update_api_key_details (oci.generative_ai.models.UpdateApiKeyDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_api_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_dedicated_ai_cluster_and_wait_for_state(dedicated_ai_cluster_id, update_dedicated_ai_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_dedicated_ai_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
dedicated_ai_cluster_id (str) –
(required) The OCID of the dedicated AI cluster.
update_dedicated_ai_cluster_details (oci.generative_ai.models.UpdateDedicatedAiClusterDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_dedicated_ai_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_endpoint_and_wait_for_state(endpoint_id, update_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
endpoint_id (str) –
(required) The OCID of the endpoint.
update_endpoint_details (oci.generative_ai.models.UpdateEndpointDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_generative_ai_private_endpoint_and_wait_for_state(generative_ai_private_endpoint_id, update_generative_ai_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_generative_ai_private_endpoint()and waits for theWorkRequestto enter the given state(s).- Parameters
generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.
update_generative_ai_private_endpoint_details (oci.generative_ai.models.UpdateGenerativeAiPrivateEndpointDetails) – (required) Details for updating a Generative AI private endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_generative_ai_private_endpoint()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_generative_ai_project_and_wait_for_state(generative_ai_project_id, update_generative_ai_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_generative_ai_project()and waits for theWorkRequestto enter the given state(s).- Parameters
generative_ai_project_id (str) –
(required) The OCID of the generativeAiProject.
update_generative_ai_project_details (oci.generative_ai.models.UpdateGenerativeAiProjectDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_generative_ai_project()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_hosted_application_and_wait_for_state(hosted_application_id, update_hosted_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_hosted_application()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_application_id (str) –
(required) The OCID of the hosted application.
update_hosted_application_details (oci.generative_ai.models.UpdateHostedApplicationDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_hosted_application()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_hosted_application_iam_and_wait_for_state(hosted_application_iam_id, update_hosted_application_iam_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_hosted_application_iam()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_application_iam_id (str) –
(required) The OCID of the hosted application.
update_hosted_application_iam_details (oci.generative_ai.models.UpdateHostedApplicationIamDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_hosted_application_iam()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_hosted_deployment_and_wait_for_state(hosted_deployment_id, update_hosted_deployment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_hosted_deployment()and waits for theWorkRequestto enter the given state(s).- Parameters
hosted_deployment_id (str) –
(required) The OCID of the hosted deployment.
update_hosted_deployment_details (oci.generative_ai.models.UpdateHostedDeploymentDetails) – (required) update hosted deployment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_hosted_deployment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_imported_model_and_wait_for_state(imported_model_id, update_imported_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_imported_model()and waits for theWorkRequestto enter the given state(s).- Parameters
imported_model_id (str) – (required) The importedModel OCID
update_imported_model_details (oci.generative_ai.models.UpdateImportedModelDetails) – (required) The model information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_imported_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_model_and_wait_for_state(model_id, update_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_model()and waits for theModelacted upon to enter the given state(s).- Parameters
model_id (str) – (required) The model OCID
update_model_details (oci.generative_ai.models.UpdateModelDetails) – (required) The model information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_model()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_routing_profile_and_wait_for_state(routing_profile_id, update_routing_profile_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_routing_profile()and waits for theRoutingProfileacted upon to enter the given state(s).- Parameters
routing_profile_id (str) –
(required) The OCID of the routing profile.
update_routing_profile_details (oci.generative_ai.models.UpdateRoutingProfileDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_routing_profile()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_sandbox_warm_pool_and_wait_for_state(project_id, name, update_sandbox_warm_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_sandbox_warm_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.
name (str) – (required) Immutable name within the Project.
update_sandbox_warm_pool_details (oci.generative_ai.models.UpdateSandboxWarmPoolDetails) – (required) Replacement desired capacity to persist.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_sandbox_warm_pool()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_semantic_store_and_wait_for_state(semantic_store_id, update_semantic_store_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_semantic_store()and waits for theSemanticStoreacted upon to enter the given state(s).- Parameters
semantic_store_id (str) –
(required) The OCID of the SemanticStore.
update_semantic_store_details (oci.generative_ai.models.UpdateSemanticStoreDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_semantic_store()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_vector_store_connector_and_wait_for_state(vector_store_connector_id, update_vector_store_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_vector_store_connector()and waits for theWorkRequestto enter the given state(s).- Parameters
vector_store_connector_id (str) –
(required) The OCID of the VectorStoreConnector.
update_vector_store_connector_details (oci.generative_ai.models.UpdateVectorStoreConnectorDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_vector_store_connector()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait