feat(api): add user feedback

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 54
+configured_endpoints: 55
 openapi_spec_hash: 7daf4896ba4932714f8fe4fff277d7c7
-config_hash: 930284cfa37f835d949c8a1b124f4807
+config_hash: bed87752f4056d0c4bf2ddf856307800

api.md

@@ -202,6 +202,7 @@ Types:
 from codex.types.projects import (
     QueryLogRetrieveResponse,
     QueryLogListResponse,
+    QueryLogAddUserFeedbackResponse,
     QueryLogListByGroupResponse,
     QueryLogListGroupsResponse,
     QueryLogStartRemediationResponse,
@@ -212,6 +213,7 @@ Methods:
 
 - <code title="get /api/projects/{project_id}/query_logs/{query_log_id}">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">retrieve</a>(query_log_id, \*, project_id) -> <a href="./src/codex/types/projects/query_log_retrieve_response.py">QueryLogRetrieveResponse</a></code>
 - <code title="get /api/projects/{project_id}/query_logs/">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">list</a>(project_id, \*\*<a href="src/codex/types/projects/query_log_list_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_list_response.py">SyncOffsetPageQueryLogs[QueryLogListResponse]</a></code>
+- <code title="post /api/projects/{project_id}/query_logs/{query_log_id}/user_feedback">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">add_user_feedback</a>(query_log_id, \*, project_id, \*\*<a href="src/codex/types/projects/query_log_add_user_feedback_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_add_user_feedback_response.py">QueryLogAddUserFeedbackResponse</a></code>
 - <code title="get /api/projects/{project_id}/query_logs/logs_by_group">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">list_by_group</a>(project_id, \*\*<a href="src/codex/types/projects/query_log_list_by_group_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_list_by_group_response.py">QueryLogListByGroupResponse</a></code>
 - <code title="get /api/projects/{project_id}/query_logs/groups">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">list_groups</a>(project_id, \*\*<a href="src/codex/types/projects/query_log_list_groups_params.py">params</a>) -> <a href="./src/codex/types/projects/query_log_list_groups_response.py">SyncOffsetPageQueryLogGroups[QueryLogListGroupsResponse]</a></code>
 - <code title="post /api/projects/{project_id}/query_logs/{query_log_id}/start_remediation">client.projects.query_logs.<a href="./src/codex/resources/projects/query_logs.py">start_remediation</a>(query_log_id, \*, project_id) -> <a href="./src/codex/types/projects/query_log_start_remediation_response.py">QueryLogStartRemediationResponse</a></code>

src/codex/resources/projects/query_logs.py

@@ -25,11 +25,17 @@
     AsyncOffsetPageQueryLogGroups,
 )
 from ..._base_client import AsyncPaginator, make_request_options
-from ...types.projects import query_log_list_params, query_log_list_groups_params, query_log_list_by_group_params
+from ...types.projects import (
+    query_log_list_params,
+    query_log_list_groups_params,
+    query_log_list_by_group_params,
+    query_log_add_user_feedback_params,
+)
 from ...types.projects.query_log_list_response import QueryLogListResponse
 from ...types.projects.query_log_retrieve_response import QueryLogRetrieveResponse
 from ...types.projects.query_log_list_groups_response import QueryLogListGroupsResponse
 from ...types.projects.query_log_list_by_group_response import QueryLogListByGroupResponse
+from ...types.projects.query_log_add_user_feedback_response import QueryLogAddUserFeedbackResponse
 from ...types.projects.query_log_start_remediation_response import QueryLogStartRemediationResponse
 
 __all__ = ["QueryLogsResource", "AsyncQueryLogsResource"]
@@ -184,6 +190,46 @@ def list(
             model=QueryLogListResponse,
         )
 
