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

Uploaded Python 3

File details

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

File metadata

  • Download URL: outerproduct_http_types-0.8.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for outerproduct_http_types-0.8.0.tar.gz
Algorithm Hash digest
SHA256 7508f2a2bbb2b99d677c9e14610463919eadc80f111b5e0ebef4a5fb4e6820f8
MD5 0803e650023af0b4e5734f4d01ed4471
BLAKE2b-256 8831098d9ca102acc9714ff4209b7fb50a22534b97825a30c8cda1c106b1fdb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for outerproduct_http_types-0.8.0.tar.gz:

Publisher: release-packages.yml on OuterProduct-ai/outerproduct-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for outerproduct_http_types-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb3c379192e7af29febcfd4c048d7728365ce4e79db7d1ced46f56dca606d870
MD5 0c2b78dab10a83cf7e415b4c20dda968
BLAKE2b-256 bb5f2cc2891bc5d54bde8d0f11d313d8d90b64cf2c408b8cab0ddc83c899126c

See more details on using hashes here.

Provenance

The following attestation bundles were made for outerproduct_http_types-0.8.0-py3-none-any.whl:

Publisher: release-packages.yml on OuterProduct-ai/outerproduct-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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