ollama_embeddings
Generates vector embeddings from text, using the Ollama API.
Introduced in version 4.32.0.
# Common config fields, showing default valueslabel: ""ollama_embeddings: model: nomic-embed-text # No default (required) text: "" # No default (optional) runner: context_size: 0 # No default (optional) batch_size: 0 # No default (optional) server_address: http://127.0.0.1:11434 # No default (optional)# Advanced config fields, showing default valueslabel: ""ollama_embeddings: model: nomic-embed-text # No default (required) text: "" # No default (optional) runner: context_size: 0 # No default (optional) batch_size: 0 # No default (optional) gpu_layers: 0 # No default (optional) threads: 0 # No default (optional) use_mmap: false # No default (optional) server_address: http://127.0.0.1:11434 # No default (optional) cache_directory: /opt/cache/connect/ollama # No default (optional) download_url: "" # No default (optional)This processor sends text to your chosen Ollama large language model (LLM) and creates vector embeddings, using the Ollama API. Vector embeddings are long arrays of numbers that represent values or objects, in this case text.
By default, the processor starts and runs a locally installed Ollama server. Alternatively, to use an already running Ollama server, add your server details to the server_address field. You can download and install Ollama from the Ollama website.
For more information, see the Ollama documentation.
Examples
Compute embeddings for some generated data and store it within xrefs:component:outputs/qdrant.adoc[Qdrant]
input: generate: interval: 1s mapping: | root = {"text": fake("paragraph")}pipeline: processors: - ollama_embeddings: model: snowflake-artic-embed text: "${!this.text}"output: qdrant: grpc_host: localhost:6334 collection_name: "example_collection" id: "root = uuid_v4()" vector_mapping: "root = this"Compute embeddings for some generated data and store it within xrefs:component:outputs/cyborgdb.adoc[CyborgDB]
input: generate: interval: 1s mapping: | root = {"text": fake("paragraph")}pipeline: processors: - ollama_embeddings: model: snowflake-artic-embed text: "${!this.text}"output: cyborgdb: host: "${CYBORGDB_HOST}" api_key: "${CYBORGDB_API_KEY}" index_key: "${CYBORGDB_INDEX_KEY}" index_name: "my_encrypted_index" operation: "upsert" id: "root = uuid_v4()" vector_mapping: "root = this"Compute embeddings for some generated data and store it within Clickhouse
input: generate: interval: 1s mapping: | root = {"text": fake("paragraph")}pipeline: processors: - branch: processors: - ollama_embeddings: model: snowflake-artic-embed text: "${!this.text}" result_map: | root.embeddings = thisoutput: sql_insert: driver: clickhouse dsn: "clickhouse://localhost:9000" table: searchable_text columns: ["id", "text", "vector"] args_mapping: "root = [uuid_v4(), this.text, this.embeddings]"Fields
model
The name of the Ollama LLM to use. For a full list of models, see the Ollama website.
Type: string
# Examples
model: nomic-embed-text
model: mxbai-embed-large
model: snowflake-artic-embed
model: all-minilmtext
The text you want to create vector embeddings for. By default, the processor submits the entire payload as a string. This field supports interpolation functions.
Type: string
runner
Options for the model runner that are used when the model is first loaded into memory.
Type: object
runner.context_size
Sets the size of the context window used to generate the next token. Using a larger context window uses more memory and takes longer to processor.
Type: int
runner.batch_size
The maximum number of requests to process in parallel.
Type: int
runner.gpu_layers
This option allows offloading some layers to the GPU for computation. This generally results in increased performance. By default, the runtime decides the number of layers dynamically.
Type: int
runner.threads
Set the number of threads to use during generation. For optimal performance, it is recommended to set this value to the number of physical CPU cores your system has. By default, the runtime decides the optimal number of threads.
Type: int
runner.use_mmap
Map the model into memory. This is only support on unix systems and allows loading only the necessary parts of the model as needed.
Type: bool
server_address
The address of the Ollama server to use. Leave the field blank and the processor starts and runs a local Ollama server or specify the address of your own local or remote server.
Type: string
# Examples
server_address: http://127.0.0.1:11434cache_directory
If server_address is not set - the directory to download the ollama binary and use as a model cache.
Type: string
# Examples
cache_directory: /opt/cache/connect/ollamadownload_url
If server_address is not set - the URL to download the ollama binary from. Defaults to the offical Ollama GitHub release for this platform.
Type: string