Quickstart

An application represents a unified entity that encapsulates all the information about your generative AI app. It includes several key components:

1. Application Name: A unique name to identify your application.
2. Description: A brief description of your application.
3. Provider: The AI service provider you’re using (e.g., OpenAI, Anthropic, Google).
4. Model: The specific AI model being utilized (e.g., GPT-3.5, GPT-4, Claude).
5. Parameters: Configuration settings that define how the model behaves (e.g., system prompt, temperature, max tokens).

To get started with setting up your application, visit our Application Setup Guide.

For detailed API, check out our API Reference.

Policies and guardrails are rules that you want to enforce on your application.

Visit our Policies and Guardrails Setup Guide.

For detailed API information, check out our API Reference.

Evaluate allows you to enforce your policies and guardrails on your application in real-time.

1. Prepare your request: You’ll need to include the following in your request:

   • User input
   • LLM output
   • Policy IDs to evaluate against

2. Send the request: Use our API to send these details for evaluation.

3. Receive the evaluation: The API will return whether the interaction complies with your policies.

4. Auto-correction: If the LLM output doesn’t comply, evaluate can automatically correct it to ensure compliance.

For detailed API information, check out our API Reference.

Probes are predefined test scenarios or inputs designed to assess the vulnerabilities and robustness of your AI application. They help identify potential weaknesses in your model’s responses.

Examples:

1. Prompt Injection: These probes test if an attacker can manipulate the model’s behavior by inserting malicious instructions.

2. Hallucinations: These probes evaluate if the model generates false or nonsensical information confidently.

3. Data Leakage: These probes test if the model reveals sensitive information it shouldn’t.

To view and select from our comprehensive list of probes, visit our Probe Catalog.

For information, see our Vulnerability Scanning Guide.

Before running a scan, you should create an application with model and provider details.

1. Run the scan: Initiate the vulnerability scan using our API.

2. Review results: Analyze the scan results to identify:

   • Detected vulnerabilities
   • Severity levels
   • Recommended mitigation strategies

3. Mitigate: Based on the results, implement necessary changes to your policies and guardrails.

For detailed API information and best practices, refer to our Vulnerability Scanning Guide.