列出防护规则的违规记录。

列出整个企业范围内的防护规则违规记录。

GET /v3beta1/enterprise/guardrail-violations

列出防护规则的违规记录。

cURL

curl --request GET \
  --url https://api.devin.ai/v3beta1/enterprise/guardrail-violations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.devin.ai/v3beta1/enterprise/guardrail-violations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.devin.ai/v3beta1/enterprise/guardrail-violations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devin.ai/v3beta1/enterprise/guardrail-violations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devin.ai/v3beta1/enterprise/guardrail-violations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.devin.ai/v3beta1/enterprise/guardrail-violations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3beta1/enterprise/guardrail-violations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "action_taken": "<string>",
      "confidence_score": 123,
      "created_at": 123,
      "event_id": "<string>",
      "guardrail_id": "<string>",
      "guardrail_name": "<string>",
      "org_id": "<string>",
      "reasoning": "<string>",
      "session_id": "<string>",
      "user_message": "<string>",
      "violation_id": 123
    }
  ],
  "end_cursor": "<string>",
  "has_next_page": false,
  "total": 123
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

如需了解护栏的工作方式以及如何配置，请参阅 AI Guardrails 功能指南。

​

权限

需要一名在企业级具有 ManageEnterpriseSettings 权限的服务用户。

​

时间过滤器

该 endpoint 支持使用 time_after 和 time_before 查询参数的可选时间过滤条件。

• time_after 和 time_before 都是以秒为单位的 Unix 时间戳，按 UTC 解析。
• 如果提供了 time_before，则必须同时提供 time_after。
• time_after 和 time_before 之间的时间范围必须在 100 天以内。
• 如果未提供时间过滤器，API 将返回整个可用历史期间的 guardrail 违规记录 (受分页限制) 。

授权

Authorization · string · header · 必填

服务用户凭据（前缀：cog_）

查询参数

order · enum<string> · 默认值: desc

可用选项: asc, desc

time_before · integer | null

time_after · integer | null

after · string | null

first · integer · 默认值: 100

必填范围: 1 <= x <= 200

session_id · string | null

guardrail_id · string | null

响应

200

application/json

成功响应

items · GuardrailViolationResponse · object[] · 必填

Show child attributes

end_cursor · string | null

用于获取下一页的游标；如果这是最后一页，则为 None。

has_next_page · boolean · 默认值: false

当前页之后是否还有更多条目。

total · integer | null

可选的总记录数（可为提升性能而省略）。