# Maxim Docs

## Docs

- [Create Alert](https://www.getmaxim.ai/docs/alerts/alert/create-alert.md): Create a new alert
- [Delete Alert](https://www.getmaxim.ai/docs/alerts/alert/delete-alert.md): Delete an alert
- [Get Alerts](https://www.getmaxim.ai/docs/alerts/alert/get-alerts.md): Get alerts for a workspace
- [Update Alert](https://www.getmaxim.ai/docs/alerts/alert/update-alert.md): Update an alert
- [Custom Logs Dashboards](https://www.getmaxim.ai/docs/dashboards/custom-logs-dashboard.md): Create custom dashboards to analyze and track your AI application logs across repositories using configurable metrics and filters charts
- [Test Runs Comparison Dashboard](https://www.getmaxim.ai/docs/dashboards/test-runs-comparison-dashboard.md): Learn how to create a comparison report for your test runs
- [Create Dataset Columns](https://www.getmaxim.ai/docs/datasets/dataset-column/create-dataset-columns.md): Create dataset columns
- [Delete Dataset Columns](https://www.getmaxim.ai/docs/datasets/dataset-column/delete-dataset-columns.md): Delete dataset columns
- [Get Dataset Columns](https://www.getmaxim.ai/docs/datasets/dataset-column/get-dataset-columns.md): Get dataset columns
- [Update Dataset Columns](https://www.getmaxim.ai/docs/datasets/dataset-column/update-dataset-columns.md): Update dataset columns
- [Create Dataset entries](https://www.getmaxim.ai/docs/datasets/dataset-entry/create-dataset-entries.md): Create dataset entries
- [Delete Dataset Entries](https://www.getmaxim.ai/docs/datasets/dataset-entry/delete-dataset-entries.md): Delete dataset entries
- [Get Dataset Entries](https://www.getmaxim.ai/docs/datasets/dataset-entry/get-dataset-entries.md): Get dataset entries
- [Update Dataset Entries](https://www.getmaxim.ai/docs/datasets/dataset-entry/update-dataset-entries.md): Update dataset entries
- [Create Dataset Split](https://www.getmaxim.ai/docs/datasets/dataset-split/create-dataset-split.md): Create dataset split
- [Delete Dataset Split](https://www.getmaxim.ai/docs/datasets/dataset-split/delete-dataset-split.md): Delete dataset split
- [Get Dataset Splits](https://www.getmaxim.ai/docs/datasets/dataset-split/get-dataset-splits.md): Get dataset splits
- [Update Dataset Split](https://www.getmaxim.ai/docs/datasets/dataset-split/update-dataset-split.md): Update dataset split
- [Create Dataset](https://www.getmaxim.ai/docs/datasets/dataset/create-dataset.md): Create a new dataset
- [Delete Dataset](https://www.getmaxim.ai/docs/datasets/dataset/delete-dataset.md): Delete a dataset
- [Get Datasets](https://www.getmaxim.ai/docs/datasets/dataset/get-datasets.md): Get datasets or a specific dataset
- [Update Dataset](https://www.getmaxim.ai/docs/datasets/dataset/update-dataset.md): Update a dataset
- [Execute an evaluator](https://www.getmaxim.ai/docs/evaluators/evaluator/execute-an-evaluator.md): Execute an evaluator to assess content based on predefined criteria and return grading results, reasoning, and execution logs
- [Get evaluators](https://www.getmaxim.ai/docs/evaluators/evaluator/get-evaluators.md): Get an evaluator by ID, name or fetch all evaluators for a workspace
- [Get Folder Contents](https://www.getmaxim.ai/docs/folders/folder-contents/get-folder-contents.md): Get the contents (entities) of a specific folder, identified by folderId or name+parentFolderId.
- [Create Folder](https://www.getmaxim.ai/docs/folders/folder/create-folder.md): Create a new folder for organizing entities
- [Get Folders](https://www.getmaxim.ai/docs/folders/folder/get-folders.md): Get folder details. If id or name is provided, returns a single folder object. Otherwise, lists sub-folders under the parentFolderId (or root).
- [Create a PagerDuty Integration](https://www.getmaxim.ai/docs/integrations/create-a-pagerduty-integration.md): Learn how to create a PagerDuty integration in Maxim to receive notifications when your AI application's performance metrics or quality scores exceed specified thresholds.
- [Create a Slack Integration](https://www.getmaxim.ai/docs/integrations/create-a-slack-integration.md): Learn how to create a Slack integration in Maxim to receive notifications when your AI application's performance metrics or quality scores exceed specified thresholds.
- [Create Integration](https://www.getmaxim.ai/docs/integrations/integration/create-integration.md): Create a new integration for notification channels
- [Delete Integration](https://www.getmaxim.ai/docs/integrations/integration/delete-integration.md): Delete an integration
- [Get Integrations](https://www.getmaxim.ai/docs/integrations/integration/get-integrations.md): Get integrations for a workspace
- [Update Integration](https://www.getmaxim.ai/docs/integrations/integration/update-integration.md): Update an integration
- [OpenAI Agents SDK](https://www.getmaxim.ai/docs/integrations/openai-agents-sdk.md): How to integrate Maxim's observability and real-time evaluation capabilities with OpenAI Agents SDK.
- [Platform Overview](https://www.getmaxim.ai/docs/introduction/overview.md): Maxim streamlines AI application development and deployment by applying traditional software best practices to non-deterministic AI workflows.
- [Running Your First Eval](https://www.getmaxim.ai/docs/introduction/running-your-first-eval.md): Learn how to get started with your first evaluation run in Maxim
- [Library Concepts](https://www.getmaxim.ai/docs/library/concepts.md): Explore key concepts in AI evaluation, including evaluators, datasets, and custom tools for assessing model performance and output quality.
- [Context Sources](https://www.getmaxim.ai/docs/library/context-sources.md): Learn how to create, use, and evaluate context sources for your AI applications
- [Curate Datasets](https://www.getmaxim.ai/docs/library/datasets/curate-datasets.md): Learn how to curate datasets from production logs and human annotations
- [Import or Create Datasets](https://www.getmaxim.ai/docs/library/datasets/import-or-create-datasets.md): Learn how to import or create datasets in Maxim
- [Manage Datasets](https://www.getmaxim.ai/docs/library/datasets/manage-datasets.md): Learn how to manage datasets
- [Local Datasets](https://www.getmaxim.ai/docs/library/datasets/use-local-datasets.md): Learn how to add new entries to a Dataset using the Maxim SDK
- [Custom Evaluators](https://www.getmaxim.ai/docs/library/evaluators/custom-evaluators.md): Create and configure custom evaluators to meet your specific evaluation needs
- [Pre-built Evaluators](https://www.getmaxim.ai/docs/library/evaluators/pre-built-evaluators.md): Get started quickly with ready-made evaluators for common AI evaluation scenarios
- [Third Party Evaluators](https://www.getmaxim.ai/docs/library/evaluators/third-party-evaluators.md): A comprehensive guide to supported third-party evaluation metrics for assessing AI model outputs
- [Library Overview](https://www.getmaxim.ai/docs/library/overview.md)
- [Creating Prompt Partials](https://www.getmaxim.ai/docs/library/prompt-partials.md): Learn how to create and use prompt partials in Maxim
- [Prompt Tools](https://www.getmaxim.ai/docs/library/prompt-tools.md): Comprehensive documentation for creating and using different types of prompt tools in Maxim
- [Create a new log repository](https://www.getmaxim.ai/docs/log repositories/log-repository/create-a-new-log-repository.md): Create a new log repository
- [Delete a log repository](https://www.getmaxim.ai/docs/log repositories/log-repository/delete-a-log-repository.md): Delete a log repository
- [Get log repositories](https://www.getmaxim.ai/docs/log repositories/log-repository/get-log-repositories.md): Get log repositories
- [Get trace by ID](https://www.getmaxim.ai/docs/log repositories/log-repository/get-trace-by-id.md): Get a specific trace by ID
- [Search logs in a log repository](https://www.getmaxim.ai/docs/log repositories/log-repository/search-logs-in-a-log-repository.md): Search logs in a log repository
- [Update log repository](https://www.getmaxim.ai/docs/log repositories/log-repository/update-log-repository.md): Update log repository
- [Offline Evaluation Concepts](https://www.getmaxim.ai/docs/offline-evals/concepts.md): Learn about the key concepts in Maxim
- [Create a Customer Support Email Agent](https://www.getmaxim.ai/docs/offline-evals/guides/create-customer-support-agent.md): Create a workflow that automatically categorizes support emails, creates help desk tickets, and sends responses
- [Create a Product Description Generator](https://www.getmaxim.ai/docs/offline-evals/guides/create-product-description-generator.md): Build an AI workflow to generate product descriptions from images using Agents via no-code builder
- [Evaluating the Quality of AI HR Assistants](https://www.getmaxim.ai/docs/offline-evals/guides/evaluating-the-quality-of-ai-hr-assistants.md): Learn how to evaluate the quality of AI HR assistants using Maxim's evaluation suite, ensuring accurate and efficient HR processes.
- [Evaluating AI Healthcare Assistants](https://www.getmaxim.ai/docs/offline-evals/guides/evaluating-the-quality-of-healthcare-assistants-using-maxim-ai.md): Learn how to evaluate the quality and reliability of AI healthcare assistants using Maxim's evaluation suite, ensuring patient safety and clinical reliability.
- [Offline Evaluation Overview](https://www.getmaxim.ai/docs/offline-evals/overview.md): Learn how to evaluate AI application performance through prompt testing, workflow automation, and continuous log monitoring. Streamline your AI testing pipeline with comprehensive evaluation tools.
- [HTTP Agent CI/CD Integration](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-http/ci-cd-integration.md): Learn how to integrate HTTP endpoint evaluations into your CI/CD pipeline using GitHub Actions
- [Endpoint on Maxim](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-http/endpoint-on-maxim.md): Learn how to test AI agents using workflows stored on the Maxim platform using the Maxim SDK
- [Local Endpoint Testing](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-http/local-endpoint.md): Learn how to test AI agents running on local endpoints using the Maxim SDK
- [SDK HTTP Agent Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-http/quickstart.md): Learn how to quickly get started with running agent evaluations via HTTP endpoints using the Maxim SDK
- [Agent on Maxim](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-no-code/agent-on-maxim.md): Learn how to test AI agents using no-code agents configured and stored on the Maxim platform
- [Local Agent Testing](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-no-code/local-agent.md): Learn how to create and evaluate custom AI agents using local execution via Maxim SDK
- [SDK No-Code Agent Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-sdk/agent-no-code/quickstart.md): Learn how to quickly get started with evaluating AI agents using no-code agents and the Maxim SDK
- [Prompt CI/CD Integration](https://www.getmaxim.ai/docs/offline-evals/via-sdk/prompts/ci-cd-integration.md): Learn how to integrate prompt evaluations into your CI/CD pipeline using GitHub Actions
- [Local Prompt Testing](https://www.getmaxim.ai/docs/offline-evals/via-sdk/prompts/local-prompt.md): Learn how to test locally defined prompts using the Maxim SDK
- [Maxim Prompt Testing](https://www.getmaxim.ai/docs/offline-evals/via-sdk/prompts/maxim-prompt.md): Learn how to test prompts stored on the Maxim platform using the Maxim SDK
- [Querying Prompts](https://www.getmaxim.ai/docs/offline-evals/via-sdk/prompts/querying-prompts.md): Learn how to retrieve and use tested prompts from the Maxim platform for your production workflows
- [SDK Prompt Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-sdk/prompts/quickstart.md): Learn how to quickly get started with running prompt evaluations using the Maxim SDK
- [Customized Reports](https://www.getmaxim.ai/docs/offline-evals/via-ui/advanced/customized-reports.md): The run report is a single source of truth for you to understand exactly how your AI system is performing during your experiments or pre-release testing. You can customize reports to gain insights and make decisions.
- [Dataset Evaluation](https://www.getmaxim.ai/docs/offline-evals/via-ui/advanced/dataset-evaluation.md): Learn how to evaluate your AI outputs against expected results using Maxim's Dataset evaluation tools
- [Notifications](https://www.getmaxim.ai/docs/offline-evals/via-ui/advanced/notifications.md): Test runs are a core part of continuous testing workflows and could be triggered via UI or in the CI/CD pipeline. Teams need visibility into triggered runs, status updates, and result summaries without having to come to the dashboard to constantly check. Integrations with Slack and PagerDuty allow notifications to be configured for some of these events.
- [Presets](https://www.getmaxim.ai/docs/offline-evals/via-ui/advanced/presets.md): As your team starts running tests regularly on your entities, make it simple and quick to configure tests and see results. Test presets are a way to help you reuse your configurations with a single click, reducing the time it takes to start a run. You can create labeled presets combining a dataset and evaluators and use them with any entity you want to test.
- [Scheduled Runs](https://www.getmaxim.ai/docs/offline-evals/via-ui/advanced/scheduled-runs.md): Learn how to schedule test runs for your prompts, agents and workflows at a regular interval.
- [HTTP Agent Evals](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-http-endpoint/agent-evals.md)
- [HTTP Endpoint Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-http-endpoint/quickstart.md): Run your first test on an AI application via HTTP endpoint with ease, no code changes needed.
- [Scripts](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-http-endpoint/scripts.md): Customize your API requests and responses using Workflow scripts
- [Agent Deployment](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/agent-deployment.md): Quick iterations on agents should not require code deployments every time. With more and more stakeholders working on prompt engineering, its critical to keep deployments of agents as easy as possible without much overhead. Agent deployments on Maxim allow conditional deployment of agent changes that can be used via the SDK.
- [No-Code Agent Evals](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/agent-evals.md): Test Agents using datasets to evaluate performance across examples
- [Error debugging](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/error-debugging.md): Identify and fix errors at each step of your AI workflow with detailed diagnostics
- [Loops](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/loops.md): Rerun a part of the flow multiple times
- [Multi-agent System](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/multi-agent-system.md): Multi-agent systems are a powerful way to build complex applications that can handle a wide variety of tasks.
- [No-Code Agent Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/quickstart.md): Test your agentic workflows using Agents via no-code builder with Datasets and Evaluators in minutes. View results across your test cases to find areas where it works well or needs improvement.
- [Types of Nodes](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/types-of-nodes.md): Make external API calls at any point in your agent to integrate with third-party services. The API node lets you validate data, log events, fetch information, or perform any HTTP request without leaving your agent. Simply configure the endpoint, method, and payload to connect your AI workflow with external systems.
- [Variables in Agents](https://www.getmaxim.ai/docs/offline-evals/via-ui/agents-via-no-code-builder/variables-in-agents.md): Inject variables from your Dataset directly into your agent
- [Folders and Tags](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/folders-and-tags.md): Building AI applications collaboratively needs Prompts to be organized well for easy reference and access. Adding Prompts to folders, tagging them, and versioning on Maxim helps you maintain a holistic Prompt CMS.
- [Human Annotation](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/human-annotation.md): Human annotation is critical to improve your AI quality. Getting human raters to provide feedback on various dimensions can help measure the present status and be used to improve the system over time. Maxim's human-in-the-loop pipeline allows team members as well as external raters like subject matter experts to annotate AI outputs.
- [MCP (Model Context Protocol)](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/mcp.md): Learn how to use MCP to test your prompts
- [Prompt Deployment](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-deployment.md): Quick iterations on Prompts should not require code deployments every time. With more and more stakeholders working on prompt engineering, its critical to keep deployments of Prompts as easy as possible without much overhead. Prompt deployments on Maxim allow conditional deployment of prompt changes that can be used via the SDK.
- [Prompt Evals](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-evals.md): Experimenting across prompt versions at scale helps you compare results for performance and quality scores. By running experiments across datasets of test cases, you can make more informed decisions, prevent regressions and push to production with confidence and speed.
- [Using Prompt Partials](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-partials.md): Learn how to use Prompt partials within your Prompts
- [Prompt Playground](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-playground.md): Learn how to use the Prompt Playground to compare Prompts
- [Prompt Sessions](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-sessions.md): Sessions act as a history by saving your prompt's complete state as you work. This allows you to experiment freely without fear of losing your progress.
- [Prompt Versions](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/prompt-versions.md): As teams build their AI applications, a big part of experimentation is iterating on the prompt structure. In order to collaborate effectively and organize your changes clearly, Maxim allows prompt versioning and comparison runs across versions.
- [Prompt Testing Quickstart](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/quickstart.md): Test your Prompts with Datasets and Evaluators in minutes. View results across your test cases to find areas where it works well or needs improvement.
- [Prompt Retrieval Testing](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/retrieval.md): Retrieval quality directly impacts the quality of output from your AI application. While testing prompts, Maxim allows you to connect your RAG pipeline via a simple API endpoint and evaluates the retrieved context for every run. Context specific evaluators for precision, recall and relevance make it easy to see where retrieval quality is low.
- [Prompt Tool Calls](https://www.getmaxim.ai/docs/offline-evals/via-ui/prompts/tool-calls.md): Ensuring your prompt selects the accurate tool call (function) is crucial for building reliable and efficient AI workflows. Maxim’s playground allows you to attach your tools (API, code or schema) and measure tool call accuracy for agentic systems.
- [Online Evaluation Overview](https://www.getmaxim.ai/docs/online-evals/overview.md): Get started with online evals.
- [Set Up Alerts and Notifications](https://www.getmaxim.ai/docs/online-evals/set-up-alerts-and-notifications.md): Learn how to configure notification channels (Slack and PagerDuty) and set up alerts to monitor your AI application's performance and quality metrics.
- [Node Level Evaluation](https://www.getmaxim.ai/docs/online-evals/via-sdk/node-level-evaluation.md): Evaluate any component of your trace or log to gain insights into your agent's behavior.
- [Set Up Auto Evaluation on Logs](https://www.getmaxim.ai/docs/online-evals/via-ui/set-up-auto-evaluation-on-logs.md): Evaluate captured logs automatically from the UI based on filters and sampling
- [Set Up Human Annotation on Logs](https://www.getmaxim.ai/docs/online-evals/via-ui/set-up-human-annotation-on-logs.md): Use human evaluation or rating to assess the quality of your logs and evaluate them.
- [Get Prompt Config](https://www.getmaxim.ai/docs/prompts/prompt-config/get-prompt-config.md): Get prompt configuration
- [Update Prompt Config](https://www.getmaxim.ai/docs/prompts/prompt-config/update-prompt-config.md): Update prompt configuration
- [Deploy Prompt Version](https://www.getmaxim.ai/docs/prompts/prompt-deployment/deploy-prompt-version.md): Deploy a prompt version
- [Create a prompt version](https://www.getmaxim.ai/docs/prompts/prompt-version/create-a-prompt-version.md): Create a prompt version
- [Get Prompt Versions](https://www.getmaxim.ai/docs/prompts/prompt-version/get-prompt-versions.md): Get versions of a prompt
- [Run Prompt Version](https://www.getmaxim.ai/docs/prompts/prompt-version/run-prompt-version.md): Run a specific version of a prompt
- [Create Prompt](https://www.getmaxim.ai/docs/prompts/prompt/create-prompt.md): Create a new prompt
- [Delete Prompt](https://www.getmaxim.ai/docs/prompts/prompt/delete-prompt.md): Delete a prompt
- [Get Prompts](https://www.getmaxim.ai/docs/prompts/prompt/get-prompts.md): Get prompts for a workspace
- [Update Prompt](https://www.getmaxim.ai/docs/prompts/prompt/update-prompt.md): Update an existing prompt
- [API Reference Overview](https://www.getmaxim.ai/docs/public-apis/overview.md): Welcome to the Maxim API documentation. This guide provides comprehensive information about our available APIs, their endpoints, and how to use them.
- [Introduction](https://www.getmaxim.ai/docs/sdk/overview.md): Dive into the Maxim SDK to supercharge your AI application development
- [Anthropic SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/anthropic/anthropic.md): Learn how to integrate Maxim observability with the Anthropic SDK in just one line of code.
- [Maxim Integration](https://www.getmaxim.ai/docs/sdk/python/integrations/crewai/crewai.md): Start Agent monitoring, evaluation, and observability
- [Google Gemini](https://www.getmaxim.ai/docs/sdk/python/integrations/gemini/gemini.md): Learn how to integrate Maxim observability with the Google Gemini SDK in just one line of code.
- [Langchain with & without streaming](https://www.getmaxim.ai/docs/sdk/python/integrations/langchain/langchain.md): Learn how to integrate Maxim observability with LangChain OpenAI calls.
- [Tavily Search & LangGraph Agent with Maxim Observability](https://www.getmaxim.ai/docs/sdk/python/integrations/langgraph/langgraph.md): Tutorial showing how to integrate Tavily Search API with LangChain and LangGraph, plus instrumentation using Maxim for full observability in just 5 lines.
- [LiteLLM Proxy one-line integration](https://www.getmaxim.ai/docs/sdk/python/integrations/litellm/litellm-proxy.md): Learn how to integrate Maxim with the LiteLLM Proxy
- [LiteLLM SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/litellm/litellm-sdk.md): Learn how to integrate Maxim with LiteLLM for tracing and monitoring
- [LiveKit SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/livekit/livekit.md): Learn how to integrate Maxim observability with LiveKit agents for real-time voice AI applications with comprehensive tracing and monitoring.
- [Mistral SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/mistral/mistral.md): Learn how to integrate Maxim observability with the Mistral SDK in just one line of code.
- [Agents SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/openai/agents-sdk.md): Learn how to integrate Maxim with the OpenAI Agents SDK
- [OpenAI SDK](https://www.getmaxim.ai/docs/sdk/python/integrations/openai/one-line-integration.md): Learn how to integrate Maxim observability with the OpenAI SDK in just one line of code.
- [Overview](https://www.getmaxim.ai/docs/sdk/python/overview.md): Introduction to Maxim python SDK.
- [MaximApis](https://www.getmaxim.ai/docs/sdk/python/references/apis/maxim_apis.md): Maxim_Apis utilities for api client utilities for interacting with maxim services.
- [Cache](https://www.getmaxim.ai/docs/sdk/python/references/cache/cache.md): Cache utilities for caching mechanisms and utilities for optimizing performance.
- [Inmemory](https://www.getmaxim.ai/docs/sdk/python/references/cache/inMemory.md): Inmemory utilities for caching mechanisms and utilities for optimizing performance.
- [dataset.Dataset](https://www.getmaxim.ai/docs/sdk/python/references/dataset/dataset.md): Dataset utilities for dataset management and manipulation utilities.
- [decorators.Generation](https://www.getmaxim.ai/docs/sdk/python/references/decorators/generation.md): Generation utilities for decorators for automatic logging and instrumentation of functions and methods.
- [decorators.Retrieval](https://www.getmaxim.ai/docs/sdk/python/references/decorators/retrieval.md): Retrieval utilities for decorators for automatic logging and instrumentation of functions and methods.
- [decorators.Span](https://www.getmaxim.ai/docs/sdk/python/references/decorators/span.md): Span utilities for decorators for automatic logging and instrumentation of functions and methods.
- [decorators.ToolCall](https://www.getmaxim.ai/docs/sdk/python/references/decorators/tool_call.md): Tool_Call utilities for decorators for automatic logging and instrumentation of functions and methods.
- [decorators.Trace](https://www.getmaxim.ai/docs/sdk/python/references/decorators/trace.md): Trace utilities for decorators for automatic logging and instrumentation of functions and methods.
- [BaseEvaluator](https://www.getmaxim.ai/docs/sdk/python/references/evaluators/base_evaluator.md): Base_Evaluator utilities for evaluation tools and utilities for assessing model performance.
- [evaluators.Utils](https://www.getmaxim.ai/docs/sdk/python/references/evaluators/utils.md): Utility functions and helpers for Evaluators integration.
- [Expiring Key Value Store](https://www.getmaxim.ai/docs/sdk/python/references/expiring_key_value_store.md): Expiring\_Key\_Value\_Store module utilities and functionality.
- [Filter Objects](https://www.getmaxim.ai/docs/sdk/python/references/filter_objects.md): Filter\_Objects module utilities and functionality.
- [anthropic.Client](https://www.getmaxim.ai/docs/sdk/python/references/logger/anthropic/client.md): Anthropic client implementation for API interactions and model integration.
- [Message](https://www.getmaxim.ai/docs/sdk/python/references/logger/anthropic/message.md): Message utilities for anthropic ai model integration and logging utilities.
- [StreamManager](https://www.getmaxim.ai/docs/sdk/python/references/logger/anthropic/stream_manager.md): Stream_Manager utilities for anthropic ai model integration and logging utilities.
- [anthropic.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/anthropic/utils.md): Utility functions and helpers for Anthropic integration.
- [bedrock.AsyncClient](https://www.getmaxim.ai/docs/sdk/python/references/logger/bedrock/async_client.md): Async_Client utilities for aws bedrock integration utilities.
- [bedrock.Client](https://www.getmaxim.ai/docs/sdk/python/references/logger/bedrock/client.md): Bedrock client implementation for API interactions and model integration.
- [bedrock.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/bedrock/utils.md): Utility functions and helpers for Bedrock integration.
- [components.Attachment](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/attachment.md): Attachment functionality for Components integration.
- [Base](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/base.md): Base functionality for Components integration.
- [Error](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/error.md): Error functionality for Components integration.
- [Feedback](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/feedback.md): Feedback functionality for Components integration.
- [components.Generation](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/generation.md): Generation functionality for Components integration.
- [components.Retrieval](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/retrieval.md): Retrieval functionality for Components integration.
- [Session](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/session.md): Session functionality for Components integration.
- [components.Span](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/span.md): Span functionality for Components integration.
- [components.ToolCall](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/tool_call.md): Tool Call functionality for Components integration.
- [components.Trace](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/trace.md): Trace functionality for Components integration.
- [Types](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/types.md): Types functionality for Components integration.
- [components.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/components/utils.md): Utility functions and helpers for Components integration.
- [crewai.Client](https://www.getmaxim.ai/docs/sdk/python/references/logger/crewai/client.md): Crewai client implementation for API interactions and model integration.
- [crewai.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/crewai/utils.md): Utility functions and helpers for Crewai integration.
- [gemini.AsyncClient](https://www.getmaxim.ai/docs/sdk/python/references/logger/gemini/async_client.md): Async_Client utilities for google gemini model integration and logging utilities.
- [gemini.Client](https://www.getmaxim.ai/docs/sdk/python/references/logger/gemini/client.md): Gemini client implementation for API interactions and model integration.
- [gemini.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/gemini/utils.md): Utility functions and helpers for Gemini integration.
- [langchain.Tracer](https://www.getmaxim.ai/docs/sdk/python/references/logger/langchain/tracer.md): Tracing and instrumentation utilities for Langchain integration.
- [langchain.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/langchain/utils.md): Utility functions and helpers for Langchain integration.
- [litellm.Tracer](https://www.getmaxim.ai/docs/sdk/python/references/logger/litellm/tracer.md): Tracing and instrumentation utilities for Litellm integration.
- [litellm_proxy.Tracer](https://www.getmaxim.ai/docs/sdk/python/references/logger/litellm_proxy/tracer.md): Tracing and instrumentation utilities for Litellm_Proxy integration.
- [AgentSession](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/agent_session.md): Agent_Session utilities for livekit real-time communication integration utilities.
- [GeminiRealtimeSession](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/gemini/gemini_realtime_session.md): Gemini_Realtime_Session utilities for google gemini model integration and logging utilities.
- [Instrumenter](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/instrumenter.md): Instrumenter utilities for livekit real-time communication integration utilities.
- [Handler](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/openai/realtime/handler.md): Handler functionality for Realtime integration.
- [RealtimeSession](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/realtime_session.md): Realtime_Session utilities for livekit real-time communication integration utilities.
- [Store](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/store.md): Store utilities for livekit real-time communication integration utilities.
- [livekit.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/livekit/utils.md): Utility functions and helpers for Livekit integration.
- [Logger](https://www.getmaxim.ai/docs/sdk/python/references/logger/logger.md): Logger utilities for logging and instrumentation utilities for tracking ai model interactions.
- [mistral.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/mistral/utils.md): Utility functions and helpers for Mistral integration.
- [Container](https://www.getmaxim.ai/docs/sdk/python/references/logger/models/container.md): Container utilities for data models and type definitions used throughout the maxim sdk.
- [AsyncChat](https://www.getmaxim.ai/docs/sdk/python/references/logger/openai/async_chat.md): Async_Chat utilities for openai model integration and logging utilities.
- [openai.AsyncClient](https://www.getmaxim.ai/docs/sdk/python/references/logger/openai/async_client.md): Async_Client utilities for openai model integration and logging utilities.
- [AsyncCompletions](https://www.getmaxim.ai/docs/sdk/python/references/logger/openai/async_completions.md): Async_Completions utilities for openai model integration and logging utilities.
- [Chat](https://www.getmaxim.ai/docs/sdk/python/references/logger/openai/chat.md): Chat utilities for openai model integration and logging utilities.
- [openai.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/openai/utils.md): Utility functions and helpers for Openai integration.
- [GenerationParser](https://www.getmaxim.ai/docs/sdk/python/references/logger/parsers/generation_parser.md): Generation Parser functionality for Parsers integration.
- [TagsParser](https://www.getmaxim.ai/docs/sdk/python/references/logger/parsers/tags_parser.md): Tags Parser functionality for Parsers integration.
- [portkey.Client](https://www.getmaxim.ai/docs/sdk/python/references/logger/portkey/client.md): Portkey client implementation for API interactions and model integration.
- [Portkey](https://www.getmaxim.ai/docs/sdk/python/references/logger/portkey/portkey.md): Portkey utilities for portkey integration utilities.
- [logger.Utils](https://www.getmaxim.ai/docs/sdk/python/references/logger/utils.md): Utility functions and helpers for Logger integration.
- [Writer](https://www.getmaxim.ai/docs/sdk/python/references/logger/writer.md): Writer utilities for logging and instrumentation utilities for tracking ai model interactions.
- [Maxim](https://www.getmaxim.ai/docs/sdk/python/references/maxim.md): Core Maxim Python SDK functionality and main entry point.
- [models.Attachment](https://www.getmaxim.ai/docs/sdk/python/references/models/attachment.md): Attachment utilities for data models and type definitions used throughout the maxim sdk.
- [models.Dataset](https://www.getmaxim.ai/docs/sdk/python/references/models/dataset.md): Dataset utilities for data models and type definitions used throughout the maxim sdk.
- [Evaluator](https://www.getmaxim.ai/docs/sdk/python/references/models/evaluator.md): Evaluator utilities for data models and type definitions used throughout the maxim sdk.
- [Folder](https://www.getmaxim.ai/docs/sdk/python/references/models/folder.md): Folder utilities for data models and type definitions used throughout the maxim sdk.
- [Metadata](https://www.getmaxim.ai/docs/sdk/python/references/models/metadata.md): Metadata utilities for data models and type definitions used throughout the maxim sdk.
- [Prompt](https://www.getmaxim.ai/docs/sdk/python/references/models/prompt.md): Prompt utilities for data models and type definitions used throughout the maxim sdk.
- [PromptChain](https://www.getmaxim.ai/docs/sdk/python/references/models/prompt_chain.md): Prompt_Chain utilities for data models and type definitions used throughout the maxim sdk.
- [QueryBuilder](https://www.getmaxim.ai/docs/sdk/python/references/models/query_builder.md): Query_Builder utilities for data models and type definitions used throughout the maxim sdk.
- [TestRun](https://www.getmaxim.ai/docs/sdk/python/references/models/test_run.md): Test_Run utilities for data models and type definitions used throughout the maxim sdk.
- [Scribe](https://www.getmaxim.ai/docs/sdk/python/references/scribe.md): Scribe module utilities and functionality.
- [TestRunBuilder](https://www.getmaxim.ai/docs/sdk/python/references/test_runs/test_run_builder.md): Test_Run_Builder utilities for test execution and management utilities.
- [test_runs.Utils](https://www.getmaxim.ai/docs/sdk/python/references/test_runs/utils.md): Utility functions and helpers for Test_Runs integration.
- [MockWriter](https://www.getmaxim.ai/docs/sdk/python/references/tests/mock_writer.md): Mock Writer functionality for Tests integration.
- [TestAnthropic](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_anthropic.md): Test Anthropic functionality for Tests integration.
- [TestConnectionRetryLogic](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_connection_retry_logic.md): Test Connection Retry Logic functionality for Tests integration.
- [TestLoggerLangchain03x](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_logger_langchain_03x.md): Test Logger Langchain 03X functionality for Tests integration.
- [TestMaximCoreSimple](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_maxim_core_simple.md): Test Maxim Core Simple functionality for Tests integration.
- [TestPortkey](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_portkey.md): Test Portkey functionality for Tests integration.
- [TestTestRuns](https://www.getmaxim.ai/docs/sdk/python/references/tests/test_test_runs.md): Test Test Runs functionality for Tests integration.
- [Upgrading to v3](https://www.getmaxim.ai/docs/sdk/python/upgrading-to-v3.md): Changes in the Maxim SDK
- [LangChain Integration](https://www.getmaxim.ai/docs/sdk/typescript/integrations/langchain/langchain.md): Complete guide to integrating Maxim observability with LangChain applications in TypeScript/JavaScript
- [LangGraph Integration](https://www.getmaxim.ai/docs/sdk/typescript/integrations/langgraph/langgraph.md): Complete guide to integrating Maxim observability with LangGraph applications in TypeScript/JavaScript
- [BaseContainer](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/BaseContainer.md)
- [CSVFile](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/CSVFile.md)
- [CommitLog](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/CommitLog.md)
- [Error](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Error.md)
- [EvaluatableBaseContainer](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/EvaluatableBaseContainer.md)
- [EvaluateContainer](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/EvaluateContainer.md)
- [EventEmittingBaseContainer](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/EventEmittingBaseContainer.md)
- [Generation](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Generation.md)
- [LogWriter](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/LogWriter.md)
- [Maxim](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Maxim.md)
- [MaximLogger](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/MaximLogger.md)
- [MaximLogsAPI](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/MaximLogsAPI.md)
- [QueryBuilder](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/QueryBuilder.md)
- [Retrieval](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Retrieval.md)
- [Session](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Session.md)
- [Span](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Span.md)
- [ToolCall](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/ToolCall.md)
- [Trace](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/classes/Trace.md)
- [Entity](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/enumerations/Entity.md)
- [QueryRuleType](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/enumerations/QueryRuleType.md)
- [VariableType](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/enumerations/VariableType.md)
- [ChatCompletionChoice](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ChatCompletionChoice.md)
- [ChatCompletionMessage](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ChatCompletionMessage.md)
- [ChatCompletionResult](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ChatCompletionResult.md)
- [ChatCompletionToolCall](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ChatCompletionToolCall.md)
- [CompletionRequest](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/CompletionRequest.md)
- [GenerationError](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/GenerationError.md)
- [Logprobs](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/Logprobs.md)
- [MaximCache](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/MaximCache.md)
- [TestRunLogger](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/TestRunLogger.md)
- [TextCompletionChoice](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/TextCompletionChoice.md)
- [TextCompletionResult](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/TextCompletionResult.md)
- [ToolCallConfig](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ToolCallConfig.md)
- [ToolCallError](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ToolCallError.md)
- [ToolCallFunction](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/ToolCallFunction.md)
- [Usage](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/interfaces/Usage.md)
- [core](https://www.getmaxim.ai/docs/sdk/typescript/reference/core/overview.md)
- [MaximLangchainTracer](https://www.getmaxim.ai/docs/sdk/typescript/reference/langchain/classes/MaximLangchainTracer.md)
- [langchain](https://www.getmaxim.ai/docs/sdk/typescript/reference/langchain/overview.md)
- [modules](https://www.getmaxim.ai/docs/sdk/typescript/reference/modules.md)
- [@maximai/maxim-js](https://www.getmaxim.ai/docs/sdk/typescript/reference/overview.md)
- [Data plane deployment](https://www.getmaxim.ai/docs/self-hosting/dataplane.md): This guide details Maxim's data plane deployment process, outlining how to establish data processing infrastructure within your cloud environment. It emphasizes enhanced security, control, and data tenancy, ensuring compliance with data residency requirements while leveraging cloud-based services.
- [Self-Hosting Overview](https://www.getmaxim.ai/docs/self-hosting/overview.md): Maxim offers self hosting and flexible enterprise deployment options with either full VPC isolation (Zero Touch) or hybrid setup with secure VPC peering (Data Plane), tailored to your security needs.
- [Zero Touch Deployment](https://www.getmaxim.ai/docs/self-hosting/zerotouch.md): This guide outlines Maxim's zero-touch deployment process, covering infrastructure components, security protocols, and supported cloud providers.
- [Custom Pricing](https://www.getmaxim.ai/docs/settings/custom-pricing.md): Learn how to set up custom token pricing in Maxim for accurate cost reporting in AI evaluations and logs, ensuring displayed costs match your actual expenses.
- [Maxim API keys](https://www.getmaxim.ai/docs/settings/maxim-api-keys.md): Learn how to create Maxim API keys.
- [Members and Roles](https://www.getmaxim.ai/docs/settings/members-and-roles.md): Learn how to invite team members and create roles in Maxim.
- [Model Configuration](https://www.getmaxim.ai/docs/settings/model-configuration.md): Learn how to configure models in Maxim.
- [Two-Factor Authentication](https://www.getmaxim.ai/docs/settings/two-factor-authentication.md): Learn how to set up two-factor authentication in Maxim.
- [Vault](https://www.getmaxim.ai/docs/settings/vault.md): Learn how to set up vault in Maxim.
- [Simulation Overview](https://www.getmaxim.ai/docs/simulations/overview.md)
- [Simulation Runs](https://www.getmaxim.ai/docs/simulations/simulation-runs.md): Test your AI's conversational abilities with realistic, scenario-based simulations
- [Get test run entries](https://www.getmaxim.ai/docs/test run entries/test-run-entries/get-test-run-entries.md): Get test run entries
- [Share test run report](https://www.getmaxim.ai/docs/test run reports/test-run-report/share-test-run-report.md): Share a test run report
- [Delete test runs](https://www.getmaxim.ai/docs/test runs/test-run/delete-test-runs.md): Delete test runs from a workspace
- [Get test runs](https://www.getmaxim.ai/docs/test runs/test-run/get-test-runs.md): Get test runs for a workspace
- [Tracing Concepts](https://www.getmaxim.ai/docs/tracing/concepts.md): Learn about the key concepts of Maxim's distributed tracing for AI applications.
- [Dashboard](https://www.getmaxim.ai/docs/tracing/dashboard.md): Learn how to use the dashboard to filter and sort your logs
- [Exports](https://www.getmaxim.ai/docs/tracing/exports.md): Learn how to export your logs and evaluation data in Maxim
- [Forwarding via Data Connectors](https://www.getmaxim.ai/docs/tracing/opentelemetry/forwarding-via-data-connectors.md): Send your traces to Maxim once and we'll forward them to your preferred observability platforms - New Relic, Snowflake, or any OpenTelemetry collector.
- [Ingesting via OTLP Endpoint](https://www.getmaxim.ai/docs/tracing/opentelemetry/ingesting-via-otlp.md): Learn how to send OpenTelemetry (OTLP) traces to Maxim for AI and LLM Observability.
- [Tracing Overview](https://www.getmaxim.ai/docs/tracing/overview.md): Monitor AI applications in real-time with Maxim's enterprise-grade LLM observability platform.
- [Tracing Quickstart](https://www.getmaxim.ai/docs/tracing/quickstart.md): Set up distributed tracing for your GenAI applications to monitor performance and debug issues across services.
- [Reporting](https://www.getmaxim.ai/docs/tracing/reporting.md): Learn how to set up reporting for your logs and evaluation data in Maxim
- [Attachments](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/attachments.md): Learn how to attach files and URLs to traces and spans for richer observability in Maxim.
- [Errors](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/errors.md): Learn how to effectively track and log errors from LLM results and Tool calls in your AI application traces to improve performance and reliability.
- [Events](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/events.md): Track application milestones and state changes using event logging
- [Generations](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/generations.md): Use generations to log individual calls to Large Language Models (LLMs)
- [Tracing Retrieval](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/retrieval.md): Retrieval-Augmented Generation (RAG) is a technique that enhances large language models by retrieving relevant information from external sources before generating responses.
- [Sessions](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/sessions.md): Learn how to group related traces into sessions to track complete user interactions with your GenAI system.
- [Spans](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/spans.md): Spans help you organize and track requests across microservices within traces. A trace represents the entire journey of a request through your system, while spans are smaller units of work within that trace.
- [Tags](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/tags.md): Tag your traces to group and filter endpoint data effectively. Add tags to any node type - spans, generations, retrievals, events, and more.
- [Tracing Tool Calls](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/tool-calls.md): Track external system calls triggered by LLM responses in your agentic endpoints. Tool calls represent interactions with external services, allowing you to monitor execution time and responses.
- [Traces](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/traces.md): Learn how to set up tracing using the Maxim platform
- [User Feedback](https://www.getmaxim.ai/docs/tracing/tracing-via-sdk/user-feedback.md): Track and collect user feedback in application traces using Maxim's Feedback entity. Enhance your AI applications with structured user ratings and comments


## Optional

- [Blog](https://www.getmaxim.ai/blog)
- [Cookbooks](https://github.com/maximhq/maxim-cookbooks)
- [Tutorials](https://www.youtube.com/playlist?list=PLJh32rQ0yHHIC_nNZ6i2taEzAYiH8s6rP)