{"id":14069937,"url":"https://github.com/BWurster/explain-selection-with-ai","last_synced_at":"2025-07-30T06:33:29.836Z","repository":{"id":243338989,"uuid":"805638973","full_name":"BWurster/explain-selection-with-ai","owner":"BWurster","description":"This is my first go at making an Obsidian plugin to elaborate on and describe selected bits of information and their context.","archived":false,"fork":false,"pushed_at":"2024-06-19T02:32:04.000Z","size":45,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-04T01:07:55.598Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BWurster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-25T03:45:47.000Z","updated_at":"2024-09-30T00:10:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"4f0e07f4-a7fe-42ee-95d9-7c39313d7c12","html_url":"https://github.com/BWurster/explain-selection-with-ai","commit_stats":null,"previous_names":["bwurster/obsidian-ai-expander"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWurster%2Fexplain-selection-with-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWurster%2Fexplain-selection-with-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWurster%2Fexplain-selection-with-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BWurster%2Fexplain-selection-with-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BWurster","download_url":"https://codeload.github.com/BWurster/explain-selection-with-ai/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228102435,"owners_count":17869849,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:07:21.101Z","updated_at":"2024-12-04T11:31:08.116Z","avatar_url":"https://github.com/BWurster.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Obsidian Explain Selection with AI Plugin\n\nThis is a plugin for Obsidian (https://obsidian.md).\n\nThis plugin provides an additional element to the editor context menu that will prompt an [OpenAI Chat Completion API](https://platform.openai.com/docs/guides/text-generation/chat-completions-api)-compatible AI endpoint to elaborate on the selected text in the surrounding context.\n\nThere are three supported ways to set this up:\n1. Using OpenAI\n2. Using Ollama\n3. Running a custom local or remote model\n\n## Using OpenAI (recommended)\n\nThe AI endpoint is the parameter that defines the LLM that is used for text generation. If you are using OpenAI models, possible options for this field could be\n\n- `gpt-3.5-turbo`\n- `gpt-4o`\n- `gpt-4-turbo`\n\nIf this is the case for you, you will also need to have the OpenAI key field populated with your API key from OpenAI.\n\nIf you wish to use other OpenAI model, perform an advanced custom setup with the `Base URL` set to `https://api.openai.com/v1/` and the endpoint set to your desired OpenAI model.\n\n## Using Ollama\n\n[Ollama](https://www.ollama.com/) is an open-source way to manage locally installed and ran large-language models. Such a system supports the [OpenAI Chat Completion API](https://platform.openai.com/docs/guides/text-generation/chat-completions-api) format, so it has been added as an easy integration with support for `llama3` and `mistral` models.\n\nIf you wish to use other models at this time, see the next section on configuring alternative local models, setting the `Base URL` to point at your Ollama instance (`http://localhost:11434/v1/` by default) and then set the `Endpoint` setting to be your desired [Ollama model](https://www.ollama.com/library)\n\n## Using alternative local or remote model (advanced)\n\nIf you are not familiar with the [Hugging Face Text Generation Interface (TGI)](https://huggingface.co/docs/text-generation-inference/en/index), it is not recommended to go this route. Having access to models spun up locally or remotely is a prerequisite for successfully using this interface and is beyond the scope of this documentation.\n\nWith this in mind, provide the `Base URL` and `Endpoint` settings as well as an optional `API Key` should your setup necessitate that to interface with your local or remote model.\n\nThis is ultimately an \"under-the-hood\" access to the Chat API to be an option for more advanced users or restricted endpoints.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBWurster%2Fexplain-selection-with-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBWurster%2Fexplain-selection-with-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBWurster%2Fexplain-selection-with-ai/lists"}