aymara_ai.resources.reports

aymara_ai.resources.reports#

Classes#

ReportsResource

AsyncReportsResource

Module Contents#

class aymara_ai.resources.reports.ReportsResource(client)[source]#

Bases: aymara_ai._resource.SyncAPIResource

Parameters:

client (aymara_ai._client.AymaraAI)

property with_raw_response: ReportsResourceWithRawResponse#

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:

ReportsResourceWithRawResponse

property with_streaming_response: ReportsResourceWithStreamingResponse#

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:

ReportsResourceWithStreamingResponse

create(*, eval_run_uuids, is_sandbox=NOT_GIVEN, workspace_uuid=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Create a summary for a suite of eval runs.

Parameters:

  • eval_run_uuids (List[str]) – List of eval run UUIDs to include in the suite summary.

  • 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

  • is_sandbox (Optional[bool] | aymara_ai._types.NotGiven)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai.types.eval_suite_report.EvalSuiteReport

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

List all eval run suite summaries, with optional filtering.

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)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai.pagination.SyncOffsetPage[aymara_ai.types.eval_suite_report.EvalSuiteReport]

delete(report_uuid, *, workspace_uuid=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Delete an eval run suite report.

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

  • report_uuid (str)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

None

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

Get a specific eval run suite report by 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

  • report_uuid (str)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai.types.eval_suite_report.EvalSuiteReport

class aymara_ai.resources.reports.AsyncReportsResource(client)[source]#

Bases: aymara_ai._resource.AsyncAPIResource

Parameters:

client (aymara_ai._client.AsyncAymaraAI)

property with_raw_response: AsyncReportsResourceWithRawResponse#

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:

AsyncReportsResourceWithRawResponse

property with_streaming_response: AsyncReportsResourceWithStreamingResponse#

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:

AsyncReportsResourceWithStreamingResponse

async create(*, eval_run_uuids, is_sandbox=NOT_GIVEN, workspace_uuid=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Create a summary for a suite of eval runs.

Parameters:

  • eval_run_uuids (List[str]) – List of eval run UUIDs to include in the suite summary.

  • 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

  • is_sandbox (Optional[bool] | aymara_ai._types.NotGiven)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai.types.eval_suite_report.EvalSuiteReport

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

List all eval run suite summaries, with optional filtering.

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)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai._base_client.AsyncPaginator[aymara_ai.types.eval_suite_report.EvalSuiteReport, aymara_ai.pagination.AsyncOffsetPage[aymara_ai.types.eval_suite_report.EvalSuiteReport]]

async delete(report_uuid, *, workspace_uuid=NOT_GIVEN, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)[source]#

Delete an eval run suite report.

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

  • report_uuid (str)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

None

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

Get a specific eval run suite report by 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

  • report_uuid (str)

  • workspace_uuid (str | aymara_ai._types.NotGiven)

Return type:

aymara_ai.types.eval_suite_report.EvalSuiteReport

Contents