nemo_microservices.resources.beta.audit.audit#

Module Contents#

Classes#

API#

class nemo_microservices.resources.beta.audit.audit.AsyncAuditResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.AsyncConfigsResource#
async get_plugin_info(
*,
plugin_name: str,
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,
) object#

Get detailed information about a specific Garak plugin.

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

Args: 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: 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,
) object#

Info

property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.AsyncJobsResource#
list_plugins(
*,
filter: nemo_microservices.types.beta.audit.audit_plugin_filter_param.AuditPluginFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.beta.audit.audit_plugin_sort_field.AuditPluginSortField | 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._base_client.AsyncPaginator[nemo_microservices.types.beta.audit.audit_plugin.AuditPlugin, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.beta.audit.audit_plugin.AuditPlugin]]#

Get supported Garak plugins list, filtered by type.

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

Args: 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

property targets: nemo_microservices.resources.beta.audit.targets.AsyncTargetsResource#
property with_raw_response: nemo_microservices.resources.beta.audit.audit.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: nemo_microservices.resources.beta.audit.audit.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

class nemo_microservices.resources.beta.audit.audit.AsyncAuditResourceWithRawResponse(
audit: nemo_microservices.resources.beta.audit.audit.AsyncAuditResource,
)#

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.AsyncConfigsResourceWithRawResponse#
property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.AsyncJobsResourceWithRawResponse#
property targets: nemo_microservices.resources.beta.audit.targets.AsyncTargetsResourceWithRawResponse#
class nemo_microservices.resources.beta.audit.audit.AsyncAuditResourceWithStreamingResponse(
audit: nemo_microservices.resources.beta.audit.audit.AsyncAuditResource,
)#

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.AsyncConfigsResourceWithStreamingResponse#
property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.AsyncJobsResourceWithStreamingResponse#
property targets: nemo_microservices.resources.beta.audit.targets.AsyncTargetsResourceWithStreamingResponse#
class nemo_microservices.resources.beta.audit.audit.AuditResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.ConfigsResource#
get_plugin_info(
*,
plugin_name: str,
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,
) object#

Get detailed information about a specific Garak plugin.

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

Args: 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: 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,
) object#

Info

property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.JobsResource#
list_plugins(
*,
filter: nemo_microservices.types.beta.audit.audit_plugin_filter_param.AuditPluginFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.beta.audit.audit_plugin_sort_field.AuditPluginSortField | 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.pagination.SyncDefaultPagination[nemo_microservices.types.beta.audit.audit_plugin.AuditPlugin]#

Get supported Garak plugins list, filtered by type.

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

Args: 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

property targets: nemo_microservices.resources.beta.audit.targets.TargetsResource#
property with_raw_response: nemo_microservices.resources.beta.audit.audit.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: nemo_microservices.resources.beta.audit.audit.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

class nemo_microservices.resources.beta.audit.audit.AuditResourceWithRawResponse(
audit: nemo_microservices.resources.beta.audit.audit.AuditResource,
)#

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.ConfigsResourceWithRawResponse#
property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.JobsResourceWithRawResponse#
property targets: nemo_microservices.resources.beta.audit.targets.TargetsResourceWithRawResponse#
class nemo_microservices.resources.beta.audit.audit.AuditResourceWithStreamingResponse(
audit: nemo_microservices.resources.beta.audit.audit.AuditResource,
)#

Initialization

property configs: nemo_microservices.resources.beta.audit.configs.ConfigsResourceWithStreamingResponse#
property jobs: nemo_microservices.resources.beta.audit.jobs.jobs.JobsResourceWithStreamingResponse#
property targets: nemo_microservices.resources.beta.audit.targets.TargetsResourceWithStreamingResponse#