oci 2.126.4__py3-none-any.whl → 2.128.0__py3-none-any.whl

oci/generative_ai_inference/models/cohere_tool.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: 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 CohereTool(object):
+    """
+    A definition of tool (function).
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereTool 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 CohereTool.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this CohereTool.
+        :type description: str
+
+        :param parameter_definitions:
+            The value to assign to the parameter_definitions property of this CohereTool.
+        :type parameter_definitions: dict(str, CohereParameterDefinition)
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'description': 'str',
+            'parameter_definitions': 'dict(str, CohereParameterDefinition)'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'description': 'description',
+            'parameter_definitions': 'parameterDefinitions'
+        }
+
+        self._name = None
+        self._description = None
+        self._parameter_definitions = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this CohereTool.
+        The name of the tool to be called. Valid names contain only the characters a-z, A-Z, 0-9, _ and must not begin with a digit.
+
+
+        :return: The name of this CohereTool.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this CohereTool.
+        The name of the tool to be called. Valid names contain only the characters a-z, A-Z, 0-9, _ and must not begin with a digit.
+
+
+        :param name: The name of this CohereTool.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def description(self):
+        """
+        **[Required]** Gets the description of this CohereTool.
+        The description of what the tool does, the model uses the description to choose when and how to call the function.
+
+
+        :return: The description of this CohereTool.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CohereTool.
+        The description of what the tool does, the model uses the description to choose when and how to call the function.
+
+
+        :param description: The description of this CohereTool.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def parameter_definitions(self):
+        """
+        Gets the parameter_definitions of this CohereTool.
+        The input parameters of the tool.
+
+
+        :return: The parameter_definitions of this CohereTool.
+        :rtype: dict(str, CohereParameterDefinition)
+        """
+        return self._parameter_definitions
+
+    @parameter_definitions.setter
+    def parameter_definitions(self, parameter_definitions):
+        """
+        Sets the parameter_definitions of this CohereTool.
+        The input parameters of the tool.
+
+
+        :param parameter_definitions: The parameter_definitions of this CohereTool.
+        :type: dict(str, CohereParameterDefinition)
+        """
+        self._parameter_definitions = parameter_definitions
+
+    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/cohere_tool_call.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: 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 CohereToolCall(object):
+    """
+    A tool call generated by the model.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereToolCall 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 CohereToolCall.
+        :type name: str
+
+        :param parameters:
+            The value to assign to the parameters property of this CohereToolCall.
+        :type parameters: object
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'parameters': 'object'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'parameters': 'parameters'
+        }
+
+        self._name = None
+        self._parameters = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this CohereToolCall.
+        Name of the tool to call.
+
+
+        :return: The name of this CohereToolCall.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this CohereToolCall.
+        Name of the tool to call.
+
+
+        :param name: The name of this CohereToolCall.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def parameters(self):
+        """
+        **[Required]** Gets the parameters of this CohereToolCall.
+        The parameters to use when invoking a tool.
+
+
+        :return: The parameters of this CohereToolCall.
+        :rtype: object
+        """
+        return self._parameters
+
+    @parameters.setter
+    def parameters(self, parameters):
+        """
+        Sets the parameters of this CohereToolCall.
+        The parameters to use when invoking a tool.
+
+
+        :param parameters: The parameters of this CohereToolCall.
+        :type: object
+        """
+        self._parameters = parameters
+
+    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/cohere_tool_message.py

@@ -0,0 +1,82 @@
+# 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 .cohere_message import CohereMessage
+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 CohereToolMessage(CohereMessage):
+    """
+    A message that represents a single chat dialog as TOOL role.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereToolMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereToolMessage.role` attribute
+        of this class is ``TOOL`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param role:
+            The value to assign to the role property of this CohereToolMessage.
+            Allowed values for this property are: "CHATBOT", "USER", "SYSTEM", "TOOL"
+        :type role: str
+
+        :param tool_results:
+            The value to assign to the tool_results property of this CohereToolMessage.
+        :type tool_results: list[oci.generative_ai_inference.models.CohereToolResult]
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'tool_results': 'list[CohereToolResult]'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'tool_results': 'toolResults'
+        }
+
+        self._role = None
+        self._tool_results = None
+        self._role = 'TOOL'
+
+    @property
+    def tool_results(self):
+        """
+        **[Required]** Gets the tool_results of this CohereToolMessage.
+        A list of results from invoking tools recommended by the model in the previous chat turn.
+
+
+        :return: The tool_results of this CohereToolMessage.
+        :rtype: list[oci.generative_ai_inference.models.CohereToolResult]
+        """
+        return self._tool_results
+
+    @tool_results.setter
+    def tool_results(self, tool_results):
+        """
+        Sets the tool_results of this CohereToolMessage.
+        A list of results from invoking tools recommended by the model in the previous chat turn.
+
+
+        :param tool_results: The tool_results of this CohereToolMessage.
+        :type: list[oci.generative_ai_inference.models.CohereToolResult]
+        """
+        self._tool_results = tool_results
+
+    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/cohere_tool_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: 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 CohereToolResult(object):
+    """
+    The result from invoking tools recommended by the model in the previous chat turn.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereToolResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param call:
+            The value to assign to the call property of this CohereToolResult.
+        :type call: oci.generative_ai_inference.models.CohereToolCall
+
+        :param outputs:
+            The value to assign to the outputs property of this CohereToolResult.
+        :type outputs: list[object]
+
+        """
+        self.swagger_types = {
+            'call': 'CohereToolCall',
+            'outputs': 'list[object]'
+        }
+
+        self.attribute_map = {
+            'call': 'call',
+            'outputs': 'outputs'
+        }
+
+        self._call = None
+        self._outputs = None
+
+    @property
+    def call(self):
+        """
+        **[Required]** Gets the call of this CohereToolResult.
+
+        :return: The call of this CohereToolResult.
+        :rtype: oci.generative_ai_inference.models.CohereToolCall
+        """
+        return self._call
+
+    @call.setter
+    def call(self, call):
+        """
+        Sets the call of this CohereToolResult.
+
+        :param call: The call of this CohereToolResult.
+        :type: oci.generative_ai_inference.models.CohereToolCall
+        """
+        self._call = call
+
+    @property
+    def outputs(self):
+        """
+        **[Required]** Gets the outputs of this CohereToolResult.
+        An array of objects returned by tool.
+
+
+        :return: The outputs of this CohereToolResult.
+        :rtype: list[object]
+        """
+        return self._outputs
+
+    @outputs.setter
+    def outputs(self, outputs):
+        """
+        Sets the outputs of this CohereToolResult.
+        An array of objects returned by tool.
+
+
+        :param outputs: The outputs of this CohereToolResult.
+        :type: list[object]
+        """
+        self._outputs = outputs
+
+    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/cohere_user_message.py

