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

oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.py

@@ -108,7 +108,7 @@ class GenerativeAiAgentRuntimeClient(object):
             'regional_client': True,
             'service_endpoint': kwargs.get('service_endpoint'),
             'base_path': '/20240531',
-            'service_endpoint_template': 'https://genai-agent-service.{region}.oci.{secondLevelDomain}',
+            'service_endpoint_template': 'https://agent-runtime.generativeai.{region}.oci.{secondLevelDomain}',
             'service_endpoint_template_per_realm': {  },  # noqa: E201 E202
             'skip_deserialization': kwargs.get('skip_deserialization', False),
             'circuit_breaker_strategy': kwargs.get('circuit_breaker_strategy', circuit_breaker.GLOBAL_CIRCUIT_BREAKER_STRATEGY),
@@ -168,7 +168,7 @@ class GenerativeAiAgentRuntimeClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.0/generativeaiagentruntime/chat.py.html>`__ to see an example of how to use chat API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/chat.py.html>`__ to see an example of how to use chat API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['agentEndpointId']
@@ -285,7 +285,7 @@ class GenerativeAiAgentRuntimeClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.0/generativeaiagentruntime/create_session.py.html>`__ to see an example of how to use create_session API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/create_session.py.html>`__ to see an example of how to use create_session API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['agentEndpointId']
@@ -398,7 +398,7 @@ class GenerativeAiAgentRuntimeClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.0/generativeaiagentruntime/delete_session.py.html>`__ to see an example of how to use delete_session API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/delete_session.py.html>`__ to see an example of how to use delete_session API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['agentEndpointId', 'sessionId']
@@ -500,7 +500,7 @@ class GenerativeAiAgentRuntimeClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.0/generativeaiagentruntime/get_session.py.html>`__ to see an example of how to use get_session API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/get_session.py.html>`__ to see an example of how to use get_session API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['agentEndpointId', 'sessionId']
@@ -572,6 +572,128 @@ class GenerativeAiAgentRuntimeClient(object):
                 api_reference_link=api_reference_link,
                 required_arguments=required_arguments)
 
