Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8bbd0aa
1.8.1 updates
siddharthmenon-7 Oct 22, 2026
6290da7
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
siddharthmenon-7 Oct 22, 2026
87a4c7e
Artemis Context Guide - Phase 1 implementation
prabhat-singh-kore Oct 22, 2026
f55c2fd
Update workflows.mdx
melindaVi-Kore Oct 22, 2026
a185878
Artemis Context Guide - Phase 2, 4 new docs/pages added
prabhat-singh-kore Oct 22, 2026
fd08db9
Updated MD linting rules
ashishguptaiitb Oct 22, 2026
3c91561
Linting, formatting, spell check, etc.
ashishguptaiitb Oct 22, 2026
17936a9
Linting, formatting, spell check, etc.
ashishguptaiitb Oct 22, 2026
8d9c319
Related articles
prabhat-singh-kore Oct 22, 2026
5385151
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
prabhat-singh-kore Oct 22, 2026
baaa3a2
prompt library
prabhat-singh-kore Oct 22, 2026
b1af1e4
Minor edits
prabhat-singh-kore Oct 22, 2026
be603af
Adding a WIP experiment in drafts folder
ashishguptaiitb Oct 22, 2026
39acad2
Minor edit
ashishguptaiitb Oct 22, 2026
aca146c
Update workflows.mdx
melindaVi-Kore Oct 22, 2026
59a5e55
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
melindaVi-Kore Oct 22, 2026
c13ac6e
Screenshot update
ashishguptaiitb Oct 22, 2026
742b5f0
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
ashishguptaiitb Oct 22, 2026
64af656
Minor copyedit
ashishguptaiitb Oct 22, 2026
39b56c7
Updated Whatsapp channel
siddharthmenon-7 Oct 22, 2026
66f6b80
Update voice.mdx
vishnubkore Oct 22, 2026
0011cb6
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
vishnubkore Oct 22, 2026
0f603d3
Updated readme.md file - updated contribution instruction and added n…
ashishguptaiitb Oct 22, 2026
3097dcd
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
ashishguptaiitb Oct 22, 2026
26e2992
Update voice.mdx
vishnubkore Oct 22, 2026
c0d4be1
Merge branch 'agentplatform-dev' of https://github.com/Koredotcom/doc…
vishnubkore Oct 22, 2026
6a927f0
Update prompts.mdx
ashishguptaiitb Oct 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
*/

"MD001": true, //Heading levels should only increment by one level at a time. But in RNs we use this.
"MD009": true, //No trailing spaces.
"MD012": true //Multiple consecutive blank lines.
"MD013": false, //Line length should be within limits.
"MD022": true, //Headings should be surrounded by blank lines
"MD023": true, //Headings must start at the beginning of the line
Expand All @@ -19,12 +21,15 @@
"MD029": true, //Ordered list item prefix. Turn to true later since it'll catch improperly-indented content in ordered lists.
"MD031": true, //Fenced code blocks should be surrounded by blank lines. Turn to true later.
"MD032": true, //Lists should be surrounded by blank lines
"MD033": false, //No inline HTML
"MD034": true, //Bare URL or email used. Mentions of naked email ID converts an intended sample to a mailto link. Or a sip example to a mailto link.
"MD036": false, //Emphasis used instead of a heading. We use bold for heading but that's incorrect.
"MD039": true, //Spaces inside link text. Turn it on later
"MD040": true, //Fenced code blocks should have a language specified.
"MD041": true, //All articles start with a heading in the first line in the MD file.
"MD047": true, //Files should end with a single newline character
"MD056": true, //Table column count. Some incorrectly-formatted table rows can have less or more cells than the rest of the table. The information in such cells is lost in the output that we don't want.
"MD058": true, //Tables should be surrounded by blank lines.
"MD059": true, //Link text should be descriptive. Turn it on later after we edit link texts.
"MD041": true //All articles start with a heading in the first line in the MD file.
"MD060": false //Table column style
}
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,11 @@ Other business solutions of Kore.ai:

## Contribute to this Documentation

Prerequisites to author and contribute are:
This repo is public. To contribute edits, clone it or fork it and submit a PR. Request a review of your PR and wait for it to be merged to `main`. To report bugs or share suggestions, create an issue.

