oci 2.125.1__py3-none-any.whl → 2.125.3__py3-none-any.whl

oci/generative_ai_inference/models/chat_details.py

@@ -0,0 +1,126 @@
+# 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: 20231130
+
+
+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):
+    """
+    Details of the conversation for the model to respond.
+    """
+
+    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 compartment_id:
+            The value to assign to the compartment_id property of this ChatDetails.
+        :type compartment_id: str
+
+        :param serving_mode:
+            The value to assign to the serving_mode property of this ChatDetails.
+        :type serving_mode: oci.generative_ai_inference.models.ServingMode
+
+        :param chat_request:
+            The value to assign to the chat_request property of this ChatDetails.
+        :type chat_request: oci.generative_ai_inference.models.BaseChatRequest
+
+        """
+        self.swagger_types = {
+            'compartment_id': 'str',
+            'serving_mode': 'ServingMode',
+            'chat_request': 'BaseChatRequest'
+        }
+
+        self.attribute_map = {
+            'compartment_id': 'compartmentId',
+            'serving_mode': 'servingMode',
+            'chat_request': 'chatRequest'
+        }
+
+        self._compartment_id = None
+        self._serving_mode = None
+        self._chat_request = None
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this ChatDetails.
+        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+
+
+        :return: The compartment_id of this ChatDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this ChatDetails.
+        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+
+
+        :param compartment_id: The compartment_id of this ChatDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def serving_mode(self):
+        """
+        **[Required]** Gets the serving_mode of this ChatDetails.
+
+        :return: The serving_mode of this ChatDetails.
+        :rtype: oci.generative_ai_inference.models.ServingMode
+        """
+        return self._serving_mode
+
+    @serving_mode.setter
+    def serving_mode(self, serving_mode):
+        """
+        Sets the serving_mode of this ChatDetails.
+
+        :param serving_mode: The serving_mode of this ChatDetails.
+        :type: oci.generative_ai_inference.models.ServingMode
+        """
+        self._serving_mode = serving_mode
+
+    @property
+    def chat_request(self):
+        """
+        Gets the chat_request of this ChatDetails.
+
+        :return: The chat_request of this ChatDetails.
+        :rtype: oci.generative_ai_inference.models.BaseChatRequest
+        """
+        return self._chat_request
+
+    @chat_request.setter
+    def chat_request(self, chat_request):
+        """
+        Sets the chat_request of this ChatDetails.
+
+        :param chat_request: The chat_request of this ChatDetails.
+        :type: oci.generative_ai_inference.models.BaseChatRequest
+        """
+        self._chat_request = chat_request
+
+    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_inference/models/chat_result.py

@@ -0,0 +1,130 @@
+# 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: 20231130
+
+
+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 to the chat conversation.
+    """
+
+    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 model_id:
+            The value to assign to the model_id property of this ChatResult.
+        :type model_id: str
+
+        :param model_version:
+            The value to assign to the model_version property of this ChatResult.
+        :type model_version: str
+
+        :param chat_response:
+            The value to assign to the chat_response property of this ChatResult.
+        :type chat_response: oci.generative_ai_inference.models.BaseChatResponse
+
+        """
+        self.swagger_types = {
+            'model_id': 'str',
+            'model_version': 'str',
+            'chat_response': 'BaseChatResponse'
+        }
+
+        self.attribute_map = {
+            'model_id': 'modelId',
+            'model_version': 'modelVersion',
+            'chat_response': 'chatResponse'
+        }
+
+        self._model_id = None
+        self._model_version = None
+        self._chat_response = None
+
+    @property
+    def model_id(self):
+        """
+        **[Required]** Gets the model_id of this ChatResult.
+        The OCID of the model used in this inference request.
+
+
+        :return: The model_id of this ChatResult.
+        :rtype: str
+        """
+        return self._model_id
+
+    @model_id.setter
+    def model_id(self, model_id):
+        """
+        Sets the model_id of this ChatResult.
+        The OCID of the model used in this inference request.
+
+
+        :param model_id: The model_id of this ChatResult.
+        :type: str
+        """
+        self._model_id = model_id
+
+    @property
+    def model_version(self):
+        """
+        **[Required]** Gets the model_version of this ChatResult.
+        The version of the model.
+
+
+        :return: The model_version of this ChatResult.
+        :rtype: str
+        """
+        return self._model_version
+
+    @model_version.setter
+    def model_version(self, model_version):
+        """
+        Sets the model_version of this ChatResult.
+        The version of the model.
+
+
+        :param model_version: The model_version of this ChatResult.
+        :type: str
+        """
+        self._model_version = model_version
+
+    @property
+    def chat_response(self):
+        """
+        **[Required]** Gets the chat_response of this ChatResult.
+
+        :return: The chat_response of this ChatResult.
+        :rtype: oci.generative_ai_inference.models.BaseChatResponse
+        """
+        return self._chat_response
+
+    @chat_response.setter
+    def chat_response(self, chat_response):
+        """
+        Sets the chat_response of this ChatResult.
+
+        :param chat_response: The chat_response of this ChatResult.
+        :type: oci.generative_ai_inference.models.BaseChatResponse
+        """
+        self._chat_response = chat_response
+
+    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_inference/models/citation.py

@@ -0,0 +1,165 @@
+# 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: 20231130
+
+
+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):
+    """
+    A section of the generated reply which cites external knowledge.
+    """
+
+    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 start:
+            The value to assign to the start property of this Citation.
+        :type start: int
+
+        :param end:
+            The value to assign to the end property of this Citation.
+        :type end: int
+
+        :param text:
+            The value to assign to the text property of this Citation.
+        :type text: str
+
+        :param document_ids:
+            The value to assign to the document_ids property of this Citation.
+        :type document_ids: list[str]
+
+        """
+        self.swagger_types = {
+            'start': 'int',
+            'end': 'int',
+            'text': 'str',
+            'document_ids': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'start': 'start',
+            'end': 'end',
+            'text': 'text',
+            'document_ids': 'documentIds'
+        }
+
+        self._start = None
+        self._end = None
+        self._text = None
+        self._document_ids = None
+
+    @property
+    def start(self):
+        """
+        **[Required]** Gets the start of this Citation.
+        The index of text that the citation starts at, counting from zero.
+
+
+        :return: The start of this Citation.
+        :rtype: int
+        """
+        return self._start
+
+    @start.setter
+    def start(self, start):
+        """
+        Sets the start of this Citation.
+        The index of text that the citation starts at, counting from zero.
+
+
+        :param start: The start of this Citation.
+        :type: int
+        """
+        self._start = start
+
+    @property
+    def end(self):
+        """
+        **[Required]** Gets the end of this Citation.
+        The index of text that the citation ends after, counting from zero.
+
+
+        :return: The end of this Citation.
+        :rtype: int
+        """
+        return self._end
+
+    @end.setter
+    def end(self, end):
+        """
+        Sets the end of this Citation.
+        The index of text that the citation ends after, counting from zero.
+
+
+        :param end: The end of this Citation.
+        :type: int
+        """
+        self._end = end
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this Citation.
+        The text of the citation
+
+
+        :return: The text of this Citation.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this Citation.
+        The text of the citation
+
+
+        :param text: The text of this Citation.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def document_ids(self):
+        """
+        **[Required]** Gets the document_ids of this Citation.
+        Identifiers of documents cited by this section of the generated reply.
+
+
+        :return: The document_ids of this Citation.
+        :rtype: list[str]
+        """
+        return self._document_ids
+
+    @document_ids.setter
+    def document_ids(self, document_ids):
+        """
+        Sets the document_ids of this Citation.
+        Identifiers of documents cited by this section of the generated reply.
+
+
+        :param document_ids: The document_ids of this Citation.
+        :type: list[str]
+        """
+        self._document_ids = document_ids
+
+    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