Entities

Submodules

• Agentic App
  • AgenticApp
    • AgenticApp.metrics_configuration
    • AgenticApp.name
    • AgenticApp.nodes
    • AgenticApp.model_validate_json()
  • MetricsConfiguration
    • MetricsConfiguration.configuration
    • MetricsConfiguration.metric_groups
    • MetricsConfiguration.metrics
    • MetricsConfiguration.metrics_serializer()
    • MetricsConfiguration.model_validate()
  • Node
    • Node.foundation_models
    • Node.func_name
    • Node.metrics_configurations
    • Node.name
    • Node.model_validate()
• AI Evaluation
  • AIEvaluationAsset
    • AIEvaluationAsset.asset_details
    • AIEvaluationAsset.asset_id
    • AIEvaluationAsset.asset_type
    • AIEvaluationAsset.container_id
    • AIEvaluationAsset.container_name
    • AIEvaluationAsset.container_type
    • AIEvaluationAsset.created_at
    • AIEvaluationAsset.creator_id
    • AIEvaluationAsset.description
    • AIEvaluationAsset.evaluation_configuration
    • AIEvaluationAsset.href
    • AIEvaluationAsset.name
    • AIEvaluationAsset.owner_id
    • AIEvaluationAsset.to_json()
  • EvaluationAsset
    • EvaluationAsset.attachment_id
    • EvaluationAsset.container_id
    • EvaluationAsset.container_type
    • EvaluationAsset.id
    • EvaluationAsset.name
    • EvaluationAsset.nodes
    • EvaluationAsset.run_id
    • EvaluationAsset.run_name
    • EvaluationAsset.test_data
  • EvaluationConfig
    • EvaluationConfig.evaluation_assets
    • EvaluationConfig.monitors
• AI Experiment
  • AIExperiment
    • AIExperiment.asset_id
    • AIExperiment.asset_type
    • AIExperiment.component_id
    • AIExperiment.component_name
    • AIExperiment.component_type
    • AIExperiment.container_id
    • AIExperiment.container_name
    • AIExperiment.container_type
    • AIExperiment.created_at
    • AIExperiment.creator_id
    • AIExperiment.description
    • AIExperiment.name
    • AIExperiment.owner_id
    • AIExperiment.runs
    • AIExperiment.to_json()
  • AIExperimentRun
    • AIExperimentRun.agent_method_name
    • AIExperimentRun.attachment_id
    • AIExperimentRun.created_at
    • AIExperimentRun.created_by
    • AIExperimentRun.custom_tags
    • AIExperimentRun.description
    • AIExperimentRun.duration
    • AIExperimentRun.id_deleted
    • AIExperimentRun.nodes
    • AIExperimentRun.properties
    • AIExperimentRun.run_id
    • AIExperimentRun.run_name
    • AIExperimentRun.source_name
    • AIExperimentRun.source_url
    • AIExperimentRun.test_data
    • AIExperimentRun.tracked
    • AIExperimentRun.to_json()
  • AIExperimentRunRequest
    • AIExperimentRunRequest.agent_method_name
    • AIExperimentRunRequest.custom_tags
    • AIExperimentRunRequest.description
    • AIExperimentRunRequest.name
    • AIExperimentRunRequest.source_name
    • AIExperimentRunRequest.source_url
  • Node
    • Node.foundation_models
    • Node.id
    • Node.name
    • Node.type
    • Node.convert_foundation_models()
    • Node.to_json()
• Base Classes
  • BaseConfiguration
    • BaseConfiguration.record_id_field
    • BaseConfiguration.record_timestamp_field
  • BaseMetric
    • BaseMetric.name
    • BaseMetric.model_post_init()
    • BaseMetric.id
  • BaseMetricGroup
    • BaseMetricGroup.name
    • BaseMetricGroup.model_post_init()
    • BaseMetricGroup.metrics
  • BaseMetricResult
    • BaseMetricResult.additional_info
    • BaseMetricResult.errors
    • BaseMetricResult.group
    • BaseMetricResult.method
    • BaseMetricResult.name
    • BaseMetricResult.provider
    • BaseMetricResult.thresholds
    • BaseMetricResult.value
  • Error
    • Error.code
    • Error.message_en
    • Error.parameters
