ArchAstro.Types.ContextDocument (archastro v0.2.0)

Copy Markdown

A context document stored within a context source. Carries metadata and size information only; retrieve the full text content via the /content endpoint.

Summary

Types

t()

@type t() :: %ArchAstro.Types.ContextDocument{
  agent: String.t() | ArchAstro.Unset.t(),
  content_hash: String.t() | ArchAstro.Unset.t(),
  created_at: DateTime.t() | ArchAstro.Unset.t(),
  file: String.t() | ArchAstro.Unset.t(),
  id: String.t(),
  metadata: %{optional(String.t()) => ArchAstro.JSON.t()} | ArchAstro.Unset.t(),
  source: String.t() | ArchAstro.Unset.t(),
  team: String.t() | ArchAstro.Unset.t(),
  title: String.t() | ArchAstro.Unset.t(),
  total_lines: integer() | ArchAstro.Unset.t(),
  total_size: integer() | ArchAstro.Unset.t(),
  updated_at: DateTime.t() | ArchAstro.Unset.t(),
  user: String.t() | ArchAstro.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.JSON.object()