Request Types

pydantic model dyff.schema.requests.AnalysisCreateRequest

Bases: DyffEntityCreateRequest, AnalysisBase

An Analysis transforms Datasets, Evaluations, and Measurements into new Measurements or SafetyCases.

field method: str [Required]

Method ID

pydantic model dyff.schema.requests.AuditQueryRequest

Bases: DyffEntityQueryRequest

field name: str | None = None

pydantic model dyff.schema.requests.DatasetCreateRequest

Bases: DyffEntityCreateRequest, DatasetBase

pydantic model dyff.schema.requests.DatasetQueryRequest

Bases: DyffEntityQueryRequest

field name: str | None = None

pydantic model dyff.schema.requests.DocumentationEditRequest

Bases: DyffRequestBase, DocumentationBase

pydantic model dyff.schema.requests.DyffEntityCreateRequest

Bases: DyffRequestBase

field account: str [Required]

Account that owns the entity

pydantic model dyff.schema.requests.DyffEntityQueryRequest

Bases: DyffRequestDefaultValidators

field account: str | None = None

field id: str | None = None

field labels: str | None = None

Labels dict represented as a JSON string.

field query: str | None = None

A JSON structure describing a query, encoded as a string. Valid keys are the same as the valid query keys for the corresponding endpoint. Values can be scalars or lists. Lists are treated as disjunctive queries (i.e., ‘value $in list’).

field reason: str | None = None

field status: str | None = None

pydantic model dyff.schema.requests.DyffRequestBase

Bases: SchemaVersion, DyffRequestDefaultValidators

pydantic model dyff.schema.requests.DyffRequestDefaultValidators

Bases: DyffDefaultSerializers

This must be the base class for all request models in the Dyff schema.

Adds a root validator to ensure that all user-provided datetime fields have a timezone set. Timezones will be converted to UTC once the data enters the platform, but we allow requests to have non-UTC timezones for user convenience.

pydantic model dyff.schema.requests.EvaluationCreateRequest

Bases: DyffEntityCreateRequest, EvaluationBase

A description of how to run an InferenceService on a Dataset to obtain a set of evaluation results.

field inferenceSession: EvaluationInferenceSessionRequest | None = None

Specification of the InferenceSession that will perform inference for the evaluation.

field inferenceSessionReference: str | None = None

The ID of a running inference session that will be used for the evaluation, instead of starting a new one.

validator check_session_exactly_one  »  all fields

pydantic model dyff.schema.requests.EvaluationInferenceSessionRequest

Bases: InferenceSessionBase

field inferenceService: str [Required]

InferenceService ID

pydantic model dyff.schema.requests.EvaluationQueryRequest

Bases: DyffEntityQueryRequest

field dataset: str | None = None

field inferenceService: str | None = None

field inferenceServiceName: str | None = None

field model: str | None = None

field modelName: str | None = None

pydantic model dyff.schema.requests.FamilyCreateRequest

Bases: DyffEntityCreateRequest, FamilyBase

pydantic model dyff.schema.requests.FamilyMembersEditRequest

Bases: DyffRequestBase, FamilyMembers

pydantic model dyff.schema.requests.FamilyQueryRequest

Bases: DyffEntityQueryRequest

pydantic model dyff.schema.requests.InferenceServiceCreateRequest

Bases: DyffEntityCreateRequest, InferenceServiceBase

field model: str | None = None

ID of Model backing the service, if applicable

validator validate_image_not_none  »  image

pydantic model dyff.schema.requests.InferenceServiceQueryRequest

Bases: DyffEntityQueryRequest

field model: str | None = None

field modelName: str | None = None

field name: str | None = None

pydantic model dyff.schema.requests.InferenceSessionCreateRequest

Bases: DyffEntityCreateRequest, InferenceSessionBase

field inferenceService: str [Required]

InferenceService ID

pydantic model dyff.schema.requests.InferenceSessionQueryRequest

Bases: DyffEntityQueryRequest

field inferenceService: str | None = None

field inferenceServiceName: str | None = None

field model: str | None = None

field modelName: str | None = None

field name: str | None = None

pydantic model dyff.schema.requests.InferenceSessionTokenCreateRequest

Bases: DyffRequestBase

field expires: datetime | None = None

Expiration time of the token. Must be <= expiration time of session. Default: expiration time of session.

pydantic model dyff.schema.requests.LabelUpdateRequest

Bases: DyffRequestBase, Labeled

pydantic model dyff.schema.requests.MeasurementQueryRequest

Bases: _AnalysisProductQueryRequest

pydantic model dyff.schema.requests.MethodCreateRequest

Bases: DyffEntityCreateRequest, MethodBase

pydantic model dyff.schema.requests.MethodQueryRequest

Bases: DyffEntityQueryRequest

field name: str | None = None

field outputKind: str | None = None

pydantic model dyff.schema.requests.ModelCreateRequest

Bases: DyffEntityCreateRequest, ModelSpec

pydantic model dyff.schema.requests.ModelQueryRequest

Bases: DyffEntityQueryRequest

field name: str | None = None

pydantic model dyff.schema.requests.ModuleCreateRequest

Bases: DyffEntityCreateRequest, ModuleBase

pydantic model dyff.schema.requests.ModuleQueryRequest

Bases: DyffEntityQueryRequest

field name: str | None = None

pydantic model dyff.schema.requests.ReportCreateRequest

Bases: DyffEntityCreateRequest, ReportBase

A Report transforms raw model outputs into some useful statistics.

Deprecated since version 0.8.0: Report functionality has been refactored into the Method/Measurement/Analysis apparatus. Creation of new Reports is disabled.

field datasetView: str | DataView | None = None

View of the input dataset required by the report (e.g., ground-truth labels).

field evaluationView: str | DataView | None = None

View of the evaluation output data required by the report.

pydantic model dyff.schema.requests.ReportQueryRequest

Bases: DyffEntityQueryRequest

field dataset: str | None = None

field evaluation: str | None = None

field inferenceService: str | None = None

field model: str | None = None

field report: str | None = None

pydantic model dyff.schema.requests.SafetyCaseQueryRequest

Bases: _AnalysisProductQueryRequest