Evaluation Targets Resource#

class nemo_microservices.resources.evaluation.TargetsResource(client: NeMoMicroservices)#

Bases: SyncAPIResource

property with_raw_response: TargetsResourceWithRawResponse#

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

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( *, type: TargetType, cached_outputs: CachedOutputsDataParam | NotGiven = NOT_GIVEN, custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN, dataset: target_create_params.Dataset | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, model: target_create_params.Model | NotGiven = NOT_GIVEN, name: str | NotGiven = NOT_GIVEN, namespace: str | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, rag: RagTargetParam | NotGiven = NOT_GIVEN, retriever: RetrieverTargetParam | NotGiven = NOT_GIVEN, rows: Iterable[object] | 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, ) → EvaluationTarget#

Create a new evaluation target.

Parameters:

type – The type of the evaluation target, e.g., ‘model’, ‘retriever’, ‘rag’.
cached_outputs – An evaluation target which contains cached outputs.
custom_fields – A set of custom fields that the user can define and use for various purposes.
dataset – Dataset to be evaluated.
description – The description of the entity.
model – The model to be evaluated.
name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.
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.
rag – RAG to be evaluated.
retriever – Retriever to be evaluated.
rows – Rows to be evaluated.
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

Get evaluation target 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( target_name: str, *, namespace: str, cached_outputs: CachedOutputsDataParam | NotGiven = NOT_GIVEN, custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN, dataset: target_update_params.Dataset | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, model: target_update_params.Model | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, rag: RagTargetParam | NotGiven = NOT_GIVEN, retriever: RetrieverTargetParam | NotGiven = NOT_GIVEN, rows: Iterable[object] | NotGiven = NOT_GIVEN, type: TargetType | 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, ) → EvaluationTarget#

Update an evaluation target.

Parameters:

cached_outputs – An evaluation target which contains cached outputs.
custom_fields – A set of custom fields that the user can define and use for various purposes.
dataset – Dataset to be evaluated.
description – The description of the entity.
model – The model to be evaluated.
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.
rag – RAG to be evaluated.
retriever – Retriever to be evaluated.
rows – Rows to be evaluated.
type – The type of the evaluation target, e.g., ‘model’, ‘retriever’, ‘rag’.
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 available evaluation targets.

Parameters:

filter – Filter targets 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 Evaluation Target

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.AsyncTargetsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property with_raw_response: AsyncTargetsResourceWithRawResponse#

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

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( *, type: TargetType, cached_outputs: CachedOutputsDataParam | NotGiven = NOT_GIVEN, custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN, dataset: target_create_params.Dataset | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, model: target_create_params.Model | NotGiven = NOT_GIVEN, name: str | NotGiven = NOT_GIVEN, namespace: str | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, rag: RagTargetParam | NotGiven = NOT_GIVEN, retriever: RetrieverTargetParam | NotGiven = NOT_GIVEN, rows: Iterable[object] | 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, ) → EvaluationTarget#

Create a new evaluation target.

Parameters:

type – The type of the evaluation target, e.g., ‘model’, ‘retriever’, ‘rag’.
cached_outputs – An evaluation target which contains cached outputs.
custom_fields – A set of custom fields that the user can define and use for various purposes.
dataset – Dataset to be evaluated.
description – The description of the entity.
model – The model to be evaluated.
name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.
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.
rag – RAG to be evaluated.
retriever – Retriever to be evaluated.
rows – Rows to be evaluated.
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

Get evaluation target 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( target_name: str, *, namespace: str, cached_outputs: CachedOutputsDataParam | NotGiven = NOT_GIVEN, custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN, dataset: target_update_params.Dataset | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, model: target_update_params.Model | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, rag: RagTargetParam | NotGiven = NOT_GIVEN, retriever: RetrieverTargetParam | NotGiven = NOT_GIVEN, rows: Iterable[object] | NotGiven = NOT_GIVEN, type: TargetType | 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, ) → EvaluationTarget#

Update an evaluation target.

Parameters:

cached_outputs – An evaluation target which contains cached outputs.
custom_fields – A set of custom fields that the user can define and use for various purposes.
dataset – Dataset to be evaluated.
description – The description of the entity.
model – The model to be evaluated.
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.
rag – RAG to be evaluated.
retriever – Retriever to be evaluated.
rows – Rows to be evaluated.
type – The type of the evaluation target, e.g., ‘model’, ‘retriever’, ‘rag’.
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 available evaluation targets.

Parameters:

filter – Filter targets 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 Evaluation Target

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#