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

oci/generative_ai_agent_runtime/models/metadata_filter.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 MetadataFilter(object):
+    """
+    Filter for retrieving specific metadata
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new MetadataFilter object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param field_name:
+            The value to assign to the field_name property of this MetadataFilter.
+        :type field_name: str
+
+        :param value:
+            The value to assign to the value property of this MetadataFilter.
+        :type value: str
+
+        """
+        self.swagger_types = {
+            'field_name': 'str',
+            'value': 'str'
+        }
+        self.attribute_map = {
+            'field_name': 'fieldName',
+            'value': 'value'
+        }
+        self._field_name = None
+        self._value = None
+
+    @property
+    def field_name(self):
+        """
+        **[Required]** Gets the field_name of this MetadataFilter.
+        The name of the field to filter on
+
+
+        :return: The field_name of this MetadataFilter.
+        :rtype: str
+        """
+        return self._field_name
+
+    @field_name.setter
+    def field_name(self, field_name):
+        """
+        Sets the field_name of this MetadataFilter.
+        The name of the field to filter on
+
+
+        :param field_name: The field_name of this MetadataFilter.
+        :type: str
+        """
+        self._field_name = field_name
+
+    @property
+    def value(self):
+        """
+        **[Required]** Gets the value of this MetadataFilter.
+        The value to filter for in the specified field
+
+
+        :return: The value of this MetadataFilter.
+        :rtype: str
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        """
+        Sets the value of this MetadataFilter.
+        The value to filter for in the specified field
+
+
+        :param value: The value of this MetadataFilter.
+        :type: str
+        """
+        self._value = value
+
+    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/paragraph.py

@@ -0,0 +1,132 @@
+# 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 Paragraph(object):
+    """
+    The paragraph of the generated message that contains a citation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Paragraph object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param text:
+            The value to assign to the text property of this Paragraph.
+        :type text: str
+
+        :param start:
+            The value to assign to the start property of this Paragraph.
+        :type start: int
+
+        :param end:
+            The value to assign to the end property of this Paragraph.
+        :type end: int
+
+        """
+        self.swagger_types = {
+            'text': 'str',
+            'start': 'int',
+            'end': 'int'
+        }
+        self.attribute_map = {
+            'text': 'text',
+            'start': 'start',
+            'end': 'end'
+        }
+        self._text = None
+        self._start = None
+        self._end = None
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this Paragraph.
+        The part of the generated message that contains a citation.
+
+
+        :return: The text of this Paragraph.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this Paragraph.
+        The part of the generated message that contains a citation.
+
+
+        :param text: The text of this Paragraph.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def start(self):
+        """
+        **[Required]** Gets the start of this Paragraph.
+        Where the text with a citation starts in the generated message.
+
+
+        :return: The start of this Paragraph.
+        :rtype: int
+        """
+        return self._start
+
+    @start.setter
+    def start(self, start):
+        """
+        Sets the start of this Paragraph.
+        Where the text with a citation starts in the generated message.
+
+
+        :param start: The start of this Paragraph.
+        :type: int
+        """
+        self._start = start
+
+    @property
+    def end(self):
+        """
+        **[Required]** Gets the end of this Paragraph.
+        Where the text with a citation ends in the generated message.
+
+
+        :return: The end of this Paragraph.
+        :rtype: int
+        """
+        return self._end
+
+    @end.setter
+    def end(self, end):
+        """
+        Sets the end of this Paragraph.
+        Where the text with a citation ends in the generated message.
+
+
+        :param end: The end of this Paragraph.
+        :type: int
+        """
+        self._end = end
+
+    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/paragraph_citation.py

@@ -0,0 +1,97 @@
+# 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 ParagraphCitation(object):
+    """
+    The source of information for the paragraph of agent's response.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ParagraphCitation object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param paragraph:
+            The value to assign to the paragraph property of this ParagraphCitation.
+        :type paragraph: oci.generative_ai_agent_runtime.models.Paragraph
+
+        :param citations:
+            The value to assign to the citations property of this ParagraphCitation.
+        :type citations: list[oci.generative_ai_agent_runtime.models.Citation]
+
+        """
+        self.swagger_types = {
+            'paragraph': 'Paragraph',
+            'citations': 'list[Citation]'
+        }
+        self.attribute_map = {
+            'paragraph': 'paragraph',
+            'citations': 'citations'
+        }
+        self._paragraph = None
+        self._citations = None
+
+    @property
+    def paragraph(self):
+        """
+        **[Required]** Gets the paragraph of this ParagraphCitation.
+
+        :return: The paragraph of this ParagraphCitation.
+        :rtype: oci.generative_ai_agent_runtime.models.Paragraph
+        """
+        return self._paragraph
+
+    @paragraph.setter
+    def paragraph(self, paragraph):
+        """
+        Sets the paragraph of this ParagraphCitation.
+
+        :param paragraph: The paragraph of this ParagraphCitation.
+        :type: oci.generative_ai_agent_runtime.models.Paragraph
+        """
+        self._paragraph = paragraph
+
+    @property
+    def citations(self):
+        """
+        Gets the citations of this ParagraphCitation.
+        A list of citations for the paragraph of the generated message.
+
+
+        :return: The citations of this ParagraphCitation.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Citation]
+        """
+        return self._citations
+
+    @citations.setter
+    def citations(self, citations):
+        """
+        Sets the citations of this ParagraphCitation.
+        A list of citations for the paragraph of the generated message.
+
+
+        :param citations: The citations of this ParagraphCitation.
+        :type: list[oci.generative_ai_agent_runtime.models.Citation]
+        """
+        self._citations = citations
+
+    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/performed_action.py

@@ -0,0 +1,138 @@
+# 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 PerformedAction(object):
+    """
+    The base structure for an action that has already been performed.
+    """
+
+    #: A constant which can be used with the performed_action_type property of a PerformedAction.
+    #: This constant has a value of "HUMAN_APPROVAL_PERFORMED_ACTION"
+    PERFORMED_ACTION_TYPE_HUMAN_APPROVAL_PERFORMED_ACTION = "HUMAN_APPROVAL_PERFORMED_ACTION"
+
+    #: A constant which can be used with the performed_action_type property of a PerformedAction.
+    #: This constant has a value of "FUNCTION_CALLING_PERFORMED_ACTION"
+    PERFORMED_ACTION_TYPE_FUNCTION_CALLING_PERFORMED_ACTION = "FUNCTION_CALLING_PERFORMED_ACTION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PerformedAction object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.generative_ai_agent_runtime.models.FunctionCallingPerformedAction`
+        * :class:`~oci.generative_ai_agent_runtime.models.HumanApprovalPerformedAction`
+
+        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 PerformedAction.
+        :type action_id: str
+
+        :param performed_action_type:
+            The value to assign to the performed_action_type property of this PerformedAction.
+            Allowed values for this property are: "HUMAN_APPROVAL_PERFORMED_ACTION", "FUNCTION_CALLING_PERFORMED_ACTION"
+        :type performed_action_type: str
+
+        """
+        self.swagger_types = {
+            'action_id': 'str',
+            'performed_action_type': 'str'
+        }
+        self.attribute_map = {
+            'action_id': 'actionId',
+            'performed_action_type': 'performedActionType'
+        }
+        self._action_id = None
+        self._performed_action_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['performedActionType']
+
+        if type == 'FUNCTION_CALLING_PERFORMED_ACTION':
+            return 'FunctionCallingPerformedAction'
+
+        if type == 'HUMAN_APPROVAL_PERFORMED_ACTION':
+            return 'HumanApprovalPerformedAction'
+        else:
+            return 'PerformedAction'
+
+    @property
+    def action_id(self):
+        """
+        **[Required]** Gets the action_id of this PerformedAction.
+        The unique identifier for the action that has been performed.
+
+
+        :return: The action_id of this PerformedAction.
+        :rtype: str
+        """
+        return self._action_id
+
+    @action_id.setter
+    def action_id(self, action_id):
+        """
+        Sets the action_id of this PerformedAction.
+        The unique identifier for the action that has been performed.
+
+
+        :param action_id: The action_id of this PerformedAction.
+        :type: str
+        """
+        self._action_id = action_id
+
+    @property
+    def performed_action_type(self):
+        """
+        **[Required]** Gets the performed_action_type of this PerformedAction.
+        Specifies the type of the performed action.
+
+        Allowed values for this property are: "HUMAN_APPROVAL_PERFORMED_ACTION", "FUNCTION_CALLING_PERFORMED_ACTION"
+
+
+        :return: The performed_action_type of this PerformedAction.
+        :rtype: str
+        """
+        return self._performed_action_type
+
+    @performed_action_type.setter
+    def performed_action_type(self, performed_action_type):
+        """
+        Sets the performed_action_type of this PerformedAction.
+        Specifies the type of the performed action.
+
+
+        :param performed_action_type: The performed_action_type of this PerformedAction.
+        :type: str
+        """
+        allowed_values = ["HUMAN_APPROVAL_PERFORMED_ACTION", "FUNCTION_CALLING_PERFORMED_ACTION"]
+        if not value_allowed_none_or_none_sentinel(performed_action_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `performed_action_type`, must be None or one of {allowed_values}"
+            )
+        self._performed_action_type = performed_action_type
+
+    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/required_action.py

