|
| 1 | +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import httpx |
| 6 | + |
| 7 | +from ..types import evaluate_score_query_params |
| 8 | +from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given |
| 9 | +from .._utils import maybe_transform, async_maybe_transform |
| 10 | +from .._compat import cached_property |
| 11 | +from .._resource import SyncAPIResource, AsyncAPIResource |
| 12 | +from .._response import ( |
| 13 | + to_raw_response_wrapper, |
| 14 | + to_streamed_response_wrapper, |
| 15 | + async_to_raw_response_wrapper, |
| 16 | + async_to_streamed_response_wrapper, |
| 17 | +) |
| 18 | +from ..types.query import Query |
| 19 | +from .._base_client import make_request_options |
| 20 | +from ..types.evaluate_score_query_response import EvaluateScoreQueryResponse |
| 21 | + |
| 22 | +__all__ = ["EvaluateResource", "AsyncEvaluateResource"] |
| 23 | + |
| 24 | + |
| 25 | +class EvaluateResource(SyncAPIResource): |
| 26 | + @cached_property |
| 27 | + def with_raw_response(self) -> EvaluateResourceWithRawResponse: |
| 28 | + """ |
| 29 | + This property can be used as a prefix for any HTTP method call to return |
| 30 | + the raw response object instead of the parsed content. |
| 31 | +
|
| 32 | + For more information, see https://www.github.com/hyperspell/python-sdk#accessing-raw-response-data-eg-headers |
| 33 | + """ |
| 34 | + return EvaluateResourceWithRawResponse(self) |
| 35 | + |
| 36 | + @cached_property |
| 37 | + def with_streaming_response(self) -> EvaluateResourceWithStreamingResponse: |
| 38 | + """ |
| 39 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 40 | +
|
| 41 | + For more information, see https://www.github.com/hyperspell/python-sdk#with_streaming_response |
| 42 | + """ |
| 43 | + return EvaluateResourceWithStreamingResponse(self) |
| 44 | + |
| 45 | + def get_query( |
| 46 | + self, |
| 47 | + query_id: str, |
| 48 | + *, |
| 49 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 50 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 51 | + extra_headers: Headers | None = None, |
| 52 | + extra_query: Query | None = None, |
| 53 | + extra_body: Body | None = None, |
| 54 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 55 | + ) -> Query: |
| 56 | + """ |
| 57 | + Retrieve an existing query |
| 58 | +
|
| 59 | + Args: |
| 60 | + extra_headers: Send extra headers |
| 61 | +
|
| 62 | + extra_query: Add additional query parameters to the request |
| 63 | +
|
| 64 | + extra_body: Add additional JSON properties to the request |
| 65 | +
|
| 66 | + timeout: Override the client-level default timeout for this request, in seconds |
| 67 | + """ |
| 68 | + if not query_id: |
| 69 | + raise ValueError(f"Expected a non-empty value for `query_id` but received {query_id!r}") |
| 70 | + return self._get( |
| 71 | + f"/memories/query/{query_id}", |
| 72 | + options=make_request_options( |
| 73 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 74 | + ), |
| 75 | + cast_to=Query, |
| 76 | + ) |
| 77 | + |
| 78 | + def score_query( |
| 79 | + self, |
| 80 | + *, |
| 81 | + query_id: str, |
| 82 | + score: float | Omit = omit, |
| 83 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 84 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 85 | + extra_headers: Headers | None = None, |
| 86 | + extra_query: Query | None = None, |
| 87 | + extra_body: Body | None = None, |
| 88 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 89 | + ) -> EvaluateScoreQueryResponse: |
| 90 | + """ |
| 91 | + Provide feedback on a query result. |
| 92 | +
|
| 93 | + Args: |
| 94 | + query_id: The ID of the query to provide feedback on. |
| 95 | +
|
| 96 | + score: Rating of the query result from -1 (bad) to +1 (good). |
| 97 | +
|
| 98 | + extra_headers: Send extra headers |
| 99 | +
|
| 100 | + extra_query: Add additional query parameters to the request |
| 101 | +
|
| 102 | + extra_body: Add additional JSON properties to the request |
| 103 | +
|
| 104 | + timeout: Override the client-level default timeout for this request, in seconds |
| 105 | + """ |
| 106 | + return self._post( |
| 107 | + "/memories/query/feedback", |
| 108 | + body=maybe_transform( |
| 109 | + { |
| 110 | + "query_id": query_id, |
| 111 | + "score": score, |
| 112 | + }, |
| 113 | + evaluate_score_query_params.EvaluateScoreQueryParams, |
| 114 | + ), |
| 115 | + options=make_request_options( |
| 116 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 117 | + ), |
| 118 | + cast_to=EvaluateScoreQueryResponse, |
| 119 | + ) |
| 120 | + |
| 121 | + |
| 122 | +class AsyncEvaluateResource(AsyncAPIResource): |
| 123 | + @cached_property |
| 124 | + def with_raw_response(self) -> AsyncEvaluateResourceWithRawResponse: |
| 125 | + """ |
| 126 | + This property can be used as a prefix for any HTTP method call to return |
| 127 | + the raw response object instead of the parsed content. |
| 128 | +
|
| 129 | + For more information, see https://www.github.com/hyperspell/python-sdk#accessing-raw-response-data-eg-headers |
| 130 | + """ |
| 131 | + return AsyncEvaluateResourceWithRawResponse(self) |
| 132 | + |
| 133 | + @cached_property |
| 134 | + def with_streaming_response(self) -> AsyncEvaluateResourceWithStreamingResponse: |
| 135 | + """ |
| 136 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 137 | +
|
| 138 | + For more information, see https://www.github.com/hyperspell/python-sdk#with_streaming_response |
| 139 | + """ |
| 140 | + return AsyncEvaluateResourceWithStreamingResponse(self) |
| 141 | + |
| 142 | + async def get_query( |
| 143 | + self, |
| 144 | + query_id: str, |
| 145 | + *, |
| 146 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 147 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 148 | + extra_headers: Headers | None = None, |
| 149 | + extra_query: Query | None = None, |
| 150 | + extra_body: Body | None = None, |
| 151 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 152 | + ) -> Query: |
| 153 | + """ |
| 154 | + Retrieve an existing query |
| 155 | +
|
| 156 | + Args: |
| 157 | + extra_headers: Send extra headers |
| 158 | +
|
| 159 | + extra_query: Add additional query parameters to the request |
| 160 | +
|
| 161 | + extra_body: Add additional JSON properties to the request |
| 162 | +
|
| 163 | + timeout: Override the client-level default timeout for this request, in seconds |
| 164 | + """ |
| 165 | + if not query_id: |
| 166 | + raise ValueError(f"Expected a non-empty value for `query_id` but received {query_id!r}") |
| 167 | + return await self._get( |
| 168 | + f"/memories/query/{query_id}", |
| 169 | + options=make_request_options( |
| 170 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 171 | + ), |
| 172 | + cast_to=Query, |
| 173 | + ) |
| 174 | + |
| 175 | + async def score_query( |
| 176 | + self, |
| 177 | + *, |
| 178 | + query_id: str, |
| 179 | + score: float | Omit = omit, |
| 180 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 181 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 182 | + extra_headers: Headers | None = None, |
| 183 | + extra_query: Query | None = None, |
| 184 | + extra_body: Body | None = None, |
| 185 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 186 | + ) -> EvaluateScoreQueryResponse: |
| 187 | + """ |
| 188 | + Provide feedback on a query result. |
| 189 | +
|
| 190 | + Args: |
| 191 | + query_id: The ID of the query to provide feedback on. |
| 192 | +
|
| 193 | + score: Rating of the query result from -1 (bad) to +1 (good). |
| 194 | +
|
| 195 | + extra_headers: Send extra headers |
| 196 | +
|
| 197 | + extra_query: Add additional query parameters to the request |
| 198 | +
|
| 199 | + extra_body: Add additional JSON properties to the request |
| 200 | +
|
| 201 | + timeout: Override the client-level default timeout for this request, in seconds |
| 202 | + """ |
| 203 | + return await self._post( |
| 204 | + "/memories/query/feedback", |
| 205 | + body=await async_maybe_transform( |
| 206 | + { |
| 207 | + "query_id": query_id, |
| 208 | + "score": score, |
| 209 | + }, |
| 210 | + evaluate_score_query_params.EvaluateScoreQueryParams, |
| 211 | + ), |
| 212 | + options=make_request_options( |
| 213 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 214 | + ), |
| 215 | + cast_to=EvaluateScoreQueryResponse, |
| 216 | + ) |
| 217 | + |
| 218 | + |
| 219 | +class EvaluateResourceWithRawResponse: |
| 220 | + def __init__(self, evaluate: EvaluateResource) -> None: |
| 221 | + self._evaluate = evaluate |
| 222 | + |
| 223 | + self.get_query = to_raw_response_wrapper( |
| 224 | + evaluate.get_query, |
| 225 | + ) |
| 226 | + self.score_query = to_raw_response_wrapper( |
| 227 | + evaluate.score_query, |
| 228 | + ) |
| 229 | + |
| 230 | + |
| 231 | +class AsyncEvaluateResourceWithRawResponse: |
| 232 | + def __init__(self, evaluate: AsyncEvaluateResource) -> None: |
| 233 | + self._evaluate = evaluate |
| 234 | + |
| 235 | + self.get_query = async_to_raw_response_wrapper( |
| 236 | + evaluate.get_query, |
| 237 | + ) |
| 238 | + self.score_query = async_to_raw_response_wrapper( |
| 239 | + evaluate.score_query, |
| 240 | + ) |
| 241 | + |
| 242 | + |
| 243 | +class EvaluateResourceWithStreamingResponse: |
| 244 | + def __init__(self, evaluate: EvaluateResource) -> None: |
| 245 | + self._evaluate = evaluate |
| 246 | + |
| 247 | + self.get_query = to_streamed_response_wrapper( |
| 248 | + evaluate.get_query, |
| 249 | + ) |
| 250 | + self.score_query = to_streamed_response_wrapper( |
| 251 | + evaluate.score_query, |
| 252 | + ) |
| 253 | + |
| 254 | + |
| 255 | +class AsyncEvaluateResourceWithStreamingResponse: |
| 256 | + def __init__(self, evaluate: AsyncEvaluateResource) -> None: |
| 257 | + self._evaluate = evaluate |
| 258 | + |
| 259 | + self.get_query = async_to_streamed_response_wrapper( |
| 260 | + evaluate.get_query, |
| 261 | + ) |
| 262 | + self.score_query = async_to_streamed_response_wrapper( |
| 263 | + evaluate.score_query, |
| 264 | + ) |
![stainless-app[bot]](https://avatars.githubusercontent.com/in/378072?v=4&size=40){kind=avatar}
0 commit comments