google-cloud-agentplatform 1.165.1.dev0__py3-none-any.whl

agentplatform/_genai/feedback_contexts.py

@@ -0,0 +1,700 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Code generated by the Google Gen AI SDK generator DO NOT EDIT.
+
+import json
+import logging
+from typing import Any, Optional, Union
+from urllib.parse import urlencode
+
+from google.genai import _api_module
+from google.genai import _common
+from google.genai._common import get_value_by_path as getv
+from google.genai._common import set_value_by_path as setv
+
+from . import _agent_engines_utils
+from . import types
+
+logger = logging.getLogger("agentplatform_genai.feedbackcontexts")
+
+logger.setLevel(logging.INFO)
+
+
+def _GetRuntimeFeedbackContextOperationParameters_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+    to_object: dict[str, Any] = {}
+    if getv(from_object, ["operation_name"]) is not None:
+        setv(
+            to_object, ["_url", "operationName"], getv(from_object, ["operation_name"])
+        )
+
+    return to_object
+
+
+def _GetRuntimeFeedbackContextRequestParameters_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+    to_object: dict[str, Any] = {}
+    if getv(from_object, ["name"]) is not None:
+        setv(to_object, ["_url", "name"], getv(from_object, ["name"]))
+
+    return to_object
+
+
+def _UpdateRuntimeFeedbackContextConfig_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+    to_object: dict[str, Any] = {}
+
+    if getv(from_object, ["update_mask"]) is not None:
+        setv(
+            parent_object, ["_query", "updateMask"], getv(from_object, ["update_mask"])
+        )
+
+    return to_object
+
+
+def _UpdateRuntimeFeedbackContextRequestParameters_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+    to_object: dict[str, Any] = {}
+    if getv(from_object, ["name"]) is not None:
+        setv(to_object, ["_url", "name"], getv(from_object, ["name"]))
+
+    if getv(from_object, ["context_events"]) is not None:
+        setv(
+            to_object,
+            ["contextEvents"],
+            [item for item in getv(from_object, ["context_events"])],
+        )
+
+    if getv(from_object, ["config"]) is not None:
+        _UpdateRuntimeFeedbackContextConfig_to_vertex(
+            getv(from_object, ["config"]), to_object
+        )
+
+    return to_object
+
+
+class FeedbackContexts(_api_module.BaseModule):
+
+    def _get(
+        self,
+        *,
+        name: str,
+        config: Optional[types.GetRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.FeedbackContext:
+        """
+        Gets a Runtime Feedback Context.
+
+        Args:
+            name (str): Required. The name of the Feedback Context to retrieve. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}/feedbackContext`.
+            config (GetRuntimeFeedbackContextConfig):
+                Optional. The configuration for getting the Feedback Context.
+
+        Returns:
+            FeedbackContext: The requested Feedback Context.
+
+        """
+
+        parameter_model = types._GetRuntimeFeedbackContextRequestParameters(
+            name=name,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _GetRuntimeFeedbackContextRequestParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{name}".format_map(request_url_dict)
+            else:
+                path = "{name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = self._api_client.request("get", path, request_dict, http_options)
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.FeedbackContext._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    def _get_feedback_context_operation(
+        self,
+        *,
+        operation_name: str,
+        config: Optional[types.GetRuntimeFeedbackContextOperationConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        parameter_model = types._GetRuntimeFeedbackContextOperationParameters(
+            operation_name=operation_name,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _GetRuntimeFeedbackContextOperationParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{operation_name}".format_map(request_url_dict)
+            else:
+                path = "{operation_name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = self._api_client.request("get", path, request_dict, http_options)
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.RuntimeFeedbackContextOperation._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    def _update(
+        self,
+        *,
+        name: str,
+        context_events: Optional[list[types.SessionEventOrDict]] = None,
+        config: Optional[types.UpdateRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        """
+        Updates a Feedback Context.
+        """
+
+        parameter_model = types._UpdateRuntimeFeedbackContextRequestParameters(
+            name=name,
+            context_events=context_events,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _UpdateRuntimeFeedbackContextRequestParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{name}".format_map(request_url_dict)
+            else:
+                path = "{name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = self._api_client.request("patch", path, request_dict, http_options)
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.RuntimeFeedbackContextOperation._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    def get(
+        self,
+        *,
+        parent: str,
+        config: Optional[types.GetRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.FeedbackContext:
+        """Gets the Feedback Context from the Runtime.
+
+        Args:
+            parent (str): Required. Resource name of the parent Feedback Entry. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}`.
+            config (GetRuntimeFeedbackContextConfig):
+                Optional. Additional configurations for getting the Feedback Context.
+
+        Returns:
+            FeedbackContext: The requested Feedback Context.
+        """
+        if config is None:
+            config = types.GetRuntimeFeedbackContextConfig()
+        elif isinstance(config, dict):
+            config = types.GetRuntimeFeedbackContextConfig.model_validate(config)
+        return self._get(
+            name=f"{parent}/feedbackContext",
+            config=config,
+        )
+
+    def update(
+        self,
+        *,
+        parent: str,
+        context_events: Optional[list[types.SessionEvent]] = None,
+        config: Optional[types.UpdateRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        """Updates a Feedback Context in the Runtime.
+
+        Args:
+            parent (str): Required. Resource name of the parent Feedback Entry. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}`.
+            context_events (list[SessionEvent]): Optional. Events from the conversation relevant to the parent Feedback Entry.
+            config (UpdateRuntimeFeedbackContextConfig):
+                Optional. Additional configurations for updating the Feedback Context.
+
+        Returns:
+            RuntimeFeedbackContextOperation: The operation for updating the Feedback Context.
+        """
+        if config is None:
+            config = types.UpdateRuntimeFeedbackContextConfig()
+        elif isinstance(config, dict):
+            config = types.UpdateRuntimeFeedbackContextConfig.model_validate(config)
+        operation = self._update(
+            name=f"{parent}/feedbackContext",
+            context_events=context_events,
+            config=config,
+        )
+        if config.wait_for_completion:
+            if not operation.done:
+                operation = _agent_engines_utils._await_operation(
+                    operation_name=operation.name,
+                    get_operation_fn=self._get_feedback_context_operation,
+                    poll_interval_seconds=0.5,
+                )
+            if operation.error:
+                raise RuntimeError(
+                    f"Failed to update Feedback Context: {operation.error}"
+                )
+        return operation
+
+
+class AsyncFeedbackContexts(_api_module.BaseModule):
+
+    async def _get(
+        self,
+        *,
+        name: str,
+        config: Optional[types.GetRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.FeedbackContext:
+        """
+        Gets a Runtime Feedback Context.
+
+        Args:
+            name (str): Required. The name of the Feedback Context to retrieve. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}/feedbackContext`.
+            config (GetRuntimeFeedbackContextConfig):
+                Optional. The configuration for getting the Feedback Context.
+
+        Returns:
+            FeedbackContext: The requested Feedback Context.
+
+        """
+
+        parameter_model = types._GetRuntimeFeedbackContextRequestParameters(
+            name=name,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _GetRuntimeFeedbackContextRequestParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{name}".format_map(request_url_dict)
+            else:
+                path = "{name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = await self._api_client.async_request(
+            "get", path, request_dict, http_options
+        )
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.FeedbackContext._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    async def _get_feedback_context_operation(
+        self,
+        *,
+        operation_name: str,
+        config: Optional[types.GetRuntimeFeedbackContextOperationConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        parameter_model = types._GetRuntimeFeedbackContextOperationParameters(
+            operation_name=operation_name,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _GetRuntimeFeedbackContextOperationParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{operation_name}".format_map(request_url_dict)
+            else:
+                path = "{operation_name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = await self._api_client.async_request(
+            "get", path, request_dict, http_options
+        )
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.RuntimeFeedbackContextOperation._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    async def _update(
+        self,
+        *,
+        name: str,
+        context_events: Optional[list[types.SessionEventOrDict]] = None,
+        config: Optional[types.UpdateRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        """
+        Updates a Feedback Context.
+        """
+
+        parameter_model = types._UpdateRuntimeFeedbackContextRequestParameters(
+            name=name,
+            context_events=context_events,
+            config=config,
+        )
+
+        request_url_dict: Optional[dict[str, str]]
+        if not self._api_client.vertexai:
+            raise ValueError(
+                "This method is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode."
+            )
+        else:
+            request_dict = _UpdateRuntimeFeedbackContextRequestParameters_to_vertex(
+                parameter_model
+            )
+            request_url_dict = request_dict.get("_url")
+            if request_url_dict:
+                path = "{name}".format_map(request_url_dict)
+            else:
+                path = "{name}"
+
+        query_params = request_dict.get("_query")
+        if query_params:
+            path = f"{path}?{urlencode(query_params)}"
+        # TODO: remove the hack that pops config.
+        request_dict.pop("config", None)
+
+        http_options: Optional[types.HttpOptions] = None
+        if (
+            parameter_model.config is not None
+            and parameter_model.config.http_options is not None
+        ):
+            http_options = parameter_model.config.http_options
+
+        request_dict = _common.convert_to_dict(request_dict)
+        request_dict = _common.encode_unserializable_types(request_dict)
+
+        response = await self._api_client.async_request(
+            "patch", path, request_dict, http_options
+        )
+
+        response_dict = {} if not response.body else json.loads(response.body)
+
+        return_value = types.RuntimeFeedbackContextOperation._from_response(
+            response=response_dict,
+            kwargs=(
+                {
+                    "config": {
+                        "response_schema": getattr(
+                            parameter_model.config, "response_schema", None
+                        ),
+                        "response_json_schema": getattr(
+                            parameter_model.config, "response_json_schema", None
+                        ),
+                        "include_all_fields": getattr(
+                            parameter_model.config, "include_all_fields", None
+                        ),
+                    }
+                }
+                if getattr(parameter_model, "config", None)
+                else {}
+            ),
+        )
+
+        self._api_client._verify_response(return_value)
+        return return_value
+
+    async def get(
+        self,
+        *,
+        parent: str,
+        config: Optional[types.GetRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.FeedbackContext:
+        """Gets the Feedback Context from the Runtime.
+
+        Args:
+            parent (str): Required. Resource name of the parent Feedback Entry. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}`.
+            config (GetRuntimeFeedbackContextConfig):
+                Optional. Additional configurations for getting the Feedback Context.
+
+        Returns:
+            FeedbackContext: The requested Feedback Context.
+        """
+        if config is None:
+            config = types.GetRuntimeFeedbackContextConfig()
+        elif isinstance(config, dict):
+            config = types.GetRuntimeFeedbackContextConfig.model_validate(config)
+        return await self._get(
+            name=f"{parent}/feedbackContext",
+            config=config,
+        )
+
+    async def update(
+        self,
+        *,
+        parent: str,
+        context_events: Optional[list[types.SessionEvent]] = None,
+        config: Optional[types.UpdateRuntimeFeedbackContextConfigOrDict] = None,
+    ) -> types.RuntimeFeedbackContextOperation:
+        """Updates a Feedback Context in the Runtime.
+
+        Args:
+            parent (str): Required. Resource name of the parent Feedback Entry. Format:
+                `projects/{project}/locations/{location}/reasoningEngines/{resource_id}/feedbackEntries/{feedback_entry_id}`.
+            context_events (list[SessionEvent]): Optional. Events from the conversation relevant to the parent Feedback Entry.
+            config (UpdateRuntimeFeedbackContextConfig):
+                Optional. Additional configurations for updating the Feedback Context.
+
+        Returns:
+            RuntimeFeedbackContextOperation: The operation for updating the Feedback Context.
+        """
+        if config is None:
+            config = types.UpdateRuntimeFeedbackContextConfig()
+        elif isinstance(config, dict):
+            config = types.UpdateRuntimeFeedbackContextConfig.model_validate(config)
+        operation = await self._update(
+            name=f"{parent}/feedbackContext",
+            context_events=context_events,
+            config=config,
+        )
+        if config.wait_for_completion:
+            if not operation.done:
+                operation = await _agent_engines_utils._await_async_operation(
+                    operation_name=operation.name,
+                    get_operation_fn=self._get_feedback_context_operation,
+                    poll_interval_seconds=0.5,
+                )
+            if operation.error:
+                raise RuntimeError(
+                    f"Failed to update Feedback Context: {operation.error}"
+                )
+        return operation