• Container
  • BaseContainer
    • BaseContainer.container_id
    • BaseContainer.container_type
    • BaseContainer.monitors
    • BaseContainer.prompt_setup
    • BaseContainer.stage
  • ProjectContainer
    • ProjectContainer.container_type
    • ProjectContainer.stage
  • SpaceContainer
    • SpaceContainer.base_model_id
    • SpaceContainer.container_type
    • SpaceContainer.description
    • SpaceContainer.name
    • SpaceContainer.serving_name
    • SpaceContainer.stage
    • SpaceContainer.version_date
• Credentials
  • AzureOpenAICredentials
    • AzureOpenAICredentials.api_key
    • AzureOpenAICredentials.api_version
    • AzureOpenAICredentials.url
    • AzureOpenAICredentials.create_from_env()
  • Credentials
    • Credentials.api_key
    • Credentials.disable_ssl
    • Credentials.password
    • Credentials.region
    • Credentials.service_instance_id
    • Credentials.url
    • Credentials.username
    • Credentials.version
    • Credentials.create_from_env()
    • Credentials.validate_credentials
  • OpenAICredentials
    • OpenAICredentials.api_key
    • OpenAICredentials.url
    • OpenAICredentials.create_from_env()
  • RITSCredentials
    • RITSCredentials.api_key
    • RITSCredentials.hostname
    • RITSCredentials.create_from_env()
  • WxAICredentials
    • WxAICredentials.api_key
    • WxAICredentials.instance_id
    • WxAICredentials.password
    • WxAICredentials.url
    • WxAICredentials.username
    • WxAICredentials.version
    • WxAICredentials.create_from_env()
  • WxGovConsoleCredentials
    • WxGovConsoleCredentials.api_key
    • WxGovConsoleCredentials.password
    • WxGovConsoleCredentials.url
    • WxGovConsoleCredentials.username
    • WxGovConsoleCredentials.create_from_env()
• Enums
  • ContainerType
    • ContainerType.PROJECT
    • ContainerType.SPACE
  • EvaluationProvider
    • EvaluationProvider.DETECTORS
    • EvaluationProvider.UNITXT
    • EvaluationProvider.WATSONX_GOV
    • EvaluationProvider.values()
  • EvaluationStage
    • EvaluationStage.DEVELOPMENT
    • EvaluationStage.PRE_PRODUCTION
    • EvaluationStage.PRODUCTION
  • EvaluatorFields
    • EvaluatorFields.CONTEXT_FIELDS
    • EvaluatorFields.CONVERSATION_ID_FIELD
    • EvaluatorFields.INPUT_FIELDS
    • EvaluatorFields.INTERACTION_ID_FIELD
    • EvaluatorFields.OUTPUT_FIELDS
    • EvaluatorFields.PROMPT_FIELD
    • EvaluatorFields.RECORD_ID_FIELD
    • EvaluatorFields.RECORD_TIMESTAMP_FIELD
    • EvaluatorFields.REFERENCE_FIELDS
    • EvaluatorFields.TOOL_CALLS_FIELD
    • EvaluatorFields.get_default_fields_mapping()
  • GraniteGuardianRisks
    • GraniteGuardianRisks.ANSWER_RELEVANCE
    • GraniteGuardianRisks.CONTEXT_RELEVANCE
    • GraniteGuardianRisks.EVASIVENESS
    • GraniteGuardianRisks.FAITHFULNESS
    • GraniteGuardianRisks.HARM
    • GraniteGuardianRisks.HARM_ENGAGEMENT
    • GraniteGuardianRisks.JAILBREAK
    • GraniteGuardianRisks.PROFANITY
    • GraniteGuardianRisks.SEXUAL_CONTENT
    • GraniteGuardianRisks.SOCIAL_BIAS
    • GraniteGuardianRisks.TOOL_CALL_ACCURACY
    • GraniteGuardianRisks.UNETHICAL_BEHAVIOR
    • GraniteGuardianRisks.VIOLENCE
    • GraniteGuardianRisks.values()
  • InputDataType
    • InputDataType.IMAGE
    • InputDataType.MULTIMODAL
    • InputDataType.STRUCTURED
    • InputDataType.TEXT
  • MetricGroup
    • MetricGroup.ANSWER_QUALITY
    • MetricGroup.CONTENT_SAFETY
    • MetricGroup.PERFORMANCE
    • MetricGroup.READABILITY
    • MetricGroup.RETRIEVAL_QUALITY
    • MetricGroup.TOOL_CALL_QUALITY
    • MetricGroup.USAGE
    • MetricGroup.get_metrics()
  • MistakeType
    • MistakeType.ALLOWED_VALUES
    • MistakeType.HALLUCINATED_CALL
    • MistakeType.HALLUCINATED_PARAM
    • MistakeType.NEED_MORE_APIS
    • MistakeType.NEED_MORE_INFORMATION
    • MistakeType.NONE_FUNC
    • MistakeType.PARAM_TYPE
    • MistakeType.REQ_PARAM_MISSING
    • MistakeType.WRONG_API_SELECTION
    • MistakeType.WRONG_NUMBER_OF_APIS
    • MistakeType.WRONG_PARAMETER_VALUE
    • MistakeType.WRONG_UNITS_TRANSFORMATION
  • ModelProviderType
    • ModelProviderType.AZURE_OPENAI
    • ModelProviderType.CUSTOM
    • ModelProviderType.IBM_WATSONX_AI
    • ModelProviderType.OPENAI
    • ModelProviderType.RITS
  • ProblemType
    • ProblemType.BINARY
    • ProblemType.MULTICLASS
    • ProblemType.REGRESSION
  • Region
    • Region.AU_SYD
    • Region.CA_TOR
    • Region.EU_DE
    • Region.EU_GB
    • Region.JP_TOK
    • Region.US_SOUTH
    • Region.values()
  • TaskType
    • TaskType.CLASSIFICATION
    • TaskType.EXTRACTION
    • TaskType.GENERATION
    • TaskType.QA
    • TaskType.RAG
    • TaskType.SUMMARIZATION
    • TaskType.get_metrics()
    • TaskType.values()
