Audit Configuration Resource#

This page documents the Auditor config resource class from the nemo_microservices package.

class nemo_microservices.resources.beta.audit.AuditResource(client: NeMoMicroservices)#

Bases: SyncAPIResource

property configs: ConfigsResource#
property targets: TargetsResource#
property jobs: JobsResource#
property with_raw_response: AuditResourceWithRawResponse#

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: AuditResourceWithStreamingResponse#

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

get_plugin_info(
*,
plugin_name: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Get detailed information about a specific Garak plugin.

See https://reference.garak.ai/ for details

Parameters:

  • plugin_name – The name of the plugin to get information for

  • 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

info(
*,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Info

list_plugins(
*,
filter: AuditPluginFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: AuditPluginSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → SyncDefaultPagination[AuditPlugin]#

Get supported Garak plugins list, filtered by type.

See https://reference.garak.ai/ for details

Parameters:

  • filter – Filter results on various criteria.

  • page – Page number.

  • page_size – Page size.

  • sort – The field to sort by. To sort in descending order, use - in front of the field 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

create_from_dict(data: dict[str, object]) → object#
class nemo_microservices.resources.beta.audit.AsyncAuditResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property configs: AsyncConfigsResource#
property targets: AsyncTargetsResource#
property jobs: AsyncJobsResource#
property with_raw_response: AsyncAuditResourceWithRawResponse#

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: AsyncAuditResourceWithStreamingResponse#

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

async get_plugin_info(
*,
plugin_name: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Get detailed information about a specific Garak plugin.

See https://reference.garak.ai/ for details

Parameters:

  • plugin_name – The name of the plugin to get information for

  • 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

async info(
*,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → object#

Info

list_plugins(
*,
filter: AuditPluginFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: AuditPluginSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) → AsyncPaginator[AuditPlugin, AsyncDefaultPagination[AuditPlugin]]#

Get supported Garak plugins list, filtered by type.

See https://reference.garak.ai/ for details

Parameters:

  • filter – Filter results on various criteria.

  • page – Page number.

  • page_size – Page size.

  • sort – The field to sort by. To sort in descending order, use - in front of the field 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

create_from_dict(data: dict[str, object]) → object#