nemo_microservices.resources.v2.evaluation.jobs.jobs#

Module Contents#

Classes#

API#

class nemo_microservices.resources.v2.evaluation.jobs.jobs.AsyncJobsResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async cancel(
job_id: 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,
) nemo_microservices.types.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Cancel Job

Args: 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 create(
*,
spec: nemo_microservices.types.v2.evaluation.evaluation_job_input_v2_param.EvaluationJobInputV2Param,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: Dict[str, object] | nemo_microservices._types.Omit = omit,
project: str | 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.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Create Job

Args: 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 delete(
job_id: 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#

Delete Job

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

list(
*,
filter: nemo_microservices.types.v2.evaluation.evaluator_v2_jobs_list_filter_param.EvaluatorV2JobsListFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.v2.evaluation.evaluator_v2_jobs_sort_field.EvaluatorV2JobsSortField | 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.v2.evaluation.evaluator_v2_job.EvaluatorV2Job, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.v2.evaluation.evaluator_v2_job.EvaluatorV2Job]]#

List Jobs

Args: filter: Filter jobs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing 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 logs: nemo_microservices.resources.v2.evaluation.jobs.logs.AsyncLogsResource#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.AsyncResultsResource#
async retrieve(
job_id: 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,
) nemo_microservices.types.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Get Job

Args: 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 status: nemo_microservices.resources.v2.evaluation.jobs.status.AsyncStatusResource#
property with_raw_response: nemo_microservices.resources.v2.evaluation.jobs.jobs.AsyncJobsResourceWithRawResponse#

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.v2.evaluation.jobs.jobs.AsyncJobsResourceWithStreamingResponse#

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.v2.evaluation.jobs.jobs.AsyncJobsResourceWithRawResponse(
jobs: nemo_microservices.resources.v2.evaluation.jobs.jobs.AsyncJobsResource,
)#

Initialization

property logs: nemo_microservices.resources.v2.evaluation.jobs.logs.AsyncLogsResourceWithRawResponse#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.AsyncResultsResourceWithRawResponse#
property status: nemo_microservices.resources.v2.evaluation.jobs.status.AsyncStatusResourceWithRawResponse#
class nemo_microservices.resources.v2.evaluation.jobs.jobs.AsyncJobsResourceWithStreamingResponse(
jobs: nemo_microservices.resources.v2.evaluation.jobs.jobs.AsyncJobsResource,
)#

Initialization

property logs: nemo_microservices.resources.v2.evaluation.jobs.logs.AsyncLogsResourceWithStreamingResponse#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.AsyncResultsResourceWithStreamingResponse#
property status: nemo_microservices.resources.v2.evaluation.jobs.status.AsyncStatusResourceWithStreamingResponse#
class nemo_microservices.resources.v2.evaluation.jobs.jobs.JobsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

cancel(
job_id: 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,
) nemo_microservices.types.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Cancel Job

Args: 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(
*,
spec: nemo_microservices.types.v2.evaluation.evaluation_job_input_v2_param.EvaluationJobInputV2Param,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: Dict[str, object] | nemo_microservices._types.Omit = omit,
project: str | 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.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Create Job

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

delete(
job_id: 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#

Delete Job

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

list(
*,
filter: nemo_microservices.types.v2.evaluation.evaluator_v2_jobs_list_filter_param.EvaluatorV2JobsListFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.v2.evaluation.evaluator_v2_jobs_sort_field.EvaluatorV2JobsSortField | 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.v2.evaluation.evaluator_v2_job.EvaluatorV2Job]#

List Jobs

Args: filter: Filter jobs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing 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 logs: nemo_microservices.resources.v2.evaluation.jobs.logs.LogsResource#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.ResultsResource#
retrieve(
job_id: 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,
) nemo_microservices.types.v2.evaluation.evaluator_v2_job.EvaluatorV2Job#

Get Job

Args: 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 status: nemo_microservices.resources.v2.evaluation.jobs.status.StatusResource#
property with_raw_response: nemo_microservices.resources.v2.evaluation.jobs.jobs.JobsResourceWithRawResponse#

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.v2.evaluation.jobs.jobs.JobsResourceWithStreamingResponse#

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.v2.evaluation.jobs.jobs.JobsResourceWithRawResponse(
jobs: nemo_microservices.resources.v2.evaluation.jobs.jobs.JobsResource,
)#

Initialization

property logs: nemo_microservices.resources.v2.evaluation.jobs.logs.LogsResourceWithRawResponse#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.ResultsResourceWithRawResponse#
property status: nemo_microservices.resources.v2.evaluation.jobs.status.StatusResourceWithRawResponse#
class nemo_microservices.resources.v2.evaluation.jobs.jobs.JobsResourceWithStreamingResponse(
jobs: nemo_microservices.resources.v2.evaluation.jobs.jobs.JobsResource,
)#

Initialization

property logs: nemo_microservices.resources.v2.evaluation.jobs.logs.LogsResourceWithStreamingResponse#
property results: nemo_microservices.resources.v2.evaluation.jobs.results.results.ResultsResourceWithStreamingResponse#
property status: nemo_microservices.resources.v2.evaluation.jobs.status.StatusResourceWithStreamingResponse#