Brand Voice-Zusammenfassungen

Eine Brand Voice in ihre Zusammenfassung im Prompt-Text rendern

POST/api/v1/workspaces/{workspaceId}/brand-voice-summaries

Rendern Sie die Brand Voice, die durch brandVoiceId identifiziert wird, in das Klartextfragment, das die nachgelagerte LLM-Generierung steuert. Synchron; die Antwort ist der geränderte String.

Ressource. Eine BrandVoiceSummary ist die geränderte Textform einer Brand Voice — die deterministische Ausgabe des Renderers für eine gegebene Brand-Voice-ID. Dieser Endpunkt erstellt eine. Die Ausgabe ist für die gleiche Brand Voice konsistent und eignet sich zum Einfügen in den System-Prompt eines nachgelagerten LLM-Aufrufs.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
workspaceId	string	Ja	Der Arbeitsbereich, auf den die Anfrage operiert. Muss mit dem Workspace-Anspruch im Gateway-Token übereinstimmen.

Anfrage-Body

FeldTypErforderlichBeschreibung

brandVoiceIdstringJaKennung der Brand Voice, die zusammengefasst werden soll. Gibt 404 brandVoiceNotFound zurück, wenn die ID keiner Brand Voice in diesem Arbeitsbereich entspricht, oder 403, wenn der Aufrufer kein Mitglied des Arbeitsbereichs ist.

Antwort

FeldTypBeschreibung

textstringGeränderte Klartext-Brand-Voice-Zusammenfassung, bereit zum Einfügen in den System-Prompt eines nachgelagerten LLM-Aufrufs. Das Format wird durch die serverseitige Vorlage festgelegt (geladen aus shared_{env}.prompts_v1 für jeden Aufruf) und ist für die gleiche Brand Voice über Aufrufe hinweg konsistent.

Beispiel

cURL

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/brand-voice-summaries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "brandVoiceId": "string"
  }'

Python

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/brand-voice-summaries",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "brandVoiceId": "string"
    },
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/v1/workspaces/${workspaceId}/brand-voice-summaries`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "brandVoiceId": "string"
    }),
  }
).then((r) => r.json());

Go

body, _ := json.Marshal(map[string]any{
		"brandVoiceId": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/v1/workspaces/"+workspaceID+"/brand-voice-summaries", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "text": "## **Brand Voice Dokumentation**\n..."
}