- [Node.js](https://nodejs.org) v20.17.0 or later (LTS version recommended).
- Get write access to this repo.
- Install Mintlify CLI `npm i -g mintlify`.
When editing .mdx files, follow GitHub Flavored Markdown syntax.

To author and preview, follow these steps:

1. Clone the repo. Use GitHub Desktop client.
1. Work only in your [product-specific branch](https://github.com/Koredotcom/docs-v2/branches) and your product-specific folder.
1. Create or update the .mdx files or other assets.
1. To preview locally, create a local build using `mint dev` or `mint dev --port xxxx` in the cloned repo's root folder.
1. To preview on stage, create [a pull requests](https://github.com/Koredotcom/docs-v2/pulls) targeting `main` branch and view the preview or deployment link in it.
1. To publish your doc updates, request a review of your PR and wait for it to be merged. Do NOT merge on your own.
To preview your edits locally, use the npm package of [Mintlify](https://www.mintlify.com/docs/cli/index).

## Folder structure and common files

Expand All @@ -45,12 +36,17 @@ assets/ # Common assets for all docs, say favicon, logo, etc. Used in d
├── koreailogo-white.svg
custom-css # custom stylesheets. Don't edit.
├── style.css
drafts # Drafted content or assets that are to be used later.
snippets # Reusable content for single sourcing
.cspell.json # Spell check config file that's NOT available in the repo but added in everyone's local clone manually. Works when extension is installed in VSCode editor.
.gitignore # Exclusions from repo uploads
.lycheeignore # Configuration for Lychee linkchecker. It is configured to run as an on-demand Action on this repo.
.markdownlint.jsonc # Markdown linting rules. Works when extension is installed in VSCode editor
.mintignore # Exclusions from the Mintlify build
docs.json # Config, TOC, home page design theme, analytics integration, etc.
home.mdx # Docs home page
License # MIT license for docs
linkinator.config.json # Config for Linkinator link checker. It is used separately from the CLI.
README.md # This file.
search.js # JavaScript that powers search of AI for Service and AI for Work help articles.
```
53 changes: 53 additions & 0 deletions agent-platform/abl/reference/configuration-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Configuration reference
sidebarTitle: Configuration reference
---

A one-page index of every setting that changes what the model reads on a turn -- where it's set, what it defaults to, and what it changes. Use this page to find the right lever quickly, then follow the link to the full reference for the syntax and examples.

ABL settings take effect in new conversations once saved, or once published and deployed for production channels. Project settings take effect on the next turn unless noted otherwise.

<Note>Knowledge-base and voice levers are covered in full on [Knowledge bases and knowledge tools](/agent-platform/knowledge) and [Voice agents](/agent-platform/channels/voice) -- this table includes only their headline entries.</Note>

| Setting | Where | Default | Changes |
|---------|-------|---------|---------|
| [`BEHAVIOR: role:`](/agent-platform/abl-reference/multi-agent-and-supervisor#behavior-settings) | Agent ABL | Not set (allow-list mode) | Which values reach `## Current Context`, and which prompt template is used -- see [How a turn is built](/agent-platform/context-and-prompts#what-the-model-sees-each-turn) |
| `GOAL`, `PERSONA`, `LIMITATIONS`, `{{refs}}` | Agent ABL | -- | The identity section; references also make values visible in `## Current Context` |
| `SYSTEM_PROMPT:` | Agent ABL | Catalog template | Replaces the template; runtime sections are still appended |
| [`MEMORY: SESSION:`](/agent-platform/memory-and-state#session-memory) | Agent ABL | -- | `## Session Memory` content, and what the model may write |
| [`MEMORY: persistent:`, `remember:`, `recall:`](/agent-platform/memory-and-state#persistent-memory) | Agent ABL | -- | Values loaded into the session; `recall: INSTRUCTION` lines in the prompt |
| [`HANDOFF … CONTEXT:`](/agent-platform/abl-reference/multi-agent-and-supervisor#handoff-context) (`pass`, `summary`, `history`, `memory_grants`) | Agent ABL | `history: full` | The receiving agent's history, context, and granted memory |
| [`DELEGATE … INPUT` / `PURPOSE`](/agent-platform/abl-reference/multi-agent-and-supervisor#delegate) | Agent ABL | -- | The only context a delegate gets |
| `CONVERSATION:` | Agent ABL | -- | `## Conversation Behavior` lines; listening and barge-in behavior on voice |
| [`EXECUTION.inline_gather`](/agent-platform/abl-reference/agent-declaration#configuration-properties) | Agent ABL | `false` (on in the voice profile) | `## Information Collection` instead of the `GATHER` list |
| [`EXECUTION.compaction.*`](/agent-platform/context-compaction#size-limits-and-compaction) | Agent ABL | See [Context size, compaction, and budgets](/agent-platform/context-compaction) | Tool results, earlier turns, and `## Current Context` budgets |
| `EXECUTION.models.summarization` | Agent ABL | Project tier | The model used for tool-result summaries |
| `EXECUTION.voice.instructions` | Agent ABL | -- | `## Voice Delivery Instructions` and voice formatting rules |
| `EXECUTION.guardrail_builtins` | Agent ABL | `false` | Whether a guardrail check can read `content`, `session_state`, and `tool_results` |
| [Tool `MODEL_CONTEXT`](/agent-platform/abl-reference/tools#model_context-on-a-tool-result) (`FIELDS` / `TEMPLATE`) | Tool ABL | -- | What the model sees of a tool result, now and later |
| [Response `MODEL_CONTEXT`](/agent-platform/abl-reference/flow#model_context-on-a-response) | Hook `RESPOND`, `COMPLETE`, `FLOW` step | -- | What the history records for a rich response |
| [Tool `compaction:`](/agent-platform/abl-reference/tools#result-compaction) (`essential_fields`, `summary_timeout_ms`, `max_search_tokens`) | Tool ABL | -- | Per-tool compaction, and the knowledge-base token budget |
| [Tool `store_result`](/agent-platform/abl-reference/tools#store-result) | Tool ABL | `true`; `false` once the tool has `on_result: SET` | Whether `last_<tool>_result` is kept |
| Tool param `default_source`, `visibility_model`, `visibility_trace` | Tool ABL | Visible | Hides a runtime-supplied value from the model and from traces |
| [KB `search_instructions`, `kb_name`, `description`](/agent-platform/knowledge#tool-level-search-settings) | Tool ABL / KB settings | -- | How and when the model searches |
| [Index Top K, similarity threshold, keyword weight](/agent-platform/knowledge#additional-settings) | Studio KB index settings | 10, 0.2, 0.5 | How many chunks come back |
| Citations | Studio KB citation settings | On by default, per index | Citation instructions added to the prompt |
| [`GUARDRAILS:`](/agent-platform/abl-reference/guardrails) | Agent ABL | -- | Per-agent checks -- see [Guardrail checkpoints](/agent-platform/safety-and-guardrails#guardrail-checkpoints) |
| Guardrail policies, providers, fail mode | Studio Govern → Guardrails | Fail open | Project and tenant checks; `## Current Policy` |
| [Project compaction](/agent-platform/context-compaction#where-to-set-compaction-policies) | Project runtime config (API or import) | Platform defaults | Project-wide budgets; resolved once per conversation |
| [Voice latency profile and overrides](/agent-platform/administration/general-settings#voice-low-latency-profile) | Studio Settings → Runtime Config | Auto-seeded for voice | Tighter budgets, fast model tier, reasoning off, inline gather on |
| Filler | Project runtime config | Profile defaults | Voice filler behavior and the status-update instruction |
| [PII redaction](/agent-platform/administration/general-settings#pii-redaction) (`pii_redaction`) | Project runtime config | On | Tokens in place of personal data in the prompt and in traces. Built-in detectors start off on new projects. |
| [Multi-intent](/agent-platform/administration/general-settings#multi-intent-recognition) | Project runtime config | -- | Multi-request routing and task sections |
| [Cross-channel recall](/agent-platform/administration/agent-behavior-settings#omnichannel) | Project omnichannel settings | Per project | `## Previous Conversations (Other Channels)`: up to 30 messages of 500 characters each |

<Note>Fixed by the platform, not configurable: the order of prompt sections, the Customer Output Contract, the tool-history marker and its 6-round window, the realtime voice handoff history-replay limits, and the absolute limits on `## Current Context` (40,000 characters per value, 100,000 for the whole block).</Note>

---

{{related}}

- [How a turn is built](/agent-platform/context-and-prompts) -- what each of these settings ultimately controls.
- [Context size, compaction, and budgets](/agent-platform/context-compaction) -- the compaction defaults in full.
- [Agent declaration](/agent-platform/abl-reference/agent-declaration) -- `GOAL`/`PERSONA`/`SYSTEM_PROMPT` and the `EXECUTION:` block.
- [Multi-agent and supervisor](/agent-platform/abl-reference/multi-agent-and-supervisor) -- `HANDOFF`, `DELEGATE`, and `ESCALATE`.
2 changes: 2 additions & 0 deletions agent-platform/abl/reference/multi-agent-and-supervisor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,8 @@ CONTEXT:

<Note>The legacy shorthand `history: last_10` is still accepted during the compatibility window, but new agents should use the typed `mode` + `count` block.</Note>

<Warning>Three forms parse without error and are silently ignored, each falling back to `full`: a single-line flow-mapping value such as `history: { mode: last_n, count: 3 }` (use the indented block shown above instead); an uppercase key inside `CONTEXT:`, such as `HISTORY:` or `PASS:` (keys inside `CONTEXT:` must be lowercase, unlike the handoff entry's own `TO:` / `WHEN:` keys); and a misspelled value, such as `history: recent`. Check the Request view of the target agent's first LLM step (see [LLM step request and response](/agent-platform/sessions#llm-step-request-and-response)) if the history you expect isn't showing up.</Warning>

### Return expectations

When `EXPECT_RETURN: true`, the calling agent pauses and waits for the target agent to complete.
Expand Down
6 changes: 6 additions & 0 deletions agent-platform/abl/reference/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1313,6 +1313,12 @@ TOOLS:
store_result: false
```

When `store_result` is `true` (the default), the raw result is kept as a session value named `last_<tool>_result`. It surfaces in `## Current Context` on later turns, but only for the agent that called the tool, and cut to 4,000 characters. This is separate from the within-turn shaping in [Result compaction](#result-compaction) and [MODEL_CONTEXT on a tool result](#model_context-on-a-tool-result) above, which apply only while the call is in progress -- `last_<tool>_result` is what carries the result forward once the turn ends.

<Warning>Declaring an `on_result: SET:` block on the tool changes the default: `store_result` becomes `false` and `last_<tool>_result` is no longer written, unless `store_result: true` is set explicitly alongside it. If a later turn needs a field from the result, either keep `store_result: true` or capture that field into a session value with `on_result: SET:`.</Warning>

For the agent-wide limits on how many compacted tool rounds survive in history, and how tool results are compacted across turns, see [Compaction policy overrides](/agent-platform/abl-reference/agent-declaration#compaction-policy-overrides).

### Reuse secrets across tools (SecretRef)

Some flows need a credential produced by one tool (a one-time token, session key, or OTP) to be sent to a later tool — without ever exposing the raw value to the LLM. SecretRef captures such values into an encrypted, session-scoped **secret vault** and restores them into downstream tool calls.
Expand Down
2 changes: 2 additions & 0 deletions agent-platform/administration/agent-behavior-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,8 @@ The **Agent Transfer Settings** page configures defaults for agent transfer sess

**Navigation**: **Project** → **Settings** → **Agent Transfer**

<Note>These are project-wide defaults for a human-agent transfer. An agent overrides them at runtime with an `ESCALATE` block's `routing` and `routing.voice` -- see [Routing configuration](/agent-platform/abl-reference/multi-agent-and-supervisor#routing-configuration) and [Voice transfer settings](/agent-platform/abl-reference/multi-agent-and-supervisor#voice-transfer-settings) in the ABL reference.</Note>

The page organizes content into three collapsible sections. Select a section header to expand or collapse it. Select **Save** to apply changes or **Reset** to restore all values to defaults.

| Section | Description |
Expand Down
5 changes: 4 additions & 1 deletion agent-platform/administration/ai-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ The Agent Platform is provider-neutral. Agents can use models from multiple LLM

The page is organized into three tabs: **Credentials**, **Model Catalog**, and **Project Access**.

{/*### How model resolution works
{/*

### How model resolution works

Model configuration follows a layered approach. When the runtime executes an agent, it resolves the model through a five-level priority cascade, stopping at the first match:

Expand Down Expand Up @@ -53,6 +55,7 @@ Every LLM call tracks token usage and estimated cost, broken down by agent, proj
| Estimated cost | Calculated from token counts and the model's known pricing. |
| Model used | Which model served the request. |
| Latency | Time-to-first-token and total request duration. |

*/}

### Credentials
Expand Down
2 changes: 2 additions & 0 deletions agent-platform/administration/general-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,8 @@ This section controls how the runtime handles personally identifiable informatio
| **Classify explicit DTMF using project PII patterns** | Matches a completed keypad entry to the project's enabled PII patterns, so a recognized value carries a type and a validation status while anything else stays a generic token. Raw digits never reach the model either way, so this setting changes how an entry is labelled rather than whether it's protected. |
| **Detection methods allowed** | Sets the ceiling on which detection engines the project's patterns may use. Each pattern still selects its own method on the PII Protection page, so this field decides what's available to them rather than what they do. |

<Note>This redaction policy is project-wide. For a specific tool that needs to see the original, unredacted values despite it, see [PII access](/agent-platform/abl-reference/tools#pii-access) (`pii_access`) in the ABL tools reference.</Note>

### Lookup tables

Lookup tables are the reference data the runtime uses to validate field values and perform fuzzy matching during extraction.
Expand Down
Loading
Loading