aymara_ai.resources.eval_types

aymara_ai.resources.eval_types#

Classes#

EvalTypesResource

AsyncEvalTypesResource

Module Contents#

class aymara_ai.resources.eval_types.EvalTypesResource(client)[source]#

Bases: aymara_ai._resource.SyncAPIResource

Parameters:

client (aymara_ai._client.AymaraAI)

property with_raw_response: EvalTypesResourceWithRawResponse#

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://www.github.com/aymara-ai/aymara-sdk-python#accessing-raw-response-data-eg-headers

Return type:

EvalTypesResourceWithRawResponse

property with_streaming_response: EvalTypesResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/aymara-ai/aymara-sdk-python#with_streaming_response

Return type:

EvalTypesResourceWithStreamingResponse

list(*, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

List all available eval types.

Returns: list[EvalTypeSchema]: List of available eval types.

Raises: AymaraAPIError: If the request is invalid.

Example: GET /api/eval-types

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai.pagination.SyncOffsetPage[aymara_ai.types.eval_type.EvalType]

find_instructions(*, eval_type_slug, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve instructions for a specific eval type by its slug.

Args: eval_type_slug (str): Slug identifier for the eval type.

Returns: list[AiInstruction]: List of AI instructions for the eval type.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/-/instructions?eval_type_slug=…

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_slug (str)

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai.pagination.SyncOffsetPage[aymara_ai.types.ai_instruction.AIInstruction]

get(eval_type_uuid, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve a specific eval type by its UUID.

Args: eval_type_uuid (str): UUID of the eval type to retrieve.

Returns: EvalTypeSchema: The eval type data.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/{eval_type_uuid}

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_uuid (str)

Return type:

aymara_ai.types.eval_type.EvalType

list_instructions(eval_type_uuid, *, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve AI instructions for a specific eval type by its UUID.

Args: eval_type_uuid (str): UUID of the eval type.

Returns: list[AiInstruction]: List of AI instructions for the eval type.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/{eval_type_uuid}/instructions

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_uuid (str)

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai.pagination.SyncOffsetPage[aymara_ai.types.ai_instruction.AIInstruction]

class aymara_ai.resources.eval_types.AsyncEvalTypesResource(client)[source]#

Bases: aymara_ai._resource.AsyncAPIResource

Parameters:

client (aymara_ai._client.AsyncAymaraAI)

property with_raw_response: AsyncEvalTypesResourceWithRawResponse#

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://www.github.com/aymara-ai/aymara-sdk-python#accessing-raw-response-data-eg-headers

Return type:

AsyncEvalTypesResourceWithRawResponse

property with_streaming_response: AsyncEvalTypesResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/aymara-ai/aymara-sdk-python#with_streaming_response

Return type:

AsyncEvalTypesResourceWithStreamingResponse

list(*, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

List all available eval types.

Returns: list[EvalTypeSchema]: List of available eval types.

Raises: AymaraAPIError: If the request is invalid.

Example: GET /api/eval-types

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai._base_client.AsyncPaginator[aymara_ai.types.eval_type.EvalType, aymara_ai.pagination.AsyncOffsetPage[aymara_ai.types.eval_type.EvalType]]

find_instructions(*, eval_type_slug, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve instructions for a specific eval type by its slug.

Args: eval_type_slug (str): Slug identifier for the eval type.

Returns: list[AiInstruction]: List of AI instructions for the eval type.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/-/instructions?eval_type_slug=…

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_slug (str)

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai._base_client.AsyncPaginator[aymara_ai.types.ai_instruction.AIInstruction, aymara_ai.pagination.AsyncOffsetPage[aymara_ai.types.ai_instruction.AIInstruction]]

async get(eval_type_uuid, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve a specific eval type by its UUID.

Args: eval_type_uuid (str): UUID of the eval type to retrieve.

Returns: EvalTypeSchema: The eval type data.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/{eval_type_uuid}

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_uuid (str)

Return type:

aymara_ai.types.eval_type.EvalType

list_instructions(eval_type_uuid, *, limit=NOT_GIVEN, offset=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Retrieve AI instructions for a specific eval type by its UUID.

Args: eval_type_uuid (str): UUID of the eval type.

Returns: list[AiInstruction]: List of AI instructions for the eval type.

Raises: AymaraAPIError: If the eval type is not found.

Example: GET /api/eval-types/{eval_type_uuid}/instructions

Parameters:

  • extra_headers (aymara_ai._types.Headers | None) – Send extra headers

  • extra_query (aymara_ai._types.Query | None) – Add additional query parameters to the request

  • extra_body (aymara_ai._types.Body | None) – Add additional JSON properties to the request

  • timeout (float | httpx.Timeout | None | aymara_ai._types.NotGiven) – Override the client-level default timeout for this request, in seconds

  • eval_type_uuid (str)

  • limit (int | aymara_ai._types.NotGiven)

  • offset (int | aymara_ai._types.NotGiven)

Return type:

aymara_ai._base_client.AsyncPaginator[aymara_ai.types.ai_instruction.AIInstruction, aymara_ai.pagination.AsyncOffsetPage[aymara_ai.types.ai_instruction.AIInstruction]]

Contents