+    def retrieve_metadata(self, knowledge_base_id, retrieve_metadata_details, **kwargs):
+        """
+        Returns metadata of provided knowledgeBase. Return available metadata with information of field names, their types, supported operations, and possible values.
+
+
+        :param str knowledge_base_id: (required)
+            A unique ID for the Knowledge Base.
+
+        :param oci.generative_ai_agent_runtime.models.RetrieveMetadataDetails retrieve_metadata_details: (required)
+            Input for retrieve metadata.
+
+        :param str opc_request_id: (optional)
+            The client request ID for tracing.
+
+        :param str if_match: (optional)
+            For optimistic concurrency control. In the PUT or DELETE call
+            for a resource, set the `if-match` parameter to the value of the
+            etag from a previous GET or POST response for that resource.
+            The resource will be updated or deleted only if the etag you
+            provide matches the resource's current etag value.
+
+        :param str opc_retry_token: (optional)
+            A token that uniquely identifies a request so it can be retried in case of a timeout or
+            server error without risk of executing that same action again. Retry tokens expire after 24
+            hours, but can be invalidated before then due to conflicting operations. For example, if a resource
+            has been deleted and purged from the system, then a retry of the original creation request
+            might be rejected.
+
+        :param obj retry_strategy: (optional)
+            A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
+
+            This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided.
+            The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
+
+            To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
+
+        :param bool allow_control_chars: (optional)
+            allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
+            By default, the response will not allow control characters in strings
+
+        :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.generative_ai_agent_runtime.models.KnowledgeBaseMetadataSummary`
+        :rtype: :class:`~oci.response.Response`
+
+        :example:
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/retrieve_metadata.py.html>`__ to see an example of how to use retrieve_metadata API.
+        """
+        # Required path and query arguments. These are in camelCase to replace values in service endpoints.
+        required_arguments = ['knowledgeBaseId']
+        resource_path = "/knowledgeBases/{knowledgeBaseId}/actions/retrieveMetadata"
+        method = "POST"
+        operation_name = "retrieve_metadata"
+        api_reference_link = "https://docs.oracle.com/iaas/api/#/en/generative-ai-agents-client/20240531/KnowledgeBaseMetadataSummary/RetrieveMetadata"
+
+        # Don't accept unknown kwargs
+        expected_kwargs = [
+            "allow_control_chars",
+            "retry_strategy",
+            "opc_request_id",
+            "if_match",
+            "opc_retry_token"
+        ]
+        extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
+        if extra_kwargs:
+            raise ValueError(
+                f"retrieve_metadata got unknown kwargs: {extra_kwargs!r}")
+
+        path_params = {
+            "knowledgeBaseId": knowledge_base_id
+        }
+
+        path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
+
+        for (k, v) in six.iteritems(path_params):
+            if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
+                raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
+
+        header_params = {
+            "accept": "application/json",
+            "content-type": "application/json",
+            "opc-request-id": kwargs.get("opc_request_id", missing),
+            "if-match": kwargs.get("if_match", missing),
+            "opc-retry-token": kwargs.get("opc_retry_token", missing)
+        }
+        header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
+
+        retry_strategy = self.base_client.get_preferred_retry_strategy(
+            operation_retry_strategy=kwargs.get('retry_strategy'),
+            client_retry_strategy=self.retry_strategy
+        )
+        if retry_strategy is None:
+            retry_strategy = retry.DEFAULT_RETRY_STRATEGY
+
+        if retry_strategy:
+            if not isinstance(retry_strategy, retry.NoneRetryStrategy):
+                self.base_client.add_opc_retry_token_if_needed(header_params)
+                self.base_client.add_opc_client_retries_header(header_params)
+                retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
+            return retry_strategy.make_retrying_call(
+                self.base_client.call_api,
+                resource_path=resource_path,
+                method=method,
+                path_params=path_params,
+                header_params=header_params,
+                body=retrieve_metadata_details,
+                response_type="list[KnowledgeBaseMetadataSummary]",
+                allow_control_chars=kwargs.get('allow_control_chars'),
+                operation_name=operation_name,
+                api_reference_link=api_reference_link,
+                required_arguments=required_arguments)
+        else:
+            return self.base_client.call_api(
+                resource_path=resource_path,
+                method=method,
+                path_params=path_params,
+                header_params=header_params,
+                body=retrieve_metadata_details,
+                response_type="list[KnowledgeBaseMetadataSummary]",
+                allow_control_chars=kwargs.get('allow_control_chars'),
+                operation_name=operation_name,
+                api_reference_link=api_reference_link,
+                required_arguments=required_arguments)
+
     def update_session(self, agent_endpoint_id, session_id, update_session_details, **kwargs):
         """
         Update session metadata, including but not limited to description, tags.
@@ -612,7 +734,7 @@ class GenerativeAiAgentRuntimeClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.0/generativeaiagentruntime/update_session.py.html>`__ to see an example of how to use update_session API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.149.2/generativeaiagentruntime/update_session.py.html>`__ to see an example of how to use update_session API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['agentEndpointId', 'sessionId']

oci/generative_ai_agent_runtime/models/__init__.py

@@ -11,13 +11,25 @@ from .chat_result import ChatResult
 from .citation import Citation
 from .create_session_details import CreateSessionDetails
 from .error_trace import ErrorTrace
+from .function_call import FunctionCall
+from .function_calling_performed_action import FunctionCallingPerformedAction
+from .function_calling_required_action import FunctionCallingRequiredAction
 from .generation_trace import GenerationTrace
+from .human_approval_performed_action import HumanApprovalPerformedAction
+from .knowledge_base_metadata_summary import KnowledgeBaseMetadataSummary
+from .knowledge_base_metadata_value import KnowledgeBaseMetadataValue
 from .message import Message
 from .message_content import MessageContent
+from .metadata_filter import MetadataFilter
 from .oci_database_source_location import OciDatabaseSourceLocation
 from .oci_object_storage_source_location import OciObjectStorageSourceLocation
 from .oci_open_search_source_location import OciOpenSearchSourceLocation
+from .paragraph import Paragraph
+from .paragraph_citation import ParagraphCitation
+from .performed_action import PerformedAction
+from .required_action import RequiredAction
 from .retrieval_trace import RetrievalTrace
+from .retrieve_metadata_details import RetrieveMetadataDetails
 from .session import Session
 from .source_location import SourceLocation
 from .trace import Trace
@@ -30,13 +42,25 @@ generative_ai_agent_runtime_type_mapping = {
     "Citation": Citation,
     "CreateSessionDetails": CreateSessionDetails,
     "ErrorTrace": ErrorTrace,
+    "FunctionCall": FunctionCall,
+    "FunctionCallingPerformedAction": FunctionCallingPerformedAction,
+    "FunctionCallingRequiredAction": FunctionCallingRequiredAction,
     "GenerationTrace": GenerationTrace,
+    "HumanApprovalPerformedAction": HumanApprovalPerformedAction,
+    "KnowledgeBaseMetadataSummary": KnowledgeBaseMetadataSummary,
+    "KnowledgeBaseMetadataValue": KnowledgeBaseMetadataValue,
     "Message": Message,
     "MessageContent": MessageContent,
+    "MetadataFilter": MetadataFilter,
     "OciDatabaseSourceLocation": OciDatabaseSourceLocation,
     "OciObjectStorageSourceLocation": OciObjectStorageSourceLocation,
     "OciOpenSearchSourceLocation": OciOpenSearchSourceLocation,
+    "Paragraph": Paragraph,
+    "ParagraphCitation": ParagraphCitation,
+    "PerformedAction": PerformedAction,
+    "RequiredAction": RequiredAction,
     "RetrievalTrace": RetrievalTrace,
+    "RetrieveMetadataDetails": RetrieveMetadataDetails,
     "Session": Session,
     "SourceLocation": SourceLocation,
     "Trace": Trace,

oci/generative_ai_agent_runtime/models/chat_details.py

@@ -32,25 +32,39 @@ class ChatDetails(object):
             The value to assign to the session_id property of this ChatDetails.
         :type session_id: str
 
+        :param tool_parameters:
+            The value to assign to the tool_parameters property of this ChatDetails.
+        :type tool_parameters: dict(str, str)
+
+        :param performed_actions:
+            The value to assign to the performed_actions property of this ChatDetails.
+        :type performed_actions: list[oci.generative_ai_agent_runtime.models.PerformedAction]
+
         """
         self.swagger_types = {
             'user_message': 'str',
             'should_stream': 'bool',
-            'session_id': 'str'
+            'session_id': 'str',
+            'tool_parameters': 'dict(str, str)',
+            'performed_actions': 'list[PerformedAction]'
         }
         self.attribute_map = {
             'user_message': 'userMessage',
             'should_stream': 'shouldStream',
-            'session_id': 'sessionId'
+            'session_id': 'sessionId',
+            'tool_parameters': 'toolParameters',
+            'performed_actions': 'performedActions'
         }
         self._user_message = None
         self._should_stream = None
         self._session_id = None