@@ -0,0 +1,82 @@
+# 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 .cohere_message import CohereMessage
+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 CohereUserMessage(CohereMessage):
+    """
+    A message that represents a single chat dialog as USER role.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CohereUserMessage object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereUserMessage.role` attribute
+        of this class is ``USER`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param role:
+            The value to assign to the role property of this CohereUserMessage.
+            Allowed values for this property are: "CHATBOT", "USER", "SYSTEM", "TOOL"
+        :type role: str
+
+        :param message:
+            The value to assign to the message property of this CohereUserMessage.
+        :type message: str
+
+        """
+        self.swagger_types = {
+            'role': 'str',
+            'message': 'str'
+        }
+
+        self.attribute_map = {
+            'role': 'role',
+            'message': 'message'
+        }
+
+        self._role = None
+        self._message = None
+        self._role = 'USER'
+
+    @property
+    def message(self):
+        """
+        **[Required]** Gets the message of this CohereUserMessage.
+        Contents of the chat message.
+
+
+        :return: The message of this CohereUserMessage.
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """
+        Sets the message of this CohereUserMessage.
+        Contents of the chat message.
+
+
+        :param message: The message of this CohereUserMessage.
+        :type: str
+        """
+        self._message = 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_inference/models/embed_text_details.py

@@ -104,7 +104,7 @@ class EmbedTextDetails(object):
     def inputs(self):
         """
         **[Required]** Gets the inputs of this EmbedTextDetails.
-        Provide a list of strings with a maximum number of 96 entries. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
+        Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
 
 
         :return: The inputs of this EmbedTextDetails.
@@ -116,7 +116,7 @@ class EmbedTextDetails(object):
     def inputs(self, inputs):
         """
         Sets the inputs of this EmbedTextDetails.
-        Provide a list of strings with a maximum number of 96 entries. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
+        Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.
 
 
         :param inputs: The inputs of this EmbedTextDetails.
@@ -148,7 +148,7 @@ class EmbedTextDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this EmbedTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to create text embeddings.
 
 
         :return: The compartment_id of this EmbedTextDetails.
@@ -160,7 +160,7 @@ class EmbedTextDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this EmbedTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to create text embeddings.
 
 
         :param compartment_id: The compartment_id of this EmbedTextDetails.

oci/generative_ai_inference/models/generate_text_details.py

@@ -53,7 +53,7 @@ class GenerateTextDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this GenerateTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to generate text.
 
 
         :return: The compartment_id of this GenerateTextDetails.
@@ -65,7 +65,7 @@ class GenerateTextDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this GenerateTextDetails.
-        The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+        The OCID of compartment in which to call the Generative AI service to generate text.
 
 
         :param compartment_id: The compartment_id of this GenerateTextDetails.

oci/generative_ai_inference/models/generic_chat_request.py

@@ -133,7 +133,7 @@ class GenericChatRequest(BaseChatRequest):
     def messages(self):
         """
         Gets the messages of this GenericChatRequest.
-        The series of messages associated with this chat completion request. It should include previous messages in the conversation. Each message has a role and content.
+        The series of messages in a chat request. Includes the previous messages in a conversation. Each message includes a role (`USER` or the `CHATBOT`) and content.
 
 
         :return: The messages of this GenericChatRequest.
