Input Set Module

This section documents the input set components of the Nextmv Cloud API.

input_set

Definitions for input sets and related cloud objects.

This module provides classes for managing inputs and input sets in the Nextmv Cloud.

CLASS	DESCRIPTION
ManagedInput	An input created for experimenting with an application.
InputSet	A collection of inputs from associated runs.

InputSet

Bases: BaseModel

A collection of inputs from associated runs.

You can import the InputSet class directly from cloud:

from nextmv.cloud import InputSet

An input set aggregates multiple inputs used for experimentation with an application in the Nextmv Cloud. It allows organizing and managing related inputs for comparison and analysis.

PARAMETER	DESCRIPTION
app_id	Identifier of the application that the input set belongs to. TYPE: str
created_at	Timestamp when the input set was created. TYPE: datetime
description	User-defined description of the input set. TYPE: str
id	Unique identifier of the input set. TYPE: str
input_ids	List of identifiers of the inputs in the input set. TYPE: list[str]
name	User-defined name of the input set. TYPE: str
updated_at	Timestamp when the input set was last updated. TYPE: datetime
inputs	List of ManagedInput objects contained in this input set. TYPE: list[ManagedInput]

Examples:

>>> input_set = InputSet(
...     app_id="app_123456789",
...     id="is_987654321",
...     name="My Input Set",
...     description="A collection of routing inputs",
...     input_ids=["inp_111", "inp_222"],
...     created_at=datetime.now(),
...     updated_at=datetime.now(),
...     inputs=[]
... )
>>> print(input_set.name)
My Input Set
>>> print(len(input_set.input_ids))
2

app_id instance-attribute

app_id: str

ID of the application that the input set belongs to.

created_at instance-attribute

created_at: datetime

Creation time of the input set.

description instance-attribute

description: str

Description of the input set.

id instance-attribute

id: str

ID of the input set.

input_ids instance-attribute

input_ids: list[str]

IDs of the inputs in the input set.

inputs instance-attribute

inputs: list[ManagedInput]

List of inputs in the input set.

name instance-attribute

name: str

Name of the input set.

updated_at instance-attribute

updated_at: datetime

Last update time of the input set.

ManagedInput

Bases: BaseModel

An input created for experimenting with an application.

You can import the ManagedInput class directly from cloud:

from nextmv.cloud import ManagedInput

This class represents an input that was uploaded to the Nextmv Cloud for experimentation purposes. It contains metadata about the input, such as its ID, name, description, and creation time.

PARAMETER	DESCRIPTION
id	Unique identifier of the input. TYPE: str
name	User-defined name of the input. TYPE: str
description	User-defined description of the input. TYPE: str
run_id	Identifier of the run that created this input. TYPE: str
upload_id	Identifier of the upload that created this input. TYPE: str
format	Format of the input (e.g., JSON, CSV). TYPE: Format
created_at	Timestamp when the input was created. TYPE: datetime
updated_at	Timestamp when the input was last updated. TYPE: datetime

Examples:

>>> input = ManagedInput(id="inp_123456789")
>>> print(input.id)
inp_123456789

created_at class-attribute instance-attribute

created_at: Optional[datetime] = None

Creation time of the input.

description class-attribute instance-attribute

description: Optional[str] = None

Description of the input.

format class-attribute instance-attribute

format: Optional[Format] = None

Format of the input.

id instance-attribute

id: str

ID of the input.

name class-attribute instance-attribute

name: Optional[str] = None

Name of the input.

run_id class-attribute instance-attribute

run_id: Optional[str] = None

ID of the run that created the input.

updated_at class-attribute instance-attribute

updated_at: Optional[datetime] = None

Last update time of the input.

upload_id class-attribute instance-attribute

upload_id: Optional[str] = None

ID of the upload that created the input.