Trustwise SDK
Contents
Installation
Usage
Metrics
API Reference
API Versioning
Changelog
Trustwise SDK
Index
Index
_
|
A
|
B
|
C
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
V
_
__init__() (trustwise.sdk.config.TrustwiseConfig method)
(trustwise.sdk.guardrails.Guardrail method)
(trustwise.sdk.TrustwiseSDK method)
(trustwise.sdk.TrustwiseSDKAsync method)
__repr__() (trustwise.sdk.types.SDKBaseModel method)
__repr_html__() (trustwise.sdk.types.SDKBaseModel method)
__str__() (trustwise.sdk.types.ClarityResponse method)
_format_dict_html() (trustwise.sdk.types.SDKBaseModel method)
_format_html() (trustwise.sdk.types.SDKBaseModel method)
_format_json_value() (trustwise.sdk.types.SDKBaseModel method)
_format_nested_dict() (trustwise.sdk.types.SDKBaseModel method)
_format_output() (trustwise.sdk.types.SDKBaseModel method)
_get_field_description() (trustwise.sdk.types.SDKBaseModel method)
_get_metric_kwargs() (trustwise.sdk.guardrails.Guardrail method)
_get_value_css_class() (trustwise.sdk.types.SDKBaseModel method)
_repr_mimebundle_() (trustwise.sdk.types.SDKBaseModel method)
_validate_url() (trustwise.sdk.config.TrustwiseConfig method)
A
AdherenceRequest (class in trustwise.sdk.types)
AdherenceResponse (class in trustwise.sdk.types)
allowlist (trustwise.sdk.types.PIIRequest attribute)
AnswerRelevancyRequest (class in trustwise.sdk.types)
AnswerRelevancyResponse (class in trustwise.sdk.types)
api_key (trustwise.sdk.config.TrustwiseConfig attribute)
average_latency (trustwise.sdk.types.CarbonRequest attribute)
(trustwise.sdk.types.CostRequest attribute)
avg (trustwise.sdk.types.StabilityResponse attribute)
B
base_url (trustwise.sdk.config.TrustwiseConfig attribute)
blocked (trustwise.sdk.types.GuardrailResponse attribute)
blocklist (trustwise.sdk.types.PIIRequest attribute)
built-in function
metrics.adherence.evaluate()
metrics.answer_relevancy.evaluate()
metrics.carbon.evaluate()
metrics.clarity.evaluate()
metrics.completion.evaluate()
metrics.context_relevancy.evaluate()
metrics.cost.evaluate()
metrics.faithfulness.evaluate()
metrics.formality.evaluate()
metrics.helpfulness.evaluate()
metrics.pii.evaluate()
metrics.prompt_injection.evaluate()
metrics.refusal.evaluate()
metrics.sensitivity.evaluate()
metrics.simplicity.evaluate()
metrics.stability.evaluate()
metrics.summarization.evaluate()
metrics.tone.evaluate()
metrics.toxicity.evaluate()
C
carbon_emitted (trustwise.sdk.types.CarbonResponse attribute)
CarbonRequest (class in trustwise.sdk.types)
CarbonResponse (class in trustwise.sdk.types)
category (trustwise.sdk.types.PIIEntity attribute)
check_pii() (trustwise.sdk.guardrails.Guardrail method)
check_scores() (trustwise.sdk.types.ContextRelevancyResponse class method)
(trustwise.sdk.types.FormalityResponse class method)
(trustwise.sdk.types.SensitivityResponse class method)
(trustwise.sdk.types.ToneResponse class method)
(trustwise.sdk.types.ToxicityResponse class method)
ClarityRequest (class in trustwise.sdk.types)
ClarityResponse (class in trustwise.sdk.types)
CompletionRequest (class in trustwise.sdk.types)
CompletionResponse (class in trustwise.sdk.types)
Context (in module trustwise.sdk.types)
context (trustwise.sdk.types.ContextRelevancyRequest attribute)
(trustwise.sdk.types.FaithfulnessRequest attribute)
(trustwise.sdk.types.SummarizationRequest attribute)
ContextNode (class in trustwise.sdk.types)
ContextRelevancyRequest (class in trustwise.sdk.types)
ContextRelevancyResponse (class in trustwise.sdk.types)
cost_estimate_per_run (trustwise.sdk.types.CostResponse attribute)
CostRequest (class in trustwise.sdk.types)
CostResponse (class in trustwise.sdk.types)
E
evaluate() (trustwise.sdk.guardrails.Guardrail method)
F
Fact (class in trustwise.sdk.types)
Facts (in module trustwise.sdk.types)
facts (trustwise.sdk.types.FaithfulnessResponse attribute)
FaithfulnessRequest (class in trustwise.sdk.types)
FaithfulnessResponse (class in trustwise.sdk.types)
FormalityRequest (class in trustwise.sdk.types)
FormalityResponse (class in trustwise.sdk.types)
format_validation_error() (trustwise.sdk.types.SDKBaseModel static method)
G
generated_question (trustwise.sdk.types.AnswerRelevancyResponse attribute)
get_alignment_url() (trustwise.sdk.config.TrustwiseConfig method)
get_beta_features() (trustwise.sdk.TrustwiseSDK method)
get_metrics_url() (trustwise.sdk.config.TrustwiseConfig method)
get_performance_url() (trustwise.sdk.config.TrustwiseConfig method)
get_safety_url() (trustwise.sdk.config.TrustwiseConfig method)
get_versions() (trustwise.sdk.TrustwiseSDK method)
Guardrail (class in trustwise.sdk.guardrails)
GuardrailResponse (class in trustwise.sdk.types)
guardrails() (trustwise.sdk.TrustwiseSDK method)
H
HelpfulnessRequest (class in trustwise.sdk.types)
HelpfulnessResponse (class in trustwise.sdk.types)
I
identified_pii (trustwise.sdk.types.PIIResponse attribute)
instance_type (trustwise.sdk.types.CarbonRequest attribute)
(trustwise.sdk.types.CostRequest attribute)
interval (trustwise.sdk.types.PIIEntity attribute)
is_beta_feature() (trustwise.sdk.TrustwiseSDK method)
L
label (trustwise.sdk.types.Fact attribute)
labels (trustwise.sdk.types.ToneResponse attribute)
(trustwise.sdk.types.ToxicityResponse attribute)
M
metrics.adherence.evaluate()
built-in function
metrics.answer_relevancy.evaluate()
built-in function
metrics.carbon.evaluate()
built-in function
metrics.clarity.evaluate()
built-in function
metrics.completion.evaluate()
built-in function
metrics.context_relevancy.evaluate()
built-in function
metrics.cost.evaluate()
built-in function
metrics.faithfulness.evaluate()
built-in function
metrics.formality.evaluate()
built-in function
metrics.helpfulness.evaluate()
built-in function
metrics.pii.evaluate()
built-in function
metrics.prompt_injection.evaluate()
built-in function
metrics.refusal.evaluate()
built-in function
metrics.sensitivity.evaluate()
built-in function
metrics.simplicity.evaluate()
built-in function
metrics.stability.evaluate()
built-in function
metrics.summarization.evaluate()
built-in function
metrics.tone.evaluate()
built-in function
metrics.toxicity.evaluate()
built-in function
min (trustwise.sdk.types.StabilityResponse attribute)
model_name (trustwise.sdk.types.CostRequest attribute)
model_provider (trustwise.sdk.types.CostRequest attribute)
model_type (trustwise.sdk.types.CostRequest attribute)
module
trustwise.sdk
trustwise.sdk.config
trustwise.sdk.guardrails
trustwise.sdk.types
N
node_id (trustwise.sdk.types.ContextNode attribute)
node_score (trustwise.sdk.types.ContextNode attribute)
node_text (trustwise.sdk.types.ContextNode attribute)
number_of_queries (trustwise.sdk.types.CostRequest attribute)
P
passed (trustwise.sdk.types.GuardrailResponse attribute)
PIIEntity (class in trustwise.sdk.types)
PIIRequest (class in trustwise.sdk.types)
PIIResponse (class in trustwise.sdk.types)
policy (trustwise.sdk.types.AdherenceRequest attribute)
prob (trustwise.sdk.types.Fact attribute)
processor_name (trustwise.sdk.types.CarbonRequest attribute)
PromptInjectionRequest (class in trustwise.sdk.types)
PromptInjectionResponse (class in trustwise.sdk.types)
provider_name (trustwise.sdk.types.CarbonRequest attribute)
provider_region (trustwise.sdk.types.CarbonRequest attribute)
Q
query (trustwise.sdk.types.AnswerRelevancyRequest attribute)
(trustwise.sdk.types.CompletionRequest attribute)
(trustwise.sdk.types.ContextRelevancyRequest attribute)
(trustwise.sdk.types.FaithfulnessRequest attribute)
(trustwise.sdk.types.PromptInjectionRequest attribute)
(trustwise.sdk.types.RefusalRequest attribute)
R
RefusalRequest (class in trustwise.sdk.types)
RefusalResponse (class in trustwise.sdk.types)
response (trustwise.sdk.types.AdherenceRequest attribute)
(trustwise.sdk.types.AnswerRelevancyRequest attribute)
(trustwise.sdk.types.ClarityRequest attribute)
(trustwise.sdk.types.CompletionRequest attribute)
(trustwise.sdk.types.FaithfulnessRequest attribute)
(trustwise.sdk.types.FormalityRequest attribute)
(trustwise.sdk.types.HelpfulnessRequest attribute)
(trustwise.sdk.types.RefusalRequest attribute)
(trustwise.sdk.types.SensitivityRequest attribute)
(trustwise.sdk.types.SimplicityRequest attribute)
(trustwise.sdk.types.SummarizationRequest attribute)
(trustwise.sdk.types.ToneRequest attribute)
(trustwise.sdk.types.ToxicityRequest attribute)
responses (trustwise.sdk.types.StabilityRequest attribute)
results (trustwise.sdk.types.GuardrailResponse attribute)
S
sci_per_10k_calls (trustwise.sdk.types.CarbonResponse attribute)
sci_per_api_call (trustwise.sdk.types.CarbonResponse attribute)
score (trustwise.sdk.types.AdherenceResponse attribute)
(trustwise.sdk.types.AnswerRelevancyResponse attribute)
(trustwise.sdk.types.ClarityResponse attribute)
(trustwise.sdk.types.CompletionResponse attribute)
(trustwise.sdk.types.ContextRelevancyResponse attribute)
(trustwise.sdk.types.FaithfulnessResponse attribute)
(trustwise.sdk.types.FormalityResponse attribute)
(trustwise.sdk.types.HelpfulnessResponse attribute)
(trustwise.sdk.types.PromptInjectionResponse attribute)
(trustwise.sdk.types.RefusalResponse attribute)
(trustwise.sdk.types.SimplicityResponse attribute)
(trustwise.sdk.types.SummarizationResponse attribute)
scores (trustwise.sdk.types.ContextRelevancyResponse attribute)
(trustwise.sdk.types.FormalityResponse attribute)
(trustwise.sdk.types.SensitivityResponse attribute)
(trustwise.sdk.types.ToneResponse attribute)
(trustwise.sdk.types.ToxicityResponse attribute)
SDKBaseModel (class in trustwise.sdk.types)
SensitivityRequest (class in trustwise.sdk.types)
SensitivityResponse (class in trustwise.sdk.types)
sentence_span (trustwise.sdk.types.Fact attribute)
sentences (trustwise.sdk.types.FormalityResponse attribute)
SimplicityRequest (class in trustwise.sdk.types)
SimplicityResponse (class in trustwise.sdk.types)
StabilityRequest (class in trustwise.sdk.types)
StabilityResponse (class in trustwise.sdk.types)
statement (trustwise.sdk.types.Fact attribute)
string (trustwise.sdk.types.PIIEntity attribute)
SummarizationRequest (class in trustwise.sdk.types)
SummarizationResponse (class in trustwise.sdk.types)
T
text (trustwise.sdk.types.PIIRequest attribute)
to_dict() (trustwise.sdk.types.GuardrailResponse method)
(trustwise.sdk.types.SDKBaseModel method)
to_json() (trustwise.sdk.types.GuardrailResponse method)
(trustwise.sdk.types.SDKBaseModel method)
ToneRequest (class in trustwise.sdk.types)
ToneResponse (class in trustwise.sdk.types)
topics (trustwise.sdk.types.ContextRelevancyResponse attribute)
(trustwise.sdk.types.SensitivityRequest attribute)
total_completion_tokens (trustwise.sdk.types.CostRequest attribute)
total_project_cost_estimate (trustwise.sdk.types.CostResponse attribute)
total_prompt_tokens (trustwise.sdk.types.CostRequest attribute)
total_tokens (trustwise.sdk.types.CostRequest attribute)
ToxicityRequest (class in trustwise.sdk.types)
ToxicityResponse (class in trustwise.sdk.types)
trustwise.sdk
module
trustwise.sdk.config
module
trustwise.sdk.guardrails
module
trustwise.sdk.types
module
TrustwiseConfig (class in trustwise.sdk.config)
TrustwiseSDK (class in trustwise.sdk)
TrustwiseSDKAsync (class in trustwise.sdk)
V
validate_lists() (trustwise.sdk.types.ToneResponse method)
validate_score_range() (trustwise.sdk.types.SDKBaseModel class method)