@@ -145,7 +145,7 @@ class GenericChatRequest(BaseChatRequest):
     def messages(self, messages):
         """
         Sets the messages of this GenericChatRequest.
-        The series of messages associated with this chat completion request. It should include previous messages in the conversation. Each message has a role and content.
+        The series of messages in a chat request. Includes the previous messages in a conversation. Each message includes a role (`USER` or the `CHATBOT`) and content.
 
 
         :param messages: The messages of this GenericChatRequest.
@@ -157,7 +157,7 @@ class GenericChatRequest(BaseChatRequest):
     def is_stream(self):
         """
         Gets the is_stream of this GenericChatRequest.
-        Whether to stream back partial progress. If set, tokens are sent as data-only server-sent events as they become available.
+        Whether to stream back partial progress. If set to true, as tokens become available, they are sent as data-only server-sent events.
 
 
         :return: The is_stream of this GenericChatRequest.
@@ -169,7 +169,7 @@ class GenericChatRequest(BaseChatRequest):
     def is_stream(self, is_stream):
         """
         Sets the is_stream of this GenericChatRequest.
-        Whether to stream back partial progress. If set, tokens are sent as data-only server-sent events as they become available.
+        Whether to stream back partial progress. If set to true, as tokens become available, they are sent as data-only server-sent events.
 
 
         :param is_stream: The is_stream of this GenericChatRequest.
@@ -205,7 +205,7 @@ class GenericChatRequest(BaseChatRequest):
     def is_echo(self):
         """
         Gets the is_echo of this GenericChatRequest.
-        Whether or not to return the user prompt in the response. Applies only to non-stream results.
+        Whether to include the user prompt in the response. Applies only to non-stream results.
 
 
         :return: The is_echo of this GenericChatRequest.
@@ -217,7 +217,7 @@ class GenericChatRequest(BaseChatRequest):
     def is_echo(self, is_echo):
         """
         Sets the is_echo of this GenericChatRequest.
-        Whether or not to return the user prompt in the response. Applies only to non-stream results.
+        Whether to include the user prompt in the response. Applies only to non-stream results.
 
 
         :param is_echo: The is_echo of this GenericChatRequest.
@@ -417,7 +417,8 @@ class GenericChatRequest(BaseChatRequest):
     def max_tokens(self):
         """
         Gets the max_tokens of this GenericChatRequest.
-        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus max_tokens cannot exceed the model's context length.
+        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus `maxTokens` must not exceed the model's context length.
+        Not setting a value for maxTokens results in the possible use of model's full context length.
 
 
         :return: The max_tokens of this GenericChatRequest.
@@ -429,7 +430,8 @@ class GenericChatRequest(BaseChatRequest):
     def max_tokens(self, max_tokens):
         """
         Sets the max_tokens of this GenericChatRequest.
-        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus max_tokens cannot exceed the model's context length.
+        The maximum number of tokens that can be generated per output sequence. The token count of your prompt plus `maxTokens` must not exceed the model's context length.
+        Not setting a value for maxTokens results in the possible use of model's full context length.
 
 
         :param max_tokens: The max_tokens of this GenericChatRequest.
@@ -441,7 +443,9 @@ class GenericChatRequest(BaseChatRequest):
     def logit_bias(self):
         """
         Gets the logit_bias of this GenericChatRequest.
-        Modify the likelihood of specified tokens appearing in the completion.
+        Modifies the likelihood of specified tokens that appear in the completion.
+
+        Example: '{\"6395\": 2, \"8134\": 1, \"21943\": 0.5, \"5923\": -100}'
 
 
         :return: The logit_bias of this GenericChatRequest.
@@ -453,7 +457,9 @@ class GenericChatRequest(BaseChatRequest):
     def logit_bias(self, logit_bias):
         """
         Sets the logit_bias of this GenericChatRequest.
-        Modify the likelihood of specified tokens appearing in the completion.
+        Modifies the likelihood of specified tokens that appear in the completion.
+
+        Example: '{\"6395\": 2, \"8134\": 1, \"21943\": 0.5, \"5923\": -100}'
 
 
         :param logit_bias: The logit_bias of this GenericChatRequest.

oci/generative_ai_inference/models/generic_chat_response.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class GenericChatResponse(BaseChatResponse):
     """
-    The response to the chat conversation.
+    The response for a chat conversation.
     """
 
     def __init__(self, **kwargs):
@@ -56,7 +56,7 @@ class GenericChatResponse(BaseChatResponse):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this GenericChatResponse.
-        The Unix timestamp (in seconds) of when the generation was created.
+        The Unix timestamp (in seconds) of when the response text was generated.
 
 
         :return: The time_created of this GenericChatResponse.
@@ -68,7 +68,7 @@ class GenericChatResponse(BaseChatResponse):
     def time_created(self, time_created):
         """
         Sets the time_created of this GenericChatResponse.
-        The Unix timestamp (in seconds) of when the generation was created.
+        The Unix timestamp (in seconds) of when the response text was generated.
 
 
         :param time_created: The time_created of this GenericChatResponse.