Liking cljdoc? Tell your friends :D

hive-chroma.connection

Chroma connection configuration, collection management, and health status.

Chroma connection configuration, collection management, and health status.
raw docstring

chroma-available?clj

(chroma-available?)

Check if Chroma is configured and reachable.

Check if Chroma is configured and reachable.
sourceraw docstring

collection-namesclj

(collection-names)
(collection-names extra)

Every collection this process could legitimately read: the default (unnamed) collection plus every collection a configured provider's dimension writes to. extra adds names the caller knows about (legacy collections a scan visits). Config only: it opens nothing and creates nothing.

Every collection this process could legitimately read: the default
(unnamed) collection plus every collection a configured provider's dimension
writes to. `extra` adds names the caller knows about (legacy collections a
scan visits). Config only: it opens nothing and creates nothing.
sourceraw docstring

collection-space-auditclj

(collection-space-audit)
(collection-space-audit opts)

Provenance of every collection this process could read, as data: one row per collection that EXISTS, from space/audit. Never creates a collection and never throws on a mismatch: this is the listing an operator uses to find the collections that need isolating or re-embedding, which is why a divergent one is reported :diverged instead of refused.

Opts: :names - extra collection names to include (legacy/sibling ones) :space - the EmbeddingSpace a caller is about to use; with it each row also carries :expected-id and the keys a divergent collection differs on.

Provenance of every collection this process could read, as data: one row per
collection that EXISTS, from `space/audit`. Never creates a collection and
never throws on a mismatch: this is the listing an operator uses to find the
collections that need isolating or re-embedding, which is why a divergent one
is reported :diverged instead of refused.

Opts:
  :names - extra collection names to include (legacy/sibling ones)
  :space - the EmbeddingSpace a caller is about to use; with it each row also
           carries :expected-id and the keys a divergent collection differs on.
sourceraw docstring

Configclj

Chroma connection settings; callers may merge in vendor options.

Chroma connection settings; callers may merge in vendor options.
sourceraw docstring

configure!clj

(configure! opts)

Configure Chroma connection settings.

Configure Chroma connection settings.
sourceraw docstring

get-configclj

(get-config)

Get current Chroma configuration map.

Get current Chroma configuration map.
sourceraw docstring

get-or-create-collectionclj

(get-or-create-collection)
(get-or-create-collection space)

Get the default (unnamed) collection or create it. A new one is stamped with the global provider's space when that space can be named.

With space (an EmbeddingSpace) the collection must hold it, as in get-or-create-named-collection: a stamped collection of another space throws ex-info :embedding-space-mismatch, an unstamped (legacy) one is admitted with a warning. No argument, or a nil space, skips the guard.

Get the default (unnamed) collection or create it. A new one is stamped
with the global provider's space when that space can be named.

With `space` (an EmbeddingSpace) the collection must hold it, as in
`get-or-create-named-collection`: a stamped collection of another space
throws ex-info :embedding-space-mismatch, an unstamped (legacy) one is
admitted with a warning. No argument, or a nil `space`, skips the guard.
sourceraw docstring

get-or-create-named-collectionclj

(get-or-create-named-collection coll-name dimension)
(get-or-create-named-collection coll-name dimension space)

Get or create a named collection with explicit dimension. Caches per collection-name. Used by type-based embedder routing.

With space (an EmbeddingSpace) a new collection is stamped with it, and an existing one must hold it: a stamped collection of another space throws ex-info :embedding-space-mismatch, so vectors of two spaces never share a collection; an unstamped (legacy) collection is admitted with a warning. A nil space (provider without a nameable space) skips the guard.

Get or create a named collection with explicit dimension.
Caches per collection-name. Used by type-based embedder routing.

With `space` (an EmbeddingSpace) a new collection is stamped with it, and
an existing one must hold it: a stamped collection of another space throws
ex-info :embedding-space-mismatch, so vectors of two spaces never share a
collection; an unstamped (legacy) collection is admitted with a warning.
A nil `space` (provider without a nameable space) skips the guard.
sourceraw docstring

metricclj

Distance Chroma scores a collection with when no hnsw:space is given.

Distance Chroma scores a collection with when no hnsw:space is given.
sourceraw docstring

provider-specclj

(provider-spec provider-type model provider)

Build the embedding space spec for a provider, including its resolved host when present. Return nil when the provider has no configured model.

Build the embedding space spec for a provider, including its resolved host
when present. Return nil when the provider has no configured model.
sourceraw docstring

reset-collection-cache!clj

(reset-collection-cache!)

Reset the collection cache (for testing/reconnection).

Reset the collection cache (for testing/reconnection).
sourceraw docstring

Statusclj

Chroma integration status.

Chroma integration status.
sourceraw docstring

statusclj

(status)

Get Chroma integration status.

Get Chroma integration status.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close