AIServiceLanguageClientCompositeOperations

class oci.ai_language.AIServiceLanguageClientCompositeOperations(client, **kwargs)

This class provides a wrapper around AIServiceLanguageClient 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 AIServiceLanguageClientCompositeOperations object
create_endpoint_and_wait_for_state(…[, …]) Calls create_endpoint() and waits for the WorkRequest to enter the given state(s).
create_job_and_wait_for_state(create_job_details) Calls create_job() 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).
create_project_and_wait_for_state(…[, …]) Calls create_project() 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_job_and_wait_for_state(job_id[, …]) Calls delete_job() 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).
delete_project_and_wait_for_state(project_id) Calls delete_project() 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_job_and_wait_for_state(job_id, …[, …]) Calls update_job() and waits for the Job acted upon to enter the given state(s).
update_model_and_wait_for_state(model_id, …) Calls update_model() and waits for the WorkRequest to enter the given state(s).
update_project_and_wait_for_state(…[, …]) Calls update_project() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new AIServiceLanguageClientCompositeOperations object

Parameters:client (AIServiceLanguageClient) – The service client which will be wrapped by this object
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.ai_language.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_job_and_wait_for_state(create_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_job() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_job_details (oci.ai_language.models.CreateJobDetails) – (required) Details for the new job.
  • 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_job()
  • 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.ai_language.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
create_project_and_wait_for_state(create_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_project() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_project_details (oci.ai_language.models.CreateProjectDetails) – (required) Details for the new Project.
  • 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_project()
  • 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_job_and_wait_for_state(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_job() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • job_id (str) – (required) Unique Transcription Job identifier.
  • 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_job()
  • 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) unique 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
delete_project_and_wait_for_state(project_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_project() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • project_id (str) – (required) The OCID of the project.
  • 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_project()
  • 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.ai_language.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_job_and_wait_for_state(job_id, update_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_job() and waits for the Job acted upon to enter the given state(s).

Parameters:
  • job_id (str) – (required) Unique Transcription Job identifier.
  • update_job_details (oci.ai_language.models.UpdateJobDetails) – (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_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_job()
  • 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 WorkRequest to enter the given state(s).

Parameters:
  • model_id (str) – (required) unique model OCID.
  • update_model_details (oci.ai_language.models.UpdateModelDetails) – (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_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_project_and_wait_for_state(project_id, update_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_project() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • project_id (str) – (required) The OCID of the project.
  • update_project_details (oci.ai_language.models.UpdateProjectDetails) – (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_project()
  • 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