uSync.AI.Sync 17.0.0

uSync.AI.Sync

uSync handlers and serializers for Umbraco.AI. AI connections, guardrails, contexts, profiles and settings are written to the uSync folder when they are saved, and travel between servers with the rest of your uSync files.

Most sites want the uSync.AI package, which installs this plus prompt and agent sync.

What is synced

Items keep the same Id on every server, so anything that refers to a context, guardrail or profile by Id (prompts, agents, content) still resolves after a sync. References are also recorded by alias, so a file still imports onto a server where the item was created by hand.

Connection secrets

By default a connection's API key is not written to disk. Any setting the provider marks as sensitive is left out of the file, and its name is listed under <Ignored>:

<Settings><![CDATA[{
  "endpoint": "https://api.openai.com/v1"
}]]></Settings>
<Ignored>
  <Setting>apiKey</Setting>
</Ignored>

On import, an ignored setting keeps whatever value the target server already has. A new connection arrives without its key: enter it once on that server and later syncs leave it alone.

To sync the key as well, store it in configuration and reference it. A value starting with $ names where the secret lives, so it is written as is:

{ "apiKey": "$Umbraco:AI:Secrets:OpenAIApiKey" }

Options

{
  "uSync": {
    "AI": {
      "Connections": {
        "IgnoreEncrypted": true,
        "IgnoreSecretValues": true,
        "IgnoreSensitive": false,
        "IgnoreSettings": []
      }
    }
  }
}

• IgnoreEncrypted (default true): leave out values that are already encrypted (ENC:...). Only the server that encrypted them can read them.
• IgnoreSecretValues (default true): leave out the value of sensitive settings, unless it is a $ configuration reference. Turn this off to sync API keys: they are written to disk in plain text, so only do it where the uSync files are kept somewhere private. Encrypted values are still left out unless IgnoreEncrypted is off too.
• IgnoreSensitive (default false): leave out sensitive settings entirely, $ references included.
• IgnoreSettings: names of settings that are always left out.