Trustwise SDK

Contents

  • Installation
    • Installing the SDK
    • Requirements
  • Platform API Client
    • Quickstart
    • Raw Envelope Access
    • Available Resources
    • Agents
    • Guardrails
    • Policies
    • Evaluations
    • Risk Engine
    • Generation (Red-Team)
    • Events
    • Subscriptions
    • Runtime Providers
    • Metrics
    • Full API Reference
  • Usage
    • Basic Setup (TrustwiseClient)
    • Legacy Setup (TrustwiseSDK)
    • Evaluating Metrics
      • Faithfulness Metric
    • Async Usage
    • Working with JSON Output
    • Working with Python Dict Output
    • Working with Result Properties
  • V4 Metrics
    • Adherence
      • metrics.adherence.evaluate()
    • Answer Relevancy
      • metrics.answer_relevancy.evaluate()
    • Clarity
      • metrics.clarity.evaluate()
    • Completion
      • metrics.completion.evaluate()
    • Context Relevancy
      • metrics.context_relevancy.evaluate()
    • Faithfulness
      • metrics.faithfulness.evaluate()
    • Formality
      • metrics.formality.evaluate()
    • Helpfulness
      • metrics.helpfulness.evaluate()
    • PII Detection
      • metrics.pii.evaluate()
    • Prompt Manipulation
      • metrics.prompt_manipulation.evaluate()
    • Refusal
      • metrics.refusal.evaluate()
    • Sensitivity
      • metrics.sensitivity.evaluate()
    • Stability
      • metrics.stability.evaluate()
    • Simplicity
      • metrics.simplicity.evaluate()
    • Tone
      • metrics.tone.evaluate()
    • Toxicity
      • metrics.toxicity.evaluate()
    • Carbon
      • metrics.carbon.evaluate()
  • API Reference
    • Platform Client (Recommended)
      • _parse()
      • TrustwiseClient
        • TrustwiseClient.__init__()
      • _list_params()
      • AgentResource
        • AgentResource.__init__()
        • AgentResource.list()
        • AgentResource.get()
        • AgentResource.create()
        • AgentResource.update()
        • AgentResource.delete()
        • AgentResource.query()
        • AgentResource.risk_classify()
        • AgentResource.add_policies()
        • AgentResource.deploy_gateway()
        • AgentResource.status_history()
        • AgentResource.update_status()
        • AgentResource.test_connection()
      • GatewayResource
        • GatewayResource.__init__()
        • GatewayResource.list_models()
        • GatewayResource.list_guardrails()
      • GuardrailResource
        • GuardrailResource.__init__()
        • GuardrailResource.list()
        • GuardrailResource.get()
        • GuardrailResource.create()
        • GuardrailResource.update()
        • GuardrailResource.delete()
        • GuardrailResource.evaluate()
        • GuardrailResource.list_evaluations()
        • GuardrailResource.get_evaluation()
        • GuardrailResource.providers()
        • GuardrailResource.provider_schemas()
        • GuardrailResource.provider_guardrails()
        • GuardrailResource.provider_regions()
      • PolicyResource
        • PolicyResource.__init__()
        • PolicyResource.list()
        • PolicyResource.get()
        • PolicyResource.create()
        • PolicyResource.update()
        • PolicyResource.delete()
        • PolicyResource.evaluate()
        • PolicyResource.recommend()
        • PolicyResource.evaluate_batch()
      • EvaluationResource
        • EvaluationResource.__init__()
        • EvaluationResource.list()
        • EvaluationResource.get()
        • EvaluationResource.create()
        • EvaluationResource.update()
        • EvaluationResource.classification()
        • EvaluationResource.audit_logs()
        • EvaluationResource.audit_log()
      • EvaluatorResource
        • EvaluatorResource.__init__()
        • EvaluatorResource.list()
      • OrganizationResource
        • OrganizationResource.__init__()
        • OrganizationResource.list()
        • OrganizationResource.get()
        • OrganizationResource.create()
        • OrganizationResource.update()
        • OrganizationResource.delete()
        • OrganizationResource.upload_logo()
        • OrganizationResource.get_logo()
        • OrganizationResource.update_logo()
        • OrganizationResource.delete_logo()
      • ProjectResource
        • ProjectResource.__init__()
        • ProjectResource.list()
        • ProjectResource.get()
        • ProjectResource.create()
        • ProjectResource.update()
        • ProjectResource.delete()
      • RiskEngineResource
        • RiskEngineResource.__init__()
        • RiskEngineResource.classify()
        • RiskEngineResource.scaffold()
        • RiskEngineResource.tags()
        • RiskEngineResource.validate()
        • RiskEngineResource.list_versions()
      • GenerationResource
        • GenerationResource.__init__()
        • GenerationResource.standard_prompt()
        • GenerationResource.similar_prompt()
        • GenerationResource.red_prompts()
        • GenerationResource.dynamic_red()
        • GenerationResource.functional_red_prompt()
        • GenerationResource.apply_strategy()
        • GenerationResource.combine_prompts()
        • GenerationResource.personas()
        • GenerationResource.policy_prompts()
        • GenerationResource.tool_input()
        • GenerationResource.tool_output()
        • GenerationResource.red_tool_input()
        • GenerationResource.red_tool_output()
      • MetricsResource
        • MetricsResource.__init__()
        • MetricsResource.answer_relevancy()
        • MetricsResource.clarity()
        • MetricsResource.context_relevancy()
        • MetricsResource.evaluate()
        • MetricsResource.faithfulness()
        • MetricsResource.formality()
        • MetricsResource.helpfulness()
        • MetricsResource.pii()
        • MetricsResource.prompt_manipulation()
        • MetricsResource.sensitivity()
        • MetricsResource.simplicity()
        • MetricsResource.tone()
        • MetricsResource.toxicity()
        • MetricsResource.adherence()
        • MetricsResource.completion()
        • MetricsResource.refusal()
        • MetricsResource.stability()
        • MetricsResource.dangerous_code()
        • MetricsResource.tool_choice_relevancy()
        • MetricsResource.tool_faithfulness()
        • MetricsResource.tool_output_relevancy()
      • EventResource
        • EventResource.__init__()
        • EventResource.list()
        • EventResource.get()
        • EventResource.health()
        • EventResource.dismiss()
      • SubscriptionResource
        • SubscriptionResource.__init__()
        • SubscriptionResource.list()
        • SubscriptionResource.get()
        • SubscriptionResource.create()
        • SubscriptionResource.update()
        • SubscriptionResource.delete()
      • RuntimeProviderResource
        • RuntimeProviderResource.__init__()
        • RuntimeProviderResource.list()
        • RuntimeProviderResource.get()
        • RuntimeProviderResource.auth_schemas()
    • Platform HTTP Transport
      • PlatformHTTP
        • PlatformHTTP.__init__()
        • PlatformHTTP.get()
        • PlatformHTTP.post()
        • PlatformHTTP.put()
        • PlatformHTTP.patch()
        • PlatformHTTP.delete()
    • SDK (Legacy)
      • TrustwiseSDK
        • TrustwiseSDK.__init__()
        • TrustwiseSDK.get_versions()
      • TrustwiseSDKAsync
        • TrustwiseSDKAsync.__init__()
    • Configuration
      • TrustwiseConfig
        • TrustwiseConfig.api_key
        • TrustwiseConfig.__init__()
        • TrustwiseConfig.base_url
        • TrustwiseConfig._validate_url()
        • TrustwiseConfig.get_performance_url()
        • TrustwiseConfig.get_metrics_url()
    • Types
      • Score
        • Score.value
        • Score.__float__()
        • Score.__str__()
        • Score.__repr__()
      • convert_to_score()
      • ObjectStyleScore
        • ObjectStyleScore.label
        • ObjectStyleScore.score
      • ContextChunk
        • ContextChunk.chunk_text
        • ContextChunk.chunk_id
      • ContextRelevancyRequest
        • ContextRelevancyRequest.query
        • ContextRelevancyRequest.context
        • ContextRelevancyRequest.severity
        • ContextRelevancyRequest.include_chunk_scores
        • ContextRelevancyRequest.metadata
      • PromptManipulationRequest
        • PromptManipulationRequest.text
        • PromptManipulationRequest.severity
      • PromptManipulationResponse
        • PromptManipulationResponse.score
        • PromptManipulationResponse.scores
      • AnswerRelevancyRequest
        • AnswerRelevancyRequest.query
        • AnswerRelevancyRequest.response
      • AnswerRelevancyResponse
        • AnswerRelevancyResponse.score
        • AnswerRelevancyResponse.generated_question
      • FaithfulnessRequest
        • FaithfulnessRequest.query
        • FaithfulnessRequest.response
        • FaithfulnessRequest.context
        • FaithfulnessRequest.severity
        • FaithfulnessRequest.include_citations
      • Statement
        • Statement.statement
        • Statement.label
        • Statement.probability
        • Statement.sentence_span
      • FaithfulnessResponse
        • FaithfulnessResponse.score
        • FaithfulnessResponse.statements
      • ContextRelevancyResponse
        • ContextRelevancyResponse.score
        • ContextRelevancyResponse.scores
      • ClarityRequest
        • ClarityRequest.text
      • ClarityResponse
        • ClarityResponse.score
      • FormalityRequest
        • FormalityRequest.text
      • FormalityResponse
        • FormalityResponse.score
      • SimplicityRequest
        • SimplicityRequest.text
      • SimplicityResponse
        • SimplicityResponse.score
      • ToneRequest
        • ToneRequest.text
        • ToneRequest.tones
      • ToneResponse
        • ToneResponse.scores
      • ToxicityRequest
        • ToxicityRequest.text
        • ToxicityRequest.severity
      • ToxicityResponse
        • ToxicityResponse.score
        • ToxicityResponse.scores
      • PIIEntity
        • PIIEntity.interval
        • PIIEntity.string
        • PIIEntity.category
      • PIIRequest
        • PIIRequest.text
        • PIIRequest.allowlist
        • PIIRequest.blocklist
        • PIIRequest.categories
      • PIIResponse
        • PIIResponse.pii
      • HelpfulnessRequest
        • HelpfulnessRequest.text
      • HelpfulnessResponse
        • HelpfulnessResponse.score
      • SensitivityRequest
        • SensitivityRequest.text
        • SensitivityRequest.topics
      • SensitivityResponse
        • SensitivityResponse.scores
      • RefusalRequest
        • RefusalRequest.query
        • RefusalRequest.response
      • RefusalResponse
        • RefusalResponse.score
      • CompletionRequest
        • CompletionRequest.query
        • CompletionRequest.response
      • CompletionResponse
        • CompletionResponse.score
      • AdherenceRequest
        • AdherenceRequest.policy
        • AdherenceRequest.response
      • AdherenceResponse
        • AdherenceResponse.score
      • StabilityRequest
        • StabilityRequest.responses
      • StabilityResponse
        • StabilityResponse.min
        • StabilityResponse.avg
      • CarbonValue
        • CarbonValue.value
        • CarbonValue.unit
      • CarbonComponent
        • CarbonComponent.component
        • CarbonComponent.carbon
      • CarbonRequest
        • CarbonRequest.provider
        • CarbonRequest.region
        • CarbonRequest.instance_type
        • CarbonRequest.latency
      • CarbonResponse
        • CarbonResponse.carbon
        • CarbonResponse.components
    • Base Types
      • SDKBaseModel
        • SDKBaseModel.to_json()
        • SDKBaseModel.to_dict()
        • SDKBaseModel.validate_score_range()
        • SDKBaseModel.format_validation_error()
        • SDKBaseModel._get_field_description()
        • SDKBaseModel._format_output()
        • SDKBaseModel._format_nested_dict()
        • SDKBaseModel.__repr__()
        • SDKBaseModel._format_json_value()
        • SDKBaseModel._repr_mimebundle_()
        • SDKBaseModel._format_html()
        • SDKBaseModel._get_value_css_class()
        • SDKBaseModel._format_dict_html()
        • SDKBaseModel.__repr_html__()
      • SDKRequestModel
        • SDKRequestModel.metadata
      • SDKResponseModel
      • CostResponseV3
        • CostResponseV3.cost_estimate_per_run
        • CostResponseV3.total_project_cost_estimate
      • CostRequestV3
        • CostRequestV3.model_name
        • CostRequestV3.model_type
        • CostRequestV3.model_provider
        • CostRequestV3.number_of_queries
        • CostRequestV3.total_prompt_tokens
        • CostRequestV3.total_completion_tokens
        • CostRequestV3.total_tokens
        • CostRequestV3.instance_type
        • CostRequestV3.average_latency
  • API Versioning
    • Version Management
      • Available Versions
      • Current Version
    • Usage Patterns
      • Explicit Version Path
      • Default Version
    • Supported Versions
  • Migrating from TrustwiseSDK to TrustwiseClient
    • Why Migrate
    • What Changes
    • Step-by-Step
      • 1. Update Imports
      • 2. Replace Instantiation
      • 3. Update Metric Calls
      • 4. Use Server-Side Guardrails
    • Complete Before / After
    • FAQ
  • Changelog
    • v4.5.0 (2026-04-30)
      • Breaking Changes
      • New Features
      • Other
    • v4.4.0b1 (2026-04-08)
      • New Features
      • Deprecations
    • v1.0.0b10 (10-07-2025)
      • Deprecation Notices
      • Features
      • Migration
    • v1.0.0 (06-20-2025)
      • Features
      • Metrics
      • Guardrails System (Experimental)
      • Version Management
      • Configuration
Trustwise SDK
  • Python Module Index

Python Module Index

t
 
t
- trustwise
    trustwise.sdk
    trustwise.sdk.config
    trustwise.sdk.metrics.v4.types
    trustwise.sdk.platform._http
    trustwise.sdk.platform.client
    trustwise.sdk.types

© Copyright 2025-2026, Trustwise Team.

Built with Sphinx using a theme provided by Read the Docs.