Skip to content

server_state

AddModelRequest

Bases: BaseModel

Request to add a model to the inference server.

Attributes:

Name Type Description
model_id str

A unique model identifier.

model_type Optional[str]

The type of the model, usually referring to what task the model performs.

api_key Optional[str]

Roboflow API Key that will be passed to the model during initialization for artifact retrieval.

Source code in inference/core/entities/requests/server_state.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
class AddModelRequest(BaseModel):
    """Request to add a model to the inference server.

    Attributes:
        model_id (str): A unique model identifier.
        model_type (Optional[str]): The type of the model, usually referring to what task the model performs.
        api_key (Optional[str]): Roboflow API Key that will be passed to the model during initialization for artifact retrieval.
    """

    model_config = ConfigDict(protected_namespaces=())
    model_id: str = ModelID
    model_type: Optional[str] = ModelType
    api_key: Optional[str] = ApiKey

ClearModelRequest

Bases: BaseModel

Request to clear a model from the inference server.

Attributes:

Name Type Description
model_id str

A unique model identifier.

Source code in inference/core/entities/requests/server_state.py
23
24
25
26
27
28
29
30
31
class ClearModelRequest(BaseModel):
    """Request to clear a model from the inference server.

    Attributes:
        model_id (str): A unique model identifier.
    """

    model_config = ConfigDict(protected_namespaces=())
    model_id: str = ModelID