Skip to content
ochat
Search documentation

Use quotes for an exact phrase.

Search by topic, command, or code identifier.

    GitHub ↗

    Applications

    Turn scattered notes into a research brief

    Compare supplied source notes, preserve attribution, and separate evidence from open questions.

    View Markdown source ↗
    ← All applications

    InputTwo labeled research notes

    OutputA comparison and questions to investigate

    Setup Installed Ochat, a configured provider with access to gpt-4.1 (or an edited supported model), and launch from the extracted directory. Model requests incur provider charges.

    Inspect the agent files →Give an agent a file tool →
    Workflow overview · illustrative
    1. Read both sources
    2. Compare the evidence
    3. Write a sourced brief

    Compare supplied source notes, preserve attribution, and separate evidence from open questions.

    Start with supplied notes, then add web-page ingestion and indexed retrieval when your research grows.

    The outcome

    Section titled “The outcome”

    Input: Two labeled research notes.

    Output: A comparison and questions to investigate.

    Run the supplied-notes example

    Section titled “Run the supplied-notes example”

    Complete installation and provider setup, extract the research-brief bundle, and run from that directory:

    Terminal window
    mkdir -p runs
    ochat chat-completion -prompt-file agent.chatmd -output-file runs/brief-01.chatmd

    The prompt already includes the question. The two notes describe a fictional team’s documentation needs. A useful brief cites reference/notes-a.txt and reference/notes-b.txt, compares the supplied evidence, and leaves unresolved questions open. These notes do not establish which hosting provider is best.

    Add real research inputs

    Section titled “Add real research inputs”

    Replace the sample notes with material you may share with your provider. Keep a source title, URL where applicable, and capture date alongside each note. For supplied public URLs, declare webpage_to_markdown using the built-in tool guide. For a growing local collection, follow Markdown indexing and retrieval. The included agent reads local files; it does not browse or build an index.

    Check and extend the result

    Section titled “Check and extend the result”

    Open the saved ChatMD transcript and check citations against the source notes. Do not treat a fluent synthesis as independent verification. A specialist can review attribution or missing evidence using the agent composition pattern.

    Explore another application or follow the tutorial curriculum.

    View source · Research brief4 files

    Complete source files. Open a filename to read it here.

    agent.chatmdStart here
    <config model="gpt-4.1" max_tokens="1200"/>
<tool name="read_file">
  <read id="reference" path="${workspace}/reference" description="Included example input files"/>
</tool>
<developer>Read notes-a.txt and notes-b.txt from the reference root. Produce a concise comparison of the two publishing approaches, cite each supplied note by filename, and list unanswered questions. Do not claim to have browsed the web or infer facts not present in the notes.</developer>
<user>Compare the two options for the Lantern team. Which questions should we resolve before deciding?</user>

    Link to this fileDownload this file

    reference/notes-a.txtdata
    Source A: Lantern team interview (fictional sample)
The team has three maintainers. Documentation changes are reviewed in Git. They prefer a static site and do not need authentication. They have not chosen a hosting provider.

    Link to this fileDownload this file

    reference/notes-b.txtdata
    Source B: Lantern operations note (fictional sample)
The team can maintain a build pipeline but has little time to operate a server. Search is required. They have not tested either hosting option or agreed who handles releases.

    Link to this fileDownload this file

    LICENSE.txtnotice
    MIT License

Copyright (c) 2025 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

    Link to this fileDownload this file