oci 2.149.0__py3-none-any.whl → 2.149.2__py3-none-any.whl

oci/generative_ai_agent_runtime/models/function_calling_performed_action.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531
+
+from .performed_action import PerformedAction
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class FunctionCallingPerformedAction(PerformedAction):
+    """
+    Represents an action for recording the result of a function call.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionCallingPerformedAction object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.FunctionCallingPerformedAction.performed_action_type` attribute
+        of this class is ``FUNCTION_CALLING_PERFORMED_ACTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param action_id:
+            The value to assign to the action_id property of this FunctionCallingPerformedAction.
+        :type action_id: str
+
+        :param performed_action_type:
+            The value to assign to the performed_action_type property of this FunctionCallingPerformedAction.
+            Allowed values for this property are: "HUMAN_APPROVAL_PERFORMED_ACTION", "FUNCTION_CALLING_PERFORMED_ACTION"
+        :type performed_action_type: str
+
+        :param function_call_output:
+            The value to assign to the function_call_output property of this FunctionCallingPerformedAction.
+        :type function_call_output: str
+
+        """
+        self.swagger_types = {
+            'action_id': 'str',
+            'performed_action_type': 'str',
+            'function_call_output': 'str'
+        }
+        self.attribute_map = {
+            'action_id': 'actionId',
+            'performed_action_type': 'performedActionType',
+            'function_call_output': 'functionCallOutput'
+        }
+        self._action_id = None
+        self._performed_action_type = None
+        self._function_call_output = None
+        self._performed_action_type = 'FUNCTION_CALLING_PERFORMED_ACTION'
+
+    @property
+    def function_call_output(self):
+        """
+        **[Required]** Gets the function_call_output of this FunctionCallingPerformedAction.
+        The result or output of the function call.
+
+
+        :return: The function_call_output of this FunctionCallingPerformedAction.
+        :rtype: str
+        """
+        return self._function_call_output
+
+    @function_call_output.setter
+    def function_call_output(self, function_call_output):
+        """
+        Sets the function_call_output of this FunctionCallingPerformedAction.
+        The result or output of the function call.
+
+
+        :param function_call_output: The function_call_output of this FunctionCallingPerformedAction.
+        :type: str
+        """
+        self._function_call_output = function_call_output
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_agent_runtime/models/function_calling_required_action.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531
+
+from .required_action import RequiredAction
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class FunctionCallingRequiredAction(RequiredAction):
+    """
+    Represents an action for submitting function call outputs.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionCallingRequiredAction object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.FunctionCallingRequiredAction.required_action_type` attribute
+        of this class is ``FUNCTION_CALLING_REQUIRED_ACTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param action_id:
+            The value to assign to the action_id property of this FunctionCallingRequiredAction.
+        :type action_id: str
+
+        :param required_action_type:
+            The value to assign to the required_action_type property of this FunctionCallingRequiredAction.
+            Allowed values for this property are: "HUMAN_APPROVAL_REQUIRED_ACTION", "FUNCTION_CALLING_REQUIRED_ACTION"
+        :type required_action_type: str
+
+        :param function_call:
+            The value to assign to the function_call property of this FunctionCallingRequiredAction.
+        :type function_call: oci.generative_ai_agent_runtime.models.FunctionCall
+
+        """
+        self.swagger_types = {
+            'action_id': 'str',
+            'required_action_type': 'str',
+            'function_call': 'FunctionCall'
+        }
+        self.attribute_map = {
+            'action_id': 'actionId',
+            'required_action_type': 'requiredActionType',
+            'function_call': 'functionCall'
+        }
+        self._action_id = None
+        self._required_action_type = None
+        self._function_call = None
+        self._required_action_type = 'FUNCTION_CALLING_REQUIRED_ACTION'
+
+    @property
+    def function_call(self):
+        """
+        **[Required]** Gets the function_call of this FunctionCallingRequiredAction.
+
+        :return: The function_call of this FunctionCallingRequiredAction.
+        :rtype: oci.generative_ai_agent_runtime.models.FunctionCall
+        """
+        return self._function_call
+
+    @function_call.setter
+    def function_call(self, function_call):
+        """
+        Sets the function_call of this FunctionCallingRequiredAction.
+
+        :param function_call: The function_call of this FunctionCallingRequiredAction.
+        :type: oci.generative_ai_agent_runtime.models.FunctionCall
+        """
+        self._function_call = function_call
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_agent_runtime/models/human_approval_performed_action.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531
+
+from .performed_action import PerformedAction
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class HumanApprovalPerformedAction(PerformedAction):
+    """
+    An action describing user approval to the agent.
+    """
+
+    #: A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction.
+    #: This constant has a value of "APPROVE"
+    CHOSEN_OPTION_APPROVE = "APPROVE"
+
+    #: A constant which can be used with the chosen_option property of a HumanApprovalPerformedAction.
+    #: This constant has a value of "DENY"
+    CHOSEN_OPTION_DENY = "DENY"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new HumanApprovalPerformedAction object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.HumanApprovalPerformedAction.performed_action_type` attribute
+        of this class is ``HUMAN_APPROVAL_PERFORMED_ACTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param action_id:
+            The value to assign to the action_id property of this HumanApprovalPerformedAction.
+        :type action_id: str
+
+        :param performed_action_type:
+            The value to assign to the performed_action_type property of this HumanApprovalPerformedAction.
+            Allowed values for this property are: "HUMAN_APPROVAL_PERFORMED_ACTION", "FUNCTION_CALLING_PERFORMED_ACTION"
+        :type performed_action_type: str
+
+        :param chosen_option:
+            The value to assign to the chosen_option property of this HumanApprovalPerformedAction.
+            Allowed values for this property are: "APPROVE", "DENY"
+        :type chosen_option: str
+
+        """
+        self.swagger_types = {
+            'action_id': 'str',
+            'performed_action_type': 'str',
+            'chosen_option': 'str'
+        }
+        self.attribute_map = {
+            'action_id': 'actionId',
+            'performed_action_type': 'performedActionType',
+            'chosen_option': 'chosenOption'
+        }
+        self._action_id = None
+        self._performed_action_type = None
+        self._chosen_option = None
+        self._performed_action_type = 'HUMAN_APPROVAL_PERFORMED_ACTION'
+
+    @property
+    def chosen_option(self):
+        """
+        **[Required]** Gets the chosen_option of this HumanApprovalPerformedAction.
+        The chosen approval or denial option to the agent.
+
+        Allowed values for this property are: "APPROVE", "DENY"
+
+
+        :return: The chosen_option of this HumanApprovalPerformedAction.
+        :rtype: str
+        """
+        return self._chosen_option
+
+    @chosen_option.setter
+    def chosen_option(self, chosen_option):
+        """
+        Sets the chosen_option of this HumanApprovalPerformedAction.
+        The chosen approval or denial option to the agent.
+
+
+        :param chosen_option: The chosen_option of this HumanApprovalPerformedAction.
+        :type: str
+        """
+        allowed_values = ["APPROVE", "DENY"]
+        if not value_allowed_none_or_none_sentinel(chosen_option, allowed_values):
+            raise ValueError(
+                f"Invalid value for `chosen_option`, must be None or one of {allowed_values}"
+            )
+        self._chosen_option = chosen_option
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.py

@@ -0,0 +1,262 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class KnowledgeBaseMetadataSummary(object):
+    """
+    Represents metadata about a field including its name, type, supported operations, and possible values.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new KnowledgeBaseMetadataSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param name:
+            The value to assign to the name property of this KnowledgeBaseMetadataSummary.
+        :type name: str
+
+        :param type:
+            The value to assign to the type property of this KnowledgeBaseMetadataSummary.
+        :type type: str
+
+        :param operations:
+            The value to assign to the operations property of this KnowledgeBaseMetadataSummary.
+        :type operations: list[str]
+
+        :param values:
+            The value to assign to the values property of this KnowledgeBaseMetadataSummary.
+        :type values: list[oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue]
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this KnowledgeBaseMetadataSummary.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this KnowledgeBaseMetadataSummary.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this KnowledgeBaseMetadataSummary.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'type': 'str',
+            'operations': 'list[str]',
+            'values': 'list[KnowledgeBaseMetadataValue]',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'type': 'type',
+            'operations': 'operations',
+            'values': 'values',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+        self._name = None
+        self._type = None
+        self._operations = None
+        self._values = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this KnowledgeBaseMetadataSummary.
+        The name of the field
+
+
+        :return: The name of this KnowledgeBaseMetadataSummary.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this KnowledgeBaseMetadataSummary.
+        The name of the field
+
+
+        :param name: The name of this KnowledgeBaseMetadataSummary.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this KnowledgeBaseMetadataSummary.
+        The data type of the field (e.g., \"array\", \"number\", \"string\")
+
+
+        :return: The type of this KnowledgeBaseMetadataSummary.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this KnowledgeBaseMetadataSummary.
+        The data type of the field (e.g., \"array\", \"number\", \"string\")
+
+
+        :param type: The type of this KnowledgeBaseMetadataSummary.
+        :type: str
+        """
+        self._type = type
+
+    @property
+    def operations(self):
+        """
+        **[Required]** Gets the operations of this KnowledgeBaseMetadataSummary.
+        List of supported operations for this field (e.g., \"equals\", \"in\", \"contains\")
+
+
+        :return: The operations of this KnowledgeBaseMetadataSummary.
+        :rtype: list[str]
+        """
+        return self._operations
+
+    @operations.setter
+    def operations(self, operations):
+        """
+        Sets the operations of this KnowledgeBaseMetadataSummary.
+        List of supported operations for this field (e.g., \"equals\", \"in\", \"contains\")
+
+
+        :param operations: The operations of this KnowledgeBaseMetadataSummary.
+        :type: list[str]
+        """
+        self._operations = operations
+
+    @property
+    def values(self):
+        """
+        **[Required]** Gets the values of this KnowledgeBaseMetadataSummary.
+        List of metadata values available in the knowledge base along with the matching documents count.
+
+
+        :return: The values of this KnowledgeBaseMetadataSummary.
+        :rtype: list[oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue]
+        """
+        return self._values
+
+    @values.setter
+    def values(self, values):
+        """
+        Sets the values of this KnowledgeBaseMetadataSummary.
+        List of metadata values available in the knowledge base along with the matching documents count.
+
+
+        :param values: The values of this KnowledgeBaseMetadataSummary.
+        :type: list[oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataValue]
+        """
+        self._values = values
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this KnowledgeBaseMetadataSummary.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+
+        :return: The freeform_tags of this KnowledgeBaseMetadataSummary.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this KnowledgeBaseMetadataSummary.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+
+        :param freeform_tags: The freeform_tags of this KnowledgeBaseMetadataSummary.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this KnowledgeBaseMetadataSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :return: The defined_tags of this KnowledgeBaseMetadataSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._defined_tags
+
+    @defined_tags.setter
+    def defined_tags(self, defined_tags):
+        """
+        Sets the defined_tags of this KnowledgeBaseMetadataSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :param defined_tags: The defined_tags of this KnowledgeBaseMetadataSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this KnowledgeBaseMetadataSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :return: The system_tags of this KnowledgeBaseMetadataSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._system_tags
+
+    @system_tags.setter
+    def system_tags(self, system_tags):
+        """
+        Sets the system_tags of this KnowledgeBaseMetadataSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :param system_tags: The system_tags of this KnowledgeBaseMetadataSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_agent_runtime/models/knowledge_base_metadata_value.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20240531
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class KnowledgeBaseMetadataValue(object):
+    """
+    Represents a metadata value and the number of appearances in knowledge base.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new KnowledgeBaseMetadataValue object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param value:
+            The value to assign to the value property of this KnowledgeBaseMetadataValue.
+        :type value: str
+
+        :param count:
+            The value to assign to the count property of this KnowledgeBaseMetadataValue.
+        :type count: int
+
+        """
+        self.swagger_types = {
+            'value': 'str',
+            'count': 'int'
+        }
+        self.attribute_map = {
+            'value': 'value',
+            'count': 'count'
+        }
+        self._value = None
+        self._count = None
+
+    @property
+    def value(self):
+        """
+        **[Required]** Gets the value of this KnowledgeBaseMetadataValue.
+        The value of the metadata
+
+
+        :return: The value of this KnowledgeBaseMetadataValue.
+        :rtype: str
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        """
+        Sets the value of this KnowledgeBaseMetadataValue.
+        The value of the metadata
+
+
+        :param value: The value of this KnowledgeBaseMetadataValue.
+        :type: str
+        """
+        self._value = value
+
+    @property
+    def count(self):
+        """
+        **[Required]** Gets the count of this KnowledgeBaseMetadataValue.
+        Number of documents where this value exists
+
+
+        :return: The count of this KnowledgeBaseMetadataValue.
+        :rtype: int
+        """
+        return self._count
+
+    @count.setter
+    def count(self, count):
+        """
+        Sets the count of this KnowledgeBaseMetadataValue.
+        Number of documents where this value exists
+
+
+        :param count: The count of this KnowledgeBaseMetadataValue.
+        :type: int
+        """
+        self._count = count
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/generative_ai_agent_runtime/models/message_content.py

@@ -28,17 +28,24 @@ class MessageContent(object):
             The value to assign to the citations property of this MessageContent.
         :type citations: list[oci.generative_ai_agent_runtime.models.Citation]
 
+        :param paragraph_citations:
+            The value to assign to the paragraph_citations property of this MessageContent.
+        :type paragraph_citations: list[oci.generative_ai_agent_runtime.models.ParagraphCitation]
+
         """
         self.swagger_types = {
             'text': 'str',
-            'citations': 'list[Citation]'
+            'citations': 'list[Citation]',
+            'paragraph_citations': 'list[ParagraphCitation]'
         }
         self.attribute_map = {
             'text': 'text',
-            'citations': 'citations'
+            'citations': 'citations',
+            'paragraph_citations': 'paragraphCitations'
         }
         self._text = None
         self._citations = None
+        self._paragraph_citations = None
 
     @property
     def text(self):
@@ -88,6 +95,30 @@ class MessageContent(object):
         """
         self._citations = citations
 
+    @property
+    def paragraph_citations(self):
+        """
+        Gets the paragraph_citations of this MessageContent.
+        A list of citations used to generate the paragraphs of the agent message.
+
+
+        :return: The paragraph_citations of this MessageContent.
+        :rtype: list[oci.generative_ai_agent_runtime.models.ParagraphCitation]
+        """
+        return self._paragraph_citations
+
+    @paragraph_citations.setter
+    def paragraph_citations(self, paragraph_citations):
+        """
+        Sets the paragraph_citations of this MessageContent.
+        A list of citations used to generate the paragraphs of the agent message.
+
+
+        :param paragraph_citations: The paragraph_citations of this MessageContent.
+        :type: list[oci.generative_ai_agent_runtime.models.ParagraphCitation]
+        """
+        self._paragraph_citations = paragraph_citations
+
     def __repr__(self):
         return formatted_flat_dict(self)