Perform Text Embedding
These actions provide ability to convert text into embeddings for advanced search functionality.
Perform Text Embedding Actions
EmbedText
Field
Definition
Example
Default
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"eventMeta": {
"type": "object",
"properties": {
"inputElement": {
"type": "string",
"description": "Json path for the input in request event payload",
"examples": ["input"],
"default": null
},
"outputElement": {
"type": "string",
"description": "Json path for the output in response event payload",
"examples": ["output"],
"default": null
}
}
}
}
}Parameter
Definition
Example
Default
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"eventMeta": {
"type": "object",
"properties": {
"parameters": {
"type": "object",
"properties": {
"inputPattern": {
"type": "string",
"description": "JMESpath pattern to apply on input element for getting text and metadata fields",
"examples": ["{text: \"\", metadata: \"\"}"],
"default": null
},
"extraAction": {
"type": "string",
"description": "Optional extra action to perform after generating embedding",
"examples": ["add"],
"default": null
},
"maxResults": {
"type": "integer",
"description": "Maximum results to return if search extra action is used",
"examples": [5],
"default": null
},
"minScore": {
"type": "number",
"description": "Minimum similarity score required if search extra action is used",
"examples": [0.5],
"default": null
}
}
}
}
}
}
}Last updated
