Skip to content

README.md

Latest commit

 

History

History
140 lines (92 loc) · 8.91 KB

README.md

File metadata and controls

140 lines (92 loc) · 8.91 KB
Raw

Beta.Observability.Evaluations.Optimizations

Overview

Available Operations

  • list - List optimizations with optional filters
  • get - Get an optimization by id (with its anchored evaluation + project)
  • list_trials - List an optimization's trials with their observation runs (paginated)

list

List optimizations with optional filters

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.beta.observability.evaluations.optimizations.list(page_size=50, page=1)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
project OptionalNullable[str] ➖ Filter by project slug
evaluation OptionalNullable[str] ➖ Filter by evaluation slug
status OptionalNullable[str] ➖ Filter by lifecycle status
algorithm OptionalNullable[str] ➖ Filter by algorithm
tags List[str] ➖ Filter by tags
page_size Optional[int] ➖ N/A
page Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListOptimizationsResponse

Errors

Error Type Status Code Content Type
errors.ObservabilityError 400, 404, 408, 409, 422 application/json
errors.SDKError 4XX, 5XX */*

get

Get an optimization by id (with its anchored evaluation + project)

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.beta.observability.evaluations.optimizations.get(optimization_id="fd7cc96b-0c32-4b79-b7e4-63786d9dcfea")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
optimization_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.OptimizationDetail

Errors

Error Type Status Code Content Type
errors.ObservabilityError 400, 404, 408, 409, 422 application/json
errors.SDKError 4XX, 5XX */*

list_trials

List an optimization's trials with their observation runs (paginated)

Example Usage

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.beta.observability.evaluations.optimizations.list_trials(optimization_id="54622d5d-6e77-4a86-9908-87b1f8f16424", page_size=50, page=1)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
optimization_id str ✔️ N/A
page_size Optional[int] ➖ N/A
page Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListOptimizationTrialsResponse

Errors

Error Type Status Code Content Type
errors.ObservabilityError 400, 404, 408, 409, 422 application/json
errors.SDKError 4XX, 5XX */*