nemo_microservices.resources.guardrail.chat.completions#

Module Contents#

Classes#

API#

class nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create(
*,
messages: Iterable[nemo_microservices.types.guardrail.chat.completion_create_params.Message],
model: str,
best_of: int | nemo_microservices._types.Omit = omit,
echo: bool | nemo_microservices._types.Omit = omit,
frequency_penalty: float | nemo_microservices._types.Omit = omit,
function_call: str | Dict[str, object] | nemo_microservices._types.Omit = omit,
guardrails: nemo_microservices.types.guardrails_data_param.GuardrailsDataParam | nemo_microservices._types.Omit = omit,
ignore_eos: bool | nemo_microservices._types.Omit = omit,
logit_bias: Dict[str, float] | nemo_microservices._types.Omit = omit,
logprobs: bool | nemo_microservices._types.Omit = omit,
max_tokens: int | nemo_microservices._types.Omit = omit,
n: int | nemo_microservices._types.Omit = omit,
presence_penalty: float | nemo_microservices._types.Omit = omit,
response_format: Dict[str, str] | nemo_microservices._types.Omit = omit,
seed: int | nemo_microservices._types.Omit = omit,
stop: str | nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
stream: typing_extensions.Literal[False] | typing_extensions.Literal[True] | nemo_microservices._types.Omit = omit,
suffix: str | nemo_microservices._types.Omit = omit,
system_fingerprint: str | nemo_microservices._types.Omit = omit,
temperature: float | nemo_microservices._types.Omit = omit,
tool_choice: str | Dict[str, object] | nemo_microservices._types.Omit = omit,
tools: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
top_logprobs: int | nemo_microservices._types.Omit = omit,
top_p: float | nemo_microservices._types.Omit = omit,
user: str | nemo_microservices._types.Omit = omit,
vision: bool | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.guardrail.chat.guardrail_chat_completion_response.GuardrailChatCompletionResponse | nemo_microservices._streaming.AsyncStream[nemo_microservices.types.guardrail.chat.guardrail_chat_completion_stream_response.GuardrailChatCompletionStreamResponse]#
property with_raw_response: nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResourceWithRawResponse#

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://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResourceWithRawResponse(
completions: nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResource,
)#

Initialization

class nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResourceWithStreamingResponse(
completions: nemo_microservices.resources.guardrail.chat.completions.AsyncCompletionsResource,
)#

Initialization

class nemo_microservices.resources.guardrail.chat.completions.CompletionsResource(
client: nemo_microservices._client.NeMoMicroservices,
)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create(
*,
messages: Iterable[nemo_microservices.types.guardrail.chat.completion_create_params.Message],
model: str,
best_of: int | nemo_microservices._types.Omit = omit,
echo: bool | nemo_microservices._types.Omit = omit,
frequency_penalty: float | nemo_microservices._types.Omit = omit,
function_call: str | Dict[str, object] | nemo_microservices._types.Omit = omit,
guardrails: nemo_microservices.types.guardrails_data_param.GuardrailsDataParam | nemo_microservices._types.Omit = omit,
ignore_eos: bool | nemo_microservices._types.Omit = omit,
logit_bias: Dict[str, float] | nemo_microservices._types.Omit = omit,
logprobs: bool | nemo_microservices._types.Omit = omit,
max_tokens: int | nemo_microservices._types.Omit = omit,
n: int | nemo_microservices._types.Omit = omit,
presence_penalty: float | nemo_microservices._types.Omit = omit,
response_format: Dict[str, str] | nemo_microservices._types.Omit = omit,
seed: int | nemo_microservices._types.Omit = omit,
stop: str | nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
stream: typing_extensions.Literal[False] | typing_extensions.Literal[True] | nemo_microservices._types.Omit = omit,
suffix: str | nemo_microservices._types.Omit = omit,
system_fingerprint: str | nemo_microservices._types.Omit = omit,
temperature: float | nemo_microservices._types.Omit = omit,
tool_choice: str | Dict[str, object] | nemo_microservices._types.Omit = omit,
tools: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
top_logprobs: int | nemo_microservices._types.Omit = omit,
top_p: float | nemo_microservices._types.Omit = omit,
user: str | nemo_microservices._types.Omit = omit,
vision: bool | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.guardrail.chat.guardrail_chat_completion_response.GuardrailChatCompletionResponse | nemo_microservices._streaming.Stream[nemo_microservices.types.guardrail.chat.guardrail_chat_completion_stream_response.GuardrailChatCompletionStreamResponse]#
property with_raw_response: nemo_microservices.resources.guardrail.chat.completions.CompletionsResourceWithRawResponse#

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://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.guardrail.chat.completions.CompletionsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.guardrail.chat.completions.CompletionsResourceWithRawResponse(
completions: nemo_microservices.resources.guardrail.chat.completions.CompletionsResource,
)#

Initialization

class nemo_microservices.resources.guardrail.chat.completions.CompletionsResourceWithStreamingResponse(
completions: nemo_microservices.resources.guardrail.chat.completions.CompletionsResource,
)#

Initialization