• Evaluation Result
  • AgentMetricResult
    • AgentMetricResult.applies_to
    • AgentMetricResult.conversation_id
    • AgentMetricResult.execution_count
    • AgentMetricResult.execution_order
    • AgentMetricResult.id
    • AgentMetricResult.interaction_id
    • AgentMetricResult.interaction_ts
    • AgentMetricResult.node_name
    • AgentMetricResult.ts
  • AgenticEvaluationResult
    • AgenticEvaluationResult.aggregated_metrics_results
    • AgenticEvaluationResult.metrics_results
    • AgenticEvaluationResult.get_aggregated_metrics_results()
    • AgenticEvaluationResult.get_metrics_results()
    • AgenticEvaluationResult.to_df()
    • AgenticEvaluationResult.to_json()
  • AggregateAgentMetricResult
    • AggregateAgentMetricResult.applies_to
    • AggregateAgentMetricResult.count
    • AggregateAgentMetricResult.individual_results
    • AggregateAgentMetricResult.max
    • AggregateAgentMetricResult.mean
    • AggregateAgentMetricResult.min
    • AggregateAgentMetricResult.node_name
    • AggregateAgentMetricResult.value
  • AggregateMetricResult
    • AggregateMetricResult.max
    • AggregateMetricResult.mean
    • AggregateMetricResult.min
    • AggregateMetricResult.record_level_metrics
    • AggregateMetricResult.total_records
  • MetricsEvaluationResult
    • MetricsEvaluationResult.metrics_result
    • MetricsEvaluationResult.to_df()
    • MetricsEvaluationResult.to_dict()
    • MetricsEvaluationResult.to_json()
  • RecordMetricResult
    • RecordMetricResult.record_id
    • RecordMetricResult.record_timestamp
  • ToolMetricResult
    • ToolMetricResult.execution_count
    • ToolMetricResult.tool_name
