oci 2.152.1__py3-none-any.whl → 2.154.0__py3-none-any.whl

oci/access_governance_cp/access_governance_cp_client.py

@@ -160,7 +160,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/change_governance_instance_compartment.py.html>`__ to see an example of how to use change_governance_instance_compartment API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/change_governance_instance_compartment.py.html>`__ to see an example of how to use change_governance_instance_compartment API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['governanceInstanceId']
@@ -270,7 +270,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/create_governance_instance.py.html>`__ to see an example of how to use create_governance_instance API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/create_governance_instance.py.html>`__ to see an example of how to use create_governance_instance API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = []
@@ -375,7 +375,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/delete_governance_instance.py.html>`__ to see an example of how to use delete_governance_instance API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/delete_governance_instance.py.html>`__ to see an example of how to use delete_governance_instance API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['governanceInstanceId']
@@ -476,7 +476,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/get_governance_instance.py.html>`__ to see an example of how to use get_governance_instance API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/get_governance_instance.py.html>`__ to see an example of how to use get_governance_instance API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['governanceInstanceId']
@@ -574,7 +574,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/get_governance_instance_configuration.py.html>`__ to see an example of how to use get_governance_instance_configuration API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/get_governance_instance_configuration.py.html>`__ to see an example of how to use get_governance_instance_configuration API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['compartmentId']
@@ -692,7 +692,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/list_governance_instances.py.html>`__ to see an example of how to use list_governance_instances API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/list_governance_instances.py.html>`__ to see an example of how to use list_governance_instances API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['compartmentId']
@@ -823,7 +823,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/update_governance_instance.py.html>`__ to see an example of how to use update_governance_instance API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/update_governance_instance.py.html>`__ to see an example of how to use update_governance_instance API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['governanceInstanceId']
@@ -935,7 +935,7 @@ class AccessGovernanceCPClient(object):
         :rtype: :class:`~oci.response.Response`
 
         :example:
-        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.152.1/accessgovernancecp/update_governance_instance_configuration.py.html>`__ to see an example of how to use update_governance_instance_configuration API.
+        Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.154.0/accessgovernancecp/update_governance_instance_configuration.py.html>`__ to see an example of how to use update_governance_instance_configuration API.
         """
         # Required path and query arguments. These are in camelCase to replace values in service endpoints.
         required_arguments = ['compartmentId']

oci/addons/adk/agent.py

@@ -15,7 +15,7 @@ from oci.addons.adk.agent_error import AgentError, UserError
 from oci.addons.adk.constants import MAX_STATUS_CHECK, FREEFORM_TAGS
 from oci.addons.adk.logger import default_logger as logger
 from oci.addons.adk.run.response import RunResponse
-from oci.addons.adk.run.types import FunctionCall, PerformedAction, RequiredAction
+from oci.addons.adk.run.types import FunctionCall, PerformedAction, RequiredAction, RawResponse
 from oci.addons.adk.tool import FunctionTool, Toolkit, tool
 from oci.addons.adk.tool.utils import dedupe_tools_list, diff_local_and_remote_tool
 from oci.addons.adk.tool.prebuilt import AgenticRagTool
@@ -172,6 +172,7 @@ class Agent:
             RunResponse containing the final result
         """
         try:
+            raw_responses: List[RawResponse] = []
             # if session_id is not provided, create a new one
             if session_id is None:
                 session_id = self.client.create_session(
@@ -193,6 +194,7 @@ class Agent:
                 session_id=session_id,
                 on_invoked_remote_service=on_invoked_remote_service,
             )
+            raw_responses.append(RawResponse(raw_data=response))
 
             step_count = 0
             while self._has_required_actions(response) and step_count < max_steps:
@@ -211,7 +213,7 @@ class Agent:
                     performed_actions=performed_actions,
                     on_invoked_remote_service=on_invoked_remote_service,
                 )
