Skip to main content

Shared HTTP-facing type definitions for OuterProduct services and SDKs.

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

outerproduct-http-types

Shared HTTP-facing type definitions for the OuterProduct API.

This package contains the Pydantic models that describe the request and response shapes used across OuterProduct services and SDKs. It is the source of truth for the wire contract between the OuterProduct backend and any client (including the official Python SDK).

Inside this monorepo, the package lives at packages/http-types and is consumed by the API and deployable apps through uv path sources. Run package-local checks with uv run --project packages/http-types ... from the repository root.

Most users should not depend on this package directly. Instead, install the OuterProduct SDK, which re-exports the relevant types and provides a typed client. Use this package only when you are building tooling that needs to construct or parse OuterProduct API payloads independently of the SDK.

Installation

uv add outerproduct-http-types

Or with pip:

pip install outerproduct-http-types

Usage

Import the model that matches the endpoint you are working with and construct or validate payloads as you would with any Pydantic model:

from outerproduct_http_types import PredictRequest, PredictResponse

request = PredictRequest(
    samples=[[1.0, "x"], [2.5, "y"]],
    feature_names=["feature_a", "feature_b"],
)
payload = request.model_dump_json()

# ... POST `payload` to /v1/models/{model_id}/predict, then parse:
response = PredictResponse.model_validate_json(raw_response_body)
print(response.model_id, response.predictions)

The package ships with a py.typed marker, so type checkers (mypy, pyright, ty) will pick up the type information automatically.

Versioning

This package follows semantic versioning. Breaking changes to wire types are released as a new major version. Minor versions add new endpoints or optional fields; patch versions are reserved for documentation and non-behavioral fixes.

License

Licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

outerproduct_http_types-0.7.3.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

outerproduct_http_types-0.7.3-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

Details for the file outerproduct_http_types-0.7.3.tar.gz.

File metadata

File hashes

Hashes for outerproduct_http_types-0.7.3.tar.gz
Algorithm Hash digest
SHA256 019c670bab3bb894abd69e59e31795a8c3b948079b268ccbc4a544d6883f7b34
MD5 544d5c1f43298ab56c7dd82f5a8bb1c2
BLAKE2b-256 5de1f36b80149393dd7604b79c15fed50947be909380a25fb86f1a233b772bc3

See more details on using hashes here.

File details

Details for the file outerproduct_http_types-0.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for outerproduct_http_types-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7d81f131f0de78478cfdfa471e4b4a6bdb6038ee65616dc58e3ab87148129389
MD5 89fec26778bf198a55bb84f71c5c7b5c
BLAKE2b-256 8735917dc43c6a79926a13447cf8e052b8391100c9fe9639bed5b50252679bf9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page