af-client-sdk

ActiveFence Client SDK

af_client_sdk

A standalone SDK supplied to ActiveFence clients in order to integrate analysis API calls more easily.

ActiveFenceClient

The ActiveFenceClient class provides methods to interact with the ActiveFence analysis API. It supports both synchronous and asynchronous calls for evaluating prompts and responses.

Initialization

from af_client_sdk.client import ActiveFenceClient

client = ActiveFenceClient(
    api_key="your_api_key",
    app_name="your_app_name"
)

At a minimum, you need to provide the api_key and app_name.

In addition, any of these initialization values can be configured via environment variables, whose values will be taken if not provided during initialization:

AF_API_KEY: API key for authentication.

AF_APP_NAME: Application name.

AF_MODEL_PROVIDER: Model provider name.

AF_MODEL_NAME: Model name.

AF_MODEL_VERSION: Model version.

AF_PLATFORM: Cloud platform.

AF_API_TIMEOUT: API timeout in seconds.

AF_RETRY_MAX: Maximum number of retries.

AF_RETRY_BASE_DELAY: Base delay for retries.

Analysis Context

The AnalysisContext class is used to provide context for the analysis requests. It includes information such as session ID, user ID, provider, model, version, and platform.

This information is provided when calling the evaluation methods, and sent to ActiveFence to assist in contextualizing the content being analyzed.

from af_client_sdk.client import AnalysisContext

context = AnalysisContext(
    session_id="session_id",
    user_id="user_id",
    provider="provider_name",
    model_name="model_name",
    model_version="model_version",
    platform="cloud_platform"
)

session_id - Allows for tracking of a multiturn conversation, and contextualizing a text with past prompts. Session ID should be unique for each new conversation/session.

user_id - The unique ID of the user invoking the prompts to analyze. This allows ActiveFence to analyze a specific user's history, and connect different prompts of a user across sessions.

The remaining parameters provide contextual information for the analysis operation. These parameters are optional. Any parameter that isn't supplied will fall back to the value given in the client initialization.

Methods

evaluate_prompt_sync Evaluate a user prompt synchronously.

result = client.evaluate_prompt_sync(prompt="Your prompt text", context=context)
print(result)

evaluate_response_sync Evaluate a response synchronously.

result = client.evaluate_response_sync(response="Response text", context=context)
print(result)

evaluate_prompt Evaluate a user prompt asynchronously.

import asyncio

async def evaluate_prompt_async():
    result = await client.evaluate_prompt(prompt="Your prompt text", context=context)
    print(result)

asyncio.run(evaluate_prompt_async())

evaluate_response Evaluate a response asynchronously.

async def evaluate_response_async():
    result = await client.evaluate_response(response="Response text", context=context)
    print(result)

asyncio.run(evaluate_response_async())

Response

The methods return a GuardedResult object with the following properties:
blocked: Whether the action is blocked.

reason: Reason for blocking (if applicable).

final_response: The final response text.

Retry Mechanism

The client supports retrying failed requests with exponential backoff. Configure retries using the following environment variables:
AF_RETRY_MAX: Maximum number of retries - default of 3.

AF_RETRY_BASE_DELAY: Base delay for retries in seconds - default is 1 second.