Skip to main content

Low Level API

Users

Types

  • User
  • UserValidateResponse

Methods:

  • client.users.create({ ...params }) -> User
  • client.users.retrieve({ ...params }) -> User
  • client.users.validate(apiKey) -> UserValidateResponse

Models

Types:

  • ModelCreateResponse
  • ModelRetrieveResponse
  • ModelListResponse

Methods:

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

Applications

Types:

  • ApplicationCreateResponse
  • ApplicationRetrieveResponse
  • ApplicationDeleteResponse

Methods:

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

Evaluations​

Metrics​

Types:

  • MetricRetrieveResponse
  • MetricGetEvaluationMetricsResponse
  • MetricGetEvaluationRunMetricsResponse

Methods:

  • client.applications.evaluations.metrics.retrieve({ ...params }) -> MetricRetrieveResponse
  • client.applications.evaluations.metrics.getEvaluationMetrics(evaluationId, { ...params }) -> MetricGetEvaluationMetricsResponse
  • client.applications.evaluations.metrics.getEvaluationRunMetrics(evaluationId, evaluationRunId, { ...params }) -> MetricGetEvaluationRunMetricsResponse

Production​

Metrics​

Types:

  • MetricRetrieveResponse

Methods:

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

Datasets

Types:

  • Dataset

Methods:

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

Records​

Types:

  • RecordListResponse

Methods:

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

Collection​

Types:

  • CollectionCreateResponse
  • CollectionRetrieveResponse

Methods:

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

Evaluations

Types:

  • EvaluationCreateResponse
  • EvaluationRetrieveResponse

Methods:

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

Run​

Types:

  • RunCreateResponse

Methods:

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

Analyze

Types:

  • AnalyzeCreateResponse

Methods:

  • client.analyze.create([ ...body ]) -> AnalyzeCreateResponse

Inference

Types:

  • InferenceDetectResponse

Methods:

  • client.inference.detect([ ...body ]) -> InferenceDetectResponse