Skip to content

API Reference

Welcome to the TruLens API Reference! Use the search and navigation to explore the various modules and classes available in the TruLens library.

Required and 📦 Optional packages

These packages are installed when installing the main trulens package.

  • trulens-core installs core.

  • trulens-feedback installs feedback.

  • trulens-dashboard installs dashboard.

  • trulens_eval installs trulens_eval, a temporary package for backwards compatibility.

Three categories of optional packages contain integrations with 3rd party app types and providers:

  • Apps for instrumenting apps.

    • 📦 TruChain in package trulens-apps-langchain for instrumenting LangChain apps.

    • 📦 TruLlama in package trulens-app-trullama for instrumenting LlamaIndex apps.

    • 📦 TruRails in package trulens-app-nemo for instrumenting NeMo Guardrails apps.

  • Providers for invoking various models or using them for feedback functions.

    • 📦 Cortex in the package trulens-providers-cortex for using Snowflake Cortex models.

    • 📦 Langchain in the package trulens-providers-langchain for using models via Langchain.

    • 📦 Bedrock in the package trulens-providers-bedrock for using Amazon Bedrock models.

    • 📦 Huggingface and HuggingfaceLocal in the package trulens-providers-huggingface for using Huggingface models.

    • 📦 LiteLLM in the package trulens-providers-litellm for using models via LiteLLM.

    • 📦 OpenAI and AzureOpenAI in the package trulens-providers-openai for using OpenAI models.

  • Connectors for storing TruLens data.

    • 📦 SnowflakeConnector in package trulens-connectors-snowlake for connecting to Snowflake databases.

Other optional packages:

  • 📦 Benchmark in package trulens-benchmark for running benchmarks and meta evaluations.

Private API

Module members which begin with an underscore _ are private are should not be used by code outside of TruLens.

Module members which begin but not end with double underscore __ are class/module private and should not be used outside of the defining module or class.

Warning

There is no deprecation period for the private API.