-
+                raw_responses.append(RawResponse(raw_data=response))
                 step_count += 1
 
             if step_count >= max_steps:
@@ -219,8 +221,6 @@ class Agent:
                     f"Reached maximum number of steps ({max_steps}). Exiting loop."
                 )
 
-            return RunResponse(session_id=session_id, data=response)
-
         except Exception as e:
             logger.error(f"Error during agent execution: {e}", exc_info=True)
             raise
@@ -231,6 +231,7 @@ class Agent:
                     agent_endpoint_id=self.agent_endpoint_id,
                     session_id=session_id,
                 )
+        return RunResponse(session_id=session_id, data=response, raw_responses=raw_responses)
 
     def as_tool(
         self,
@@ -270,7 +271,7 @@ class Agent:
 
         # Create a decorated wrapper function using the @tool decorator
         @tool(name=name, description=description)
-        def agent_run_wrapper(input: str, **kwargs) -> Dict[str, Any]:
+        def agent_run_wrapper(input: str, **kwargs) -> Dict[str, Any] | None:
             """Execute this agent with the given user input and additional params."""
             response = self.run(input=input, **kwargs)
             return response.data
@@ -495,10 +496,8 @@ class Agent:
             logger.info(
                 "Agent settings are not synchronized. Updating remote agent settings"
             )
-            logger.debug(
-                f"Local agent settings: {self.name}, {self.description}, {self.instructions}",
-                f"Remote agent settings: {display_name}, {description}, {instruction}",
-            )
+            logger.debug(f"Local agent settings: {self.name}, {self.description}, {self.instructions}")
+            logger.debug(f"Remote agent settings: {display_name}, {description}, {instruction}")
             self.client.update_agent(
                 self.agent_details["agent_id"],
                 name=self.name,
@@ -777,12 +776,16 @@ class Agent:
         """
 
         response_message = json.dumps(response.get("message"), indent=4)
-
+        guardrail_result = None
+        if response is not None and "guardrail_result" in response and response["guardrail_result"] is not None:
+            guardrail_result = json.loads(str(response.get("guardrail_result")))
+            guardrail_result = json.dumps(guardrail_result, indent=4)
         message_text = (
             f"(Local <-- Remote)\n\n"
             f"agent message:\n[bold green]{response_message}[/bold green]\n\n"
             f"required actions for client to take:\n"
-            f"[bold magenta]{json.dumps(response.get('required_actions', []), indent=4)}[/bold magenta]"  # noqa: E501
+            f"[bold magenta]{json.dumps(response.get('required_actions', []), indent=4)}[/bold magenta]\n\n"
+            f"guardrail result:\n[bold green]{guardrail_result}[/bold green]\n\n"  # noqa: E501
         )
         logger.print(
             message_text,

oci/addons/adk/run/response.py

@@ -7,17 +7,18 @@ ADK run response
 """
 
 import json
-from typing import Any, Dict
+from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel, Field, computed_field
 
 from oci.addons.adk.logger import default_logger as logger
+from oci.addons.adk.run.types import RawResponse, RequiredAction, GuardrailResult, GuardrailFinding
 
 
 class RunResponse(BaseModel):
     """Response from the agent run containing the final output."""
-
-    data: Dict[str, Any] = Field(..., description="Raw response from the agent")
+    raw_responses: List[RawResponse] = Field(..., description="Accumulated list of raw response from agent.")
+    data: Dict[str, Any] | None = Field(default=None, description="Last response from the agent")
     session_id: str = Field(..., description="Session ID used for the response")
 
     @computed_field  # type: ignore[prop-decorator]
@@ -32,10 +33,77 @@ class RunResponse(BaseModel):
         """Direct access to the agent message text as output"""
         return self.final_output
 
+    @computed_field
+    def last_guardrail_result(self) -> GuardrailResult | None:
+        """Direct access to the last agent guardrail result"""
+        return self.raw_responses[-1].get_guardrail_result() if len(self.raw_responses) > 0 else None
+
+    @computed_field
+    def first_guardrail_result(self) -> GuardrailResult | None:
+        """Direct access to the first agent guardrail result"""
+        return self.raw_responses[0].get_guardrail_result() if len(self.raw_responses) > 0 else None
+
+    @computed_field
+    def messages(self) -> List[str | None]:
+        """Get all chat message content text."""
+        return [raw_response.get_nested_text() for raw_response in self.raw_responses]
+
+    @computed_field
+    def required_actions(self) -> List[List[RequiredAction] | None]:
+        """Get all required actions results."""
+        return [raw_response.get_required_action() for raw_response in self.raw_responses]
+
+    @computed_field
+    def guardrail_results(self) -> List[GuardrailResult | None]:
+        """Get all guardrail results."""
+        return [raw_response.get_guardrail_result() for raw_response in self.raw_responses]
+
+    def _format_guardrail_result(self) -> str:
+        """Format the guardrail result into human-readable form."""
+        messages = []
+
+        # Parse and validate the guardrail result from JSON
+        guardrail_result = None
+        if self.data and "guardrail_result" in self.data:
+            guardrail_result = GuardrailResult.model_validate(
+                json.loads(self.data["guardrail_result"])
+            )
+
+        if not guardrail_result:
+            return "No guardrail issues detected."
+
+        for location in ["input", "output"]:
+            content: Optional[GuardrailFinding] = getattr(guardrail_result, location, None)
+            if not content:
+                continue
+
+            # Content Moderation
+            if content.content_moderation:
+                for category, score in content.content_moderation.model_dump().items():
+                    messages.append(
+                        f"Content moderation detected - {category.upper()} with score {score} in {location.lower()}"
+                    )
+
+            # Prompt Injection
+            if content.prompt_injection:
+                score = content.prompt_injection.score
+                messages.append(
+                    f"Prompt injection risk detected with score {score} in {location.lower()}"
+                )
+
+            # Personally Identifiable Information
+            personally_identifiable_information = content.personally_identifiable_information
+            if personally_identifiable_information:
+                for pii in personally_identifiable_information:
+                    messages.append(
+                        f"Personally identifiable information detected with ({pii.label}): '{pii.text}' in {location.lower()}"
+                    )
+        return "\n".join(messages) if messages else "No guardrail issues detected."
+
     def _get_nested_text(self) -> str | None:
         """Safely extract text from nested data structure."""
         try:
-            return self.data["message"]["content"]["text"]
+            return self.raw_responses[-1].get_nested_text()
         except (KeyError, TypeError):
             return None
 
@@ -48,7 +116,13 @@ class RunResponse(BaseModel):
 
         if print_data:
             message_text += f"\n\ndata:\n[bold magenta]{json.dumps(self.data, indent=4)}[/bold magenta]"  # noqa: E501
-
+        if self.data is not None and "guardrail_result" in self.data and self.data["guardrail_result"] is not None:
+            guardrail_result = self._format_guardrail_result()
+            logger.print(
+                guardrail_result,
+                title="Guardrail Result",
+                border_style="blue",
+            )
         logger.print(
             message_text,
             title="Agent run response",

oci/addons/adk/run/types.py

@@ -5,8 +5,13 @@
 """
 ADK Run action models
 """
+import json
+from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel, Field
+from pydantic_core import ValidationError
+
+from oci.addons.adk.agent_error import AgentError
 
 
 class FunctionCall(BaseModel):
@@ -30,3 +35,70 @@ class RequiredAction(BaseModel):
     action_id: str = Field(..., alias="action_id")
     required_action_type: str = Field(..., alias="required_action_type")
     function_call: FunctionCall = Field(..., alias="function_call")
+
+
+class ContentModeration(BaseModel):
+    """Represents content moderation from server."""
+
+    violence: float = Field(..., ge=0.0, le=1.0, description="Level of violence content")
+
+
+class PromptInjection(BaseModel):
+    """Represents prompt injection violation from server."""
+
+    score: float = Field(..., ge=0.0, le=1.0, description="Confidence score for prompt injection detection")
+
+
+class PersonallyIdentifiableInformation(BaseModel):
+    """Represents personally identifiable information from server."""
+
+    length: int = Field(..., ge=0, description="Length of the detected entity")
+    offset: int = Field(..., ge=0, description="Character offset in the original text")
+    text: str = Field(..., description="The actual detected text")
+    label: str = Field(..., description="The type of PII (e.g., TELEPHONE_NUMBER, EMAIL)")
+    score: float = Field(..., ge=0.0, le=1.0, description="Confidence score of detection")
+
+
+class GuardrailFinding(BaseModel):
+    """Represents guardrail input or output content from server."""
+
+    content_moderation: Optional[ContentModeration] = Field(None, alias="contentModeration")
+    personally_identifiable_information: Optional[List[PersonallyIdentifiableInformation]] | None = Field(None, alias="personallyIdentifiableInformation")
+    prompt_injection: Optional[PromptInjection] = Field(None, alias="promptInjection")
+
+
+class GuardrailResult(BaseModel):
+    """Represents guardrail result from server."""
+
+    input: Optional[GuardrailFinding] = Field(None, description="Input guardrail result of agent response.")
+    output: Optional[GuardrailFinding] = Field(None, description="Output guardrail result of agent response.")
+
+
+class RawResponse(BaseModel):
+    """Represents an action that is required from the client."""
+    raw_data: Dict[str, Any] = Field(..., alias="raw_data")
+
+    def get_guardrail_result(self) -> GuardrailResult | None:
+        """Safely extract guardrail result (a JSON encoded string) from agent response."""
+        try:
+            return GuardrailResult.model_validate(json.loads(self.raw_data["guardrail_result"])) if self.raw_data["guardrail_result"] else None
+        except (KeyError, TypeError, ValidationError):
+            return None
+
+    def get_required_action(self) -> List[RequiredAction] | None:
+        """Safely extract required action result from agent response."""
+        try:
+            required_actions: List[RequiredAction] = [RequiredAction.model_validate(item) for item in
+                                                      self.raw_data["required_actions"]]
+            return required_actions
+        except (KeyError, TypeError, ValidationError):
+            return None
+
+    def get_nested_text(self) -> str | None:
+        """Safely extract text from nested data structure."""
+        try:
+            if self.raw_data is None:
+                raise AgentError("RunResponse raw_data cannot be none")
+            return self.raw_data["message"]["content"]["text"]
+        except (KeyError, TypeError, AgentError):
+            return None

oci/addons/adk/tool/function_tool.py

@@ -309,7 +309,8 @@ class FunctionTool(BaseModel):
             Dictionary mapping parameter names to their descriptions
         """
         param_descriptions = {}
-        if docstring := getdoc(callable_func):
+        docstring = getdoc(callable_func)
+        if docstring:
             parsed_doc = parse(docstring)
             param_docs = parsed_doc.params
 

oci/addons/adk/util.py

@@ -168,7 +168,6 @@ class JsonSchemaGenerator:
             len(type_args) == 2 and
             any(arg is NoneType for arg in type_args)
         )
-
         if is_optional:
             actual_type = next(arg for arg in type_args if arg is not NoneType)
             return True, actual_type
@@ -222,11 +221,7 @@ class JsonSchemaGenerator:
                             arg_json_schema["type"] = [arg_json_schema["type"], "null"]
 
                     # Add description
-                    if (
-                        param_descriptions and
-                        k in param_descriptions and
-                        param_descriptions[k]
-                    ):
+                    if (param_descriptions and k in param_descriptions and param_descriptions[k]):
                         arg_json_schema["description"] = param_descriptions[k]
 
                     json_schema["properties"][k] = arg_json_schema