AshAi

Documentation for AshAi.

tools

tool name, resource, action

Name	Type	Default	Docs
`name`	`atom`
`resource`	`module`
`action`	`atom`

Name	Type	Default	Docs
`load`	`any`	`[]`
`async`	`boolean`	`true`
`description`	`String.t`		A description for the tool. Defaults to the action's description.
`identity`	`atom`		The identity to use for update/destroy actions. Defaults to the primary key. Set to `false` to disable entirely.

Name	Type	Default	Docs
`embedding_model`	`module`
`attributes`	`keyword`	`[]`	A keyword list of attributes to vectorize, and the name of the attribute to store the vector in
`strategy`	`:after_action \| :manual \| :ash_oban \| :ash_oban_manual`	`:after_action`	How to compute the vector. Currently supported strategies are `:after_action`, `:manual`, and `:ash_oban`.
`define_update_action_for_manual_strategy?`	`boolean`	`true`	If true, an `ash_ai_update_embeddings` update action will be defined, which will automatically update the embeddings when run.
`ash_oban_trigger_name`	`atom`	`:ash_ai_update_embeddings`	The name of the AshOban-trigger that will be run in order to update the record's embeddings. Defaults to `:ash_ai_update_embeddings`.

Name	Type	Default	Docs
`text`	`(any -> any)`		A function or expr that takes a list of records and computes a full text string that will be vectorized. If given an expr, use `atomic_ref` to refer to new values, as this is set as an atomic update.
`name`	`atom`	`:full_text_vector`	The name of the attribute to store the text vector in
`used_attributes`	`list(atom)`		If set, a vector is only regenerated when these attributes are changed