`guardrail`#

Module Contents#

Classes#

`AsyncGuardrailResource`
`AsyncGuardrailResourceWithRawResponse`
`AsyncGuardrailResourceWithStreamingResponse`
`GuardrailResource`
`GuardrailResourceWithRawResponse`
`GuardrailResourceWithStreamingResponse`

API#

class guardrail.AsyncGuardrailResource( client: nemo_platform._client.AsyncNeMoPlatform, )#

Bases: nemo_platform._resource.AsyncAPIResource

Initialization

property chat: chat.chat.AsyncChatResource#

async check( *, workspace: str | None = None, messages: Iterable[nemo_platform.types.guardrail_check_params.Message], model: str, frequency_penalty: float | nemo_platform._types.Omit = omit, function_call: Union[str, Dict[str, object]] | nemo_platform._types.Omit = omit, guardrails: nemo_platform.types.guardrails_data_param.GuardrailsDataParam | nemo_platform._types.Omit = omit, ignore_eos: bool | nemo_platform._types.Omit = omit, logit_bias: Dict[str, float] | nemo_platform._types.Omit = omit, logprobs: bool | nemo_platform._types.Omit = omit, max_completion_tokens: int | nemo_platform._types.Omit = omit, max_tokens: int | nemo_platform._types.Omit = omit, n: int | nemo_platform._types.Omit = omit, presence_penalty: float | nemo_platform._types.Omit = omit, reasoning_effort: str | nemo_platform._types.Omit = omit, response_format: Dict[str, object] | nemo_platform._types.Omit = omit, seed: int | nemo_platform._types.Omit = omit, stop: Union[str, nemo_platform._types.SequenceNotStr[str]] | nemo_platform._types.Omit = omit, stream: bool | nemo_platform._types.Omit = omit, stream_options: Dict[str, bool] | nemo_platform._types.Omit = omit, temperature: float | nemo_platform._types.Omit = omit, tool_choice: Union[str, Dict[str, object]] | nemo_platform._types.Omit = omit, tools: Iterable[Dict[str, object]] | nemo_platform._types.Omit = omit, top_logprobs: int | nemo_platform._types.Omit = omit, top_p: float | nemo_platform._types.Omit = omit, user: str | nemo_platform._types.Omit = omit, vision: bool | nemo_platform._types.Omit = omit, extra_headers: nemo_platform._types.Headers | None = None, extra_query: nemo_platform._types.Query | None = None, extra_body: nemo_platform._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given, ) → nemo_platform.types.guardrail_check_response.GuardrailCheckResponse#

property completions: completions.AsyncCompletionsResource#

property configs: configs.AsyncConfigsResource#

property with_raw_response: guardrail.AsyncGuardrailResourceWithRawResponse#

property with_streaming_response: guardrail.AsyncGuardrailResourceWithStreamingResponse#

class guardrail.AsyncGuardrailResourceWithRawResponse( guardrail: guardrail.AsyncGuardrailResource, )#

Initialization

property chat: chat.chat.AsyncChatResourceWithRawResponse#

property completions: completions.AsyncCompletionsResourceWithRawResponse#

property configs: configs.AsyncConfigsResourceWithRawResponse#

class guardrail.AsyncGuardrailResourceWithStreamingResponse( guardrail: guardrail.AsyncGuardrailResource, )#

Initialization

property chat: chat.chat.AsyncChatResourceWithStreamingResponse#

property completions: completions.AsyncCompletionsResourceWithStreamingResponse#

property configs: configs.AsyncConfigsResourceWithStreamingResponse#

class guardrail.GuardrailResource(client: nemo_platform._client.NeMoPlatform)#

Bases: nemo_platform._resource.SyncAPIResource

Initialization

property chat: chat.chat.ChatResource#

check( *, workspace: str | None = None, messages: Iterable[nemo_platform.types.guardrail_check_params.Message], model: str, frequency_penalty: float | nemo_platform._types.Omit = omit, function_call: Union[str, Dict[str, object]] | nemo_platform._types.Omit = omit, guardrails: nemo_platform.types.guardrails_data_param.GuardrailsDataParam | nemo_platform._types.Omit = omit, ignore_eos: bool | nemo_platform._types.Omit = omit, logit_bias: Dict[str, float] | nemo_platform._types.Omit = omit, logprobs: bool | nemo_platform._types.Omit = omit, max_completion_tokens: int | nemo_platform._types.Omit = omit, max_tokens: int | nemo_platform._types.Omit = omit, n: int | nemo_platform._types.Omit = omit, presence_penalty: float | nemo_platform._types.Omit = omit, reasoning_effort: str | nemo_platform._types.Omit = omit, response_format: Dict[str, object] | nemo_platform._types.Omit = omit, seed: int | nemo_platform._types.Omit = omit, stop: Union[str, nemo_platform._types.SequenceNotStr[str]] | nemo_platform._types.Omit = omit, stream: bool | nemo_platform._types.Omit = omit, stream_options: Dict[str, bool] | nemo_platform._types.Omit = omit, temperature: float | nemo_platform._types.Omit = omit, tool_choice: Union[str, Dict[str, object]] | nemo_platform._types.Omit = omit, tools: Iterable[Dict[str, object]] | nemo_platform._types.Omit = omit, top_logprobs: int | nemo_platform._types.Omit = omit, top_p: float | nemo_platform._types.Omit = omit, user: str | nemo_platform._types.Omit = omit, vision: bool | nemo_platform._types.Omit = omit, extra_headers: nemo_platform._types.Headers | None = None, extra_query: nemo_platform._types.Query | None = None, extra_body: nemo_platform._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_platform._types.NotGiven = not_given, ) → nemo_platform.types.guardrail_check_response.GuardrailCheckResponse#