Index

A

additional_properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) all_of (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) all_of_schema() (in module guardrails_ai.types.json_schema_2020_12) anchor (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

any_of (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) any_of_schema() (in module guardrails_ai.types.json_schema_2020_12) args (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute) array_schema() (in module guardrails_ai.types.json_schema_2020_12)

C

call_id (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) chat (guardrails_ai.sdk.guards_api.GuardsApi attribute) ChatApi (class in guardrails_ai.sdk.chat_completions_api) Client (class in guardrails_ai.sdk.abstract_client) comment (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) completions (guardrails_ai.sdk.chat_completions_api.ChatApi attribute) CompletionsApi (class in guardrails_ai.sdk.chat_completions_api) const (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) const_schema() (in module guardrails_ai.types.json_schema_2020_12) contains (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

content_encoding (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) content_media_type (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) content_schema (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) create() (guardrails_ai.sdk.chat_completions_api.CompletionsApi method) (guardrails_ai.sdk.guards_api.GuardsApi method) create_boolean_schema() (in module guardrails_ai.types.json_schema_2020_12) create_schema() (in module guardrails_ai.types.json_schema_2020_12) CreateGuardRequest (class in guardrails_ai.types) (class in guardrails_ai.types.guard) CUSTOM (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1]

D

default (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) definitions (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) defs (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) delete() (guardrails_ai.sdk.guards_api.GuardsApi method) delete_guard() (in module guardrails_ai.sdk.methods) dependencies (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) dependent_required (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) dependent_schemas (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) deprecated (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

description (guardrails_ai.types.CreateGuardRequest attribute) (guardrails_ai.types.guard.CreateGuardRequest attribute) (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) deserialize_outcome() (guardrails_ai.types.fail_result.FailResult class method) (guardrails_ai.types.FailResult class method) (guardrails_ai.types.pass_result.PassResult class method) (guardrails_ai.types.PassResult class method) deserialize_value_override() (guardrails_ai.types.pass_result.PassResult class method) (guardrails_ai.types.PassResult class method) dynamic_anchor (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) dynamic_ref (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

E

else_ (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) end (guardrails_ai.types.error_span.ErrorSpan attribute) (guardrails_ai.types.ErrorSpan attribute) enum (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) enum_schema() (in module guardrails_ai.types.json_schema_2020_12) error (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) error_message (guardrails_ai.types.fail_result.FailResult attribute) (guardrails_ai.types.FailResult attribute) error_spans (guardrails_ai.types.fail_result.FailResult attribute) (guardrails_ai.types.FailResult attribute) (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationSummary attribute)

ErrorSpan (class in guardrails_ai.types) (class in guardrails_ai.types.error_span) examples (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) EXCEPTION (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1] exclusive_maximum (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) exclusive_minimum (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

F

FAIL (guardrails_ai.types.Outcome attribute) (guardrails_ai.types.validation_result.Outcome attribute) fail_results (guardrails_ai.types.ReAsk attribute) (guardrails_ai.types.reask.ReAsk attribute) FailResult (class in guardrails_ai.types) (class in guardrails_ai.types.fail_result) failure_reason (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationSummary attribute) FILTER (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1]

FIX (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1] FIX_REASK (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1] fix_value (guardrails_ai.types.fail_result.FailResult attribute) (guardrails_ai.types.FailResult attribute) format (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

G

get_guard() (in module guardrails_ai.sdk.methods) get_guards() (in module guardrails_ai.sdk.methods) Guard (class in guardrails_ai.types) (class in guardrails_ai.types.guard) GuardedChatCompletion (class in guardrails_ai.sdk.chat_completions_api) GuardedChatCompletionChunk (class in guardrails_ai.sdk.chat_completions_api) guardrails (guardrails_ai.sdk.chat_completions_api.GuardedChatCompletion attribute) (guardrails_ai.sdk.chat_completions_api.GuardedChatCompletionChunk attribute) guardrails_ai module guardrails_ai.sdk module guardrails_ai.sdk.abstract_client module guardrails_ai.sdk.chat_completions_api module guardrails_ai.sdk.guardrails_ai_client module guardrails_ai.sdk.guards_api module guardrails_ai.sdk.methods module guardrails_ai.types module guardrails_ai.types.error_span module

guardrails_ai.types.fail_result module guardrails_ai.types.guard module guardrails_ai.types.json_schema_2020_12 module guardrails_ai.types.on_fail module guardrails_ai.types.pass_result module guardrails_ai.types.reask module guardrails_ai.types.validation_outcome module guardrails_ai.types.validation_result module guardrails_ai.types.validation_summary module guardrails_ai.types.validator module GuardrailsAI (class in guardrails_ai.sdk) (class in guardrails_ai.sdk.guardrails_ai_client) guards (guardrails_ai.sdk.guardrails_ai_client.GuardrailsAI attribute) (guardrails_ai.sdk.GuardrailsAI attribute) GuardsApi (class in guardrails_ai.sdk.guards_api)

H

headers (guardrails_ai.sdk.abstract_client.Client attribute) (guardrails_ai.sdk.chat_completions_api.ChatApi attribute) (guardrails_ai.sdk.chat_completions_api.CompletionsApi attribute) (guardrails_ai.sdk.guardrails_ai_client.GuardrailsAI attribute) (guardrails_ai.sdk.GuardrailsAI attribute) (guardrails_ai.sdk.guards_api.GuardsApi attribute)

http_client (guardrails_ai.sdk.abstract_client.Client attribute) (guardrails_ai.sdk.chat_completions_api.ChatApi attribute) (guardrails_ai.sdk.chat_completions_api.CompletionsApi attribute) (guardrails_ai.sdk.guardrails_ai_client.GuardrailsAI attribute) (guardrails_ai.sdk.GuardrailsAI attribute) (guardrails_ai.sdk.guards_api.GuardsApi attribute)

I

id (guardrails_ai.types.Guard attribute) (guardrails_ai.types.guard.Guard attribute) (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute)

if_ (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) incorrect_value (guardrails_ai.types.ReAsk attribute) (guardrails_ai.types.reask.ReAsk attribute) items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

J

JSONSchema (class in guardrails_ai.types) (class in guardrails_ai.types.json_schema_2020_12)

K

kwargs (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute)

L

list() (guardrails_ai.sdk.guards_api.GuardsApi method)

M

max_contains (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) max_items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) max_length (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) max_properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) max_retries (guardrails_ai.sdk.abstract_client.Client attribute) (guardrails_ai.sdk.chat_completions_api.ChatApi attribute) (guardrails_ai.sdk.chat_completions_api.CompletionsApi attribute) (guardrails_ai.sdk.guardrails_ai_client.GuardrailsAI attribute) (guardrails_ai.sdk.GuardrailsAI attribute) (guardrails_ai.sdk.guards_api.GuardsApi attribute) maximum (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) metadata (guardrails_ai.types.validation_result.ValidationResult attribute) (guardrails_ai.types.ValidationResult attribute) min_contains (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) min_items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) min_length (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) min_properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) minimum (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) model_config (guardrails_ai.types.CreateGuardRequest attribute) (guardrails_ai.types.error_span.ErrorSpan attribute) (guardrails_ai.types.ErrorSpan attribute) (guardrails_ai.types.Guard attribute) (guardrails_ai.types.guard.CreateGuardRequest attribute) (guardrails_ai.types.guard.Guard attribute) (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) (guardrails_ai.types.ReAsk attribute) (guardrails_ai.types.reask.ReAsk attribute) (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.validation_result.ValidationResult attribute) (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationOutcome attribute) (guardrails_ai.types.ValidationResult attribute) (guardrails_ai.types.ValidationSummary attribute) (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute)

module guardrails_ai guardrails_ai.sdk guardrails_ai.sdk.abstract_client guardrails_ai.sdk.chat_completions_api guardrails_ai.sdk.guardrails_ai_client guardrails_ai.sdk.guards_api guardrails_ai.sdk.methods guardrails_ai.types guardrails_ai.types.error_span guardrails_ai.types.fail_result guardrails_ai.types.guard guardrails_ai.types.json_schema_2020_12 guardrails_ai.types.on_fail guardrails_ai.types.pass_result guardrails_ai.types.reask guardrails_ai.types.validation_outcome guardrails_ai.types.validation_result guardrails_ai.types.validation_summary guardrails_ai.types.validator multiple_of (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

N

name (guardrails_ai.types.CreateGuardRequest attribute) (guardrails_ai.types.guard.CreateGuardRequest attribute) NOOP (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1]

not_ (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) not_schema() (in module guardrails_ai.types.json_schema_2020_12) number_schema() (in module guardrails_ai.types.json_schema_2020_12)

O

object_schema() (in module guardrails_ai.types.json_schema_2020_12) on (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute) on_fail (guardrails_ai.types.Validator attribute) (guardrails_ai.types.validator.Validator attribute) one_of (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) one_of_schema() (in module guardrails_ai.types.json_schema_2020_12) OnFail (class in guardrails_ai.types) (class in guardrails_ai.types.on_fail)

OT (in module guardrails_ai.types.validation_outcome) Outcome (class in guardrails_ai.types) (class in guardrails_ai.types.validation_result) outcome (guardrails_ai.types.fail_result.FailResult attribute) (guardrails_ai.types.FailResult attribute) (guardrails_ai.types.pass_result.PassResult attribute) (guardrails_ai.types.PassResult attribute) (guardrails_ai.types.validation_result.ValidationResult attribute) (guardrails_ai.types.ValidationResult attribute) output_schema (guardrails_ai.types.CreateGuardRequest attribute) (guardrails_ai.types.guard.CreateGuardRequest attribute)

P

PASS (guardrails_ai.types.Outcome attribute) (guardrails_ai.types.validation_result.Outcome attribute) PassResult (class in guardrails_ai.types) (class in guardrails_ai.types.pass_result) PassResult.ValueOverrideSentinel (class in guardrails_ai.types) (class in guardrails_ai.types.pass_result) pattern (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) pattern_properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

post_guard() (in module guardrails_ai.sdk.methods) post_guard_validate() (in module guardrails_ai.sdk.methods) prefix_items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) property_names (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) property_path (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationSummary attribute) put_guard() (in module guardrails_ai.sdk.methods)

R

raw_llm_output (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) read_only (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) ReAsk (class in guardrails_ai.types) (class in guardrails_ai.types.reask) REASK (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1] reask (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) reason (guardrails_ai.types.error_span.ErrorSpan attribute) (guardrails_ai.types.ErrorSpan attribute)

recursive_anchor (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) recursive_ref (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) ref (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) ref_schema() (in module guardrails_ai.types.json_schema_2020_12) REFRAIN (guardrails_ai.types.on_fail.OnFail attribute), [1] (guardrails_ai.types.OnFail attribute), [1] required (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) retrieve() (guardrails_ai.sdk.guards_api.GuardsApi method)

S

Schema (in module guardrails_ai.types.json_schema_2020_12) schema_ (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) SchemaValue (in module guardrails_ai.types.json_schema_2020_12) serialize_value_override() (guardrails_ai.types.pass_result.PassResult method) (guardrails_ai.types.PassResult method)

start (guardrails_ai.types.error_span.ErrorSpan attribute) (guardrails_ai.types.ErrorSpan attribute) string_schema() (in module guardrails_ai.types.json_schema_2020_12) StringOrStringArray (in module guardrails_ai.types.json_schema_2020_12)

T

then (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) title (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

type (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

U

unevaluated_items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) unevaluated_properties (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

unique_items (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute) update() (guardrails_ai.sdk.guards_api.GuardsApi method)

V

validate() (guardrails_ai.sdk.guards_api.GuardsApi method) validate_conditional() (guardrails_ai.types.json_schema_2020_12.JSONSchema method) (guardrails_ai.types.JSONSchema method) validate_contains_constraints() (guardrails_ai.types.json_schema_2020_12.JSONSchema method) (guardrails_ai.types.JSONSchema method) validate_length_constraints() (guardrails_ai.types.json_schema_2020_12.JSONSchema method) (guardrails_ai.types.JSONSchema method) validate_numeric_constraints() (guardrails_ai.types.json_schema_2020_12.JSONSchema method) (guardrails_ai.types.JSONSchema method) validate_type() (guardrails_ai.types.json_schema_2020_12.JSONSchema class method) (guardrails_ai.types.JSONSchema class method) validated_chunk (guardrails_ai.types.validation_result.ValidationResult attribute) (guardrails_ai.types.ValidationResult attribute) validated_output (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) validation_passed (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute) validation_summaries (guardrails_ai.types.validation_outcome.ValidationOutcome attribute) (guardrails_ai.types.ValidationOutcome attribute)

ValidationOutcome (class in guardrails_ai.types) (class in guardrails_ai.types.validation_outcome) ValidationResult (class in guardrails_ai.types) (class in guardrails_ai.types.validation_result) ValidationSummary (class in guardrails_ai.types) (class in guardrails_ai.types.validation_summary) Validator (class in guardrails_ai.types) (class in guardrails_ai.types.validator) validator_name (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationSummary attribute) validator_status (guardrails_ai.types.validation_summary.ValidationSummary attribute) (guardrails_ai.types.ValidationSummary attribute) validators (guardrails_ai.types.CreateGuardRequest attribute) (guardrails_ai.types.guard.CreateGuardRequest attribute) value_override (guardrails_ai.types.pass_result.PassResult attribute) (guardrails_ai.types.PassResult attribute) vocabulary (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)

W

write_only (guardrails_ai.types.json_schema_2020_12.JSONSchema attribute) (guardrails_ai.types.JSONSchema attribute)