Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

IBM watsonx.governance SDK 1.2.0 documentation

Toggle table of contents sidebar

IBM watsonx.governance SDK 1.2.0 documentation

Installation

Setup
Toggle navigation of Setup
- IBM watsonx.governance as a service
- IBM watsonx.governance

API
Toggle navigation of API
- Config
  Toggle navigation of Config
- Entities
  Toggle navigation of Entities
- Metrics
  Toggle navigation of Metrics
  - Answer Relevance
    Toggle navigation of Answer Relevance
    - Answer Relevance Decorator
    - Answer Relevance Metric
  - Answer Similarity
    Toggle navigation of Answer Similarity
    - Answer Similarity Decorator
    - Answer Similarity Metric
  - Average Precision
    Toggle navigation of Average Precision
    - Average Precision Decorator
    - Average Precision Metric
  - Context Relevance
    Toggle navigation of Context Relevance
    - Context Relevance Decorator
    - Context Relevance Metric
  - Evasiveness
    Toggle navigation of Evasiveness
    - Evasiveness Decorator
    - Evasiveness Metric
  - Faithfulness
    Toggle navigation of Faithfulness
    - Faithfulness Decorator
    - Faithfulness Metric
  - Hap
    Toggle navigation of Hap
    - Hap Decorator
    - Hap Metric
  - Harm
    Toggle navigation of Harm
    - Harm Decorator
    - Harm Metric
  - Harm Engagement
    Toggle navigation of Harm Engagement
    - Harm Engagement Decorator
    - Harm Engagement Metric
  - Hit Rate
    Toggle navigation of Hit Rate
    - Hit Rate Decorator
    - Hit Rate Metric
  - Jailbreak
    Toggle navigation of Jailbreak
    - Jailbreak Decorator
    - Jailbreak Metric
  - NDCG
    Toggle navigation of NDCG
    - NDCG Decorator
    - NDCG Metric
  - Pii
    Toggle navigation of Pii
    - Pii Decorator
    - Pii Metric
  - Profanity
    Toggle navigation of Profanity
    - Profanity Decorator
    - Profanity Metric
  - Prompt Safety Risk
    Toggle navigation of Prompt Safety Risk
    - Prompt Safety Risk Decorator
    - Prompt Safety Risk Metric
  - Reciprocal Rank
    Toggle navigation of Reciprocal Rank
    - Reciprocal Rank Decorator
    - Reciprocal Rank Metric
  - Retrieval Precision
    Toggle navigation of Retrieval Precision
    - Retrieval Precision Decorator
    - Retrieval Precision Metric
  - Sexual Content
    Toggle navigation of Sexual Content
    - Sexual Content Decorator
    - Sexual Content Metric
  - Social Bias
    Toggle navigation of Social Bias
    - Social Bias Decorator
    - Social Bias Metric
  - Text Grade Level
    Toggle navigation of Text Grade Level
    - Text Grade Level Decorator
    - Text Grade Level Metric
  - Text Reading Ease
    Toggle navigation of Text Reading Ease
    - Text Reading Ease Decorator
    - Text Reading Ease Metric
  - Tool Call Accuracy
    Toggle navigation of Tool Call Accuracy
    - Tool Call Accuracy Decorator
    - Tool Call Accuracy Metric
  - Tool Call Parameter Accuracy
    Toggle navigation of Tool Call Parameter Accuracy
    - Tool Call Parameter Accuracy Decorator
    - Tool Call Parameter Accuracy Metric
  - Tool Call Relevance
    Toggle navigation of Tool Call Relevance
    - Tool Call Relevance Decorator
    - Tool Call Relevance Metric
  - Tool Call Syntactic Accuracy
    Toggle navigation of Tool Call Syntactic Accuracy
    - Tool Call Syntactic Accuracy Decorator
    - Tool Call Syntactic Accuracy Metric
  - Topic Relevance
    Toggle navigation of Topic Relevance
    - Topic Relevance Decorator
    - Topic Relevance Metric
  - Unethical Behavior
    Toggle navigation of Unethical Behavior
    - Unethical Behavior Decorator
    - Unethical Behavior Metric
  - Unsuccessful Requests
    Toggle navigation of Unsuccessful Requests
    - Unsuccessful Requests Decorator
    - Unsuccessful Requests Metric
  - Violence
    Toggle navigation of Violence
    - Violence Decorator
    - Violence Metric
  - Base Metric Decorator
- Visualizations
  Toggle navigation of Visualizations
- Prompt Evaluator
  Toggle navigation of Prompt Evaluator
  - Prompt Evaluator
- Evaluators
  Toggle navigation of Evaluators
- Tools
  Toggle navigation of Tools
  - Clients
    Toggle navigation of Clients
    - AI Tool Client
    - Detector Client
  - Core
    Toggle navigation of Core
    - Tool Loader
  - Entities
    Toggle navigation of Entities
    - AI Tools
  - Rest Api
    Toggle navigation of Rest Api
    - Restapi Tool
  - Utils
    Toggle navigation of Utils
- Agent Catalog
  Toggle navigation of Agent Catalog
  - Clients
    Toggle navigation of Clients
    - AI Agent Client
  - Core
    Toggle navigation of Core
    - Agent Loader
    - Agents
  - Entities
    Toggle navigation of Entities
    - AI Agent
  - Utils
    Toggle navigation of Utils
    - Constants
    - Notebook Utils

Toggle table of contents sidebar

Metric Descriptions¶

Copyright © 2025, IBM

Made with Sphinx and @pradyunsg's Furo