Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 2.79 KB

README.md

File metadata and controls

74 lines (58 loc) · 2.79 KB
Raw

Obsidian AI Image Analyser Plugin

This plugin allows you to analyze images in Obsidian using the Ollama API. Because of this it requires Ollama to be installed and running on some machine. Ensure you have the newest version of Ollama installed. Ollama download

Features

It analyses images and returns a keyword list of the image.

Currently it supports:

  • jpg
  • jpeg
  • png
  • webp

How to use

To analyze an image, right-click on the image and select Ai analyze image. Or use the command palette and search for AI image analyzer.

Models

The plugin uses the llava-llama3 model from Ollama as the default model.

Other models can be used by changing the model setting in the plugin settings:

  • llava-llama3
  • llava
  • llava:13b
  • llava:34b

If you have a really powerful Computer I recommend using the llava:13b or llava:34b model, in my testing they were the most accurate. llava for me was the worst model, but it is a little bit smaller than the llava-llama3 model.

OmniSearch

The plugin is integrated with the Obsidian OmniSearch Plugin. You can enable Image AI Indexing in the settings of the OmniSearch plugin to index the results of the image analysis.

Cache & Sync

The plugin caches the results of the analysis, so it doesn't have to be done every time. It caches the result in a json file inside the plugin folder. Those files can be synced between devices.

Limitations

The prompt to analyze the image will sometimes deliver varying results. In the future, I will improve on the prompt to make it more consistent. You can also modify the prompt in the settings.

Installation

You can download the latest release from the GitHub releases page and install it manually in Obsidian. In the future, this plugin will hopefully be available in the Obsidian community plugins.

Using AI image analyser as a dependency for your plugin

The exposed API:

// Add this type somewhere in your code
export type AIImageAnalyzerAPI = {
	analyzeImage: (file: TFile) => Promise<string>;
	canBeAnalyzed: (file: TFile) => boolean;
	isInCache: (file: TFile) => Promise<boolean>;
}

// Then, you can just use this function to get the API
export function getAIImageAnalyser(): AIImageAnalyzerAPI | undefined {
	return (app as any).plugins?.plugins?.['ai-image-analyzer']?.api
}

// And use it like this
const text = await getAIImageAnalyser()?.analyzeImage(file)

Contributing

If you want to contribute to this plugin, you can do so by creating a pull request or an issue on the GitHub repository.

Thanks

This plugin is heavily inspired by the Obsidian Text Extractor Plugin.