Arize Phoenix API Reference

Welcome to Arize Phoenix’s API reference. This reference details Phoenix’s API and how to use its various features. To get a complete guide on how to use Phoenix, including tutorials, quickstarts, and concept explanations, see the complete documentation.

Sub-Packages

The arize-phoenix includes the entire Phoenix platform. However if you have deployed the Phoenix platform, there are light-weight Python sub-packages that can be used in conjunction with the platform.

• arize-phoenix-otel - Provides a lightweight wrapper around OpenTelemetry primitives with Phoenix-aware defaults

• arize-phoenix-client - Lightweight client for interacting with the Phoenix server via its OpenAPI REST interface

• arize-phoenix-evals - Tooling to evaluate LLM applications including RAG relevance, answer relevance, and more

See also

Want to become a member of Phoenix’s community? Check out our Slack and GitHub repository!

API Definition

• session
  • phoenix.launch_app
  • phoenix.active_session
  • phoenix.close_app
  • phoenix.delete_all
  • phoenix.Session
• experiments
  • phoenix.experiments
  • phoenix.experiments.evaluators
• inferences / schema
  • phoenix.Inferences
  • phoenix.Schema
  • phoenix.EmbeddingColumnNames
  • phoenix.TraceDataset