Evaluation Results Resource

class nemo_microservices.resources.evaluation.ResultsResource(client: NeMoMicroservices)

Bases: SyncAPIResource

property with_raw_response: ResultsResourceWithRawResponse

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

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

create(

*,

job: str,

custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,

description: str | NotGiven = NOT_GIVEN,

files_url: str | NotGiven = NOT_GIVEN,

groups: Dict[str, GroupResultParam] | NotGiven = NOT_GIVEN,

namespace: str | NotGiven = NOT_GIVEN,

ownership: Ownership | NotGiven = NOT_GIVEN,

project: str | NotGiven = NOT_GIVEN,

tasks: Dict[str, TaskResultParam] | 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,

) → EvaluationResult

Create a new evaluation result.

Parameters:

• job – The evaluation job associated with this results instance.

• custom_fields – A set of custom fields that the user can define and use for various purposes.

• description – The description of the entity.

• files_url – The place for the output files, if any.

• groups – The results at the group-level.

• namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

• ownership –

  Information about ownership of an entity.

  If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

• project – The URN of the project associated with this entity.

• tasks – The results at the task-level.

• 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

retrieve(

result_id: str,

*,

extra_headers: Headers | None = None,

extra_query: Query | None = None,

extra_body: Body | None = None,

timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,

) → EvaluationResult

Get evaluation result info.

Parameters:

• 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

update(

result_id: str,

*,

custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,

description: str | NotGiven = NOT_GIVEN,

files_url: str | NotGiven = NOT_GIVEN,

groups: Dict[str, GroupResultParam] | NotGiven = NOT_GIVEN,

job: str | NotGiven = NOT_GIVEN,

namespace: str | NotGiven = NOT_GIVEN,

ownership: Ownership | NotGiven = NOT_GIVEN,

project: str | NotGiven = NOT_GIVEN,

tasks: Dict[str, TaskResultParam] | 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,

) → EvaluationResult

Update the evaluation result.

Parameters:

• custom_fields – A set of custom fields that the user can define and use for various purposes.

• description – The description of the entity.

• files_url – The place for the output files, if any.

• groups – The results at the group-level.

• job – The evaluation job associated with this results instance.

• namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

• ownership –

  Information about ownership of an entity.

  If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

• project – The URN of the project associated with this entity.

• tasks – The results at the task-level.

• 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: EvaluationResultFilterParam | NotGiven = NOT_GIVEN,

page: int | NotGiven = NOT_GIVEN,

page_size: int | NotGiven = NOT_GIVEN,

sort: GenericSortField | 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[EvaluationResult]

List available evaluation results.

Parameters:

• filter – Filter results 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

delete(

result_id: str,

*,

extra_headers: Headers | None = None,

extra_query: Query | None = None,

extra_body: Body | None = None,

timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,

) → DeleteResponse

Delete Evaluation Result

Parameters:

• 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.evaluation.AsyncResultsResource(client: AsyncNeMoMicroservices)

Bases: AsyncAPIResource

property with_raw_response: AsyncResultsResourceWithRawResponse

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

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 create(

*,

job: str,

custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,

description: str | NotGiven = NOT_GIVEN,

files_url: str | NotGiven = NOT_GIVEN,

groups: Dict[str, GroupResultParam] | NotGiven = NOT_GIVEN,

namespace: str | NotGiven = NOT_GIVEN,

ownership: Ownership | NotGiven = NOT_GIVEN,

project: str | NotGiven = NOT_GIVEN,

tasks: Dict[str, TaskResultParam] | 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,

) → EvaluationResult

Create a new evaluation result.

Parameters:

• job – The evaluation job associated with this results instance.

• custom_fields – A set of custom fields that the user can define and use for various purposes.

• description – The description of the entity.

• files_url – The place for the output files, if any.

• groups – The results at the group-level.

• namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

• ownership –

  Information about ownership of an entity.

  If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

• project – The URN of the project associated with this entity.

• tasks – The results at the task-level.

• 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 retrieve(

result_id: str,

*,

extra_headers: Headers | None = None,

extra_query: Query | None = None,

extra_body: Body | None = None,

timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,

) → EvaluationResult

Get evaluation result info.

Parameters:

• 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 update(

result_id: str,

*,

custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,

description: str | NotGiven = NOT_GIVEN,

files_url: str | NotGiven = NOT_GIVEN,

groups: Dict[str, GroupResultParam] | NotGiven = NOT_GIVEN,

job: str | NotGiven = NOT_GIVEN,

namespace: str | NotGiven = NOT_GIVEN,

ownership: Ownership | NotGiven = NOT_GIVEN,

project: str | NotGiven = NOT_GIVEN,

tasks: Dict[str, TaskResultParam] | 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,

) → EvaluationResult

Update the evaluation result.

Parameters:

• custom_fields – A set of custom fields that the user can define and use for various purposes.

• description – The description of the entity.

• files_url – The place for the output files, if any.

• groups – The results at the group-level.

• job – The evaluation job associated with this results instance.

• namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

• ownership –

  Information about ownership of an entity.

  If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

• project – The URN of the project associated with this entity.

• tasks – The results at the task-level.

• 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: EvaluationResultFilterParam | NotGiven = NOT_GIVEN,

page: int | NotGiven = NOT_GIVEN,

page_size: int | NotGiven = NOT_GIVEN,

sort: GenericSortField | 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[EvaluationResult, AsyncDefaultPagination[EvaluationResult]]

List available evaluation results.

Parameters:

• filter – Filter results 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

async delete(

result_id: str,

*,

extra_headers: Headers | None = None,

extra_query: Query | None = None,

extra_body: Body | None = None,

timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,

) → DeleteResponse

Delete Evaluation Result

Parameters:

• 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