Jido.Memory.IngestResult (Jido Memory v1.0.0)

View Source

Canonical result for provider ingestion operations.

Summary

Types

t()

Functions

new(attrs)

Builds and normalizes an ingest result.

new!(attrs)

Builds and normalizes an ingest result, raising on error.

schema()

Returns the ingest result schema.

Types

t()

@type t() :: %Jido.Memory.IngestResult{
  accepted_count: integer(),
  metadata: map(),
  provider: nil | any(),
  records: [any()],
  rejected: [any()],
  scope: nil | any()
}

Functions

new(attrs)

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

Builds and normalizes an ingest result.

new!(attrs)

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

Builds and normalizes an ingest result, raising on error.

schema()

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

Returns the ingest result schema.