Agents¶
Verwende einen API-Schlüssel oder REST-OAuth-Access-Token. Scopes und deine aktuellen Workspace-Rechte gelten gemeinsam. Die Beispiele verwenden fiktive Daten.
Agent erstellen¶
Scope: agents:write
Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus.
Request-Body · application/json
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
agent |
object |
Ja | Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Ja | Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
enabled |
boolean |
Nein | Aktiviert den Agent. Auslassen oder null bedeutet false. |
agentType |
string |
Ja | VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Ja | Anzeigename der Ressource. Regeln: höchstens 255 Zeichen Beispiel: "Demo" |
description |
string |
Nein | Beschreibung des Zwecks dieser Ressource. Regeln: höchstens 10000 Zeichen; null erlaubt |
agentName |
string |
Ja | Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: höchstens 255 Zeichen Beispiel: "Demo Assistant" |
persona |
string |
Nein | Persönlichkeit und Sprechstil des Agents. Regeln: höchstens 10000 Zeichen; null erlaubt |
sttLanguages |
Liste von string |
Ja | Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: mindestens 1 Eintrag; keine doppelten Einträge Beispiel: ["de-DE"]Alle 85 erlaubten Werte anzeigen
|
voiceId |
string |
Ja | Exakte ID aus dem Stimmenkatalog einschließlich Anbieterpräfix. Regeln: höchstens 255 Zeichen |
voiceConfiguration |
object |
Nein | Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
greetingMorningText |
string |
Ja | Begrüßung am Morgen gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingAfternoonText |
string |
Ja | Begrüßung am Nachmittag gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingEveningText |
string |
Ja | Begrüßung am Abend gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
importantNote |
string |
Nein | Zusätzliche Anweisungen für den Agent. Regeln: höchstens 10000 Zeichen; null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Ja | Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. Regeln: 0–60000Beispiel: 1500 |
segmentationSilenceTimeoutMs |
integer (int32) |
Ja | Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. Regeln: 100–5000Beispiel: 500 |
phraseList |
Liste von string |
Nein | Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. Regeln: höchstens 500 Einträge; null erlaubtBeispiel: ["Nuvoca"]Je Eintrag: höchstens 500 Zeichen |
timezone |
string |
Nein | IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: höchstens 100 Zeichen; null erlaubtBeispiel: "Europe/Berlin" |
greetingNonInterruptible |
boolean |
Nein | Verhindert, dass der Anrufer die Begrüßung unterbricht. Regeln: null erlaubt |
greetingTimeoutSeconds |
integer (int32) |
Nein | Zeitlimit für die Begrüßung, in Sekunden. Regeln: 5–300; null erlaubtBeispiel: 30 |
sttProvider |
string |
Nein | Spracherkennungsanbieter aus dem Agent-Katalog. Regeln: null erlaubtWerte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Nein | Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. Regeln: 0.5–0.9; null erlaubt |
deepgramEotTimeoutMs |
integer (int32) |
Nein | Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. Regeln: 500–10000; null erlaubt |
deepgramLanguageHints |
Liste von string |
Nein | Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge; null erlaubtAlle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Nein | Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. Regeln: null erlaubt |
kugelLanguages |
Liste von string |
Nein | Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. Regeln: 1–9 Einträge; null erlaubt |
kugelTurnDetectionLevel |
string |
Nein | RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Regeln: null erlaubtWerte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
temperature |
number (double) |
Nein | Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Nein | Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Nein | Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Nein | Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Nein | Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Nein | Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Nein | Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Nein | Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
model |
string |
Ja | Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Nein | Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Ja | Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: höchstens 100000 Zeichen |
conversationHistoryLimit |
integer (int32) |
Ja | Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. Regeln: 1–100Beispiel: 20 |
knowledgeBaseId |
string (uuid) |
Nein | ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Ja | Maximale Anzahl abgerufener Wissensabschnitte pro Suche. Regeln: 1–50Beispiel: 5 |
ragSimilarityThreshold |
number (double) |
Nein | Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. Regeln: 0–1Beispiel: 0.5 |
temperature |
number (double) |
Nein | Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2Beispiel: 0.3 |
maxTokens |
integer (int32) |
Ja | Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000Beispiel: 1000 |
ttsStreamingMode |
string |
Nein | Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Nein | Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Ja | Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. Regeln: 1–100Beispiel: 5 |
queryTransformPrompt |
string |
Nein | Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. Regeln: höchstens 20000 Zeichen |
queryTransformConfidenceThreshold |
number (double) |
Nein | Erforderliche Konfidenz für die Suchumformulierung. Regeln: 0–1Beispiel: 0.8 |
queryTransformMode |
string |
Nein | Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Nein | Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
rewriteModel |
string |
Nein | Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Nein | Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Nein | Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Nein | Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"agent": {
"enabled": false,
"agentType": "VOICE",
"title": "NuvoCar Empfang – Entwurf",
"agentName": "NuvoCar Assistent",
"sttProvider": "AZURE",
"sttLanguages": [
"de-DE"
],
"voiceId": "azure:FLORIAN_HD",
"timezone": "Europe/Berlin",
"greetingMorningText": "Guten Morgen, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"greetingAfternoonText": "Guten Tag, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"greetingEveningText": "Guten Abend, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"initialSilenceTimeoutMs": 1500,
"segmentationSilenceTimeoutMs": 500,
"phraseList": [
"NuvoCar"
]
},
"options": {
"model": "GPT_4_1_MINI",
"systemPrompt": "Du bist der digitale Empfang von NuvoCar. Frage nach dem Anliegen. Erfinde keine Preise oder Termine. Erkläre offen, wenn eine Auskunft fehlt. Behaupte keine Speicherung oder Weiterleitung ohne erfolgreiche konfigurierte Aktion.",
"conversationHistoryLimit": 20,
"knowledgeBaseId": null,
"ragTopK": 5,
"ragSimilarityThreshold": 0.5,
"temperature": 0.3,
"maxTokens": 1000,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 5,
"queryTransformConfidenceThreshold": 0.8,
"queryTransformMode": "LLM"
}
}
Antwort 201
Erstellt.
| Header | Typ | Beschreibung |
|---|---|---|
Cache-Control |
string |
Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store |
Location |
string |
Pfad der erstellten Ressource. |
ETag |
string |
Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get" |
application/json
| Feld | Typ | Beschreibung |
|---|---|---|
id |
string (uuid) |
Ressourcen-ID in deinem Workspace. |
revision |
string |
Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden. |
agent |
object |
Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
enabled |
boolean |
Aktiviert den Agent. Auslassen oder null bedeutet false. |
agentType |
string |
VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Anzeigename der Ressource. Regeln: höchstens 255 Zeichen Beispiel: "Demo" |
description |
string |
Beschreibung des Zwecks dieser Ressource. Regeln: höchstens 10000 Zeichen; null erlaubt |
agentName |
string |
Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: höchstens 255 Zeichen Beispiel: "Demo Assistant" |
persona |
string |
Persönlichkeit und Sprechstil des Agents. Regeln: höchstens 10000 Zeichen; null erlaubt |
sttLanguages |
Liste von string |
Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: mindestens 1 Eintrag; keine doppelten Einträge Beispiel: ["de-DE"]Alle 85 erlaubten Werte anzeigen
|
voiceId |
string |
Exakte ID aus dem Stimmenkatalog einschließlich Anbieterpräfix. Regeln: höchstens 255 Zeichen |
voiceConfiguration |
object |
Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
greetingMorningText |
string |
Begrüßung am Morgen gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingAfternoonText |
string |
Begrüßung am Nachmittag gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingEveningText |
string |
Begrüßung am Abend gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
importantNote |
string |
Zusätzliche Anweisungen für den Agent. Regeln: höchstens 10000 Zeichen; null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. Regeln: 0–60000Beispiel: 1500 |
segmentationSilenceTimeoutMs |
integer (int32) |
Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. Regeln: 100–5000Beispiel: 500 |
phraseList |
Liste von string |
Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. Regeln: höchstens 500 Einträge; null erlaubtBeispiel: ["Nuvoca"]Je Eintrag: höchstens 500 Zeichen |
timezone |
string |
IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: höchstens 100 Zeichen; null erlaubtBeispiel: "Europe/Berlin" |
greetingNonInterruptible |
boolean |
Verhindert, dass der Anrufer die Begrüßung unterbricht. Regeln: null erlaubt |
greetingTimeoutSeconds |
integer (int32) |
Zeitlimit für die Begrüßung, in Sekunden. Regeln: 5–300; null erlaubtBeispiel: 30 |
sttProvider |
string |
Spracherkennungsanbieter aus dem Agent-Katalog. Regeln: null erlaubtWerte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. Regeln: 0.5–0.9; null erlaubt |
deepgramEotTimeoutMs |
integer (int32) |
Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. Regeln: 500–10000; null erlaubt |
deepgramLanguageHints |
Liste von string |
Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge; null erlaubtAlle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. Regeln: null erlaubt |
kugelLanguages |
Liste von string |
Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. Regeln: 1–9 Einträge; null erlaubt |
kugelTurnDetectionLevel |
string |
RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Regeln: null erlaubtWerte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
temperature |
number (double) |
Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
model |
string |
Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: höchstens 100000 Zeichen |
conversationHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. Regeln: 1–100Beispiel: 20 |
knowledgeBaseId |
string (uuid) |
ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Maximale Anzahl abgerufener Wissensabschnitte pro Suche. Regeln: 1–50Beispiel: 5 |
ragSimilarityThreshold |
number (double) |
Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. Regeln: 0–1Beispiel: 0.5 |
temperature |
number (double) |
Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2Beispiel: 0.3 |
maxTokens |
integer (int32) |
Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000Beispiel: 1000 |
ttsStreamingMode |
string |
Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. Regeln: 1–100Beispiel: 5 |
queryTransformPrompt |
string |
Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. Regeln: höchstens 20000 Zeichen |
queryTransformConfidenceThreshold |
number (double) |
Erforderliche Konfidenz für die Suchumformulierung. Regeln: 0–1Beispiel: 0.8 |
queryTransformMode |
string |
Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
rewriteModel |
string |
Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"id": "00000000-0000-0000-0000-000000000001",
"revision": "revision-from-get",
"agent": {
"enabled": false,
"agentType": "VOICE",
"title": "Demo",
"description": "string",
"agentName": "Demo Assistant",
"persona": "string",
"sttLanguages": [
"de-DE"
],
"voiceId": "azure:FLORIAN_HD",
"voiceConfiguration": {
"temperature": 0.3,
"topP": 0.3,
"topK": 1,
"cfgScale": 1,
"telecomEffectEnabled": false,
"enhancePronunciationEnabled": false,
"xmlLang": "de-AT",
"style": "string"
},
"greetingMorningText": "string",
"greetingAfternoonText": "string",
"greetingEveningText": "string",
"importantNote": "string",
"initialSilenceTimeoutMs": 1500,
"segmentationSilenceTimeoutMs": 500,
"phraseList": [
"Nuvoca"
],
"timezone": "Europe/Berlin",
"greetingNonInterruptible": false,
"greetingTimeoutSeconds": 30,
"sttProvider": "AZURE",
"deepgramEotThreshold": 0.5,
"deepgramEotTimeoutMs": 500,
"deepgramLanguageHints": [],
"preferPreProcessingGreeting": false,
"kugelLanguages": [
"string"
],
"kugelTurnDetectionLevel": "RESPONSIVE"
},
"options": {
"model": "GPT_4_1_MINI",
"reasoningEffort": "NONE",
"systemPrompt": "string",
"conversationHistoryLimit": 20,
"knowledgeBaseId": "00000000-0000-0000-0000-000000000001",
"ragTopK": 5,
"ragSimilarityThreshold": 0.5,
"temperature": 0.3,
"maxTokens": 1000,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 5,
"queryTransformPrompt": "string",
"queryTransformConfidenceThreshold": 0.8,
"queryTransformMode": "LLM",
"decisionQueryTransform": {
"rewriteModel": "GPT_4_1_MINI",
"parallel": false,
"decisionPrompt": "string",
"rewritePrompt": "string"
}
}
}
Fehlerantworten
| Status | Bedeutung |
|---|---|
400 |
Ungültige Eingabe, Auswahl oder Zeitgrenzen. |
401 |
Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein. |
403 |
Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein. |
409 |
Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen. |
429 |
Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen. |
503 |
Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen. |
Fehler-Body
| Feld | Typ | Beschreibung |
|---|---|---|
status |
integer |
HTTP-Statuscode. |
error |
string |
Beschreibung des Fehlers. |
details |
any |
Weitere Fehlerdetails, sofern vorhanden. Regeln: null erlaubt |
code |
string |
Maschinenlesbarer Fehlercode. |
params |
object |
Zusätzliche Werte zum Fehlercode. |
fieldErrors |
object |
Validierungsfehler nach Eingabefeld. |
Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.
Agents auflisten¶
Scope: agents:read
Parameter
| Name | Position | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
page |
Query | integer (int32) |
Nein | Seitenindex ab 0. Regeln: 0–100000Standard: 0 |
size |
Query | integer (int32) |
Nein | Ergebnisse pro Seite. Regeln: 1–100Standard: 25 |
Antwort 200
Erfolgreich.
| Header | Typ | Beschreibung |
|---|---|---|
Cache-Control |
string |
Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store |
application/json
| Feld | Typ | Beschreibung |
|---|---|---|
items |
Liste von object |
Ergebnisse dieser Seite. |
page |
integer (int32) |
Aktueller Seitenindex, beginnend bei 0. |
size |
integer (int32) |
Angeforderte Anzahl der Ergebnisse pro Seite. |
totalElements |
integer (int64) |
Gesamtzahl der passenden Ergebnisse. |
totalPages |
integer (int32) |
Gesamtzahl der Ergebnisseiten. |
items — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
agentId |
string (uuid) |
ID des Agents. |
tenantId |
string (uuid) |
ID des mit dem Zugang verbundenen Workspaces. |
enabled |
boolean |
Ob diese Ressource aktiviert ist. |
agentType |
string |
VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Anzeigename der Ressource. |
description |
string |
Beschreibung des Zwecks dieser Ressource. |
agentName |
string |
Name, mit dem sich der Agent im Gespräch vorstellt. |
Fehlerantworten
| Status | Bedeutung |
|---|---|
400 |
Ungültige Eingabe, Auswahl oder Zeitgrenzen. |
401 |
Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein. |
403 |
Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein. |
429 |
Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen. |
503 |
Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen. |
Fehler-Body
| Feld | Typ | Beschreibung |
|---|---|---|
status |
integer |
HTTP-Statuscode. |
error |
string |
Beschreibung des Fehlers. |
details |
any |
Weitere Fehlerdetails, sofern vorhanden. Regeln: null erlaubt |
code |
string |
Maschinenlesbarer Fehlercode. |
params |
object |
Zusätzliche Werte zum Fehlercode. |
fieldErrors |
object |
Validierungsfehler nach Eingabefeld. |
Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.
Agent abrufen¶
Scope: agents:configuration:read
Parameter
| Name | Position | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
id |
Pfad | string (uuid) |
Ja | Ressourcen-ID im gebundenen Workspace. |
Antwort 200
Erfolgreich.
| Header | Typ | Beschreibung |
|---|---|---|
Cache-Control |
string |
Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store |
ETag |
string |
Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get" |
application/json
| Feld | Typ | Beschreibung |
|---|---|---|
id |
string (uuid) |
Ressourcen-ID in deinem Workspace. |
revision |
string |
Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden. |
agent |
object |
Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
enabled |
boolean |
Aktiviert den Agent. Auslassen oder null bedeutet false. |
agentType |
string |
VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Anzeigename der Ressource. Regeln: höchstens 255 Zeichen Beispiel: "Demo" |
description |
string |
Beschreibung des Zwecks dieser Ressource. Regeln: höchstens 10000 Zeichen; null erlaubt |
agentName |
string |
Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: höchstens 255 Zeichen Beispiel: "Demo Assistant" |
persona |
string |
Persönlichkeit und Sprechstil des Agents. Regeln: höchstens 10000 Zeichen; null erlaubt |
sttLanguages |
Liste von string |
Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: mindestens 1 Eintrag; keine doppelten Einträge Beispiel: ["de-DE"]Alle 85 erlaubten Werte anzeigen
|
voiceId |
string |
Exakte ID aus dem Stimmenkatalog einschließlich Anbieterpräfix. Regeln: höchstens 255 Zeichen |
voiceConfiguration |
object |
Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
greetingMorningText |
string |
Begrüßung am Morgen gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingAfternoonText |
string |
Begrüßung am Nachmittag gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingEveningText |
string |
Begrüßung am Abend gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
importantNote |
string |
Zusätzliche Anweisungen für den Agent. Regeln: höchstens 10000 Zeichen; null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. Regeln: 0–60000Beispiel: 1500 |
segmentationSilenceTimeoutMs |
integer (int32) |
Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. Regeln: 100–5000Beispiel: 500 |
phraseList |
Liste von string |
Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. Regeln: höchstens 500 Einträge; null erlaubtBeispiel: ["Nuvoca"]Je Eintrag: höchstens 500 Zeichen |
timezone |
string |
IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: höchstens 100 Zeichen; null erlaubtBeispiel: "Europe/Berlin" |
greetingNonInterruptible |
boolean |
Verhindert, dass der Anrufer die Begrüßung unterbricht. Regeln: null erlaubt |
greetingTimeoutSeconds |
integer (int32) |
Zeitlimit für die Begrüßung, in Sekunden. Regeln: 5–300; null erlaubtBeispiel: 30 |
sttProvider |
string |
Spracherkennungsanbieter aus dem Agent-Katalog. Regeln: null erlaubtWerte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. Regeln: 0.5–0.9; null erlaubt |
deepgramEotTimeoutMs |
integer (int32) |
Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. Regeln: 500–10000; null erlaubt |
deepgramLanguageHints |
Liste von string |
Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge; null erlaubtAlle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. Regeln: null erlaubt |
kugelLanguages |
Liste von string |
Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. Regeln: 1–9 Einträge; null erlaubt |
kugelTurnDetectionLevel |
string |
RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Regeln: null erlaubtWerte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
temperature |
number (double) |
Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
model |
string |
Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: höchstens 100000 Zeichen |
conversationHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. Regeln: 1–100Beispiel: 20 |
knowledgeBaseId |
string (uuid) |
ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Maximale Anzahl abgerufener Wissensabschnitte pro Suche. Regeln: 1–50Beispiel: 5 |
ragSimilarityThreshold |
number (double) |
Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. Regeln: 0–1Beispiel: 0.5 |
temperature |
number (double) |
Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2Beispiel: 0.3 |
maxTokens |
integer (int32) |
Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000Beispiel: 1000 |
ttsStreamingMode |
string |
Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. Regeln: 1–100Beispiel: 5 |
queryTransformPrompt |
string |
Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. Regeln: höchstens 20000 Zeichen |
queryTransformConfidenceThreshold |
number (double) |
Erforderliche Konfidenz für die Suchumformulierung. Regeln: 0–1Beispiel: 0.8 |
queryTransformMode |
string |
Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
rewriteModel |
string |
Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"id": "00000000-0000-0000-0000-000000000001",
"revision": "revision-from-get",
"agent": {
"enabled": false,
"agentType": "VOICE",
"title": "Demo",
"description": "string",
"agentName": "Demo Assistant",
"persona": "string",
"sttLanguages": [
"de-DE"
],
"voiceId": "azure:FLORIAN_HD",
"voiceConfiguration": {
"temperature": 0.3,
"topP": 0.3,
"topK": 1,
"cfgScale": 1,
"telecomEffectEnabled": false,
"enhancePronunciationEnabled": false,
"xmlLang": "de-AT",
"style": "string"
},
"greetingMorningText": "string",
"greetingAfternoonText": "string",
"greetingEveningText": "string",
"importantNote": "string",
"initialSilenceTimeoutMs": 1500,
"segmentationSilenceTimeoutMs": 500,
"phraseList": [
"Nuvoca"
],
"timezone": "Europe/Berlin",
"greetingNonInterruptible": false,
"greetingTimeoutSeconds": 30,
"sttProvider": "AZURE",
"deepgramEotThreshold": 0.5,
"deepgramEotTimeoutMs": 500,
"deepgramLanguageHints": [],
"preferPreProcessingGreeting": false,
"kugelLanguages": [
"string"
],
"kugelTurnDetectionLevel": "RESPONSIVE"
},
"options": {
"model": "GPT_4_1_MINI",
"reasoningEffort": "NONE",
"systemPrompt": "string",
"conversationHistoryLimit": 20,
"knowledgeBaseId": "00000000-0000-0000-0000-000000000001",
"ragTopK": 5,
"ragSimilarityThreshold": 0.5,
"temperature": 0.3,
"maxTokens": 1000,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 5,
"queryTransformPrompt": "string",
"queryTransformConfidenceThreshold": 0.8,
"queryTransformMode": "LLM",
"decisionQueryTransform": {
"rewriteModel": "GPT_4_1_MINI",
"parallel": false,
"decisionPrompt": "string",
"rewritePrompt": "string"
}
}
}
Fehlerantworten
| Status | Bedeutung |
|---|---|
400 |
Ungültige Eingabe, Auswahl oder Zeitgrenzen. |
401 |
Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein. |
403 |
Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein. |
404 |
Ressource im gebundenen Workspace nicht verfügbar. |
429 |
Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen. |
503 |
Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen. |
Fehler-Body
| Feld | Typ | Beschreibung |
|---|---|---|
status |
integer |
HTTP-Statuscode. |
error |
string |
Beschreibung des Fehlers. |
details |
any |
Weitere Fehlerdetails, sofern vorhanden. Regeln: null erlaubt |
code |
string |
Maschinenlesbarer Fehlercode. |
params |
object |
Zusätzliche Werte zum Fehlercode. |
fieldErrors |
object |
Validierungsfehler nach Eingabefeld. |
Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.
Agent ändern¶
Scope: agents:write
Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden. Vollständige bearbeitbare Konfiguration senden. Ausgelassene Einstellungen können zurückgesetzt werden.
Parameter
| Name | Position | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
id |
Pfad | string (uuid) |
Ja | Ressourcen-ID im gebundenen Workspace. |
If-Match |
Header | string |
Ja | ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen. Beispiel: "revision-from-get" |
Request-Body · application/json
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
agent |
object |
Ja | Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Ja | Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
enabled |
boolean |
Nein | Aktiviert den Agent. Auslassen oder null bedeutet false. |
agentType |
string |
Ja | VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Ja | Anzeigename der Ressource. Regeln: höchstens 255 Zeichen Beispiel: "Demo" |
description |
string |
Nein | Beschreibung des Zwecks dieser Ressource. Regeln: höchstens 10000 Zeichen; null erlaubt |
agentName |
string |
Ja | Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: höchstens 255 Zeichen Beispiel: "Demo Assistant" |
persona |
string |
Nein | Persönlichkeit und Sprechstil des Agents. Regeln: höchstens 10000 Zeichen; null erlaubt |
sttLanguages |
Liste von string |
Ja | Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: mindestens 1 Eintrag; keine doppelten Einträge Beispiel: ["de-DE"]Alle 85 erlaubten Werte anzeigen
|
voiceId |
string |
Ja | Exakte ID aus dem Stimmenkatalog einschließlich Anbieterpräfix. Regeln: höchstens 255 Zeichen |
voiceConfiguration |
object |
Nein | Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
greetingMorningText |
string |
Ja | Begrüßung am Morgen gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingAfternoonText |
string |
Ja | Begrüßung am Nachmittag gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingEveningText |
string |
Ja | Begrüßung am Abend gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
importantNote |
string |
Nein | Zusätzliche Anweisungen für den Agent. Regeln: höchstens 10000 Zeichen; null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Ja | Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. Regeln: 0–60000Beispiel: 1500 |
segmentationSilenceTimeoutMs |
integer (int32) |
Ja | Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. Regeln: 100–5000Beispiel: 500 |
phraseList |
Liste von string |
Nein | Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. Regeln: höchstens 500 Einträge; null erlaubtBeispiel: ["Nuvoca"]Je Eintrag: höchstens 500 Zeichen |
timezone |
string |
Nein | IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: höchstens 100 Zeichen; null erlaubtBeispiel: "Europe/Berlin" |
greetingNonInterruptible |
boolean |
Nein | Verhindert, dass der Anrufer die Begrüßung unterbricht. Regeln: null erlaubt |
greetingTimeoutSeconds |
integer (int32) |
Nein | Zeitlimit für die Begrüßung, in Sekunden. Regeln: 5–300; null erlaubtBeispiel: 30 |
sttProvider |
string |
Nein | Spracherkennungsanbieter aus dem Agent-Katalog. Regeln: null erlaubtWerte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Nein | Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. Regeln: 0.5–0.9; null erlaubt |
deepgramEotTimeoutMs |
integer (int32) |
Nein | Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. Regeln: 500–10000; null erlaubt |
deepgramLanguageHints |
Liste von string |
Nein | Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge; null erlaubtAlle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Nein | Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. Regeln: null erlaubt |
kugelLanguages |
Liste von string |
Nein | Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. Regeln: 1–9 Einträge; null erlaubt |
kugelTurnDetectionLevel |
string |
Nein | RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Regeln: null erlaubtWerte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
temperature |
number (double) |
Nein | Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Nein | Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Nein | Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Nein | Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Nein | Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Nein | Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Nein | Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Nein | Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
model |
string |
Ja | Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Nein | Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Ja | Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: höchstens 100000 Zeichen |
conversationHistoryLimit |
integer (int32) |
Ja | Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. Regeln: 1–100Beispiel: 20 |
knowledgeBaseId |
string (uuid) |
Nein | ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Ja | Maximale Anzahl abgerufener Wissensabschnitte pro Suche. Regeln: 1–50Beispiel: 5 |
ragSimilarityThreshold |
number (double) |
Nein | Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. Regeln: 0–1Beispiel: 0.5 |
temperature |
number (double) |
Nein | Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2Beispiel: 0.3 |
maxTokens |
integer (int32) |
Ja | Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000Beispiel: 1000 |
ttsStreamingMode |
string |
Nein | Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Nein | Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Ja | Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. Regeln: 1–100Beispiel: 5 |
queryTransformPrompt |
string |
Nein | Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. Regeln: höchstens 20000 Zeichen |
queryTransformConfidenceThreshold |
number (double) |
Nein | Erforderliche Konfidenz für die Suchumformulierung. Regeln: 0–1Beispiel: 0.8 |
queryTransformMode |
string |
Nein | Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Nein | Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
rewriteModel |
string |
Nein | Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Nein | Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Nein | Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Nein | Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"agent": {
"enabled": false,
"agentType": "VOICE",
"title": "NuvoCar Empfang – Entwurf",
"agentName": "NuvoCar Assistent",
"sttProvider": "AZURE",
"sttLanguages": [
"de-DE"
],
"voiceId": "azure:FLORIAN_HD",
"timezone": "Europe/Berlin",
"greetingMorningText": "Guten Morgen, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"greetingAfternoonText": "Guten Tag, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"greetingEveningText": "Guten Abend, hier ist der digitale Assistent von NuvoCar. Wie kann ich helfen?",
"initialSilenceTimeoutMs": 1500,
"segmentationSilenceTimeoutMs": 500,
"phraseList": [
"NuvoCar"
]
},
"options": {
"model": "GPT_4_1_MINI",
"systemPrompt": "Du bist der digitale Empfang von NuvoCar. Frage nach dem Anliegen. Erfinde keine Preise oder Termine. Erkläre offen, wenn eine Auskunft fehlt. Behaupte keine Speicherung oder Weiterleitung ohne erfolgreiche konfigurierte Aktion.",
"conversationHistoryLimit": 20,
"knowledgeBaseId": null,
"ragTopK": 5,
"ragSimilarityThreshold": 0.5,
"temperature": 0.3,
"maxTokens": 1000,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 5,
"queryTransformConfidenceThreshold": 0.8,
"queryTransformMode": "LLM"
}
}
Antwort 200
Erfolgreich.
| Header | Typ | Beschreibung |
|---|---|---|
Cache-Control |
string |
Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store |
ETag |
string |
Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden. Beispiel: "revision-from-get" |
application/json
| Feld | Typ | Beschreibung |
|---|---|---|
id |
string (uuid) |
Ressourcen-ID in deinem Workspace. |
revision |
string |
Aktuelle Ressourcenrevision. Beim Ändern den ETag der Antwort als If-Match senden. |
agent |
object |
Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
enabled |
boolean |
Aktiviert den Agent. Auslassen oder null bedeutet false. |
agentType |
string |
VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Anzeigename der Ressource. Regeln: höchstens 255 Zeichen Beispiel: "Demo" |
description |
string |
Beschreibung des Zwecks dieser Ressource. Regeln: höchstens 10000 Zeichen; null erlaubt |
agentName |
string |
Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: höchstens 255 Zeichen Beispiel: "Demo Assistant" |
persona |
string |
Persönlichkeit und Sprechstil des Agents. Regeln: höchstens 10000 Zeichen; null erlaubt |
sttLanguages |
Liste von string |
Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: mindestens 1 Eintrag; keine doppelten Einträge Beispiel: ["de-DE"]Alle 85 erlaubten Werte anzeigen
|
voiceId |
string |
Exakte ID aus dem Stimmenkatalog einschließlich Anbieterpräfix. Regeln: höchstens 255 Zeichen |
voiceConfiguration |
object |
Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
greetingMorningText |
string |
Begrüßung am Morgen gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingAfternoonText |
string |
Begrüßung am Nachmittag gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
greetingEveningText |
string |
Begrüßung am Abend gemäß der Zeitzone des Agents. Regeln: höchstens 4000 Zeichen |
importantNote |
string |
Zusätzliche Anweisungen für den Agent. Regeln: höchstens 10000 Zeichen; null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. Regeln: 0–60000Beispiel: 1500 |
segmentationSilenceTimeoutMs |
integer (int32) |
Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. Regeln: 100–5000Beispiel: 500 |
phraseList |
Liste von string |
Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. Regeln: höchstens 500 Einträge; null erlaubtBeispiel: ["Nuvoca"]Je Eintrag: höchstens 500 Zeichen |
timezone |
string |
IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: höchstens 100 Zeichen; null erlaubtBeispiel: "Europe/Berlin" |
greetingNonInterruptible |
boolean |
Verhindert, dass der Anrufer die Begrüßung unterbricht. Regeln: null erlaubt |
greetingTimeoutSeconds |
integer (int32) |
Zeitlimit für die Begrüßung, in Sekunden. Regeln: 5–300; null erlaubtBeispiel: 30 |
sttProvider |
string |
Spracherkennungsanbieter aus dem Agent-Katalog. Regeln: null erlaubtWerte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. Regeln: 0.5–0.9; null erlaubt |
deepgramEotTimeoutMs |
integer (int32) |
Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. Regeln: 500–10000; null erlaubt |
deepgramLanguageHints |
Liste von string |
Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge; null erlaubtAlle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. Regeln: null erlaubt |
kugelLanguages |
Liste von string |
Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. Regeln: 1–9 Einträge; null erlaubt |
kugelTurnDetectionLevel |
string |
RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Regeln: null erlaubtWerte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
temperature |
number (double) |
Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
model |
string |
Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: höchstens 100000 Zeichen |
conversationHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. Regeln: 1–100Beispiel: 20 |
knowledgeBaseId |
string (uuid) |
ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Maximale Anzahl abgerufener Wissensabschnitte pro Suche. Regeln: 1–50Beispiel: 5 |
ragSimilarityThreshold |
number (double) |
Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. Regeln: 0–1Beispiel: 0.5 |
temperature |
number (double) |
Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2Beispiel: 0.3 |
maxTokens |
integer (int32) |
Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000Beispiel: 1000 |
ttsStreamingMode |
string |
Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. Regeln: 1–100Beispiel: 5 |
queryTransformPrompt |
string |
Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. Regeln: höchstens 20000 Zeichen |
queryTransformConfidenceThreshold |
number (double) |
Erforderliche Konfidenz für die Suchumformulierung. Regeln: 0–1Beispiel: 0.8 |
queryTransformMode |
string |
Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
rewriteModel |
string |
Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"id": "00000000-0000-0000-0000-000000000001",
"revision": "revision-from-get",
"agent": {
"enabled": false,
"agentType": "VOICE",
"title": "Demo",
"description": "string",
"agentName": "Demo Assistant",
"persona": "string",
"sttLanguages": [
"de-DE"
],
"voiceId": "azure:FLORIAN_HD",
"voiceConfiguration": {
"temperature": 0.3,
"topP": 0.3,
"topK": 1,
"cfgScale": 1,
"telecomEffectEnabled": false,
"enhancePronunciationEnabled": false,
"xmlLang": "de-AT",
"style": "string"
},
"greetingMorningText": "string",
"greetingAfternoonText": "string",
"greetingEveningText": "string",
"importantNote": "string",
"initialSilenceTimeoutMs": 1500,
"segmentationSilenceTimeoutMs": 500,
"phraseList": [
"Nuvoca"
],
"timezone": "Europe/Berlin",
"greetingNonInterruptible": false,
"greetingTimeoutSeconds": 30,
"sttProvider": "AZURE",
"deepgramEotThreshold": 0.5,
"deepgramEotTimeoutMs": 500,
"deepgramLanguageHints": [],
"preferPreProcessingGreeting": false,
"kugelLanguages": [
"string"
],
"kugelTurnDetectionLevel": "RESPONSIVE"
},
"options": {
"model": "GPT_4_1_MINI",
"reasoningEffort": "NONE",
"systemPrompt": "string",
"conversationHistoryLimit": 20,
"knowledgeBaseId": "00000000-0000-0000-0000-000000000001",
"ragTopK": 5,
"ragSimilarityThreshold": 0.5,
"temperature": 0.3,
"maxTokens": 1000,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 5,
"queryTransformPrompt": "string",
"queryTransformConfidenceThreshold": 0.8,
"queryTransformMode": "LLM",
"decisionQueryTransform": {
"rewriteModel": "GPT_4_1_MINI",
"parallel": false,
"decisionPrompt": "string",
"rewritePrompt": "string"
}
}
}
Fehlerantworten
| Status | Bedeutung |
|---|---|
400 |
Ungültige Eingabe, Auswahl oder Zeitgrenzen. |
401 |
Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein. |
403 |
Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein. |
404 |
Ressource im gebundenen Workspace nicht verfügbar. |
409 |
Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen. |
429 |
Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen. |
503 |
Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen. |
Fehler-Body
| Feld | Typ | Beschreibung |
|---|---|---|
status |
integer |
HTTP-Statuscode. |
error |
string |
Beschreibung des Fehlers. |
details |
any |
Weitere Fehlerdetails, sofern vorhanden. Regeln: null erlaubt |
code |
string |
Maschinenlesbarer Fehlercode. |
params |
object |
Zusätzliche Werte zum Fehlercode. |
fieldErrors |
object |
Validierungsfehler nach Eingabefeld. |
Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.
Bisherigen Agent-Snapshot lesen¶
Scope: agents:configuration:read
Bisheriger reiner Lese-Snapshot. Nutze GET /agents/{id} für die bearbeitbare Konfiguration mit ETag.
Parameter
| Name | Position | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
agentId |
Pfad | string (uuid) |
Ja | Ressourcen-ID im gebundenen Workspace. |
Antwort 200
Erfolgreich.
| Header | Typ | Beschreibung |
|---|---|---|
Cache-Control |
string |
Die Antwort darf nicht zwischengespeichert werden. Beispiel: no-store |
application/json
| Feld | Typ | Beschreibung |
|---|---|---|
agent |
object |
Einstellungen für Gespräch, Spracherkennung und Stimme. |
options |
object |
Einstellungen für Modell, Prompt und Wissenssuche. |
agent — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
agentId |
string (uuid) |
ID des Agents. |
tenantId |
string (uuid) |
ID des mit dem Zugang verbundenen Workspaces. |
enabled |
boolean |
Ob diese Ressource aktiviert ist. |
agentType |
string |
VOICE führt Telefongespräche; AGENTIC ist ein Fachagent in einem Agentic Flow. Werte: AGENTIC, VOICE |
title |
string |
Anzeigename der Ressource. |
description |
string |
Beschreibung des Zwecks dieser Ressource. Regeln: null erlaubt |
agentName |
string |
Name, mit dem sich der Agent im Gespräch vorstellt. Regeln: mindestens 1 Zeichen |
persona |
string |
Persönlichkeit und Sprechstil des Agents. Regeln: null erlaubt |
sttLanguages |
Liste von string |
Sprachen, die Azure erkennen soll. Bei einem anderen Spracherkennungsanbieter bleiben die Werte gespeichert. Regeln: keine doppelten Einträge Alle 85 erlaubten Werte anzeigen
|
voice |
string |
Stimmenkennung in der bisherigen Agent-Konfiguration.Alle 714 erlaubten Werte anzeigen
|
voiceConfiguration |
object |
Von der gewählten Stimme unterstützte Parameter. null entfernt sie beim Agent-Update. |
timezone |
string |
IANA-Zeitzone für zeitabhängiges Agent-Verhalten, etwa Europe/Berlin. Regeln: mindestens 1 Zeichen |
greetingMorningText |
string |
Begrüßung am Morgen gemäß der Zeitzone des Agents. |
greetingAfternoonText |
string |
Begrüßung am Nachmittag gemäß der Zeitzone des Agents. |
greetingEveningText |
string |
Begrüßung am Abend gemäß der Zeitzone des Agents. |
importantNote |
string |
Zusätzliche Anweisungen für den Agent. Regeln: null erlaubt |
initialSilenceTimeoutMs |
integer (int32) |
Wie lange Azure auf den Beginn einer Äußerung wartet, in Millisekunden. |
segmentationSilenceTimeoutMs |
integer (int32) |
Stille, nach der Azure erkannte Sprache in Abschnitte trennt, in Millisekunden. |
phraseList |
Liste von string |
Wörter oder Ausdrücke als Erkennungshilfe, etwa Produktnamen. Als einzelne Listeneinträge senden, nicht als kommagetrennten Text. |
greetingNonInterruptible |
boolean |
Verhindert, dass der Anrufer die Begrüßung unterbricht. |
greetingTimeoutSeconds |
integer (int32) |
Zeitlimit für die Begrüßung, in Sekunden. |
sttProvider |
string |
Spracherkennungsanbieter aus dem Agent-Katalog. Werte: AZURE, DEEPGRAM, KUGEL |
deepgramEotThreshold |
number |
Konfidenz, ab der Deepgram den Gesprächsbeitrag als beendet einstuft. |
deepgramEotTimeoutMs |
integer (int32) |
Deepgram-Zeitlimit für das Erkennen des Beitragsendes, in Millisekunden. |
deepgramLanguageHints |
Liste von string |
Sprachhinweise aus dem Agent-Katalog. Sie gewichten die Deepgram-Erkennung, ohne die unterstützten Sprachen einzuschränken. Regeln: keine doppelten Einträge Alle 10 erlaubten Werte anzeigen
|
preferPreProcessingGreeting |
boolean |
Verwendet die Begrüßung aus dem Pre Processing, sofern sie vorliegt. |
ttsProvider |
string |
Sprachausgabeanbieter in der bisherigen Agent-Konfiguration. Regeln: null erlaubtWerte: AZURE, KUGEL |
kugelVoiceId |
integer (int32) |
Stimmenkennung der bisherigen Kugel-Konfiguration. Regeln: ≥ 1; null erlaubt |
kugelLanguages |
Liste von string |
Geordnete Kugel-Sprachcodes aus dem Agent-Katalog. Die erste Sprache wird zu Gesprächsbeginn erwartet. Beim Anlegen gilt standardmäßig Deutsch; Auslassen beim Update behält die Liste. |
kugelTurnDetectionLevel |
string |
RESPONSIVE reagiert zügig; CONSERVATIVE wartet bei Denkpausen länger. Gilt für neue Anrufe; Auslassen beim Update behält die Einstellung. Werte: RESPONSIVE, CONSERVATIVE |
voiceConfiguration — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
temperature |
number (double) |
Sampling-Temperatur der Stimme. Niedrigere Werte erzeugen gleichmäßigere Sprache. Regeln: 0.3–1; null erlaubt |
topP |
number (double) |
Top-p-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 0.3–1; null erlaubt |
topK |
integer (int32) |
Top-k-Sampling-Einstellung, sofern von der Stimme unterstützt. Regeln: 1–50; null erlaubt |
cfgScale |
number (double) |
Stärke der Stimmsteuerung, sofern die Stimme diesen Parameter unterstützt. Regeln: 1–2; null erlaubt |
telecomEffectEnabled |
boolean |
Aktiviert Telefonklang für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
enhancePronunciationEnabled |
boolean |
Aktiviert die Ausspracheverfeinerung für unterstützte Azure-HD-Stimmen. null verwendet den Plattformstandard. |
xmlLang |
string |
Von der gewählten Stimme unterstützter Sprach- oder Akzentcode. Regeln: höchstens 10 Zeichen; null erlaubtBeispiel: "de-AT" |
style |
string |
Von der gewählten Stimme unterstützter Sprechstil. Regeln: höchstens 50 Zeichen; null erlaubt |
options — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
model |
string |
Agent-Modell aus dem Agent-Katalog. Reasoning-, Temperatur- und Outputgrenzen des Eintrags beachten.Alle 19 erlaubten Werte anzeigen
|
reasoningEffort |
string |
Vom gewählten Modell unterstützter Reasoning-Aufwand gemäß Agent-Katalog. Werte: NONE, MINIMAL, LOW |
systemPrompt |
string |
Vollständige Agent-Anweisungen einschließlich Verhalten, Wissensgrenzen und Fehlerbehandlung. Regeln: mindestens 1 Zeichen |
conversationHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für das Modell. |
knowledgeBaseId |
string (uuid) |
ID der zugeordneten Knowledge Base. null entfernt die Zuordnung. |
ragTopK |
integer (int32) |
Maximale Anzahl abgerufener Wissensabschnitte pro Suche. |
ragSimilarityThreshold |
number (double) |
Mindestähnlichkeit eines Wissensabschnitts, damit er berücksichtigt wird. |
temperature |
number (double) |
Variation der Antworten. Eine feste Temperatur im Katalogeintrag des Modells beachten. Regeln: 0–2 |
maxTokens |
integer (int32) |
Maximales Output-Tokenbudget. Zusätzlich die Grenze des gewählten Modells im Katalog beachten. Regeln: 10–25000 |
ttsStreamingMode |
string |
Sprachausgabemodus aus dem Agent-Katalog. Werte: QUALITY_SSML, LOW_LATENCY_TEXT_STREAM |
queryTransformEnabled |
boolean |
Formuliert Wissenssuchanfragen vor der Suche um. Auslassen oder null bedeutet false. |
queryTransformHistoryLimit |
integer (int32) |
Maximale Anzahl der Gesprächsverlaufseinträge für die Suchumformulierung. |
queryTransformPrompt |
string |
Prompt zur Suchumformulierung im LLM-Modus. DECISION verwendet decisionQueryTransform. |
queryTransformConfidenceThreshold |
number (double) |
Erforderliche Konfidenz für die Suchumformulierung. |
queryTransformMode |
string |
Verwendet eine LLM-Umformulierung oder einen separaten Suchentscheid mit Umformulierung. Werte: LLM, DECISION |
decisionQueryTransform |
object |
Einstellungen für Suchentscheidung und Suchumformulierung. Die Funktion muss im Agent-Katalog verfügbar sein. |
decisionQueryTransform — Felder
| Feld | Typ | Beschreibung |
|---|---|---|
rewriteModel |
string |
Modell zur Suchumformulierung. Im Katalog ein Modell mit supportsQueryRewrite=true wählen.Alle 19 erlaubten Werte anzeigen
|
parallel |
boolean |
Führt Suchentscheidung und Suchumformulierung gleichzeitig aus. |
decisionPrompt |
string |
Regeln für die Entscheidung, ob in der Knowledge Base gesucht wird: SEARCH oder SKIP. |
rewritePrompt |
string |
Anweisungen zur Umformulierung der Wissenssuchanfrage. |
{
"agent": {
"agentId": "00000000-0000-0000-0000-000000000001",
"tenantId": "00000000-0000-0000-0000-000000000001",
"enabled": false,
"agentType": "VOICE",
"title": "NuvoCar service",
"description": "string",
"agentName": "string",
"persona": "string",
"sttLanguages": [],
"voice": "KLAUS_MAI_FLASH",
"voiceConfiguration": {
"temperature": 0.3,
"topP": 0.3,
"topK": 1,
"cfgScale": 1,
"telecomEffectEnabled": false,
"enhancePronunciationEnabled": false,
"xmlLang": "de-AT",
"style": "string"
},
"timezone": "string",
"greetingMorningText": "string",
"greetingAfternoonText": "string",
"greetingEveningText": "string",
"importantNote": "string",
"initialSilenceTimeoutMs": 0,
"segmentationSilenceTimeoutMs": 0,
"phraseList": [],
"greetingNonInterruptible": false,
"greetingTimeoutSeconds": 0,
"sttProvider": "AZURE",
"deepgramEotThreshold": 0,
"deepgramEotTimeoutMs": 0,
"deepgramLanguageHints": [],
"preferPreProcessingGreeting": false,
"ttsProvider": "AZURE",
"kugelVoiceId": 1,
"kugelLanguages": [],
"kugelTurnDetectionLevel": "RESPONSIVE"
},
"options": {
"model": "GPT_4_1_MINI",
"reasoningEffort": "NONE",
"systemPrompt": "string",
"conversationHistoryLimit": 0,
"knowledgeBaseId": "00000000-0000-0000-0000-000000000001",
"ragTopK": 0,
"ragSimilarityThreshold": 0,
"temperature": 0,
"maxTokens": 10,
"ttsStreamingMode": "QUALITY_SSML",
"queryTransformEnabled": false,
"queryTransformHistoryLimit": 0,
"queryTransformPrompt": "string",
"queryTransformConfidenceThreshold": 0,
"queryTransformMode": "LLM",
"decisionQueryTransform": {
"rewriteModel": "GPT_4_1_MINI",
"parallel": false,
"decisionPrompt": "string",
"rewritePrompt": "string"
}
}
}
Fehlerantworten
| Status | Bedeutung |
|---|---|
400 |
Ungültige Eingabe, Auswahl oder Zeitgrenzen. |
401 |
Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein. |
403 |
Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein. |
404 |
Ressource im gebundenen Workspace nicht verfügbar. |
429 |
Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen. |
503 |
Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen. |
Fehler-Body
| Feld | Typ | Beschreibung |
|---|---|---|
status |
integer |
HTTP-Statuscode. |
error |
string |
Beschreibung des Fehlers. |
details |
any |
Weitere Fehlerdetails, sofern vorhanden. Regeln: null erlaubt |
code |
string |
Maschinenlesbarer Fehlercode. |
params |
object |
Zusätzliche Werte zum Fehlercode. |
fieldErrors |
object |
Validierungsfehler nach Eingabefeld. |
Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.