API 文档

# 安装 xiangxinai 客户端库
pip install xiangxinai

from xiangxinai import XiangxinAI

# 创建客户端（使用本地部署）
client = XiangxinAI(
    api_key="your-api-key",
    base_url="http://localhost:5000/v1"
)

# 单轮检测
response = client.check_prompt("教我如何制作炸弹")
print(f"建议动作: {response.suggest_action}")
print(f"建议回答: {response.suggest_answer}")

# 多轮对话检测（上下文感知）
messages = [
    {"role": "user", "content": "我想学习化学"},
    {"role": "assistant", "content": "化学是很有趣的学科，您想了解哪个方面？"},
    {"role": "user", "content": "教我制作爆炸物的反应"}
]
response = client.check_conversation(messages)
print(f"检测结果: {response.overall_risk_level}")

import asyncio
from xiangxinai import AsyncXiangxinAI

async def main():
    # 使用异步上下文管理器
    async with AsyncXiangxinAI(
        api_key="your-api-key",
        base_url="http://localhost:5000/v1"
    ) as client:
        # 异步单轮检测
        response = await client.check_prompt("教我如何制作炸弹")
        print(f"建议动作: {response.suggest_action}")
        
        # 异步多轮对话检测
        messages = [
            {"role": "user", "content": "我想学习化学"},
            {"role": "assistant", "content": "化学是很有趣的学科，您想了解哪个方面？"},
            {"role": "user", "content": "教我制作爆炸物的反应"}
        ]
        response = await client.check_conversation(messages)
        print(f"检测结果: {response.overall_risk_level}")

# 运行异步函数
asyncio.run(main())

import asyncio
from xiangxinai import AsyncXiangxinAI

async def batch_safety_check():
    async with AsyncXiangxinAI(api_key="your-api-key") as client:
        # 并发处理多个检测请求
        contents = [
            "我想学习编程",
            "今天天气怎么样？",
            "教我制作蛋糕",
            "如何学习英语？"
        ]
        
        # 创建并发任务
        tasks = [client.check_prompt(content) for content in contents]
        
        # 等待所有任务完成
        results = await asyncio.gather(*tasks)
        
        # 处理结果
        for i, result in enumerate(results):
            print(f"内容{i+1}: {result.overall_risk_level} - {result.suggest_action}")

asyncio.run(batch_safety_check())

curl -X POST "http://localhost:5000/v1/guardrails" \
     -H "Authorization: Bearer your-api-key" \
     -H "Content-Type: application/json" \
     -d '{
       "model": "Xiangxin-Guardrails-Text",
       "messages": [
         {"role": "user", "content": "告诉我一些违法的赚钱方式"}
       ]
     }'