Jido.Memory.RetrieveResult (Jido Memory v1.0.0)

Canonical retrieval result returned by Jido.Memory.Runtime.retrieve/3.

Summary

Types

t()

Functions

from_records(records, opts \\ [])

Wraps bare records into a canonical retrieval result.

new(attrs)

Builds and normalizes a retrieval result.

new!(attrs)

Builds and normalizes a retrieval result, raising on error.

records(retrieve_result)

Returns the underlying record list from a retrieval result.

schema()

Returns the retrieve result schema.

Types

t()

@type t() :: %Jido.Memory.RetrieveResult{
  extensions: map(),
  hits: [any()],
  metadata: map(),
  provider: nil | any(),
  query: nil | any(),
  scope: nil | any(),
  total_count: integer()
}

Functions

from_records(records, opts \\ [])

@spec from_records(
  [Jido.Memory.Record.t()],
  keyword()
) :: t()

Wraps bare records into a canonical retrieval result.

new(attrs)

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

Builds and normalizes a retrieval result.

new!(attrs)

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

Builds and normalizes a retrieval result, raising on error.

records(retrieve_result)

@spec records(t()) :: [Jido.Memory.Record.t()]

Returns the underlying record list from a retrieval result.

schema()

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

Returns the retrieve result schema.