[Index]
System-wide AI and LLM settings. Controls LLM summarization parameters and LangSmith diagnostics tracing.
Model ref.: data/AISettings
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Name of this AI settings instance.",
"type": "string",
"required": true,
"readonly": true,
"default": "Global",
"maxLength": 1024
},
"summarization_timeout": {
"title": "Summarization Timeout (seconds)",
"description": "Maximum time in seconds to wait for an LLM summarization call before timing out.",
"type": "integer",
"minimum": 30,
"maximum": 900,
"default": 300
},
"max_summary_length": {
"title": "Max Summary Length (characters)",
"description": "Maximum number of characters for a generated LLM summary before truncation.",
"type": "integer",
"minimum": 500,
"maximum": 10000,
"default": 2000
},
"max_input_tokens": {
"title": "Max Input Tokens",
"description": "Maximum estimated token budget for the summarization LLM input prompt. Large detection outputs are compressed or capped to fit within this limit. Uses chars/4 approximation.",
"type": "integer",
"minimum": 10000,
"maximum": 500000,
"default": 100000
},
"diagnostics": {
"title": "Diagnostics",
"description": "LangSmith tracing and diagnostics settings for LLM observability.",
"type": "object",
"properties": {
"langsmith_tracing_enabled": {
"title": "Enable LangSmith Tracing",
"description": "Enable LangSmith tracing for LLM calls. Do not enable in production unless actively debugging.",
"type": "boolean",
"default": false
},
"langsmith_project": {
"title": "LangSmith Project Name",
"description": "Project name in LangSmith for organizing traces.",
"type": "string",
"maxLength": 1024
},
"langsmith_workspace_id": {
"title": "LangSmith Workspace ID",
"description": "Workspace ID in LangSmith for organizing traces.",
"type": "string",
"maxLength": 1024
},
"langsmith_api_key": {
"title": "LangSmith API Key",
"description": "API key for authenticating with LangSmith. Stored encrypted.",
"type": "string",
"required": false,
"is_password": true,
"store_encrypted": true,
"maxLength": 1024
},
"langsmith_hide_inputs": {
"title": "Hide Inputs",
"description": "When enabled, LLM input payloads are not sent to LangSmith. Recommended for production to protect sensitive data.",
"type": "boolean",
"default": true
},
"langsmith_hide_outputs": {
"title": "Hide Outputs",
"description": "When enabled, LLM output payloads are not sent to LangSmith. Recommended for production to protect sensitive data.",
"type": "boolean",
"default": true
}
}
}
},
"schema_version": "1.4.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/AISettings/add/ |
|
The GUI Add form of data/AISettings as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/AISettings | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/AISettings/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/AISettings/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/AISettings/ |
|
The data/AISettings schema and all instances as JSON. |
(The list will return 0 to 3 data/AISettings instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/AISettings/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"add",
"bulk_update_form",
"list",
"update",
"transform",
"migration",
"remove",
"export",
"help",
"configuration_template",
"field_display_policy",
"get",
"export_bulkload_template"
],
"meta": {
"model_type": "data/AISettings",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"get",
"update",
"configuration_template",
"field_display_policy",
"list"
],
"schema_version": "1.4.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/AISettings/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/AISettings/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/AISettings/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/AISettings/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": [
{
"data": {
"name": "Global",
"summarization_timeout": 300,
"max_summary_length": 2000,
"max_input_tokens": 100000,
"diagnostics": {
"langsmith_tracing_enabled": false,
"langsmith_hide_inputs": true,
"langsmith_hide_outputs": true
},
"pkid": "69ee2ec476a8a1f92ddfe0ab",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/AISettings",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"base",
"core"
],
"title": "Global",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/",
"pkid": "69ee2ec476a8a1f92ddfe0aa"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee2ec476a8a1f92ddfe0aa"
],
"schema_version": "1.4.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "69ee2ec476a8a1f92ddfe0aa"
}
]
}
(Show the first instance)
{
"data": {
"name": "Global",
"summarization_timeout": 300,
"max_summary_length": 2000,
"max_input_tokens": 100000,
"diagnostics": {
"langsmith_tracing_enabled": false,
"langsmith_hide_inputs": true,
"langsmith_hide_outputs": true
},
"pkid": "69ee2ec476a8a1f92ddfe0ab"
},
"meta": {
"model_type": "data/AISettings",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"base",
"core"
],
"title": "Global",
"business_key": {
"unique": [
"name"
],
"hierarchy": false
},
"api_version": "21.2",
"cached": false,
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/",
"pkid": "69ee2ec476a8a1f92ddfe0aa"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"69ee2ec476a8a1f92ddfe0aa"
],
"schema_version": "1.4.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/AISettings/69ee2ec476a8a1f92ddfe0aa/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
}
]
},
"pkid": "69ee2ec476a8a1f92ddfe0aa"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/AISettings/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/AISettings/[pkid] | hierarchy=[hierarchy] | The data/AISettings instance with [pkid]. |