oci 2.134.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client_composite_operations.py

@@ -0,0 +1,26 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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
+
+import oci  # noqa: F401
+from oci.util import WAIT_RESOURCE_NOT_FOUND  # noqa: F401
+
+
+class GenerativeAiAgentRuntimeClientCompositeOperations(object):
+    """
+    This class provides a wrapper around :py:class:`~oci.generative_ai_agent_runtime.GenerativeAiAgentRuntimeClient` 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
+    """
+
+    def __init__(self, client, **kwargs):
+        """
+        Creates a new GenerativeAiAgentRuntimeClientCompositeOperations object
+
+        :param GenerativeAiAgentRuntimeClient client:
+            The service client which will be wrapped by this object
+        """
+        self.client = client

oci/generative_ai_agent_runtime/models/__init__.py

@@ -0,0 +1,44 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 __future__ import absolute_import
+
+from .chat_details import ChatDetails
+from .chat_result import ChatResult
+from .citation import Citation
+from .create_session_details import CreateSessionDetails
+from .error_trace import ErrorTrace
+from .generation_trace import GenerationTrace
+from .message import Message
+from .message_content import MessageContent
+from .oci_database_source_location import OciDatabaseSourceLocation
+from .oci_object_storage_source_location import OciObjectStorageSourceLocation
+from .oci_open_search_source_location import OciOpenSearchSourceLocation
+from .retrieval_trace import RetrievalTrace
+from .session import Session
+from .source_location import SourceLocation
+from .trace import Trace
+from .update_session_details import UpdateSessionDetails
+
+# Maps type names to classes for generative_ai_agent_runtime services.
+generative_ai_agent_runtime_type_mapping = {
+    "ChatDetails": ChatDetails,
+    "ChatResult": ChatResult,
+    "Citation": Citation,
+    "CreateSessionDetails": CreateSessionDetails,
+    "ErrorTrace": ErrorTrace,
+    "GenerationTrace": GenerationTrace,
+    "Message": Message,
+    "MessageContent": MessageContent,
+    "OciDatabaseSourceLocation": OciDatabaseSourceLocation,
+    "OciObjectStorageSourceLocation": OciObjectStorageSourceLocation,
+    "OciOpenSearchSourceLocation": OciOpenSearchSourceLocation,
+    "RetrievalTrace": RetrievalTrace,
+    "Session": Session,
+    "SourceLocation": SourceLocation,
+    "Trace": Trace,
+    "UpdateSessionDetails": UpdateSessionDetails
+}

