Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"cSpell.words": [
"conserver",
"vcons"
]
}
86 changes: 86 additions & 0 deletions conserver/configuring-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
description: Configuring Conserver Links
---

# Configuring Conserver Links

Links are extensibility points to the conserver.
A conserver is configured with one or more links.
A collection of links construct a chain, which is executed in sequence.

Configuration is saved in the `vcon-server/config.yml` file.

## links:

A collection of links, loaded from the folder specified in `module:`, and configured under the `options:` node.

## storage:

Storage drivers for vCons

## chains:

The sequence of links to execute when processing a vCon

### ingress_lists:

The queue to monitor for processing by the link

### egress_lists:

The queue to move the vcon upon successful processing.
Chains can be sequenced by configuring the `egress_lists:` to reference the same name as another `chain`'s `ingress_lists`.

```yaml
links:
<link-name>:
module: links.<link-folder>
options:
"name": "value-pairs"
"instructions": "in each link folder"
expire_vcon:
module: links.expire_vcon
options:
seconds: 604800
summarize:
module: links.analyze
options:
OPENAI_API_KEY: xxxxx
prompt: "Summarize this transcript in a few sentences, identify the purpose and the parties of the conversation. Mention if there was a voicemail or if the customer and agent spoke."
analysis_type: summary
model: 'gpt-4o-mini'
webhook_store_call_log:
module: links.webhook
options:
webhook-urls:
- https://example.com/conserver
storages:

chains:
my-chain:
links:
- expire_vcon
- summarize
ingress_lists:
- default_ingress
storages:
egress_lists:
- default_egress
enabled: 1
summarize_only:
links:
- summarize
ingress_lists:
- summarize_ingress
egress_lists:
- summarize_egress
notification-chain:
links:
- webhook_store_call_log
ingress_lists:
- default_egress
storages:
egress_lists:
- end-queue
enabled: 1
```
Loading