GenerativeAiAgentClientCompositeOperations

class oci.generative_ai_agent.GenerativeAiAgentClientCompositeOperations(client, **kwargs)

This class provides a wrapper around GenerativeAiAgentClient 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 GenerativeAiAgentClientCompositeOperations object

change_agent_compartment_and_wait_for_state(...)

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

change_agent_endpoint_compartment_and_wait_for_state(...)

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

change_knowledge_base_compartment_and_wait_for_state(...)

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

change_provisioned_capacity_compartment_and_wait_for_state(...)

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

create_agent_and_wait_for_state(...[, ...])

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

create_agent_endpoint_and_wait_for_state(...)

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

create_data_ingestion_job_and_wait_for_state(...)

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

create_data_source_and_wait_for_state(...[, ...])

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

create_knowledge_base_and_wait_for_state(...)

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

create_provisioned_capacity_and_wait_for_state(...)

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

create_tool_and_wait_for_state(...[, ...])

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

delete_agent_and_wait_for_state(agent_id[, ...])

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

delete_agent_endpoint_and_wait_for_state(...)

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

delete_data_ingestion_job_and_wait_for_state(...)

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

delete_data_source_and_wait_for_state(...[, ...])

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

delete_knowledge_base_and_wait_for_state(...)

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

delete_provisioned_capacity_and_wait_for_state(...)

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

delete_tool_and_wait_for_state(tool_id[, ...])

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

update_agent_and_wait_for_state(agent_id, ...)

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

update_agent_endpoint_and_wait_for_state(...)

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

update_data_source_and_wait_for_state(...[, ...])

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

update_knowledge_base_and_wait_for_state(...)

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

update_provisioned_capacity_and_wait_for_state(...)

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

update_tool_and_wait_for_state(tool_id, ...)

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

__init__(client, **kwargs)

Creates a new GenerativeAiAgentClientCompositeOperations object

Parameters

client (GenerativeAiAgentClient) – The service client which will be wrapped by this object

change_agent_compartment_and_wait_for_state(agent_id, change_agent_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_id (str) –

    (required) The OCID of the agent.

  • change_agent_compartment_details (oci.generative_ai_agent.models.ChangeAgentCompartmentDetails) – (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 change_agent_compartment()

  • 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

change_agent_endpoint_compartment_and_wait_for_state(agent_endpoint_id, change_agent_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_endpoint_id (str) –

    (required) The OCID of the endpoint.

  • change_agent_endpoint_compartment_details (oci.generative_ai_agent.models.ChangeAgentEndpointCompartmentDetails) – (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 change_agent_endpoint_compartment()

  • 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

change_knowledge_base_compartment_and_wait_for_state(knowledge_base_id, change_knowledge_base_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • knowledge_base_id (str) –

    (required) The OCID of the knowledge base.

  • change_knowledge_base_compartment_details (oci.generative_ai_agent.models.ChangeKnowledgeBaseCompartmentDetails) – (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 change_knowledge_base_compartment()

  • 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

change_provisioned_capacity_compartment_and_wait_for_state(provisioned_capacity_id, change_provisioned_capacity_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • provisioned_capacity_id (str) –

    (required) The OCID of the provisioned capacity.

  • change_provisioned_capacity_compartment_details (oci.generative_ai_agent.models.ChangeProvisionedCapacityCompartmentDetails) – (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 change_provisioned_capacity_compartment()

  • 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_agent_and_wait_for_state(create_agent_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_agent_details (oci.generative_ai_agent.models.CreateAgentDetails) – (required) Details for the new agent.

  • 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_agent()

  • 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_agent_endpoint_and_wait_for_state(create_agent_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_agent_endpoint_details (oci.generative_ai_agent.models.CreateAgentEndpointDetails) – (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_agent_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_data_ingestion_job_and_wait_for_state(create_data_ingestion_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_data_ingestion_job_details (oci.generative_ai_agent.models.CreateDataIngestionJobDetails) – (required) Details for the new data ingestion 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_data_ingestion_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_data_source_and_wait_for_state(create_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_data_source_details (oci.generative_ai_agent.models.CreateDataSourceDetails) – (required) Details for the new data source.

  • 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_data_source()

  • 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_knowledge_base_and_wait_for_state(create_knowledge_base_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_knowledge_base_details (oci.generative_ai_agent.models.CreateKnowledgeBaseDetails) – (required) Details for the new knowledge base.

  • 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_knowledge_base()

  • 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_provisioned_capacity_and_wait_for_state(create_provisioned_capacity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_provisioned_capacity_details (oci.generative_ai_agent.models.CreateProvisionedCapacityDetails) – (required) Details for the new provisioned capacity.

  • 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_provisioned_capacity()

  • 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_tool_and_wait_for_state(create_tool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_tool_details (oci.generative_ai_agent.models.CreateToolDetails) – (required) Details for the new tool.

  • 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_tool()

  • 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_agent_and_wait_for_state(agent_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_id (str) –

    (required) The OCID of the agent.

  • 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_agent()

  • 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_agent_endpoint_and_wait_for_state(agent_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_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_agent_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_data_ingestion_job_and_wait_for_state(data_ingestion_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • data_ingestion_job_id (str) –

    (required) The OCID of the data ingestion 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 delete_data_ingestion_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_data_source_and_wait_for_state(data_source_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • data_source_id (str) –

    (required) The OCID of the data source.

  • 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_data_source()

  • 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_knowledge_base_and_wait_for_state(knowledge_base_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • knowledge_base_id (str) –

    (required) The OCID of the knowledge base.

  • 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_knowledge_base()

  • 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_provisioned_capacity_and_wait_for_state(provisioned_capacity_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • provisioned_capacity_id (str) –

    (required) The OCID of the provisioned capacity.

  • 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_provisioned_capacity()

  • 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_tool_and_wait_for_state(tool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • tool_id (str) –

    (required) The OCID of the Tool.

  • 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_tool()

  • 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_agent_and_wait_for_state(agent_id, update_agent_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_id (str) –

    (required) The OCID of the agent.

  • update_agent_details (oci.generative_ai_agent.models.UpdateAgentDetails) – (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_agent()

  • 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_agent_endpoint_and_wait_for_state(agent_endpoint_id, update_agent_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • agent_endpoint_id (str) –

    (required) The OCID of the endpoint.

  • update_agent_endpoint_details (oci.generative_ai_agent.models.UpdateAgentEndpointDetails) – (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_agent_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_data_source_and_wait_for_state(data_source_id, update_data_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • data_source_id (str) –

    (required) The OCID of the data source.

  • update_data_source_details (oci.generative_ai_agent.models.UpdateDataSourceDetails) – (required) The data source 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_data_source()

  • 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_knowledge_base_and_wait_for_state(knowledge_base_id, update_knowledge_base_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • knowledge_base_id (str) –

    (required) The OCID of the knowledge base.

  • update_knowledge_base_details (oci.generative_ai_agent.models.UpdateKnowledgeBaseDetails) – (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_knowledge_base()

  • 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_provisioned_capacity_and_wait_for_state(provisioned_capacity_id, update_provisioned_capacity_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • provisioned_capacity_id (str) –

    (required) The OCID of the provisioned capacity.

  • update_provisioned_capacity_details (oci.generative_ai_agent.models.UpdateProvisionedCapacityDetails) – (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_provisioned_capacity()

  • 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_tool_and_wait_for_state(tool_id, update_tool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • tool_id (str) –

    (required) The OCID of the Tool.

  • update_tool_details (oci.generative_ai_agent.models.UpdateToolDetails) – (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_tool()

  • 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