Files
comet-ml--opik/apps/opik-documentation/documentation/fern/versions/v1.yml
T
wehub-resource-sync 5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:25:44 +08:00

1028 lines
42 KiB
YAML

tabs:
documentation:
display-name: Documentation
icon: fa-regular fa-building
slug: /
integrations:
display-name: Integrations
icon: fa-regular fa-plug
slug: /integrations
agent-optimization:
display-name: Agent Optimization
icon: fa-regular fa-robot
slug: /agent_optimization
self-host:
display-name: Self-hosting Opik
icon: fa-regular fa-server
slug: /self-host
reference:
display-name: SDK & API reference
icon: fa-regular fa-square-terminal
slug: /reference
opik-university:
display-name: Opik University
icon: fa-regular fa-graduation-cap
slug: /opik-university
navigation:
- tab: documentation
layout:
- section: Getting Started
slug: /
contents:
- page: Home
path: ../docs/home.mdx
slug: /
icon: fa-regular fa-house
- page: Quickstart
path: ../docs/quickstart.mdx
slug: /quickstart
icon: fa-regular fa-bolt
- page: Quickstart notebook
path: ../docs/cookbook/quickstart_notebook.mdx
slug: quickstart_notebook
icon: fa-regular fa-play
- page: Roadmap
path: ../docs/roadmap.mdx
slug: roadmap
icon: fa-regular fa-map
- page: FAQ
path: ../docs/faq.mdx
slug: faq
icon: fa-regular fa-question
- changelog: ../docs/changelog
title: Changelog
slug: changelog
icon: fa-regular fa-calendar
- section: Observability
slug: /tracing
contents:
- page: Concepts
path: ../docs/tracing/concepts.mdx
slug: concepts
- page: Log traces
path: ../docs/tracing/log_traces.mdx
slug: log_traces
- page: Log conversations
path: ../docs/tracing/log_chat_conversations.mdx
slug: log_chat_conversations
- page: Log user feedback
path: ../docs/tracing/annotate_traces.mdx
slug: annotate_traces
- page: Log media & attachments
path: ../docs/tracing/log_multimodal_traces.mdx
slug: log_multimodal_traces
- page: Cost tracking
path: ../docs/tracing/cost_tracking.mdx
slug: cost_tracking
- section: Manage data
skip-slug: true
collapsed: true
contents:
- page: Export by SDK, REST, and UI
path: ../docs/tracing/export_data.mdx
slug: export_data
- page: Import/Export by command line
path: ../docs/tracing/import_export_commands.mdx
slug: import_export_commands
- page: Opik Assist
path: ../docs/tracing/opik_assist.mdx
slug: opik_assist
- section: Advanced
skip-slug: true
collapsed: true
contents:
- page: SDK configuration
path: ../docs/tracing/sdk_configuration.mdx
slug: sdk_configuration
- page: Log Agent Graphs
path: ../docs/tracing/log_agent_graph.mdx
slug: log_agent_graphs
- page: Log distributed traces
path: ../docs/tracing/log_distributed_traces.mdx
slug: log_distributed_traces
- page: Offline fallback and message replay
path: ../docs/tracing/offline_fallback.mdx
slug: offline_fallback
- section: Evaluation
slug: /evaluation
contents:
- page: Overview
path: ../docs/evaluation/overview.mdx
slug: overview
- page: Concepts
path: ../docs/evaluation/concepts.mdx
slug: concepts
- page: Manage datasets
path: ../docs/evaluation/manage_datasets.mdx
slug: manage_datasets
- page: Evaluate single prompts
path: ../docs/evaluation/evaluate_prompt.mdx
slug: evaluate_prompt
- page: Evaluate your agent
path: ../docs/evaluation/evaluate_your_llm.mdx
slug: evaluate_your_llm
- page: Evaluate agent trajectories
path: ../docs/evaluation/evaluate_agent_trajectory.mdx
slug: evaluate_agent_trajectory
- page: Evaluate multimodal traces
path: ../docs/evaluation/evaluate_multimodal.mdx
slug: evaluate_multimodal
- page: Evaluate multi-turn agents
path: ../docs/evaluation/evaluate_multi_turn_agents.mdx
slug: evaluate_multi_turn_agents
- page: Manually logging experiments
path: ../docs/evaluation/log_experiments_with_rest_api.mdx
slug: log_experiments_with_rest_api
- page: Re-running an existing experiment
path: ../docs/evaluation/update_existing_experiment.mdx
slug: update_existing_experiment
- page: Annotation Queues
path: ../docs/evaluation/annotation_queues.mdx
slug: annotation_queues
- section: Metrics
slug: /metrics
contents:
- page: Overview
path: ../docs/evaluation/metrics/overview.mdx
slug: overview
- page: Heuristic metrics
path: ../docs/evaluation/metrics/heuristic_metrics.mdx
slug: heuristic_metrics
- page: Hallucination
path: ../docs/evaluation/metrics/hallucination.mdx
slug: hallucination
- page: LLM Juries
path: ../docs/evaluation/metrics/llm_juries.mdx
slug: llm_juries
- page: G-Eval
path: ../docs/evaluation/metrics/g_eval.mdx
slug: g_eval
- page: Conversation-level GEval
path: ../docs/evaluation/metrics/g_eval_conversation_metrics.mdx
slug: g_eval_conversation_metrics
- page: Compliance risk
path: ../docs/evaluation/metrics/compliance_risk.mdx
slug: compliance_risk
- page: Prompt uncertainty
path: ../docs/evaluation/metrics/prompt_diagnostics.mdx
slug: prompt_diagnostics
- page: Moderation
path: ../docs/evaluation/metrics/moderation.mdx
slug: moderation
- page: Meaning Match
path: ../docs/evaluation/metrics/meaning_match.mdx
slug: meaning_match
- page: Usefulness
path: ../docs/evaluation/metrics/usefulness.mdx
slug: usefulness
- page: Summarization consistency
path: ../docs/evaluation/metrics/summarization_consistency.mdx
slug: summarization_consistency
- page: Summarization coherence
path: ../docs/evaluation/metrics/summarization_coherence.mdx
slug: summarization_coherence
- page: Dialogue helpfulness
path: ../docs/evaluation/metrics/dialogue_helpfulness.mdx
slug: dialogue_helpfulness
- page: Answer relevance
path: ../docs/evaluation/metrics/answer_relevance.mdx
slug: answer_relevance
- page: Context precision
path: ../docs/evaluation/metrics/context_precision.mdx
slug: context_precision
- page: Context recall
path: ../docs/evaluation/metrics/context_recall.mdx
slug: context_recall
- page: Trajectory accuracy
path: ../docs/evaluation/metrics/trajectory_accuracy.mdx
slug: trajectory_accuracy
- page: Agent task completion
path: ../docs/evaluation/metrics/agent_task_completion.mdx
slug: agent_task_completion
- page: Agent tool correctness
path: ../docs/evaluation/metrics/agent_tool_correctness.mdx
slug: agent_tool_correctness
- page: Conversational metrics
path: ../docs/evaluation/metrics/conversation_threads_metrics.mdx
slug: conversation_threads_metrics
- page: Custom model
path: ../docs/evaluation/metrics/custom_model.mdx
slug: custom_model
- page: Advanced configuration
path: ../docs/evaluation/metrics/advanced_configuration.mdx
slug: advanced_configuration
- page: Custom metric
path: ../docs/evaluation/metrics/custom_metric.mdx
slug: custom_metric
- page: Custom conversation metric
path: ../docs/evaluation/metrics/custom_conversation_metric.mdx
slug: custom_conversation_metric
- page: Structured Output Compliance
path: ../docs/evaluation/metrics/structure_output_compliance.mdx
slug: structure_output_compliance
- page: Task span metrics
path: ../docs/evaluation/metrics/task_span_metrics.mdx
slug: task_span_metrics
- section: Tutorials
skip-slug: true
collapsed: true
contents:
- page: Best practices for evaluating agents
path: ../docs/evaluation/evaluate_agents.mdx
slug: evaluate_agents
- page: Evaluate threads
path: ../docs/evaluation/evaluate_threads.mdx
slug: evaluate_threads
- page: Cookbook - Evaluate hallucination metric
path: ../docs/cookbook/evaluate_hallucination_metric.mdx
slug: evaluate_hallucination_metric
- page: Cookbook - Evaluate moderation metric
path: ../docs/cookbook/evaluate_moderation_metric.mdx
slug: evaluate_moderation_metric
- section: Prompt engineering
slug: /prompt_engineering
contents:
- page: Prompt management
path: ../docs/prompt_engineering/prompt_management.mdx
slug: prompt_management
- page: Prompt Playground
path: ../docs/prompt_engineering/playground.mdx
slug: playground
- page: Prompt Generator and Improver
path: ../docs/prompt_engineering/improve.mdx
slug: improve
- page: Opik's MCP server
path: ../docs/prompt_engineering/mcp_server.mdx
slug: mcp_server
- section: Testing
slug: /testing
contents:
- page: Pytest integration
path: ../docs/testing/pytest_integration.mdx
slug: pytest_integration
- section: Production
slug: /production
contents:
- page: Production monitoring
path: ../docs/production/production_monitoring.mdx
slug: /production_monitoring
- page: Online Evaluation rules
path: ../docs/production/rules.mdx
slug: rules
- page: Gateway
path: ../docs/production/gateway.mdx
slug: gateway
- page: Guardrails
path: ../docs/production/guardrails.mdx
slug: guardrails
- page: Anonymizers
path: ../docs/production/anonymizers.mdx
slug: anonymizers
- page: Alerts
path: ../docs/production/alerts.mdx
slug: alerts
- page: Dashboards
path: ../docs/production/dashboards.mdx
slug: dashboards
- section: Administration
slug: /administration
contents:
- page: Overview
path: ../docs/administration/overview.mdx
slug: overview
- page: Roles and Permissions
path: ../docs/administration/roles_and_permissions.mdx
slug: roles_and_permissions
- section: Workspace Settings
slug: /workspace-settings
contents:
- page: Overview
path: ../docs/administration/workspace-settings/overview.mdx
slug: overview
- page: Feedback Definitions
path: ../docs/administration/workspace-settings/feedback_definitions.mdx
slug: feedback_definitions
- page: AI Providers
path: ../docs/administration/workspace-settings/ai_providers.mdx
slug: ai_providers
- page: Workspace Preferences
path: ../docs/administration/workspace-settings/workspace_preferences.mdx
slug: workspace_preferences
- page: Workspace Members
path: ../docs/administration/workspace-settings/workspace_members.mdx
slug: workspace_members
- section: Admin Dashboard
slug: /admin-dashboard
contents:
- page: Overview
path: ../docs/administration/admin-dashboard/overview.mdx
slug: overview
- page: Workspaces
path: ../docs/administration/admin-dashboard/workspaces.mdx
slug: workspaces
- page: Users
path: ../docs/administration/admin-dashboard/users.mdx
slug: users
- page: Organization Settings
path: ../docs/administration/admin-dashboard/organization_settings.mdx
slug: organization_settings
- page: Service Accounts
path: ../docs/administration/admin-dashboard/service_accounts.mdx
slug: service_accounts
- section: Authentication
slug: /authentication
contents:
- page: Overview
path: ../docs/administration/authentication/overview.mdx
slug: overview
- page: SAML SSO
path: ../docs/administration/authentication/saml.mdx
slug: saml
- page: OIDC SSO
path: ../docs/administration/authentication/oidc.mdx
slug: oidc
- page: JWT Authentication
path: ../docs/administration/authentication/jwt.mdx
slug: jwt
- section: Contributing
slug: /contributing
contents:
- page: Contribution Overview
path: ../docs/contributing/overview.mdx
slug: overview
icon: fa-regular fa-compass
- section: Specific Contribution Guides
slug: /guides
contents:
- page: Documentation
path: ../docs/contributing/documentation.mdx
slug: documentation
icon: fa-regular fa-book
- page: Local Development Setup
path: ../docs/contributing/local-development.mdx
slug: local-development
icon: fa-regular fa-laptop-code
- page: Python SDK
path: ../docs/contributing/python-sdk.mdx
slug: python-sdk
icon: fa-brands fa-python
- page: TypeScript SDK
path: ../docs/contributing/typescript-sdk.mdx
slug: typescript-sdk
icon: fa-brands fa-js
- page: Opik Optimizer
path: ../docs/contributing/agent-optimizer-sdk.mdx
slug: agent-optimizer-sdk
icon: fa-regular fa-gauge-high
- page: Frontend
path: ../docs/contributing/frontend.mdx
slug: frontend
icon: fa-regular fa-window-maximize
- page: Backend
path: ../docs/contributing/backend.mdx
slug: backend
icon: fa-regular fa-server
- section: Developer Programs
slug: /developer-programs
contents:
- page: Bounty Program
path: ../docs/contributing/bounties.mdx
slug: bounties
icon: fa-regular fa-gem
- tab: integrations
layout:
- page: Overview
path: ../docs/tracing/integrations/overview.mdx
slug: overview
- section: TypeScript
skip-slug: true
icon: fa-brands fa-js
contents:
- section: Frameworks
skip-slug: true
contents:
- page: BeeAI
path: ../docs/tracing/integrations/beeai-typescript.mdx
slug: beeai-typescript
- page: LangChain
path: ../docs/tracing/integrations/langchainjs.mdx
slug: langchainjs
- page: Mastra
path: ../docs/tracing/integrations/mastra.mdx
slug: mastra
- page: Vercel AI SDK
path: ../docs/tracing/integrations/vercel-ai-sdk.mdx
slug: vercel-ai-sdk
- section: Model Providers
skip-slug: true
contents:
- page: Cloudflare Workers AI
path: ../docs/tracing/integrations/cloudflare-workers-ai.mdx
slug: cloudflare-workers-ai
- page: Gemini
path: ../docs/tracing/integrations/gemini-typescript.mdx
slug: gemini-typescript
- page: OpenAI
path: ../docs/tracing/integrations/openai-typescript.mdx
slug: openai-typescript
- page: Opik TypeScript SDK
path: ../docs/reference/typescript-sdk/overview.mdx
slug: typescript-sdk
- section: Python
skip-slug: true
icon: fa-brands fa-python
contents:
- section: Frameworks
skip-slug: true
contents:
- page: AG2
path: ../docs/tracing/integrations/ag2.mdx
slug: ag2
- page: Agent Spec
path: ../docs/tracing/integrations/agentspec.mdx
slug: agentspec
- page: Agno
path: ../docs/tracing/integrations/agno.mdx
slug: agno
- page: BeeAI
path: ../docs/tracing/integrations/beeai.mdx
slug: beeai
- page: Claude Agent SDK
path: ../docs/tracing/integrations/claude-agent-sdk.mdx
slug: claude-agent-sdk
- page: Autogen
path: ../docs/tracing/integrations/autogen.mdx
slug: autogen
- page: CrewAI
path: ../docs/tracing/integrations/crewai.mdx
slug: crewai
- page: DSPy
path: ../docs/tracing/integrations/dspy.mdx
slug: dspy
- page: Google ADK
path: ../docs/tracing/integrations/adk.mdx
slug: adk
- page: Haystack
path: ../docs/tracing/integrations/haystack.mdx
slug: haystack
- page: Harbor
path: ../docs/tracing/integrations/harbor.mdx
slug: harbor
- page: Instructor
path: ../docs/tracing/integrations/instructor.mdx
slug: instructor
- page: LangChain
path: ../docs/tracing/integrations/langchain.mdx
slug: langchain
- page: LangGraph
path: ../docs/tracing/integrations/langgraph.mdx
slug: langgraph
- page: LangServe
path: ../docs/tracing/integrations/langserve.mdx
slug: langserve
- page: LiveKit Agents
path: ../docs/tracing/integrations/livekit.mdx
slug: livekit
- page: Llama Index
path: ../docs/tracing/integrations/llama_index.mdx
slug: llama_index
- page: Microsoft Agent Framework
path: ../docs/tracing/integrations/microsoft-agent-framework.mdx
slug: microsoft-agent-framework
- page: OpenAI Agents
path: ../docs/tracing/integrations/openai_agents.mdx
slug: openai_agents
- page: Pipecat
path: ../docs/tracing/integrations/pipecat.mdx
slug: pipecat
- page: Pydantic AI
path: ../docs/tracing/integrations/pydantic-ai.mdx
slug: pydantic-ai
- page: Semantic Kernel
path: ../docs/tracing/integrations/semantic-kernel.mdx
slug: semantic-kernel
- page: Smolagents
path: ../docs/tracing/integrations/smolagents.mdx
slug: smolagents
- page: Strands Agents
path: ../docs/tracing/integrations/strands-agents.mdx
slug: strands-agents
- page: Temporal
path: ../docs/tracing/integrations/temporal.mdx
slug: temporal
- page: VoltAgent
path: ../docs/tracing/integrations/voltagent.mdx
slug: voltagent
- section: Model Providers
skip-slug: true
contents:
- page: Anthropic
path: ../docs/tracing/integrations/anthropic.mdx
slug: anthropic
- page: Bedrock
path: ../docs/tracing/integrations/bedrock.mdx
slug: bedrock
- page: BytePlus
path: ../docs/tracing/integrations/byteplus.mdx
slug: byteplus
- page: Cohere
path: ../docs/tracing/integrations/cohere.mdx
slug: cohere
- page: DeepSeek
path: ../docs/tracing/integrations/deepseek.mdx
slug: deepseek
- page: Fireworks AI
path: ../docs/tracing/integrations/fireworks-ai.mdx
slug: fireworks-ai
- page: Gemini
path: ../docs/tracing/integrations/gemini.mdx
slug: gemini
- page: Groq
path: ../docs/tracing/integrations/groq.mdx
slug: groq
- page: Mistral AI
path: ../docs/tracing/integrations/mistral.mdx
slug: mistral
- page: Novita AI
path: ../docs/tracing/integrations/novita-ai.mdx
slug: novita-ai
- page: Ollama
path: ../docs/tracing/integrations/ollama.mdx
slug: ollama
- page: OpenAI
path: ../docs/tracing/integrations/openai.mdx
slug: openai
- page: Qianfan
path: ../docs/tracing/integrations/qianfan.mdx
slug: qianfan
- page: Predibase
path: ../docs/tracing/integrations/predibase.mdx
slug: predibase
- page: Together AI
path: ../docs/tracing/integrations/together-ai.mdx
slug: together-ai
- page: WatsonX
path: ../docs/tracing/integrations/watsonx.mdx
slug: watsonx
- page: xAI Grok
path: ../docs/tracing/integrations/xai-grok.mdx
slug: xai-grok
- section: Dataset Management
skip-slug: true
contents:
- page: Hugging Face Datasets
path: ../docs/tracing/integrations/huggingface-datasets.mdx
slug: huggingface-datasets
- section: Evaluation
skip-slug: true
contents:
- page: Ragas
path: ../docs/tracing/integrations/ragas.mdx
slug: ragas
- section: Gateways
skip-slug: true
contents:
- page: Opik LLM Gateway
path: ../docs/tracing/integrations/opik-llm-gateway.mdx
slug: opik-llm-gateway
- page: Kong AI Gateway
path: ../docs/tracing/integrations/kong-ai-gateway.mdx
slug: kong-ai-gateway
- page: AISuite
path: ../docs/tracing/integrations/aisuite.mdx
slug: aisuite
- page: Anannas AI
path: ../docs/tracing/integrations/anannas.mdx
slug: anannas
- page: Helicone
path: ../docs/tracing/integrations/helicone.mdx
slug: helicone
- page: LiteLLM
path: ../docs/tracing/integrations/litellm.mdx
slug: litellm
- page: OpenRouter
path: ../docs/tracing/integrations/openrouter.mdx
slug: openrouter
- page: Portkey
path: ../docs/tracing/integrations/portkey.mdx
slug: portkey
- page: TrueFoundry
path: ../docs/tracing/integrations/truefoundry.mdx
slug: truefoundry
- page: Vercel AI Gateway
path: ../docs/tracing/integrations/vercel-ai-gateway.mdx
slug: vercel-ai-gateway
- section: Other
skip-slug: true
contents:
- page: Guardrails AI
path: ../docs/tracing/integrations/guardrails-ai.mdx
slug: guardrails-ai
- page: Opik Python SDK
path: ../docs/reference/python-sdk/overview.mdx
slug: python-sdk
- page: OpenTelemetry Python SDK
path: ../docs/tracing/opentelemetry/python-sdk.mdx
slug: opentelemetry-python-sdk
- section: Java
skip-slug: true
icon: fa-brands fa-java
contents:
- page: Spring AI
path: ../docs/tracing/integrations/spring-ai.mdx
slug: spring-ai
- page: Quarkus LangChain4j
path: ../docs/tracing/integrations/quarkus-langchain4j.mdx
slug: quarkus-langchain4j
- section: .NET
skip-slug: true
icon: fa-solid fa-code
contents:
- section: Frameworks
skip-slug: true
contents:
- page: Microsoft Agent Framework
path: ../docs/tracing/integrations/microsoft-agent-framework-dotnet.mdx
slug: microsoft-agent-framework-dotnet
- section: Ruby
skip-slug: true
icon: fa-solid fa-gem
contents:
- page: OpenTelemetry Ruby SDK
path: ../docs/reference/ruby-otel-sdk/overview.mdx
slug: opentelemetry-ruby-sdk
- section: No-Code
skip-slug: true
icon: fa-solid fa-wand-magic-sparkles
contents:
- page: Cursor
path: ../docs/tracing/integrations/cursor.mdx
slug: cursor
- page: Dify
path: ../docs/tracing/integrations/dify.mdx
slug: dify
- page: Flowise
path: ../docs/tracing/integrations/flowise.mdx
slug: flowise
- page: Langflow
path: ../docs/tracing/integrations/langflow.mdx
slug: langflow
- page: n8n
path: ../docs/tracing/integrations/n8n.mdx
slug: n8n
- page: OpenClaw
path: ../docs/tracing/integrations/openclaw.mdx
slug: openclaw
- page: OpenAI Codex
path: ../docs/tracing/integrations/openai-codex.mdx
slug: openai-codex
- page: OpenWebUI
path: ../docs/tracing/integrations/openwebui.mdx
slug: openwebui
- page: Prompt Flow
path: ../docs/tracing/integrations/prompt-flow.mdx
slug: prompt-flow
- section: Multi-Language
skip-slug: true
icon: fa-solid fa-globe
contents:
- page: OpenTelemetry
path: ../docs/tracing/opentelemetry/overview.mdx
slug: opentelemetry
- tab: agent-optimization
layout:
- section: Getting Started
skip-slug: true
contents:
- page: Opik Agent Optimizer
icon: fa-regular fa-house
path: ../docs/agent_optimization/overview.mdx
slug: overview
- page: Optimization Studio
icon: fa-regular fa-window-maximize
path: ../docs/agent_optimization/optimization/optimization_studio.mdx
slug: optimization_studio
- page: Quickstart
icon: fa-regular fa-bolt
path: ../docs/agent_optimization/getting_started/quickstart.mdx
slug: quickstart
- page: Quickstart notebook
icon: fa-regular fa-play
path: ../docs/agent_optimization/cookbook/optimizer_introduction_cookbook.mdx
slug: quickstart_notebook
- page: FAQ
icon: fa-regular fa-question
path: ../docs/agent_optimization/opik_optimizer/faq.mdx
slug: faq
- page: Changelog
icon: fa-regular fa-calendar
path: ../docs/agent_optimization/getting_started/changelog.mdx
slug: changelog
- page: Known Issues
icon: fa-regular fa-triangle-exclamation
path: ../docs/agent_optimization/known_issues.mdx
slug: known_issues
- section: Optimization
slug: /optimization
contents:
- page: Concepts
icon: fa-regular fa-lightbulb
path: ../docs/agent_optimization/opik_optimizer/concepts.mdx
slug: concepts
- page: Configure LLM Providers
icon: fa-regular fa-gear
path: ../docs/agent_optimization/opik_optimizer/configure_models.mdx
slug: configure_models
- page: Define datasets
icon: fa-regular fa-database
path: ../docs/agent_optimization/optimization/define_datasets.mdx
slug: define_datasets
- page: Define metrics
icon: fa-regular fa-chart-line
path: ../docs/agent_optimization/optimization/define_metrics.mdx
slug: define_metrics
- page: Optimize prompts
icon: fa-regular fa-wand-magic-sparkles
path: ../docs/agent_optimization/optimization/optimize_prompts.mdx
slug: optimize_prompts
- page: Optimize tools (MCP)
icon: fa-regular fa-wand-magic-sparkles
path: ../docs/agent_optimization/optimization/optimize_tools.mdx
slug: optimize_tools
- page: Optimize agents
icon: fa-regular fa-diagram-project
path: ../docs/agent_optimization/optimization/optimize_agents/overview.mdx
slug: optimize_agents
- page: Optimize multimodal
icon: fa-regular fa-image
path: ../docs/agent_optimization/optimization/optimize_multimodal.mdx
slug: optimize_multimodal
- page: Dashboard results
icon: fa-regular fa-chart-simple
path: ../docs/agent_optimization/optimization/dashboard_results.mdx
slug: dashboard_results
- section: Optimization Algorithms
slug: /algorithms
contents:
- page: Overview
icon: fa-regular fa-list
path: ../docs/agent_optimization/algorithms/overview.mdx
slug: overview
- page: Benchmarks
icon: fa-regular fa-chart-line
path: ../docs/agent_optimization/algorithms/benchmarks.mdx
slug: benchmarks
- page: MetaPrompt
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/metaprompt_optimizer.mdx
slug: metaprompt_optimizer
- page: HRPO
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/hierarchical_reflective_optimizer.mdx
slug: hierarchical_adaptive_optimizer
- page: Few-Shot Bayesian
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/fewshot_bayesian_optimizer.mdx
slug: fewshot_bayesian_optimizer
- page: Evolutionary
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/evolutionary_optimizer.mdx
slug: evolutionary_optimizer
- page: GEPA
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/gepa_optimizer.mdx
slug: gepa_optimizer
- page: Parameter
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/parameter_optimizer.mdx
slug: parameter_optimizer
- page: Tool Optimization
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/tool_optimization.mdx
slug: tool_optimization
- section: Cookbooks & Tutorials
slug: /cookbooks
contents:
- page: Optimizer introduction
icon: fa-regular fa-book
path: ../docs/agent_optimization/cookbook/optimizer_introduction_cookbook.mdx
slug: optimizer_introduction_cookbook
- page: Synthetic data optimizer
icon: fa-regular fa-book
path: ../docs/agent_optimization/cookbook/synthetic_data_optimizer_cookbook.mdx
slug: synthetic_data_optimizer_cookbook
- page: ARC-AGI tutorial
icon: fa-regular fa-book
path: ../docs/agent_optimization/cookbook/arc_agi_optimizer_cookbook.mdx
slug: arc_agi_optimizer_cookbook
- page: Multimodal agent tutorial
icon: fa-regular fa-book
path: ../docs/agent_optimization/cookbook/multimodal_agent_optimizer_cookbook.mdx
slug: multimodal_agent_optimizer_cookbook
- section: Advanced Topics
slug: /advanced
contents:
- page: Extending optimizers
icon: fa-regular fa-puzzle-piece
path: ../docs/agent_optimization/algorithms/extending_optimizers.mdx
slug: extending_optimizers
- page: Custom metrics
icon: fa-regular fa-sliders
path: ../docs/agent_optimization/advanced/custom_metrics.mdx
slug: custom_metrics
- page: Custom optimizer prompts
icon: fa-regular fa-pen-to-square
path: ../docs/agent_optimization/advanced/prompt_customization.mdx
slug: prompt_customization
- page: Sampling controls
icon: fa-regular fa-scale-balanced
path: ../docs/agent_optimization/advanced/n_samples.mdx
slug: n_samples
- page: Multiple completions (n)
icon: fa-regular fa-code-fork
path: ../docs/agent_optimization/advanced/multiple_completions.mdx
slug: multiple_completions
- page: Chaining optimizers
icon: fa-regular fa-objects-align-bottom
path: ../docs/agent_optimization/advanced/chaining_optimizers.mdx
slug: chaining_optimizers
- page: API Reference
icon: fa-regular fa-square-terminal
path: ../docs/agent_optimization/opik_optimizer/reference.mdx
slug: api_reference
- tab: self-host
layout:
- page: Overview
path: ../docs/self-host/overview.mdx
slug: overview
- page: Local deployment
path: ../docs/self-host/local_deployment.mdx
slug: local_deployment
- page: Kubernetes deployment
path: ../docs/self-host/kubernetes.mdx
slug: kubernetes
- page: Helm chart migration
path: ../docs/self-host/helm.mdx
slug: helm
- page: Platform Architecture
path: ../docs/self-host/architecture.mdx
slug: architecture
- page: Scaling Opik
path: ../docs/self-host/scaling.mdx
slug: scaling
- page: Advanced clickhouse backup
path: ../docs/self-host/backup.mdx
slug: backup
- page: Troubleshooting
path: ../docs/self-host/troubleshooting.mdx
slug: troubleshooting
- section: Configuration
slug: /configure
contents:
- page: Anonymous usage statistics
path: ../docs/self-host/configure/anonymous_usage_statistics.mdx
slug: anonymous_usage_statistics
- page: Large CSV uploads
path: ../docs/self-host/configure/large_csv_uploads.mdx
slug: large_csv_uploads
- page: Dataset versioning migration
path: ../docs/self-host/configure/dataset_versioning_migration.mdx
slug: dataset_versioning_migration
- page: LLM model registry
path: ../docs/self-host/configure/llm-model-registry.mdx
slug: llm-model-registry
- tab: reference
layout:
- page: Overview
path: ../docs/reference/overview.mdx
slug: overview
- section: Python SDK
slug: python-sdk
contents:
- link: Reference
href: https://www.comet.com/docs/opik/python-sdk-reference/
- page: REST API Client
path: ../docs/reference/python-sdk/rest-api.mdx
slug: rest-api
- section: Troubleshooting
slug: troubleshooting
contents:
- page: Batching and updates
path: ../docs/reference/python-sdk/troubleshooting/batching-and-updates.mdx
slug: batching-and-updates
- section: Typescript SDK
slug: typescript-sdk
contents:
- page: Overview
path: ../docs/reference/typescript-sdk/overview.mdx
slug: overview
- page: Opik TS
path: ../docs/reference/typescript-sdk/opik-ts.mdx
slug: opik-ts
- page: Prompts
path: ../docs/reference/typescript-sdk/prompts.mdx
slug: prompts
- page: Opik Query Language (OQL)
path: ../docs/reference/typescript-sdk/opik-query-language.mdx
slug: opik-query-language
- section: Evaluation
slug: evaluation
contents:
- page: Overview
path: ../docs/reference/typescript-sdk/evaluation/overview.mdx
slug: overview
- page: Quick Start
path: ../docs/reference/typescript-sdk/evaluation/quick-start.mdx
slug: quick-start
- page: Datasets
path: ../docs/reference/typescript-sdk/evaluation/datasets.mdx
slug: datasets
- page: Evaluate Function
path: ../docs/reference/typescript-sdk/evaluation/evaluate.mdx
slug: evaluate_function
- page: Evaluate Prompt Function
path: ../docs/reference/typescript-sdk/evaluation/evaluatePrompt.mdx
slug: evaluate_prompt_function
- page: Models
path: ../docs/reference/typescript-sdk/evaluation/models.mdx
slug: models
- page: Metrics
path: ../docs/reference/typescript-sdk/evaluation/metrics.mdx
slug: metrics
- page: Experiments
path: ../docs/reference/typescript-sdk/evaluation/experiments.mdx
slug: experiments
- section: Rest API
slug: rest-api
contents:
- page: Overview
path: ../docs/reference/rest-api/overview.mdx
slug: overview
- api: API Reference
slug: /
display-errors: true
- tab: opik-university
layout:
- page: Overview
path: ../docs/opik-university/overview.mdx
slug: overview
icon: fa-regular fa-graduation-cap
- section: Intro
slug: /intro
contents:
- page: Opik Overview
path: ../docs/opik-university/1_intro/1.1-intro-opik-overview.mdx
slug: opik-overview
- page: Next steps / Set expectations
path: ../docs/opik-university/1_intro/1.2-intro-next-steps-set-expectations.mdx
slug: next-steps
- section: Observability
slug: /observability
contents:
- page: Log Traces
path: ../docs/opik-university/2_observability/2.1-observability-log-traces.mdx
slug: log-traces
- page: Annotate Traces
path: ../docs/opik-university/2_observability/2.2-observability-annotate-traces.mdx
slug: annotate-traces
- section: Evaluation
slug: /evaluation
contents:
- page: Evaluation Concepts and Overview
path: ../docs/opik-university/3_evaluation/3.1-evaluation-concepts-overview.mdx
slug: concepts-overview
- page: Create Evaluation Datasets
path: ../docs/opik-university/3_evaluation/3.2-evaluation-create-datasets.mdx
slug: create-datasets
- page: Define Evaluation Metrics
path: ../docs/opik-university/3_evaluation/3.3-evaluation-define-metrics.mdx
slug: define-metrics
- page: Evaluate your LLM Application
path: ../docs/opik-university/3_evaluation/3.4-evaluation-evaluate-llm-application.mdx
slug: evaluate-llm-app
- page: No-code LLM Evaluation Workflow
path: ../docs/opik-university/3_evaluation/3.5-evaluation-ui-workflow.mdx
slug: evaluation-ui-workflow
- section: Prompt Engineering
slug: /prompt-engineering
contents:
- page: Prompt Management
path: ../docs/opik-university/4_prompt-engineering/4.1-prompt-engineering-management.mdx
slug: prompt-management
- page: Prompt Playground
path: ../docs/opik-university/4_prompt-engineering/4.2-prompt-engineering-playground.mdx
slug: prompt-playground
- section: Testing
slug: /testing
contents:
- page: PyTest Integration
path: ../docs/opik-university/5_testing/5.1-testing-pytest-integration.mdx
slug: pytest-integration
- section: Production Monitoring
slug: /production-monitoring
contents:
- page: Online Evaluation Rules
path: ../docs/opik-university/6_production-monitoring/6.1-production-monitoring-online-evaluation-rules.mdx
slug: online-evaluation-rules