oci/generative_ai_agent_runtime/models/chat_details.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 ChatDetails(object):
+    """
+    Chat details.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ChatDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param user_message:
+            The value to assign to the user_message property of this ChatDetails.
+        :type user_message: str
+
+        :param should_stream:
+            The value to assign to the should_stream property of this ChatDetails.
+        :type should_stream: bool
+
+        :param session_id:
+            The value to assign to the session_id property of this ChatDetails.
+        :type session_id: str
+
+        """
+        self.swagger_types = {
+            'user_message': 'str',
+            'should_stream': 'bool',
+            'session_id': 'str'
+        }
+
+        self.attribute_map = {
+            'user_message': 'userMessage',
+            'should_stream': 'shouldStream',
+            'session_id': 'sessionId'
+        }
+
+        self._user_message = None
+        self._should_stream = None
+        self._session_id = None
+
+    @property
+    def user_message(self):
+        """
+        **[Required]** Gets the user_message of this ChatDetails.
+        The input user message content for the chat.
+
+
+        :return: The user_message of this ChatDetails.
+        :rtype: str
+        """
+        return self._user_message
+
+    @user_message.setter
+    def user_message(self, user_message):
+        """
+        Sets the user_message of this ChatDetails.
+        The input user message content for the chat.
+
+
+        :param user_message: The user_message of this ChatDetails.
+        :type: str
+        """
+        self._user_message = user_message
+
+    @property
+    def should_stream(self):
+        """
+        Gets the should_stream of this ChatDetails.
+        Whether to stream the response.
+
+
+        :return: The should_stream of this ChatDetails.
+        :rtype: bool
+        """
+        return self._should_stream
+
+    @should_stream.setter
+    def should_stream(self, should_stream):
+        """
+        Sets the should_stream of this ChatDetails.
+        Whether to stream the response.
+
+
+        :param should_stream: The should_stream of this ChatDetails.
+        :type: bool
+        """
+        self._should_stream = should_stream
+
+    @property
+    def session_id(self):
+        """
+        Gets the session_id of this ChatDetails.
+        Optional sessionId. If not provided, will chat without any prior context.
+
+
+        :return: The session_id of this ChatDetails.
+        :rtype: str
+        """
+        return self._session_id
+
+    @session_id.setter
+    def session_id(self, session_id):
+        """
+        Sets the session_id of this ChatDetails.
+        Optional sessionId. If not provided, will chat without any prior context.
+
+
+        :param session_id: The session_id of this ChatDetails.
+        :type: str
+        """
+        self._session_id = session_id
+
+    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/chat_result.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 ChatResult(object):
+    """
+    The response of a chat request.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ChatResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param message:
+            The value to assign to the message property of this ChatResult.
+        :type message: oci.generative_ai_agent_runtime.models.Message
+
+        :param traces:
+            The value to assign to the traces property of this ChatResult.
+        :type traces: list[oci.generative_ai_agent_runtime.models.Trace]
+
+        """
+        self.swagger_types = {
+            'message': 'Message',
+            'traces': 'list[Trace]'
+        }
+
+        self.attribute_map = {
+            'message': 'message',
+            'traces': 'traces'
+        }
+
+        self._message = None
+        self._traces = None
+
+    @property
+    def message(self):
+        """
+        Gets the message of this ChatResult.
+
+        :return: The message of this ChatResult.
+        :rtype: oci.generative_ai_agent_runtime.models.Message
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """
+        Sets the message of this ChatResult.
+
+        :param message: The message of this ChatResult.
+        :type: oci.generative_ai_agent_runtime.models.Message
+        """
+        self._message = message
+
+    @property
+    def traces(self):
+        """
+        Gets the traces of this ChatResult.
+        The trace that displays the internal progression, such as reasoning and actions during an execution.
+
+
+        :return: The traces of this ChatResult.
+        :rtype: list[oci.generative_ai_agent_runtime.models.Trace]
+        """
+        return self._traces
+
+    @traces.setter
+    def traces(self, traces):
+        """
+        Sets the traces of this ChatResult.
+        The trace that displays the internal progression, such as reasoning and actions during an execution.
+
+
+        :param traces: The traces of this ChatResult.
+        :type: list[oci.generative_ai_agent_runtime.models.Trace]
+        """
+        self._traces = traces
+
+    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/citation.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 Citation(object):
+    """
+    The citation displays the location of source text that is the agent uses to create the responses.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Citation object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param source_text:
+            The value to assign to the source_text property of this Citation.
+        :type source_text: str
+
+        :param source_location:
+            The value to assign to the source_location property of this Citation.
+        :type source_location: oci.generative_ai_agent_runtime.models.SourceLocation
+
+        """
+        self.swagger_types = {
+            'source_text': 'str',
+            'source_location': 'SourceLocation'
+        }
+
+        self.attribute_map = {
+            'source_text': 'sourceText',
+            'source_location': 'sourceLocation'
+        }
+
+        self._source_text = None
+        self._source_location = None
+
+    @property
+    def source_text(self):
+        """
+        Gets the source_text of this Citation.
+        The text that's the source for the agent's response.
+
+
+        :return: The source_text of this Citation.
+        :rtype: str
+        """
+        return self._source_text
+
+    @source_text.setter
+    def source_text(self, source_text):
+        """
+        Sets the source_text of this Citation.
+        The text that's the source for the agent's response.
+
+
+        :param source_text: The source_text of this Citation.
+        :type: str
+        """
+        self._source_text = source_text
+
+    @property
+    def source_location(self):
+        """
+        Gets the source_location of this Citation.
+
+        :return: The source_location of this Citation.
+        :rtype: oci.generative_ai_agent_runtime.models.SourceLocation
+        """
+        return self._source_location
+
+    @source_location.setter
+    def source_location(self, source_location):
+        """
+        Sets the source_location of this Citation.
+
+        :param source_location: The source_location of this Citation.
+        :type: oci.generative_ai_agent_runtime.models.SourceLocation
+        """
+        self._source_location = source_location
+
+    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/create_session_details.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 CreateSessionDetails(object):
+    """
+    Information about the new session.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateSessionDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param display_name:
+            The value to assign to the display_name property of this CreateSessionDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this CreateSessionDetails.
+        :type description: str
+
+        """
+        self.swagger_types = {
+            'display_name': 'str',
+            'description': 'str'
+        }
+
+        self.attribute_map = {
+            'display_name': 'displayName',
+            'description': 'description'
+        }
+
+        self._display_name = None
+        self._description = None
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this CreateSessionDetails.
+        The name of the session. A session names doesn't have to be unique and you can change the session name later.
+
+
+        :return: The display_name of this CreateSessionDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this CreateSessionDetails.
+        The name of the session. A session names doesn't have to be unique and you can change the session name later.
+
+
+        :param display_name: The display_name of this CreateSessionDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CreateSessionDetails.
+        An optional description of the session.
+
+
+        :return: The description of this CreateSessionDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateSessionDetails.
+        An optional description of the session.
+
+
+        :param description: The description of this CreateSessionDetails.
+        :type: str
+        """
+        self._description = description
+
+    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/error_trace.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 .trace import Trace
+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 ErrorTrace(Trace):
+    """
+    The trace information about the error.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ErrorTrace object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.ErrorTrace.trace_type` attribute
+        of this class is ``ERROR_TRACE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param time_created:
+            The value to assign to the time_created property of this ErrorTrace.
+        :type time_created: datetime
+
+        :param trace_type:
+            The value to assign to the trace_type property of this ErrorTrace.
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE"
+        :type trace_type: str
+
+        :param error_message:
+            The value to assign to the error_message property of this ErrorTrace.
+        :type error_message: str
+
+        """
+        self.swagger_types = {
+            'time_created': 'datetime',
+            'trace_type': 'str',
+            'error_message': 'str'
+        }
+
+        self.attribute_map = {
+            'time_created': 'timeCreated',
+            'trace_type': 'traceType',
+            'error_message': 'errorMessage'
+        }
+
+        self._time_created = None
+        self._trace_type = None
+        self._error_message = None
+        self._trace_type = 'ERROR_TRACE'
+
+    @property
+    def error_message(self):
+        """
+        Gets the error_message of this ErrorTrace.
+        The error message in this trace.
+
+
+        :return: The error_message of this ErrorTrace.
+        :rtype: str
+        """
+        return self._error_message
+
+    @error_message.setter
+    def error_message(self, error_message):
+        """
+        Sets the error_message of this ErrorTrace.
+        The error message in this trace.
+
+
+        :param error_message: The error_message of this ErrorTrace.
+        :type: str
+        """
+        self._error_message = error_message
+
+    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/generation_trace.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 .trace import Trace
+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 GenerationTrace(Trace):
+    """
+    The trace information about the generated response.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GenerationTrace object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent_runtime.models.GenerationTrace.trace_type` attribute
+        of this class is ``GENERATION_TRACE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param time_created:
+            The value to assign to the time_created property of this GenerationTrace.
+        :type time_created: datetime
+
+        :param trace_type:
+            The value to assign to the trace_type property of this GenerationTrace.
+            Allowed values for this property are: "ERROR_TRACE", "RETRIEVAL_TRACE", "GENERATION_TRACE"
+        :type trace_type: str
+
+        :param generation:
+            The value to assign to the generation property of this GenerationTrace.
+        :type generation: str
+
+        """
+        self.swagger_types = {
+            'time_created': 'datetime',
+            'trace_type': 'str',
+            'generation': 'str'
+        }
+
+        self.attribute_map = {
+            'time_created': 'timeCreated',
+            'trace_type': 'traceType',
+            'generation': 'generation'
+        }
+
+        self._time_created = None
+        self._trace_type = None
+        self._generation = None
+        self._trace_type = 'GENERATION_TRACE'
+
+    @property
+    def generation(self):
+        """
+        Gets the generation of this GenerationTrace.
+        The generated response that's returned to the user.
+
+
+        :return: The generation of this GenerationTrace.
+        :rtype: str
+        """
+        return self._generation
+
+    @generation.setter
+    def generation(self, generation):
+        """
+        Sets the generation of this GenerationTrace.
+        The generated response that's returned to the user.
+
+
+        :param generation: The generation of this GenerationTrace.
+        :type: str
+        """
+        self._generation = generation
+
+    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