+        self._tool_parameters = None
+        self._performed_actions = None
 
     @property
     def user_message(self):
         """
-        **[Required]** Gets the user_message of this ChatDetails.
+        Gets the user_message of this ChatDetails.
         The input user message content for the chat.
 
 
@@ -119,6 +133,54 @@ class ChatDetails(object):
         """
         self._session_id = session_id
 
+    @property
+    def tool_parameters(self):
+        """
+        Gets the tool_parameters of this ChatDetails.
+        A map where each key is a toolId and the value contains tool type and additional dynamic parameters.
+
+
+        :return: The tool_parameters of this ChatDetails.
+        :rtype: dict(str, str)
+        """
+        return self._tool_parameters
+
+    @tool_parameters.setter
+    def tool_parameters(self, tool_parameters):
+        """
+        Sets the tool_parameters of this ChatDetails.
+        A map where each key is a toolId and the value contains tool type and additional dynamic parameters.
+
+
+        :param tool_parameters: The tool_parameters of this ChatDetails.
+        :type: dict(str, str)
+        """
+        self._tool_parameters = tool_parameters
+
+    @property
+    def performed_actions(self):
+        """
+        Gets the performed_actions of this ChatDetails.
+        A list of actions that have been performed based on prior required actions.
+
+
+        :return: The performed_actions of this ChatDetails.
+        :rtype: list[oci.generative_ai_agent_runtime.models.PerformedAction]
+        """
+        return self._performed_actions
+
+    @performed_actions.setter
+    def performed_actions(self, performed_actions):
+        """
+        Sets the performed_actions of this ChatDetails.
+        A list of actions that have been performed based on prior required actions.
+
+
+        :param performed_actions: The performed_actions of this ChatDetails.
+        :type: list[oci.generative_ai_agent_runtime.models.PerformedAction]
+        """
+        self._performed_actions = performed_actions
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_agent_runtime/models/chat_result.py

