|
| 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 search_web_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 .._base_client import make_request_options |
| 19 | +from ..types.search_web_response import SearchWebResponse |
| 20 | + |
| 21 | +__all__ = ["SearchResource", "AsyncSearchResource"] |
| 22 | + |
| 23 | + |
| 24 | +class SearchResource(SyncAPIResource): |
| 25 | + @cached_property |
| 26 | + def with_raw_response(self) -> SearchResourceWithRawResponse: |
| 27 | + """ |
| 28 | + This property can be used as a prefix for any HTTP method call to return |
| 29 | + the raw response object instead of the parsed content. |
| 30 | +
|
| 31 | + For more information, see https://www.github.com/browserbase/sdk-python#accessing-raw-response-data-eg-headers |
| 32 | + """ |
| 33 | + return SearchResourceWithRawResponse(self) |
| 34 | + |
| 35 | + @cached_property |
| 36 | + def with_streaming_response(self) -> SearchResourceWithStreamingResponse: |
| 37 | + """ |
| 38 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 39 | +
|
| 40 | + For more information, see https://www.github.com/browserbase/sdk-python#with_streaming_response |
| 41 | + """ |
| 42 | + return SearchResourceWithStreamingResponse(self) |
| 43 | + |
| 44 | + def web( |
| 45 | + self, |
| 46 | + *, |
| 47 | + query: str, |
| 48 | + num_results: int | Omit = omit, |
| 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 | + ) -> SearchWebResponse: |
| 56 | + """ |
| 57 | + Perform a web search and return structured results. |
| 58 | +
|
| 59 | + Args: |
| 60 | + query: The search query string |
| 61 | +
|
| 62 | + num_results: Number of results to return (1-25) |
| 63 | +
|
| 64 | + extra_headers: Send extra headers |
| 65 | +
|
| 66 | + extra_query: Add additional query parameters to the request |
| 67 | +
|
| 68 | + extra_body: Add additional JSON properties to the request |
| 69 | +
|
| 70 | + timeout: Override the client-level default timeout for this request, in seconds |
| 71 | + """ |
| 72 | + return self._post( |
| 73 | + "/v1/search", |
| 74 | + body=maybe_transform( |
| 75 | + { |
| 76 | + "query": query, |
| 77 | + "num_results": num_results, |
| 78 | + }, |
| 79 | + search_web_params.SearchWebParams, |
| 80 | + ), |
| 81 | + options=make_request_options( |
| 82 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 83 | + ), |
| 84 | + cast_to=SearchWebResponse, |
| 85 | + ) |
| 86 | + |
| 87 | + |
| 88 | +class AsyncSearchResource(AsyncAPIResource): |
| 89 | + @cached_property |
| 90 | + def with_raw_response(self) -> AsyncSearchResourceWithRawResponse: |
| 91 | + """ |
| 92 | + This property can be used as a prefix for any HTTP method call to return |
| 93 | + the raw response object instead of the parsed content. |
| 94 | +
|
| 95 | + For more information, see https://www.github.com/browserbase/sdk-python#accessing-raw-response-data-eg-headers |
| 96 | + """ |
| 97 | + return AsyncSearchResourceWithRawResponse(self) |
| 98 | + |
| 99 | + @cached_property |
| 100 | + def with_streaming_response(self) -> AsyncSearchResourceWithStreamingResponse: |
| 101 | + """ |
| 102 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 103 | +
|
| 104 | + For more information, see https://www.github.com/browserbase/sdk-python#with_streaming_response |
| 105 | + """ |
| 106 | + return AsyncSearchResourceWithStreamingResponse(self) |
| 107 | + |
| 108 | + async def web( |
| 109 | + self, |
| 110 | + *, |
| 111 | + query: str, |
| 112 | + num_results: int | Omit = omit, |
| 113 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 114 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 115 | + extra_headers: Headers | None = None, |
| 116 | + extra_query: Query | None = None, |
| 117 | + extra_body: Body | None = None, |
| 118 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 119 | + ) -> SearchWebResponse: |
| 120 | + """ |
| 121 | + Perform a web search and return structured results. |
| 122 | +
|
| 123 | + Args: |
| 124 | + query: The search query string |
| 125 | +
|
| 126 | + num_results: Number of results to return (1-25) |
| 127 | +
|
| 128 | + extra_headers: Send extra headers |
| 129 | +
|
| 130 | + extra_query: Add additional query parameters to the request |
| 131 | +
|
| 132 | + extra_body: Add additional JSON properties to the request |
| 133 | +
|
| 134 | + timeout: Override the client-level default timeout for this request, in seconds |
| 135 | + """ |
| 136 | + return await self._post( |
| 137 | + "/v1/search", |
| 138 | + body=await async_maybe_transform( |
| 139 | + { |
| 140 | + "query": query, |
| 141 | + "num_results": num_results, |
| 142 | + }, |
| 143 | + search_web_params.SearchWebParams, |
| 144 | + ), |
| 145 | + options=make_request_options( |
| 146 | + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout |
| 147 | + ), |
| 148 | + cast_to=SearchWebResponse, |
| 149 | + ) |
| 150 | + |
| 151 | + |
| 152 | +class SearchResourceWithRawResponse: |
| 153 | + def __init__(self, search: SearchResource) -> None: |
| 154 | + self._search = search |
| 155 | + |
| 156 | + self.web = to_raw_response_wrapper( |
| 157 | + search.web, |
| 158 | + ) |
| 159 | + |
| 160 | + |
| 161 | +class AsyncSearchResourceWithRawResponse: |
| 162 | + def __init__(self, search: AsyncSearchResource) -> None: |
| 163 | + self._search = search |
| 164 | + |
| 165 | + self.web = async_to_raw_response_wrapper( |
| 166 | + search.web, |
| 167 | + ) |
| 168 | + |
| 169 | + |
| 170 | +class SearchResourceWithStreamingResponse: |
| 171 | + def __init__(self, search: SearchResource) -> None: |
| 172 | + self._search = search |
| 173 | + |
| 174 | + self.web = to_streamed_response_wrapper( |
| 175 | + search.web, |
| 176 | + ) |
| 177 | + |
| 178 | + |
| 179 | +class AsyncSearchResourceWithStreamingResponse: |
| 180 | + def __init__(self, search: AsyncSearchResource) -> None: |
| 181 | + self._search = search |
| 182 | + |
| 183 | + self.web = async_to_streamed_response_wrapper( |
| 184 | + search.web, |
| 185 | + ) |
![stainless-app[bot]](https://avatars.githubusercontent.com/in/378072?v=4&size=40){kind=avatar}
0 commit comments