Python APItypesafe

Core

Instrumentation

Python · Instrumentation

openinference-instrumentation-typesafe

OpenInference TypeSafe AI Instrumentation

Module
openinference.instrumentation.typesafe
Version
0.1.13
Python
>=3.10, <3.16
Instruments
typesafe-sdk >= 0.6.0

Install

pip install openinference-instrumentation-typesafe

Usage

Instrument once, at startup, before the library is used. The TypeSafeAIInstrumentor reference below lists the options.

from opentelemetry.sdk.trace import TracerProvider
from openinference.instrumentation import TraceConfig
from openinference.instrumentation.typesafe import TypeSafeAIInstrumentor

tracer_provider = TracerProvider()
# ...add a span processor that exports to Phoenix or any OTLP backend.

TypeSafeAIInstrumentor().instrument(
    tracer_provider=tracer_provider,
    config=TraceConfig(hide_inputs=True),  # optional
)

openinference.instrumentation.typesafe

TypeSafeAIInstrumentor

classSource ↗
class TypeSafeAIInstrumentor(BaseInstrumentor)

Traces the TypeSafe AI Python SDK (typesafe-sdk) as OpenInference DECISION spans.

Wraps TypeSafeClient.system_one and AsyncTypeSafeClient.system_one. instrument() accepts a tracer_provider and a TraceConfig; uninstrument() restores the original methods.

instrument

method
def instrument(
    *,
    tracer_provider: Optional[TracerProvider] = None,
    config: Optional[TraceConfig] = None,
    skip_dep_check: bool = False,
) -> None

Start tracing typesafe-sdk: patch it so its calls make OpenInference spans. Calling it again does nothing. Inherited from OpenTelemetry’s BaseInstrumentor.

Parameters

NameDescription
tracer_provider

The tracer provider the spans are made with. Defaults to the global one, opentelemetry.trace.get_tracer_provider().

config

What the spans record: hide inputs, outputs or messages, or limit image sizes. Defaults to TraceConfig(), which reads the OPENINFERENCE_* environment variables. See TraceConfig.

skip_dep_check

Instrument even if the installed version of typesafe-sdk is outside the supported range.

uninstrument

method
def uninstrument() -> None

Stop tracing: undo the patches instrument() made. Inherited from OpenTelemetry’s BaseInstrumentor.

instrumentation_dependencies

methodSource ↗
def instrumentation_dependencies() -> Collection[str]