# Omnio-js > Documentation for Omnio-js ## Docs - [Omnio-js](https://omnio-project.github.io/omnio-js): オブジェクトストレージにメタデータ検索と意味検索を組み合わせる TypeScript ライブラリです。 ## チュートリアル - [チュートリアル](https://omnio-project.github.io/omnio-js/tutorials): Omnio-js を動かしながら学ぶための入門用チュートリアルです。 - [最初のオブジェクトを保存する](https://omnio-project.github.io/omnio-js/tutorials/first-objects): Omnio を組み立て、オブジェクトの保存・取得・検索・削除を一通り試します。 - [意味検索を試す](https://omnio-project.github.io/omnio-js/tutorials/semantic-search): 複数のオブジェクトを保存し、テキスト検索・タグ絞り込み・画像検索を試します。 ## ハウツーガイド - [ハウツーガイド](https://omnio-project.github.io/omnio-js/how-to): 特定の課題を解決するための手順を目的別にまとめています。 - [部品を選んで設定する](https://omnio-project.github.io/omnio-js/how-to/configure-stack): 実行環境に合わせてエンティティストレージ、インデックス、埋め込み器を選び、Omnio を組み立てます。 - [データを永続化する](https://omnio-project.github.io/omnio-js/how-to/persist-data): エンティティストレージとインデックスを永続化し、再起動後もオブジェクトを読み出せるようにします。 - [絞り込んで一覧する](https://omnio-project.github.io/omnio-js/how-to/filter-and-paginate): メタデータ条件でオブジェクトを絞り込み、カーソルでページを取得します。 - [更新・複製・移動・削除](https://omnio-project.github.io/omnio-js/how-to/modify-objects): 保存済みオブジェクトのメタデータ更新、複製、キー変更、削除の使い分けを説明します。 - [埋め込みを管理する](https://omnio-project.github.io/omnio-js/how-to/manage-embeddings): 埋め込みの生成を制御し、モデルを変更した後に既存データを再インデックスします。 - [画像で検索する](https://omnio-project.github.io/omnio-js/how-to/search-images): 画像クエリーを使った意味検索と、その前提条件を説明します。 - [エラーと中断を扱う](https://omnio-project.github.io/omnio-js/how-to/handle-errors): Omnio が投げる例外を分類し、AbortSignal で操作を安全に中断します。 ## リファレンス - [リファレンス](https://omnio-project.github.io/omnio-js/reference): Omnio-js の API、型、設定値、エラーの正確な仕様をまとめています。 - [Omnio クラス](https://omnio-project.github.io/omnio-js/reference/omnio): Omnio のコンストラクター、プロパティ、公開メソッドのリファレンスです。 - [オブジェクトモデル](https://omnio-project.github.io/omnio-js/reference/object-model): OmnioObject のフィールド、可変メタデータ、レコードタイプのリファレンスです。 - [オブジェクトキー](https://omnio-project.github.io/omnio-js/reference/object-keys): OmnioKey の解析方法と、オブジェクトキーの制約のリファレンスです。 - [メタデータフィルター](https://omnio-project.github.io/omnio-js/reference/metadata-filter): listObjects と searchObjects で使う MetadataFilter の型と条件の意味をまとめています。 - [エラー](https://omnio-project.github.io/omnio-js/reference/errors): Omnio-js が公開する例外クラスと、発生条件のリファレンスです。 - [インデックス](https://omnio-project.github.io/omnio-js/reference/indexes): SQL インデックスパッケージのオプション、ベクトル検索、マイグレーション、IObjectIndex のリファレンスです。 - [埋め込み器](https://omnio-project.github.io/omnio-js/reference/embedders): Gemma2Embedder のオプションと、IEmbedder インターフェースのリファレンスです。 - [エンティティストレージ](https://omnio-project.github.io/omnio-js/reference/storage): IOmnioEntity、IOmnioEntityBuilder、unikvs の接続方法のリファレンスです。 ## 解説 - [解説](https://omnio-project.github.io/omnio-js/explanation): Omnio-js の設計と、一貫性・検索・削除の仕組みを説明します。 - [アーキテクチャ](https://omnio-project.github.io/omnio-js/explanation/architecture): Omnio-js を構成するエンティティストレージ、インデックス、埋め込み器の役割と処理の流れを説明します。 - [一貫性とライフサイクル](https://omnio-project.github.io/omnio-js/explanation/consistency-and-lifecycle): Omnio の可視性、削除、クラッシュ復旧、複数プロセスでの注意点を説明します。 - [意味検索の仕組み](https://omnio-project.github.io/omnio-js/explanation/semantic-search): 埋め込み、類似度、モデル変更、再インデックスの考え方を説明します。 ## Changelog - [v0.0.5](https://omnio-project.github.io/omnio-js/changelog/v0-0-5): 物理削除の予約を永続化して crash safety を確保する (5dfa2eb)削除した実体の物理削除に猶予期間を設ける (c24824d)実体を不変化し取得時にチェックサムを検証する… ## English ### Docs - [Omnio-js](https://omnio-project.github.io/omnio-js/en): A TypeScript library that combines object storage with metadata and semantic search. ### Tutorials - [Tutorials](https://omnio-project.github.io/omnio-js/en/tutorials): Hands-on tutorials for learning Omnio-js by building and running code. - [Save your first object](https://omnio-project.github.io/omnio-js/en/tutorials/first-objects): Build an Omnio instance and try saving, reading, searching, and deleting an object. - [Try semantic search](https://omnio-project.github.io/omnio-js/en/tutorials/semantic-search): Save several objects and try text search, tag filters, and image queries. ### How-to guides - [How-to guides](https://omnio-project.github.io/omnio-js/en/how-to): Task-oriented steps for solving specific problems with Omnio-js. - [Choose and configure components](https://omnio-project.github.io/omnio-js/en/how-to/configure-stack): Select an entity store, index, and embedder for your environment, then construct Omnio. - [Persist data](https://omnio-project.github.io/omnio-js/en/how-to/persist-data): Keep entity storage and the index across restarts so objects can be read again. - [Filter and paginate](https://omnio-project.github.io/omnio-js/en/how-to/filter-and-paginate): Narrow objects with metadata conditions and return pages with a cursor. - [Update, copy, rename, and delete](https://omnio-project.github.io/omnio-js/en/how-to/modify-objects): Choose between metadata updates, copying, renaming, overwriting, and deleting objects. - [Manage embeddings](https://omnio-project.github.io/omnio-js/en/how-to/manage-embeddings): Control embedding generation and reindex existing objects after changing the model. - [Search by image](https://omnio-project.github.io/omnio-js/en/how-to/search-images): Use an image query for semantic search and understand what it compares against. - [Handle errors and cancellation](https://omnio-project.github.io/omnio-js/en/how-to/handle-errors): Classify Omnio exceptions and cancel work safely with AbortSignal. ### Reference - [Reference](https://omnio-project.github.io/omnio-js/en/reference): Exact APIs, types, options, and errors for Omnio-js. - [Omnio class](https://omnio-project.github.io/omnio-js/en/reference/omnio): Reference for the Omnio constructor, properties, and public methods. - [Object model](https://omnio-project.github.io/omnio-js/en/reference/object-model): Reference for OmnioObject fields, mutable metadata, and record types. - [Object keys](https://omnio-project.github.io/omnio-js/en/reference/object-keys): Reference for OmnioKey parsing and object key constraints. - [Metadata filters](https://omnio-project.github.io/omnio-js/en/reference/metadata-filter): Reference for the MetadataFilter types used by listObjects and searchObjects. - [Errors](https://omnio-project.github.io/omnio-js/en/reference/errors): Exception classes and conditions exposed by Omnio-js. - [Indexes](https://omnio-project.github.io/omnio-js/en/reference/indexes): Reference for SQL index options, vector search, migrations, and IObjectIndex. - [Embedders](https://omnio-project.github.io/omnio-js/en/reference/embedders): Reference for Gemma2Embedder options and the IEmbedder interface. - [Entity storage](https://omnio-project.github.io/omnio-js/en/reference/storage): Reference for IOmnioEntity, IOmnioEntityBuilder, and the unikvs integration. ### Explanation - [Explanation](https://omnio-project.github.io/omnio-js/en/explanation): Understand the design, consistency, and search behavior of Omnio-js. - [Architecture](https://omnio-project.github.io/omnio-js/en/explanation/architecture): How entity storage, the index, and the embedder divide responsibilities and process data. - [Consistency and lifecycle](https://omnio-project.github.io/omnio-js/en/explanation/consistency-and-lifecycle): Visibility, deletion, crash recovery, and multi-process caveats in Omnio. - [How semantic search works](https://omnio-project.github.io/omnio-js/en/explanation/semantic-search): Understand embeddings, similarity, model changes, and reindexing. ## RSS Feeds - [Omnio-js — Changelog](https://omnio-project.github.io/omnio-js/changelog/rss.xml) ## Agent skills - [omnio-js](https://omnio-project.github.io/omnio-js/.well-known/agent-skills/omnio-js/SKILL.md): Read the Omnio-js docs instead of answering from memory. Documentation for Omnio-js Use when a task involves Omnio-js: how it works, how to set it up or configure it, or its API. ## Agent resources - [llms-full.txt](https://omnio-project.github.io/omnio-js/llms-full.txt): The full Markdown of every page in one file. - [Page Markdown](https://omnio-project.github.io/omnio-js/index.md): Append `.md` to any page URL to fetch that page as raw Markdown. - [JSON API](https://omnio-project.github.io/omnio-js/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://omnio-project.github.io/omnio-js/openapi.json. - [Agent skills](https://omnio-project.github.io/omnio-js/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes. - [API catalog](https://omnio-project.github.io/omnio-js/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here. - [AI catalog](https://omnio-project.github.io/omnio-js/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs). - [agent-readability.json](https://omnio-project.github.io/omnio-js/agent-readability.json): Manifest of every agent-facing artifact on this site. - [Sitemap](https://omnio-project.github.io/omnio-js/sitemap.xml): Every indexable page URL with its last-modified date.