GenerativeAiClientCompositeOperations

class oci.generative_ai.GenerativeAiClientCompositeOperations(client, **kwargs)

This class provides a wrapper around GenerativeAiClient and 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 functionality

Methods

__init__(client, **kwargs)	Creates a new GenerativeAiClientCompositeOperations object
create_dedicated_ai_cluster_and_wait_for_state(…)	Calls create_dedicated_ai_cluster() and waits for the WorkRequest to enter the given state(s).
create_endpoint_and_wait_for_state(…[, …])	Calls create_endpoint() and waits for the WorkRequest to enter the given state(s).
create_model_and_wait_for_state(…[, …])	Calls create_model() and waits for the WorkRequest to enter the given state(s).
delete_dedicated_ai_cluster_and_wait_for_state(…)	Calls delete_dedicated_ai_cluster() and waits for the WorkRequest to enter the given state(s).
delete_endpoint_and_wait_for_state(endpoint_id)	Calls delete_endpoint() and waits for the WorkRequest to enter the given state(s).
delete_model_and_wait_for_state(model_id[, …])	Calls delete_model() and waits for the WorkRequest to enter the given state(s).
update_dedicated_ai_cluster_and_wait_for_state(…)	Calls update_dedicated_ai_cluster() and waits for the WorkRequest to enter the given state(s).
update_endpoint_and_wait_for_state(…[, …])	Calls update_endpoint() and waits for the WorkRequest to enter the given state(s).
update_model_and_wait_for_state(model_id, …)	Calls update_model() and waits for the Model acted upon to 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

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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the WorkRequest to 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 status
• operation_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 pass max_interval_seconds or max_interval_seconds as 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 the Model acted 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_state
• operation_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 pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait