182 lines
6.5 KiB
Python
182 lines
6.5 KiB
Python
|
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
||
|
|
||
|
from __future__ import annotations
|
||
|
|
||
|
from typing import List, Union
|
||
|
from typing_extensions import Literal
|
||
|
|
||
|
import httpx
|
||
|
|
||
|
from .. import _legacy_response
|
||
|
from ..types import moderation_create_params
|
||
|
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
|
||
|
from .._utils import (
|
||
|
maybe_transform,
|
||
|
async_maybe_transform,
|
||
|
)
|
||
|
from .._compat import cached_property
|
||
|
from .._resource import SyncAPIResource, AsyncAPIResource
|
||
|
from .._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
|
||
|
from .._base_client import (
|
||
|
make_request_options,
|
||
|
)
|
||
|
from ..types.moderation_create_response import ModerationCreateResponse
|
||
|
|
||
|
__all__ = ["Moderations", "AsyncModerations"]
|
||
|
|
||
|
|
||
|
class Moderations(SyncAPIResource):
|
||
|
@cached_property
|
||
|
def with_raw_response(self) -> ModerationsWithRawResponse:
|
||
|
return ModerationsWithRawResponse(self)
|
||
|
|
||
|
@cached_property
|
||
|
def with_streaming_response(self) -> ModerationsWithStreamingResponse:
|
||
|
return ModerationsWithStreamingResponse(self)
|
||
|
|
||
|
def create(
|
||
|
self,
|
||
|
*,
|
||
|
input: Union[str, List[str]],
|
||
|
model: Union[str, Literal["text-moderation-latest", "text-moderation-stable"]] | NotGiven = NOT_GIVEN,
|
||
|
# 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,
|
||
|
) -> ModerationCreateResponse:
|
||
|
"""
|
||
|
Classifies if text is potentially harmful.
|
||
|
|
||
|
Args:
|
||
|
input: The input text to classify
|
||
|
|
||
|
model: Two content moderations models are available: `text-moderation-stable` and
|
||
|
`text-moderation-latest`.
|
||
|
|
||
|
The default is `text-moderation-latest` which will be automatically upgraded
|
||
|
over time. This ensures you are always using our most accurate model. If you use
|
||
|
`text-moderation-stable`, we will provide advanced notice before updating the
|
||
|
model. Accuracy of `text-moderation-stable` may be slightly lower than for
|
||
|
`text-moderation-latest`.
|
||
|
|
||
|
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
|
||
|
"""
|
||
|
return self._post(
|
||
|
"/moderations",
|
||
|
body=maybe_transform(
|
||
|
{
|
||
|
"input": input,
|
||
|
"model": model,
|
||
|
},
|
||
|
moderation_create_params.ModerationCreateParams,
|
||
|
),
|
||
|
options=make_request_options(
|
||
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
),
|
||
|
cast_to=ModerationCreateResponse,
|
||
|
)
|
||
|
|
||
|
|
||
|
class AsyncModerations(AsyncAPIResource):
|
||
|
@cached_property
|
||
|
def with_raw_response(self) -> AsyncModerationsWithRawResponse:
|
||
|
return AsyncModerationsWithRawResponse(self)
|
||
|
|
||
|
@cached_property
|
||
|
def with_streaming_response(self) -> AsyncModerationsWithStreamingResponse:
|
||
|
return AsyncModerationsWithStreamingResponse(self)
|
||
|
|
||
|
async def create(
|
||
|
self,
|
||
|
*,
|
||
|
input: Union[str, List[str]],
|
||
|
model: Union[str, Literal["text-moderation-latest", "text-moderation-stable"]] | NotGiven = NOT_GIVEN,
|
||
|
# 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,
|
||
|
) -> ModerationCreateResponse:
|
||
|
"""
|
||
|
Classifies if text is potentially harmful.
|
||
|
|
||
|
Args:
|
||
|
input: The input text to classify
|
||
|
|
||
|
model: Two content moderations models are available: `text-moderation-stable` and
|
||
|
`text-moderation-latest`.
|
||
|
|
||
|
The default is `text-moderation-latest` which will be automatically upgraded
|
||
|
over time. This ensures you are always using our most accurate model. If you use
|
||
|
`text-moderation-stable`, we will provide advanced notice before updating the
|
||
|
model. Accuracy of `text-moderation-stable` may be slightly lower than for
|
||
|
`text-moderation-latest`.
|
||
|
|
||
|
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
|
||
|
"""
|
||
|
return await self._post(
|
||
|
"/moderations",
|
||
|
body=await async_maybe_transform(
|
||
|
{
|
||
|
"input": input,
|
||
|
"model": model,
|
||
|
},
|
||
|
moderation_create_params.ModerationCreateParams,
|
||
|
),
|
||
|
options=make_request_options(
|
||
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
||
|
),
|
||
|
cast_to=ModerationCreateResponse,
|
||
|
)
|
||
|
|
||
|
|
||
|
class ModerationsWithRawResponse:
|
||
|
def __init__(self, moderations: Moderations) -> None:
|
||
|
self._moderations = moderations
|
||
|
|
||
|
self.create = _legacy_response.to_raw_response_wrapper(
|
||
|
moderations.create,
|
||
|
)
|
||
|
|
||
|
|
||
|
class AsyncModerationsWithRawResponse:
|
||
|
def __init__(self, moderations: AsyncModerations) -> None:
|
||
|
self._moderations = moderations
|
||
|
|
||
|
self.create = _legacy_response.async_to_raw_response_wrapper(
|
||
|
moderations.create,
|
||
|
)
|
||
|
|
||
|
|
||
|
class ModerationsWithStreamingResponse:
|
||
|
def __init__(self, moderations: Moderations) -> None:
|
||
|
self._moderations = moderations
|
||
|
|
||
|
self.create = to_streamed_response_wrapper(
|
||
|
moderations.create,
|
||
|
)
|
||
|
|
||
|
|
||
|
class AsyncModerationsWithStreamingResponse:
|
||
|
def __init__(self, moderations: AsyncModerations) -> None:
|
||
|
self._moderations = moderations
|
||
|
|
||
|
self.create = async_to_streamed_response_wrapper(
|
||
|
moderations.create,
|
||
|
)
|