diff --git a/README.md b/README.md index cedac49..9965983 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ Sets the API key and the verbose-logging switch. - **Cost:** the service restarts, since the proxy reads its config at start. - **Repeat safety:** idempotent. **Leaving the key blank keeps the existing one** rather than clearing it, so the action can be used to toggle logging without re-entering the key. - **The key is never echoed back into the form.** The logging toggle is pre-filled; the key is not. -- **Verbose logging** adds a log line naming the model of each chat request, and logs errors that cut off a streamed reply. Prompt and reply contents are never logged. +- **Verbose logging** adds model information for accepted chat requests and logs OpenAI stream errors. Error messages may include sensitive content, even when verbose logging is off. - **The key's shape is checked before it is written.** Upstream's status page rejects a malformed key outright, but a bad key written straight into the config file would only surface later as a failed request — so the same check is applied here. **Requests are billed to whichever key is set.** diff --git a/instructions.md b/instructions.md index 6afbf8c..7f88ac4 100644 --- a/instructions.md +++ b/instructions.md @@ -70,7 +70,9 @@ PPQ.AI key per request, pass it as an `Authorization: Bearer` header. Either surface works, and both write the same place: **Replace key** on the Status Page, or the **Configure PPQ API Key** action. The action is also where you turn Verbose Logging on and off; leaving its key field blank keeps the key -you already saved. +you already saved. Verbose Logging adds model information for accepted chat +requests and logs OpenAI stream errors. Error messages may include sensitive +content, even when Verbose Logging is off; review logs before sharing them. ## Limitations diff --git a/startos/actions/configureApiKey.ts b/startos/actions/configureApiKey.ts index d73e7d7..55c0d06 100644 --- a/startos/actions/configureApiKey.ts +++ b/startos/actions/configureApiKey.ts @@ -28,7 +28,7 @@ const inputSpec = InputSpec.of({ debug: Value.toggle({ name: i18n('Verbose Logging'), description: i18n( - 'Adds a log line naming the model for each chat request, and logs errors that cut off a streamed reply. Prompts and replies are never logged.', + 'Logs the model for accepted chat requests and OpenAI stream errors. Error messages may include sensitive content, even when Verbose Logging is off.', ), default: false, }), diff --git a/startos/i18n/dictionaries/default.ts b/startos/i18n/dictionaries/default.ts index 30b90cf..018da89 100644 --- a/startos/i18n/dictionaries/default.ts +++ b/startos/i18n/dictionaries/default.ts @@ -16,7 +16,7 @@ const dict = { 'Your API key from ppq.ai (Settings → API Keys). Leave blank to keep the key already saved, or to set one later from the Status Page.': 9, 'A PPQ.AI key starts with "sk-".': 10, 'Verbose Logging': 11, - 'Adds a log line naming the model for each chat request, and logs errors that cut off a streamed reply. Prompts and replies are never logged.': 12, + 'Logs the model for accepted chat requests and OpenAI stream errors. Error messages may include sensitive content, even when Verbose Logging is off.': 12, 'Configure PPQ API Key': 13, 'Set the PPQ.AI API key the proxy uses to authenticate. Requests are billed to this key.': 14, // init/taskConfigureApiKey.ts diff --git a/startos/i18n/dictionaries/translations.ts b/startos/i18n/dictionaries/translations.ts index 3331a1e..6ea80d1 100644 --- a/startos/i18n/dictionaries/translations.ts +++ b/startos/i18n/dictionaries/translations.ts @@ -14,7 +14,7 @@ export default { 9: 'Tu clave API de ppq.ai (Ajustes → Claves API). Déjalo en blanco para conservar la clave ya guardada, o para configurar una más tarde desde la Página de estado.', 10: 'Una clave de PPQ.AI empieza por «sk-».', 11: 'Registro detallado', - 12: 'Añade una línea de registro con el modelo de cada solicitud de chat y registra los errores que interrumpen una respuesta en streaming. Los prompts y las respuestas nunca se registran.', + 12: 'Registra el modelo de las solicitudes de chat aceptadas y los errores de streaming de OpenAI. Los mensajes de error pueden incluir contenido sensible, incluso cuando el Registro detallado está desactivado.', 13: 'Configurar clave API de PPQ', 14: 'Establece la clave API de PPQ.AI que el proxy usa para autenticarse. Las solicitudes se facturan a esta clave.', 15: 'Añade aquí tu clave API de PPQ.AI, o inicia el servicio y guárdala en la Página de estado', @@ -32,7 +32,7 @@ export default { 9: 'Dein API-Schlüssel von ppq.ai (Einstellungen → API-Schlüssel). Leer lassen, um den bereits gespeicherten Schlüssel zu behalten oder später auf der Statusseite einen festzulegen.', 10: 'Ein PPQ.AI-Schlüssel beginnt mit „sk-“.', 11: 'Ausführliche Protokollierung', - 12: 'Fügt für jede Chat-Anfrage eine Protokollzeile mit dem verwendeten Modell hinzu und protokolliert Fehler, die eine gestreamte Antwort abbrechen. Eingaben und Antworten werden nie protokolliert.', + 12: 'Protokolliert das Modell akzeptierter Chat-Anfragen und OpenAI-Streamingfehler. Fehlermeldungen können sensible Inhalte enthalten, auch wenn die Ausführliche Protokollierung deaktiviert ist.', 13: 'PPQ-API-Schlüssel konfigurieren', 14: 'Lege den PPQ.AI-API-Schlüssel fest, mit dem sich der Proxy authentifiziert. Anfragen werden diesem Schlüssel in Rechnung gestellt.', 15: 'Füge deinen PPQ.AI-API-Schlüssel hier hinzu, oder starte den Dienst und speichere ihn auf der Statusseite', @@ -50,7 +50,7 @@ export default { 9: 'Twój klucz API z ppq.ai (Ustawienia → Klucze API). Pozostaw puste, aby zachować już zapisany klucz lub ustawić go później na Stronie stanu.', 10: 'Klucz PPQ.AI zaczyna się od „sk-”.', 11: 'Szczegółowe logowanie', - 12: 'Dodaje do logu wiersz z nazwą modelu dla każdego żądania czatu i rejestruje błędy, które przerywają strumieniowaną odpowiedź. Treść zapytań i odpowiedzi nigdy nie jest logowana.', + 12: 'Rejestruje model zaakceptowanych żądań czatu i błędy strumieniowania OpenAI. Komunikaty błędów mogą zawierać poufne treści, nawet gdy Szczegółowe logowanie jest wyłączone.', 13: 'Skonfiguruj klucz API PPQ', 14: 'Ustaw klucz API PPQ.AI, którym proxy się uwierzytelnia. Żądania są rozliczane na ten klucz.', 15: 'Dodaj tutaj swój klucz API PPQ.AI albo uruchom usługę i zapisz go na Stronie stanu', @@ -68,7 +68,7 @@ export default { 9: "Votre clé API de ppq.ai (Paramètres → Clés API). Laissez vide pour conserver la clé déjà enregistrée, ou pour en définir une plus tard depuis la Page d'état.", 10: 'Une clé PPQ.AI commence par « sk- ».', 11: 'Journalisation détaillée', - 12: 'Ajoute une ligne de journal indiquant le modèle de chaque requête de chat, et journalise les erreurs qui interrompent une réponse en streaming. Les prompts et les réponses ne sont jamais journalisés.', + 12: "Journalise le modèle des requêtes de chat acceptées et les erreurs de streaming OpenAI. Les messages d'erreur peuvent inclure du contenu sensible, même lorsque la Journalisation détaillée est désactivée.", 13: 'Configurer la clé API PPQ', 14: "Définissez la clé API PPQ.AI avec laquelle le proxy s'authentifie. Les requêtes sont facturées sur cette clé.", 15: "Ajoutez ici votre clé API PPQ.AI, ou démarrez le service et enregistrez-la sur la Page d'état",