Jido.Memory.Hit (Jido Memory v1.0.0)

Canonical retrieval hit returned by providers.

Summary

Types

t()

Functions

from_record(record, opts \\ [])

Wraps a bare record as a canonical hit.

new(attrs)

Builds and normalizes a retrieval hit.

new!(attrs)

Builds and normalizes a hit, raising on error.

schema()

Returns the hit schema.

Types

t()

@type t() :: %Jido.Memory.Hit{
  extensions: map(),
  matched_on: [binary()],
  metadata: map(),
  rank: nil | integer(),
  record: any(),
  score: nil | any()
}

Functions

from_record(record, opts \\ [])

@spec from_record(
  Jido.Memory.Record.t(),
  keyword()
) :: t()

Wraps a bare record as a canonical hit.

new(attrs)

@spec new(map() | keyword()) :: {:ok, t()} | {:error, term()}

Builds and normalizes a retrieval hit.

new!(attrs)

@spec new!(map() | keyword()) :: t()

Builds and normalizes a hit, raising on error.

schema()

@spec schema() :: Zoi.schema()

Returns the hit schema.