Blog

Discord

Shinkai Docs

Developer Guide

Get Shinkai

Github

Get Job Scope

The list of base/core VectorResource types which are fully
composable within one another

Info about where the source data was acquired from, and when it was originally distributed

The origin where the original data was acquired from.
Based on source file that was used to create the VR if one exists (ie. pdf/webpage), or based on the VR where/when it was released

A VectorResource which uses an internal numbered/ordered list data model,
thus providing an ideal interface for document-like content such as PDFs,
epubs, web content, written works, and more.

A struct that represents a Vector Embedding with an added string id.

Struct that represents an external URI like a website URL which
has not been downloaded into a SourceFile, but is just referenced.

Struct which holds the embedding for a Vector Resource's keywords

A Scope Entry for a local VRKai that only lives in the
Job's scope (not in the VectorFS & thus not available to other jobs)

A Scope Entry for a local VRPack that only lives in the
Job's scope (not in the VectorFS & thus not available to other jobs)

A VectorResource which uses a HashMap data model, thus providing a
native key-value interface. Ideal for use cases such as field-based data sources, classical DBs,
constantly-updating data streams, or any unordered/mutating source data.

A Scope Entry for a FSFolder that (potentially) exists on another node's VectorFS (if your node has perms).
Unsupported currently, struct added for future compatibility.

Represents a Vector Resource Node which holds a unique id, one of the types of NodeContent,
metadata, and other internal relevant data.

Type that acts as a reference to a notarized source file
(meaning one that has some cryptographic proof/signature of origin)

Struct which holds the data of a source file which a VR was generated from

A map which stores SourceFiles based on VRPaths within a VectorResource.
A SourceFile at root represents the single source file for the whole VR.

Type that acts as a reference to external file/content/data

A standard source file that data was extracted from to create a VectorResource.

The source file that data was extracted from to create a VectorResource

Struct which holds the contents of the TLSNotary proof for the source file

What text chunking strategy was used to create this VR from the source file.
This is required for performing content validation/that it matches the VR nodes.
TODO: Think about how to make this more explicit/specific and future support

Enum used for VectorResources to self-attest their base type.

`CustomUnsupported(s)` allows for devs to implement custom VectorResources that fulfill the trait,
but which aren't composable with any of the base resources (we are open to PRs for adding new base types as well).

Struct which holds descriptive information about a given Vector Resource.

List of data tag names matching in internal nodes

List of metadata keys held in internal nodes

ISO RFC3339 when then Vector Resource was created

ISO RFC3339 when then Vector Resource was last written into (a node was modified)

Represents a parsed VRKai file with a BaseVectorResource, and optional SourceFileMap.
To save as a file or transfer the VRKai, call one of the `prepare_as_` methods. To parse from a file/transfer, use the `from_` methods.

A struct which holds a Vector Resource's keywords/optional
keywords embedding

Represents a parsed VRPack file, which contains a Map Vector Resource that holds a tree structure of folders & encoded VRKai nodes.
In other words, a `.vrpack` file is akin to a "compressed archive" of internally held VRKais with folder structure preserved.
Of note, VRPacks are not compressed at the top level because the VRKais held inside already are. This improves performance for large VRPacks.
To save as a file or transfer the VRPack, call one of the `encode_as_` methods. To parse from a file/transfer, use the `from_` methods.

A path inside of a Vector Resource to a Node which exists somewhere in the hierarchy.
Internally the path is made up of an ordered list of Node ids (Int-holding strings for Docs, any string for Maps).

Information about the source content a Vector Resource came from

A Scope Entry for a FSFolder saved in the VectorFS.

A Scope Entry for a FSItem saved in the VectorFS.

Job's scope which includes both Local entries (vrkai stored locally only in job)
and VecFS entries (source/vector resource stored in the FS, accessible to all jobs)

Discover the power of Shinkai with our comprehensive guides

Welcome to Shinkai

Shinkai is a platform for building and deploying AI agents.

What is Shinkai?

Start experiencing the power of Shinkai in under 5 minutes

Installation and Setup Guide

Learning how to interact with your local AI

Shinkai Overview

AI Chats

Keep all your information stored securely in Shinkai

Files Manager

Keep your content up-to-date from various sources across the decentralized Shinkai Network

Subscriptions

Your guide to installing the best model for your local AI

AI Models

Overview

OpenAI Models

OpenRouter Models

A step-by-step guide to help you install Gemini models

Gemini Models

Groq Models

Learn how to install Ollama models in Shinkai

Ollama Models

A more powerful and integrated AI experience

Shinkai Visor

Experimental features are continously improved

Optimize your tasks with customized prompts

API Documentation

General

Jobs

Subscriptions

Tool Offerings

Vector File System

Wallet

Get Job Scope

Query Parameters

Response