@@ -28,17 +28,38 @@ class ChatResult(object):
             The value to assign to the traces property of this ChatResult.
         :type traces: list[oci.generative_ai_agent_runtime.models.Trace]
 
+        :param tool_results:
+            The value to assign to the tool_results property of this ChatResult.
+        :type tool_results: dict(str, str)
+
+        :param required_actions:
+            The value to assign to the required_actions property of this ChatResult.
+        :type required_actions: list[oci.generative_ai_agent_runtime.models.RequiredAction]
+
+        :param guardrail_result:
+            The value to assign to the guardrail_result property of this ChatResult.
+        :type guardrail_result: str
+
         """
         self.swagger_types = {
             'message': 'Message',
-            'traces': 'list[Trace]'
+            'traces': 'list[Trace]',
+            'tool_results': 'dict(str, str)',
+            'required_actions': 'list[RequiredAction]',
+            'guardrail_result': 'str'
         }
         self.attribute_map = {
             'message': 'message',
-            'traces': 'traces'
+            'traces': 'traces',
+            'tool_results': 'toolResults',
+            'required_actions': 'requiredActions',
+            'guardrail_result': 'guardrailResult'
         }
         self._message = None
         self._traces = None
+        self._tool_results = None
+        self._required_actions = None
+        self._guardrail_result = None
 
     @property
     def message(self):
@@ -84,6 +105,78 @@ class ChatResult(object):
         """
         self._traces = traces
 
