Perform Text Embedding

These actions provide ability to convert text into embeddings for advanced search functionality.

Perform Text Embedding Actions

EmbedText

Transforms text into an embedding. Event metadata fields applicable for this action are as follows:

Field
Definition
Example
Default

Input Element

Json path for the input in request event payload

input

-

Output Element

Json path for the output in response event payload

output

-

With event metadata parameters as:

Parameter
Definition
Example
Default

Input Pattern

JMESpath pattern to apply on input element for getting text and metadata fields

{text: "", metadata: ""}

-

Extra Action

Optional extra action after generating embedding, add to local index or search in local index

add

-

Max Results

Maximum results to return if search extra action is used

5

-

Min Score

Minimum similarity score required if search extra action is used

0.5

-

Input element can be a text value, or an object in {chat, message} format where chat includes the ID of an ongoing chat for assistant-style use cases with memory.

Last updated