cloudflare-python/src/cloudflare/resources/ai/models/models.py

263 lines
8.9 KiB
Python

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import httpx
from .schema import (
SchemaResource,
AsyncSchemaResource,
SchemaResourceWithRawResponse,
AsyncSchemaResourceWithRawResponse,
SchemaResourceWithStreamingResponse,
AsyncSchemaResourceWithStreamingResponse,
)
from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from ...._utils import maybe_transform
from ...._compat import cached_property
from ....types.ai import model_list_params
from ...._resource import SyncAPIResource, AsyncAPIResource
from ...._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ....pagination import SyncV4PagePaginationArray, AsyncV4PagePaginationArray
from ...._base_client import AsyncPaginator, make_request_options
__all__ = ["ModelsResource", "AsyncModelsResource"]
class ModelsResource(SyncAPIResource):
@cached_property
def schema(self) -> SchemaResource:
return SchemaResource(self._client)
@cached_property
def with_raw_response(self) -> ModelsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
"""
return ModelsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> ModelsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
"""
return ModelsResourceWithStreamingResponse(self)
def list(
self,
*,
account_id: str,
author: str | Omit = omit,
hide_experimental: bool | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
search: str | Omit = omit,
source: float | Omit = omit,
task: str | Omit = omit,
# 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,
) -> SyncV4PagePaginationArray[object]:
"""
Model Search
Args:
author: Filter by Author
hide_experimental: Filter to hide experimental models
search: Search
source: Filter by Source Id
task: Filter by Task Name
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/ai/models/search",
page=SyncV4PagePaginationArray[object],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"author": author,
"hide_experimental": hide_experimental,
"page": page,
"per_page": per_page,
"search": search,
"source": source,
"task": task,
},
model_list_params.ModelListParams,
),
),
model=object,
)
class AsyncModelsResource(AsyncAPIResource):
@cached_property
def schema(self) -> AsyncSchemaResource:
return AsyncSchemaResource(self._client)
@cached_property
def with_raw_response(self) -> AsyncModelsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
"""
return AsyncModelsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncModelsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
"""
return AsyncModelsResourceWithStreamingResponse(self)
def list(
self,
*,
account_id: str,
author: str | Omit = omit,
hide_experimental: bool | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
search: str | Omit = omit,
source: float | Omit = omit,
task: str | Omit = omit,
# 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,
) -> AsyncPaginator[object, AsyncV4PagePaginationArray[object]]:
"""
Model Search
Args:
author: Filter by Author
hide_experimental: Filter to hide experimental models
search: Search
source: Filter by Source Id
task: Filter by Task Name
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 account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/ai/models/search",
page=AsyncV4PagePaginationArray[object],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"author": author,
"hide_experimental": hide_experimental,
"page": page,
"per_page": per_page,
"search": search,
"source": source,
"task": task,
},
model_list_params.ModelListParams,
),
),
model=object,
)
class ModelsResourceWithRawResponse:
def __init__(self, models: ModelsResource) -> None:
self._models = models
self.list = to_raw_response_wrapper(
models.list,
)
@cached_property
def schema(self) -> SchemaResourceWithRawResponse:
return SchemaResourceWithRawResponse(self._models.schema)
class AsyncModelsResourceWithRawResponse:
def __init__(self, models: AsyncModelsResource) -> None:
self._models = models
self.list = async_to_raw_response_wrapper(
models.list,
)
@cached_property
def schema(self) -> AsyncSchemaResourceWithRawResponse:
return AsyncSchemaResourceWithRawResponse(self._models.schema)
class ModelsResourceWithStreamingResponse:
def __init__(self, models: ModelsResource) -> None:
self._models = models
self.list = to_streamed_response_wrapper(
models.list,
)
@cached_property
def schema(self) -> SchemaResourceWithStreamingResponse:
return SchemaResourceWithStreamingResponse(self._models.schema)
class AsyncModelsResourceWithStreamingResponse:
def __init__(self, models: AsyncModelsResource) -> None:
self._models = models
self.list = async_to_streamed_response_wrapper(
models.list,
)
@cached_property
def schema(self) -> AsyncSchemaResourceWithStreamingResponse:
return AsyncSchemaResourceWithStreamingResponse(self._models.schema)