Low Level API Reference

Users

Types

from aimon.types import User, UserValidateResponse

Methods:

• client.users.create(**params) -> User
• client.users.retrieve(**params) -> User
• client.users.validate(api_key) -> UserValidateResponse

Models

Types:

from aimon.types import ModelCreateResponse, ModelRetrieveResponse, ModelListResponse

Methods:

• client.models.create(**params) -> ModelCreateResponse
• client.models.retrieve(**params) -> ModelRetrieveResponse
• client.models.list() -> ModelListResponse

Applications

Types:

from aimon.types import (
    ApplicationCreateResponse,
    ApplicationRetrieveResponse,
    ApplicationDeleteResponse,
)

Methods:

• client.applications.create(**params) -> ApplicationCreateResponse
• client.applications.retrieve(**params) -> ApplicationRetrieveResponse
• client.applications.delete(**params) -> ApplicationDeleteResponse

Evaluations

Metrics

Types:

from aimon.types.applications.evaluations import (
    MetricRetrieveResponse,
    MetricGetEvaluationMetricsResponse,
    MetricGetEvaluationRunMetricsResponse,
)

Methods:

• client.applications.evaluations.metrics.retrieve(**params) -> MetricRetrieveResponse
• client.applications.evaluations.metrics.get_evaluation_metrics(evaluation_id, **params) -> MetricGetEvaluationMetricsResponse
• client.applications.evaluations.metrics.get_evaluation_run_metrics(evaluation_run_id, *, evaluation_id, **params) -> MetricGetEvaluationRunMetricsResponse

Production

Metrics

Types:

from aimon.types.applications.production import MetricRetrieveResponse

Methods:

• client.applications.production.metrics.retrieve(**params) -> MetricRetrieveResponse

Datasets

Types:

from aimon.types import Dataset

Methods:

• client.datasets.create(**params) -> Dataset
• client.datasets.list(**params) -> Dataset

Records

Types:

from aimon.types.datasets import RecordListResponse

Methods:

• client.datasets.records.list(**params) -> RecordListResponse

Collection

Types:

from aimon.types.datasets import CollectionCreateResponse, CollectionRetrieveResponse

Methods:

• client.datasets.collection.create(**params) -> CollectionCreateResponse
• client.datasets.collection.retrieve(**params) -> CollectionRetrieveResponse

Evaluations

Types:

from aimon.types import EvaluationCreateResponse, EvaluationRetrieveResponse

Methods:

• client.evaluations.create(**params) -> EvaluationCreateResponse
• client.evaluations.retrieve(**params) -> EvaluationRetrieveResponse

Run

Types:

from aimon.types.evaluations import RunCreateResponse

Methods:

• client.evaluations.run.create(**params) -> RunCreateResponse

Analyze

Types:

from aimon.types import AnalyzeCreateResponse

Methods:

• client.analyze.create(**params) -> AnalyzeCreateResponse

Inference

Types:

from aimon.types import InferenceDetectResponse

Methods:

• client.inference.detect(**params) -> InferenceDetectResponse