Save Document Validation Custom Rule

curl --request PUT \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule_id": "<string>",
  "pattern": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "flags": [],
  "description": "<string>",
  "include_violation_details": true
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

payload = {
    "rule_id": "<string>",
    "pattern": "<string>",
    "kind": "regex",
    "display_name": "<string>",
    "flags": [],
    "description": "<string>",
    "include_violation_details": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rule_id: '<string>',
    pattern: '<string>',
    kind: 'regex',
    display_name: '<string>',
    flags: [],
    description: '<string>',
    include_violation_details: true
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'rule_id' => '<string>',
    'pattern' => '<string>',
    'kind' => 'regex',
    'display_name' => '<string>',
    'flags' => [
        
    ],
    'description' => '<string>',
    'include_violation_details' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

	payload := strings.NewReader("{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}"

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

{
  "rule_id": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "description": "<string>",
  "requires_visual_processing": true,
  "can_update": true,
  "can_delete": true,
  "include_violation_details": true,
  "pattern": "<string>",
  "flags": [
    "IGNORECASE"
  ],
  "terms": [
    "<string>"
  ],
  "case_sensitive": true,
  "rule_intent": "<string>",
  "violation_definition": "<string>",
  "non_violation_definition": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PUT

assistant

api

tenants

{tenant}

document_validation

rules

{rule_id}

Save Document Validation Custom Rule

curl --request PUT \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule_id": "<string>",
  "pattern": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "flags": [],
  "description": "<string>",
  "include_violation_details": true
}
'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

payload = {
    "rule_id": "<string>",
    "pattern": "<string>",
    "kind": "regex",
    "display_name": "<string>",
    "flags": [],
    "description": "<string>",
    "include_violation_details": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rule_id: '<string>',
    pattern: '<string>',
    kind: 'regex',
    display_name: '<string>',
    flags: [],
    description: '<string>',
    include_violation_details: true
  })
};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'rule_id' => '<string>',
    'pattern' => '<string>',
    'kind' => 'regex',
    'display_name' => '<string>',
    'flags' => [
        
    ],
    'description' => '<string>',
    'include_violation_details' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

	payload := strings.NewReader("{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rule_id\": \"<string>\",\n  \"pattern\": \"<string>\",\n  \"kind\": \"regex\",\n  \"display_name\": \"<string>\",\n  \"flags\": [],\n  \"description\": \"<string>\",\n  \"include_violation_details\": true\n}"

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

{
  "rule_id": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "description": "<string>",
  "requires_visual_processing": true,
  "can_update": true,
  "can_delete": true,
  "include_violation_details": true,
  "pattern": "<string>",
  "flags": [
    "IGNORECASE"
  ],
  "terms": [
    "<string>"
  ],
  "case_sensitive": true,
  "rule_intent": "<string>",
  "violation_definition": "<string>",
  "non_violation_definition": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

rule_id

string

required

tenant

string

required

The domain of the customer

Example:

"example.com"

Body

application/json

RegexRule
BlacklistRule
LlmRule

rule_id

string

required

Stable rule ID supplied by the caller.

pattern

string

required

Regular expression used to detect violations.

kind

string

default:regex

Allowed value: "regex"

display_name

string | null

Optional human-readable label for the rule.

flags

enum<string>[] | null

Optional regular expression flags.

Available options:

IGNORECASE,

MULTILINE,

DOTALL

description

string | null

Optional human-readable description of the rule.

include_violation_details

boolean

default:true

Whether the response should include matched_text and snippet for violations from this rule.

Response

Successful Response

rule_id

string

required

Stable rule ID.

kind

enum<string>

required

The executable rule kind.

Available options:

regex,

blacklist,

llm

display_name

string

required

Human-readable label for the UI.

description

string

required

Human-readable description of the rule.

requires_visual_processing

boolean

required

Whether the rule requires multimodal attachment input.

can_update

boolean

required

Whether the caller may modify the rule definition.

can_delete

boolean

required

Whether the caller may delete the rule definition.

include_violation_details

boolean

default:true

Whether violation details (matched_text, snippet) are included by default for this rule.

pattern

string | null

Regex pattern for editable custom regex rules.

flags

enum<string>[] | null

Regex flags for editable custom regex rules.

Available options:

IGNORECASE,

MULTILINE,

DOTALL

terms

string[] | null

Blacklist terms for editable custom blacklist rules.

case_sensitive

boolean | null

Blacklist case-sensitivity for editable custom blacklist rules.

rule_intent

string | null

High-level purpose of the rule, when LLM-based.

violation_definition

string | null

What counts as a violation, when LLM-based.

non_violation_definition

string | null

What should not be flagged, when LLM-based.