AIServiceDocumentClientCompositeOperations¶

class oci.ai_document.AIServiceDocumentClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around AIServiceDocumentClient 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 AIServiceDocumentClientCompositeOperations object
`create_model_and_wait_for_state`(…[, …])	Calls `create_model()` and waits for the `WorkRequest` to enter the given state(s).
`create_processor_job_and_wait_for_state`(…)	Calls `create_processor_job()` and waits for the `ProcessorJob` acted upon 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_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).
`patch_model_and_wait_for_state`(model_id, …)	Calls `patch_model()` 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 `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 AIServiceDocumentClientCompositeOperations object

Parameters:	client (AIServiceDocumentClient) – The service client which will be wrapped by this object

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_document.models.CreateModelDetails) – (required) The metadata about 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_processor_job_and_wait_for_state(create_processor_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_processor_job() and waits for the ProcessorJob acted upon to enter the given state(s).

Parameters:

create_processor_job_details (oci.ai_document.models.CreateProcessorJobDetails) – (required) The details for creating the processor job.
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 create_processor_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_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_document.models.CreateProjectDetails) – (required) The new Project’s details.
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_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) A unique model 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_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) A unique project 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_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

patch_model_and_wait_for_state(model_id, patch_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

model_id (str) – (required) A unique model identifier.
patch_model_details (oci.ai_document.models.PatchModelDetails) – (required) The model metadata 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 patch_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_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) A unique model identifier.
update_model_details (oci.ai_document.models.UpdateModelDetails) – (required) The model metadata 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) A unique project identifier.
update_project_details (oci.ai_document.models.UpdateProjectDetails) – (required) The project metadata 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