@@ -0,0 +1,134 @@
+# 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 RequiredAction(object):
+    """
+    Represents an action that needs to be performed by the user or client.
+    """
+
+    #: A constant which can be used with the required_action_type property of a RequiredAction.
+    #: This constant has a value of "HUMAN_APPROVAL_REQUIRED_ACTION"
+    REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION = "HUMAN_APPROVAL_REQUIRED_ACTION"
+
+    #: A constant which can be used with the required_action_type property of a RequiredAction.
+    #: This constant has a value of "FUNCTION_CALLING_REQUIRED_ACTION"
+    REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION = "FUNCTION_CALLING_REQUIRED_ACTION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RequiredAction object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.generative_ai_agent_runtime.models.FunctionCallingRequiredAction`
+
+        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 RequiredAction.
+        :type action_id: str
+
+        :param required_action_type:
+            The value to assign to the required_action_type property of this RequiredAction.
+            Allowed values for this property are: "HUMAN_APPROVAL_REQUIRED_ACTION", "FUNCTION_CALLING_REQUIRED_ACTION", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type required_action_type: str
+
+        """
+        self.swagger_types = {
+            'action_id': 'str',
+            'required_action_type': 'str'
+        }
+        self.attribute_map = {
+            'action_id': 'actionId',
+            'required_action_type': 'requiredActionType'
+        }
+        self._action_id = None
+        self._required_action_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['requiredActionType']
+
+        if type == 'FUNCTION_CALLING_REQUIRED_ACTION':
+            return 'FunctionCallingRequiredAction'
+        else:
+            return 'RequiredAction'
+
+    @property
+    def action_id(self):
+        """
+        **[Required]** Gets the action_id of this RequiredAction.
+        The unique identifier for the action to be performed.
+
+
+        :return: The action_id of this RequiredAction.
+        :rtype: str
+        """
+        return self._action_id
+
+    @action_id.setter
+    def action_id(self, action_id):
+        """
+        Sets the action_id of this RequiredAction.
+        The unique identifier for the action to be performed.
+
+
+        :param action_id: The action_id of this RequiredAction.
+        :type: str
+        """
+        self._action_id = action_id
+
+    @property
+    def required_action_type(self):
+        """
+        **[Required]** Gets the required_action_type of this RequiredAction.
+        Specifies the type of action. Used for determining the action subtype.
+
+        Allowed values for this property are: "HUMAN_APPROVAL_REQUIRED_ACTION", "FUNCTION_CALLING_REQUIRED_ACTION", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The required_action_type of this RequiredAction.
+        :rtype: str
+        """
+        return self._required_action_type
+
+    @required_action_type.setter
+    def required_action_type(self, required_action_type):
+        """
+        Sets the required_action_type of this RequiredAction.
+        Specifies the type of action. Used for determining the action subtype.
+
+
+        :param required_action_type: The required_action_type of this RequiredAction.
+        :type: str
+        """
+        allowed_values = ["HUMAN_APPROVAL_REQUIRED_ACTION", "FUNCTION_CALLING_REQUIRED_ACTION"]
+        if not value_allowed_none_or_none_sentinel(required_action_type, allowed_values):
+            required_action_type = 'UNKNOWN_ENUM_VALUE'
+        self._required_action_type = required_action_type
+
+    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/retrieve_metadata_details.py

@@ -0,0 +1,70 @@
+# 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 RetrieveMetadataDetails(object):
+    """
+    Details to retrieve metadata
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RetrieveMetadataDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param filters:
+            The value to assign to the filters property of this RetrieveMetadataDetails.
+        :type filters: list[oci.generative_ai_agent_runtime.models.MetadataFilter]
+
+        """
+        self.swagger_types = {
+            'filters': 'list[MetadataFilter]'
+        }
+        self.attribute_map = {
+            'filters': 'filters'
+        }
+        self._filters = None
+
+    @property
+    def filters(self):
+        """
+        Gets the filters of this RetrieveMetadataDetails.
+        List of metadata filters to narrow down the retrieved metadata
+
+
+        :return: The filters of this RetrieveMetadataDetails.
+        :rtype: list[oci.generative_ai_agent_runtime.models.MetadataFilter]
+        """
+        return self._filters
+
+    @filters.setter
+    def filters(self, filters):
+        """
+        Sets the filters of this RetrieveMetadataDetails.
+        List of metadata filters to narrow down the retrieved metadata
+
+
+        :param filters: The filters of this RetrieveMetadataDetails.
+        :type: list[oci.generative_ai_agent_runtime.models.MetadataFilter]
+        """
+        self._filters = filters
+
+    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