+    def add_user_feedback(
+        self,
+        query_log_id: str,
+        *,
+        project_id: str,
+        key: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> QueryLogAddUserFeedbackResponse:
+        """
+        Add User Feedback Route
+
+        Args:
+          key: A key describing the criteria of the feedback, eg 'rating'
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        if not query_log_id:
+            raise ValueError(f"Expected a non-empty value for `query_log_id` but received {query_log_id!r}")
+        return self._post(
+            f"/api/projects/{project_id}/query_logs/{query_log_id}/user_feedback",
+            body=maybe_transform({"key": key}, query_log_add_user_feedback_params.QueryLogAddUserFeedbackParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=QueryLogAddUserFeedbackResponse,
+        )
+
     def list_by_group(
         self,
         project_id: str,
@@ -568,6 +614,48 @@ def list(
             model=QueryLogListResponse,
         )
 
+    async def add_user_feedback(
+        self,
+        query_log_id: str,
+        *,
+        project_id: str,
+        key: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> QueryLogAddUserFeedbackResponse:
+        """
+        Add User Feedback Route
+
+        Args:
+          key: A key describing the criteria of the feedback, eg 'rating'
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        if not query_log_id:
+            raise ValueError(f"Expected a non-empty value for `query_log_id` but received {query_log_id!r}")
+        return await self._post(
+            f"/api/projects/{project_id}/query_logs/{query_log_id}/user_feedback",
+            body=await async_maybe_transform(
+                {"key": key}, query_log_add_user_feedback_params.QueryLogAddUserFeedbackParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=QueryLogAddUserFeedbackResponse,
+        )
+
     async def list_by_group(
         self,
         project_id: str,
@@ -813,6 +901,9 @@ def __init__(self, query_logs: QueryLogsResource) -> None:
         self.list = to_raw_response_wrapper(
             query_logs.list,
         )
+        self.add_user_feedback = to_raw_response_wrapper(
+            query_logs.add_user_feedback,
+        )
         self.list_by_group = to_raw_response_wrapper(
             query_logs.list_by_group,
         )
@@ -834,6 +925,9 @@ def __init__(self, query_logs: AsyncQueryLogsResource) -> None:
         self.list = async_to_raw_response_wrapper(
             query_logs.list,
         )
+        self.add_user_feedback = async_to_raw_response_wrapper(
+            query_logs.add_user_feedback,
+        )
         self.list_by_group = async_to_raw_response_wrapper(
             query_logs.list_by_group,
         )
@@ -855,6 +949,9 @@ def __init__(self, query_logs: QueryLogsResource) -> None:
         self.list = to_streamed_response_wrapper(
             query_logs.list,
         )
+        self.add_user_feedback = to_streamed_response_wrapper(
+            query_logs.add_user_feedback,
+        )
         self.list_by_group = to_streamed_response_wrapper(
             query_logs.list_by_group,
         )
@@ -876,6 +973,9 @@ def __init__(self, query_logs: AsyncQueryLogsResource) -> None:
         self.list = async_to_streamed_response_wrapper(
             query_logs.list,
         )
+        self.add_user_feedback = async_to_streamed_response_wrapper(
+            query_logs.add_user_feedback,
+        )
         self.list_by_group = async_to_streamed_response_wrapper(
             query_logs.list_by_group,
         )

src/codex/types/projects/__init__.py

@@ -27,6 +27,8 @@
 from .remediation_edit_answer_params import RemediationEditAnswerParams as RemediationEditAnswerParams
 from .query_log_list_by_group_response import QueryLogListByGroupResponse as QueryLogListByGroupResponse
 from .remediation_edit_answer_response import RemediationEditAnswerResponse as RemediationEditAnswerResponse
+from .query_log_add_user_feedback_params import QueryLogAddUserFeedbackParams as QueryLogAddUserFeedbackParams
+from .query_log_add_user_feedback_response import QueryLogAddUserFeedbackResponse as QueryLogAddUserFeedbackResponse
 from .query_log_start_remediation_response import QueryLogStartRemediationResponse as QueryLogStartRemediationResponse
 from .remediation_edit_draft_answer_params import RemediationEditDraftAnswerParams as RemediationEditDraftAnswerParams
 from .remediation_edit_draft_answer_response import (

src/codex/types/projects/query_log_add_user_feedback_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["QueryLogAddUserFeedbackParams"]
+
+
+class QueryLogAddUserFeedbackParams(TypedDict, total=False):
+    project_id: Required[str]
+
+    key: Required[str]
+    """A key describing the criteria of the feedback, eg 'rating'"""

src/codex/types/projects/query_log_add_user_feedback_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["QueryLogAddUserFeedbackResponse"]
+
+
+class QueryLogAddUserFeedbackResponse(BaseModel):
+    custom_metadata: object
+
+    query_log_id: str

tests/api_resources/projects/test_query_logs.py

@@ -21,6 +21,7 @@
     QueryLogRetrieveResponse,
     QueryLogListGroupsResponse,
     QueryLogListByGroupResponse,
+    QueryLogAddUserFeedbackResponse,
     QueryLogStartRemediationResponse,
 )
 
@@ -146,6 +147,63 @@ def test_path_params_list(self, client: Codex) -> None:
                 project_id="",
             )
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_add_user_feedback(self, client: Codex) -> None:
+        query_log = client.projects.query_logs.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        )
+        assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_raw_response_add_user_feedback(self, client: Codex) -> None:
+        response = client.projects.query_logs.with_raw_response.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        query_log = response.parse()
+        assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_streaming_response_add_user_feedback(self, client: Codex) -> None:
+        with client.projects.query_logs.with_streaming_response.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            query_log = response.parse()
+            assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_path_params_add_user_feedback(self, client: Codex) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `project_id` but received ''"):
+            client.projects.query_logs.with_raw_response.add_user_feedback(
+                query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                project_id="",
+                key="key",
+            )
+
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `query_log_id` but received ''"):
+            client.projects.query_logs.with_raw_response.add_user_feedback(
+                query_log_id="",
+                project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                key="key",
+            )
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     def test_method_list_by_group(self, client: Codex) -> None:
@@ -451,6 +509,63 @@ async def test_path_params_list(self, async_client: AsyncCodex) -> None:
                 project_id="",
             )
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_add_user_feedback(self, async_client: AsyncCodex) -> None:
+        query_log = await async_client.projects.query_logs.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        )
+        assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_raw_response_add_user_feedback(self, async_client: AsyncCodex) -> None:
+        response = await async_client.projects.query_logs.with_raw_response.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        query_log = await response.parse()
+        assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_streaming_response_add_user_feedback(self, async_client: AsyncCodex) -> None:
+        async with async_client.projects.query_logs.with_streaming_response.add_user_feedback(
+            query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+            key="key",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            query_log = await response.parse()
+            assert_matches_type(QueryLogAddUserFeedbackResponse, query_log, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_path_params_add_user_feedback(self, async_client: AsyncCodex) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `project_id` but received ''"):
+            await async_client.projects.query_logs.with_raw_response.add_user_feedback(
+                query_log_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                project_id="",
+                key="key",
+            )
+
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `query_log_id` but received ''"):
+            await async_client.projects.query_logs.with_raw_response.add_user_feedback(
+                query_log_id="",
+                project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
+                key="key",
+            )
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     async def test_method_list_by_group(self, async_client: AsyncCodex) -> None: