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).

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

pip install outerproduct-http-types

Requires Python 3.12 or newer.

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.1.tar.gz (26.3 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.1-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: outerproduct_http_types-0.7.1.tar.gz
  • Upload date:
  • Size: 26.3 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.7.1.tar.gz
Algorithm Hash digest
SHA256 575b1ddde3bcdb1a98d0b4124e77162858c5615264db6839eb3516db56b8ff71
MD5 4c313b1a828f9ed385665af75e85e310
BLAKE2b-256 963246a0100498e6c379d0640d93309696a29ad3153511da21386aaecb1d3acb

See more details on using hashes here.

Provenance

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

Publisher: release.yml on OuterProduct-ai/outerproduct-http-types

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.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for outerproduct_http_types-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 077275b96e33ac89d74b071dcdea29b25eab0cefe8a104ebb039f0407b67948c
MD5 1853df5dc076f403d35d927c9bae2192
BLAKE2b-256 e987ce78494a1f773bb8f4c551a45e51abf0faab56da10290177cf7eaa0f126d

See more details on using hashes here.

Provenance

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

Publisher: release.yml on OuterProduct-ai/outerproduct-http-types

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