• Foundation Model
  • AzureOpenAIFoundationModel
    • AzureOpenAIFoundationModel.model_id
    • AzureOpenAIFoundationModel.provider
  • CustomFoundationModel
    • CustomFoundationModel.provider
    • CustomFoundationModel.scoring_fn
  • FoundationModel
    • FoundationModel.model_name
    • FoundationModel.provider
  • FoundationModelInfo
    • FoundationModelInfo.model_id
    • FoundationModelInfo.model_name
    • FoundationModelInfo.provider
    • FoundationModelInfo.type
  • OpenAIFoundationModel
    • OpenAIFoundationModel.model_id
    • OpenAIFoundationModel.provider
  • RITSFoundationModel
    • RITSFoundationModel.provider
  • WxAIFoundationModel
    • WxAIFoundationModel.model_id
    • WxAIFoundationModel.project_id
    • WxAIFoundationModel.provider
    • WxAIFoundationModel.space_id
    • WxAIFoundationModel.get_params_from_env
• Llm Judge
  • LLMJudge
    • LLMJudge.model
    • LLMJudge.get_model_provider()
• Metric
  • GenAIMetric
    • GenAIMetric.group
    • GenAIMetric.is_reference_free
    • GenAIMetric.method
    • GenAIMetric.metric_dependencies
    • GenAIMetric.tasks
    • GenAIMetric.thresholds
    • GenAIMetric.evaluate()
    • GenAIMetric.evaluate_async()
    • GenAIMetric.get_aggregated_results_from_individual_results()
    • GenAIMetric.info()
    • GenAIMetric.metric_dependencies_serializer()
    • GenAIMetric.model_post_init()
    • GenAIMetric.id
  • Locale
    • Locale.input
    • Locale.output
    • Locale.reference
  • PredictiveAIMetric
    • PredictiveAIMetric.model_post_init()
• Metric Threshold
  • MetricThreshold
    • MetricThreshold.type
    • MetricThreshold.value
• Model Provider
  • AzureOpenAIModelProvider
    • AzureOpenAIModelProvider.credentials
    • AzureOpenAIModelProvider.type
    • AzureOpenAIModelProvider.create_credentials_from_env
  • CustomModelProvider
    • CustomModelProvider.type
    • CustomModelProvider.type
  • ModelProvider
    • ModelProvider.type
  • OpenAIModelProvider
    • OpenAIModelProvider.credentials
    • OpenAIModelProvider.type
    • OpenAIModelProvider.create_credentials_from_env
  • RITSModelProvider
    • RITSModelProvider.credentials
    • RITSModelProvider.type
    • RITSModelProvider.create_credentials_from_env
  • WxAIModelProvider
    • WxAIModelProvider.credentials
    • WxAIModelProvider.type
    • WxAIModelProvider.create_credentials_from_env
• Model Risk Result
  • Benchmark
    • Benchmark.metrics
    • Benchmark.name
    • Benchmark.get_metric_df()
  • ModelRiskResult
    • ModelRiskResult.output_file_path
    • ModelRiskResult.risks
    • ModelRiskResult.to_json()
  • Risk
    • Risk.benchmarks
    • Risk.name
  • RiskMetric
    • RiskMetric.name
    • RiskMetric.value
• Monitor
  • BaseMonitor
    • BaseMonitor.monitor_name
    • BaseMonitor.parameters
    • BaseMonitor.thresholds
  • DriftMonitor
    • DriftMonitor.monitor_name
  • DriftV2Monitor
    • DriftV2Monitor.monitor_name
  • FairnessMonitor
    • FairnessMonitor.monitor_name
  • GenerativeAIQualityMonitor
    • GenerativeAIQualityMonitor.monitor_name
    • GenerativeAIQualityMonitor.parameters
  • ModelHealthMonitor
    • ModelHealthMonitor.monitor_name
  • MonitorThreshold
    • MonitorThreshold.metric_id
  • QualityMonitor
    • QualityMonitor.monitor_name
    • QualityMonitor.parameters
• Prompt Setup
  • PromptSetup
    • PromptSetup.context_fields
    • PromptSetup.input_data_type
    • PromptSetup.label_column
    • PromptSetup.prediction_field
    • PromptSetup.question_field
    • PromptSetup.task_type
    • PromptSetup.require_context_and_question_columns_for_rag
• State
  • EvaluationState
    • EvaluationState.context
    • EvaluationState.generated_text
    • EvaluationState.ground_truth
    • EvaluationState.input_text
    • EvaluationState.interaction_id
    • EvaluationState.record_id
    • EvaluationState.record_timestamp