euphony README

The project's README from github.com/openai/euphony. As one markdown file: README.md.

Euphony: Harmony Chat and Codex Session Viewer

Build license

Visualize harmony chat conversations and Codex sessions in your browser 🎵

🎵 Euphony Demo 💬 Harmony Chat Example 🤖 Codex Session Example

Harmony conversations and Codex session logs are useful across training, evaluation, and agent workflows, but they are often difficult to inspect. Euphony addresses that gap by providing portable, customizable, and modular Web Components for visualizing structured chat data and Codex sessions in the browser.

Features

Feature What it does
Harmony conversation viewer Renders Harmony conversations with support for different message types and metadata.
Codex session viewer Detects Codex session JSONL files, converts them into a conversation, and renders them in the same viewer.
Flexible loading Loads data from the clipboard, local .json or .jsonl files, or public HTTP(S) JSON/JSONL URLs.
Markdown and HTML rendering Renders markdown in message content, including formulas and optional HTML blocks.
Translation Translates non-English text into English in normal mode or frontend-only mode with a user-provided OpenAI API key.
Metadata inspection Exposes conversation-level and message-level metadata directly in the UI.
Filtering and focus mode Filters datasets with JMESPath and narrows visible messages by role, recipient, or content type.
Grid and editor modes Supports dataset skimming in grid view and direct JSONL editing in editor mode.
Harmony token rendering Shows Harmony renderer output, token IDs, decoded tokens, and rendered display strings.
Embeddable web components Ships reusable custom elements for integrating the viewer into other web apps in any framework (e.g., React, Svelte, Vue).

Get Started

There are two ways you can use Euphony.

  1. Use the standalone app to view Harmony JSON/JSONL data and Codex session JSONL files.
  2. Use the Euphony JavaScript library to render Harmony data in your own web app.

Use Euphony to View My Data

  1. Load data from one of the supported sources:
    1. Paste JSON or JSONL from the clipboard
    2. Choose a local .json or .jsonl file
    3. Provide a public HTTP(S) URL that serves JSON or JSONL (e.g., Hugging Face)
  2. Euphony automatically detects and renders the input:
    1. If the JSONL is a list of conversations → Euphony renders all conversations
    2. If the JSONL is a Codex session file → Euphony renders a structured Codex session timeline
    3. If the conversation is stored at some top-level field → Euphony renders all conversations and treat other top-level fields as each conversation’s metadata
    4. Else → Euphony renders the data as raw JSON objects

Integrate Euphony into My Web App

Web Component API

To use Euphony web components, first build the Euphony library:

pnpm install
pnpm run build:library

The main library entrypoint is built at: ./lib/euphony.js.

Then, you can import the JS file. To show a viewer of Harmony data, you can add the web component to your HTML file (or React, Svelte, Vue components):

<euphony-conversation conversation-string="HARMONY_CONVERSATION_JSON_STRING">
</euphony-conversation>

Alternatively, you can pass parsed JSON object directly into the euphony-conversation HTMLElement from Javascript.

const harmonyConversation: Conversation;
const myEuphonyConvoElement = document.querySelector('euphony-conversation');
myEuphonyConvoElement.conversationJSON = harmonyConversation;

Euphony web components are customizable. For example, to style these components, you can override CSS variables in your stylesheets.

--euphony-padding-v: 10px;
--euphony-padding-h: 15px;
--euphony-font-color: hsl(0, 0%, 12.94%);
--euphony-font-color-secondary: hsl(0, 0%, 61.96%);
--euphony-user-color: hsl(122, 43.43%, 38.82%);
--euphony-assistant-color: hsl(282, 67.88%, 37.84%);
--euphony-conv-background-color: hsl(0, 0%, 96.08%);

Frontend-only and Backend-assisted Modes

Euphony can run in two modes:

Mode What it is for
Frontend-only mode Recommended for static or external hosting. URL loading happens in the browser, and translation uses a user-provided OpenAI API key when needed.
Backend-assisted mode Optional for local development. The FastAPI server supports remote JSON/JSONL loading, backend translation, and Harmony rendering. Useful to load large datasets.

The backend server is optional. It should only be used locally. Frontend-only mode is controlled with the Vite env variable VITE_EUPHONY_FRONTEND_ONLY.

The current backend includes a remote URL fetch path for loading JSON and JSONL data. If you host that backend on an external server, it can introduce SSRF risk because the server may be tricked into fetching attacker-controlled URLs. Therefore, only use the backend-assisted mode for local development.

Development

To develop Euphony locally, install Node.js and a package manager such as pnpm.

Start the backend server:

pnpm install
uvicorn fastapi-main:app --app-dir server --host 127.0.0.1 --port 8020 --reload

Start the frontend development server:

pnpm run dev

To force frontend-only mode with Vite:

VITE_EUPHONY_FRONTEND_ONLY=true pnpm run dev

Visit http://localhost:3000/, you should see Euphony running in your browser!

To build the static frontend:

pnpm run build
python -m http.server -d ./dist

To build a frontend-only static bundle:

VITE_EUPHONY_FRONTEND_ONLY=true pnpm run build
python -m http.server -d ./dist

License

Euphony is released under the Apache 2.0 license. See LICENSE.

The file src/css/prism-coldark-auto.css is derived from an upstream Prism theme (GitHub) and remains subject to the MIT license terms of that upstream work.

euphony (openai/euphony)

Searching Database…

What is this?Euphony is a browser viewer for Harmony chat data and Codex session logs. You can use it as a standalone app or embed it in your own web app as web components.
Is it a standalone app or a library I can embed?Both. You can open the standalone app to view Harmony JSON/JSONL and Codex session files, or use the Euphony JavaScript library to render Harmony data inside your own web app.
How do I get it running?Install Node.js and pnpm, clone the repository, and start the frontend development server. For a static deployment, build the frontend bundle instead.
Do I need to run a backend server?No. The FastAPI backend is optional and intended only for local development, mainly for loading large datasets. Frontend-only mode is recommended for static or external hosting.
Can I expose the backend on a public server?Not safely. Its remote URL fetching can be abused for SSRF, so the backend-assisted mode should only be used on your local machine.
Can I use it inside a React, Svelte or Vue app?Yes. It ships as custom elements that work in any framework, and you can restyle them by overriding CSS variables.
Where does my data go when I load URLs or translate text?In frontend-only mode, URL loading happens in your browser. Translation uses an OpenAI API key that you provide, and only when needed.
Why was Euphony built?Harmony chat data and Codex session logs are useful for training, evaluation and agent workflows but are hard to inspect. Euphony provides portable web components and a viewer to fill that gap.
What can I do with the loaded data?Filter with JMESPath and focus on messages by role, recipient or content type, skim datasets in grid view, edit JSONL directly in editor mode, and inspect Harmony token IDs and rendered output.
Does it translate non-English messages?Yes. It can translate non-English text into English in normal mode or frontend-only mode, using an OpenAI API key that you supply.
Creator
openai
Size
2.6 MB
Stars
426
Updated
CommitApr 22
Age
7mo
Commits · 90 Days