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.10.0.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.10.0-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for outerproduct_http_types-0.10.0.tar.gz
Algorithm Hash digest
SHA256 c0c596aae9259a96ede1fababd5813649aa4630bae865efa622ebc085b6a548c
MD5 69842cf23ef7283127c57171b4aa79f3
BLAKE2b-256 5d866bfd4fc3b333ab02f39c7a754756c7c24e03046592eb7631ab90d00192ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for outerproduct_http_types-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33946d1f5422c5e8d74a7e34dd91f8edae09be2fb7f28b8b17604030620fb382
MD5 14becac36cb9b78e4b617355fcea7012
BLAKE2b-256 2a7de3d1717d543f86aec5c814117feb6a600bde5fe68937518e00f32c80d4f3

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