+    @property
+    def tool_results(self):
+        """
+        Gets the tool_results of this ChatResult.
+        A map where each key is a toolId and the value contains tool type and additional dynamic results.
+
+
+        :return: The tool_results of this ChatResult.
+        :rtype: dict(str, str)
+        """
+        return self._tool_results
+
+    @tool_results.setter
+    def tool_results(self, tool_results):
+        """
+        Sets the tool_results of this ChatResult.
+        A map where each key is a toolId and the value contains tool type and additional dynamic results.
+
+
+        :param tool_results: The tool_results of this ChatResult.
+        :type: dict(str, str)
+        """
+        self._tool_results = tool_results
+
+    @property
+    def required_actions(self):
+        """
+        Gets the required_actions of this ChatResult.
+        A list of actions the agent requires the user or agent client to perform.
+
+
+        :return: The required_actions of this ChatResult.
+        :rtype: list[oci.generative_ai_agent_runtime.models.RequiredAction]
+        """
+        return self._required_actions
+
+    @required_actions.setter
+    def required_actions(self, required_actions):
+        """
+        Sets the required_actions of this ChatResult.
+        A list of actions the agent requires the user or agent client to perform.
+
+
+        :param required_actions: The required_actions of this ChatResult.
+        :type: list[oci.generative_ai_agent_runtime.models.RequiredAction]
+        """
+        self._required_actions = required_actions
+
+    @property
+    def guardrail_result(self):
+        """
+        Gets the guardrail_result of this ChatResult.
+        Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent.
+
+
+        :return: The guardrail_result of this ChatResult.
+        :rtype: str
+        """
+        return self._guardrail_result
+
+    @guardrail_result.setter
+    def guardrail_result(self, guardrail_result):
+        """
+        Sets the guardrail_result of this ChatResult.
+        Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent.
+
+
+        :param guardrail_result: The guardrail_result of this ChatResult.
+        :type: str
+        """
+        self._guardrail_result = guardrail_result
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_agent_runtime/models/citation.py

@@ -12,7 +12,7 @@ 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.
+    The source of information for the agent's response.
     """
 
     def __init__(self, **kwargs):
@@ -40,26 +40,33 @@ class Citation(object):
             The value to assign to the page_numbers property of this Citation.
         :type page_numbers: list[int]
 
+        :param metadata:
+            The value to assign to the metadata property of this Citation.
+        :type metadata: dict(str, object)
+
         """
         self.swagger_types = {
             'source_text': 'str',
             'source_location': 'SourceLocation',
             'title': 'str',
             'doc_id': 'str',
-            'page_numbers': 'list[int]'
+            'page_numbers': 'list[int]',
+            'metadata': 'dict(str, object)'
         }
         self.attribute_map = {
             'source_text': 'sourceText',
             'source_location': 'sourceLocation',
             'title': 'title',
             'doc_id': 'docId',
-            'page_numbers': 'pageNumbers'
+            'page_numbers': 'pageNumbers',
+            'metadata': 'metadata'
         }
         self._source_text = None
         self._source_location = None
         self._title = None
         self._doc_id = None
         self._page_numbers = None
+        self._metadata = None
 
     @property
     def source_text(self):
@@ -177,6 +184,30 @@ class Citation(object):
         """
         self._page_numbers = page_numbers
 
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this Citation.
+        The metadata of the retrieved document, if available.
+
+
+        :return: The metadata of this Citation.
+        :rtype: dict(str, object)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this Citation.
+        The metadata of the retrieved document, if available.
+
+
+        :param metadata: The metadata of this Citation.
+        :type: dict(str, object)
+        """
+        self._metadata = metadata
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_agent_runtime/models/function_call.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 FunctionCall(object):
+    """
+    Represent a function call the client need to execute in order to fulfill the required action.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionCall 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 FunctionCall.
+        :type name: str
+
+        :param arguments:
+            The value to assign to the arguments property of this FunctionCall.
+        :type arguments: str
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'arguments': 'str'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'arguments': 'arguments'
+        }
+        self._name = None
+        self._arguments = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this FunctionCall.
+        Name of the function to be executed.
+
+
+        :return: The name of this FunctionCall.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this FunctionCall.
+        Name of the function to be executed.
+
+
+        :param name: The name of this FunctionCall.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def arguments(self):
+        """
+        **[Required]** Gets the arguments of this FunctionCall.
+        Arguments for the function call as a JSON string.
+
+
+        :return: The arguments of this FunctionCall.
+        :rtype: str
+        """
+        return self._arguments
+
+    @arguments.setter
+    def arguments(self, arguments):
+        """
+        Sets the arguments of this FunctionCall.
+        Arguments for the function call as a JSON string.
+
+
+        :param arguments: The arguments of this FunctionCall.
+        :type: str
+        """
+        self._arguments = arguments
+
+    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