Obsidian integration

[Di3mex]

My workflow

Asking the question

• As Obsidian is more or less a webbrowser at its core, GPT-Researcher can be opened as a browser tab. This is achieved by installing the Surfing plugin inside Obsidian, which allows me to have browser tabs alongside notes.
• Now I can ask my question directly inside Obsidian

Export to Obsidian

• Wait until report is finished, press button to export the report using the send to obsidian button.

Read and continue

• Now that the text is a note in obsidian, I can work with it, find other related notes and ask follow up questions.

Implementation

Key points

• Uses Obsidian Local REST API plugin
• Configurable Obsidian template
• Direct export to obsidian with a single click
• Configurable folder inside obsidian

Details

• This implementation requires the user to install the Local REST API plugin in Obsidian.
• There is a simple markdown template with two placeholders for the agent output and research report. These are filled by GPT researcher. Additionally there are templater variables like the current date, a link to the current daily note. These will be automatically filled by Templater when the rest request is received in Obsidian. Of course all templater variables can be used.

Limitations

• The Local REST API is a bit of a pain to setup. By default it uses a HTTPS connection which requires the client to accept the self signed certificate. In this case a command needs to be run so that the python env trusts the certificate. Not 100% sure anymore, but that has to be documented.
• This is the first time since 2011 that I have worked with javascript. I am open to feedback on how to improve the code.

Outlook

• I currently need to wait for the export to finish, before I can press the button to export. It would be even cooler if the export to Obsidian could be done automatically when its complete. This could be a config option OBSIDIAN_AUTO_EXPORT=true.

[Di3mex]

My PR includes a minor change in that the copytoclipboard and send to obsidian button are disabled until a research report is generated.

[assafelovic]

Thank you @Di3mex for this awesome contribution, let us review it in the coming week and update. It holds great potential but will require additional installation steps from users, so we need to consider how to best structure it.

[assafelovic]

also @Di3mex please see conflicts