Skip to content

pixano.inference.client

PixanoInferenceClient

Bases: Settings

Pixano Inference Client.

connect(url) staticmethod

Connect to pixano inference.

Parameters:

Name Type Description Default
url str

The URL of the pixano inference server.

 required
Source code in pixano/inference/client.py 
41
42
43
44
45
46
47
48
49
50
@staticmethod
def connect(url: str) -> "PixanoInferenceClient":
    """Connect to pixano inference.

    Args:
        url: The URL of the pixano inference server.
    """
    settings = Settings.model_validate_json(requests.get(f"{url}/app/settings").json())
    client = PixanoInferenceClient(url=url, **settings.model_dump())
    return client

delete(path)

Perform a DELETE request to the pixano inference server.

Parameters:

Name Type Description Default
path str

The path of the request.

 required
Source code in pixano/inference/client.py 
101
102
103
104
105
106
107
def delete(self, path: str) -> Response:
    """Perform a DELETE request to the pixano inference server.

    Args:
        path: The path of the request.
    """
    return self._rest_call(path=path, method="DELETE")

get(path)

Perform a GET request to the pixano inference server.

Parameters:

Name Type Description Default
path str

The path of the request.

 required
Source code in pixano/inference/client.py 
75
76
77
78
79
80
81
def get(self, path: str) -> Response:
    """Perform a GET request to the pixano inference server.

    Args:
        path: The path of the request.
    """
    return self._rest_call(path=path, method="GET")

list_models()

List all models.

Source code in pixano/inference/client.py 
109
110
111
112
def list_models(self) -> list[ModelInfo]:
    """List all models."""
    response = self.get("app/models")
    return [ModelInfo.model_validate(model) for model in response.json()]

post(path, **kwargs)

Perform a POST request to the pixano inference server.

Parameters:

Name Type Description Default
path str

The path of the request.

 required
kwargs Any

The keyword arguments to pass to the request.

 {}
Source code in pixano/inference/client.py 
83
84
85
86
87
88
89
90
def post(self, path: str, **kwargs: Any) -> Response:
    """Perform a POST request to the pixano inference server.

    Args:
        path: The path of the request.
        kwargs: The keyword arguments to pass to the request.
    """
    return self._rest_call(path=path, method="POST", **kwargs)

put(path, **kwargs)

Perform a PUT request to the pixano inference server.

Parameters:

Name Type Description Default
path str

The path of the request.

 required
kwargs Any

The keyword arguments to pass to the request.

 {}
Source code in pixano/inference/client.py 
92
93
94
95
96
97
98
99
def put(self, path: str, **kwargs: Any) -> Response:
    """Perform a PUT request to the pixano inference server.

    Args:
        path: The path of the request.
        kwargs: The keyword arguments to pass to the request.
    """
    return self._rest_call(path=path, method="PUT", **kwargs)