AI Agent

Categories: Artificial Intelligence

Type: aiAgent/v1

Actions

Chat

Name: chat

Chat with the AI agent.

Properties

Name	Label	Type	Description	Required
format	Format	STRING Options SIMPLE, ADVANCED	Format of providing the prompt to the model.	true
userPrompt	Prompt	STRING	User prompt to the model.	true
systemPrompt	System Prompt	STRING	System prompt to the model.	false
attachments	Attachments	ARRAY Items [FILE_ENTRY]	Only text and image files are supported. Also, only certain models supports images. Please check the documentation.	false
messages	Messages	ARRAY Items [{STRING(role), STRING(content), [FILE_ENTRY](attachments)}]	A list of messages comprising the conversation so far.	true
response	Response	OBJECT Properties {STRING(responseFormat), STRING(responseSchema)}	The response from the API.	true
conversationId	null	STRING	The conversation id used in conjunction with memory.	false

Example JSON Structure

{
  "label" : "Chat",
  "name" : "chat",
  "parameters" : {
    "format" : "",
    "userPrompt" : "",
    "systemPrompt" : "",
    "attachments" : [ {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    } ],
    "messages" : [ {
      "role" : "",
      "content" : "",
      "attachments" : [ {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      } ]
    } ],
    "response" : {
      "responseFormat" : "",
      "responseSchema" : ""
    },
    "conversationId" : ""
  },
  "type" : "aiAgent/v1/chat"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Chat (stream)

Name: streamChat

Chat with the AI agent and stream the response.

Properties

Name	Label	Type	Description	Required
format	Format	STRING Options SIMPLE, ADVANCED	Format of providing the prompt to the model.	true
userPrompt	Prompt	STRING	User prompt to the model.	true
systemPrompt	System Prompt	STRING	System prompt to the model.	false
attachments	Attachments	ARRAY Items [FILE_ENTRY]	Only text and image files are supported. Also, only certain models supports images. Please check the documentation.	false
messages	Messages	ARRAY Items [{STRING(role), STRING(content), [FILE_ENTRY](attachments)}]	A list of messages comprising the conversation so far.	true
response	Response	OBJECT Properties {STRING(responseFormat), STRING(responseSchema)}	The response from the API.	true
conversationId	null	STRING	The conversation id used in conjunction with memory.	false

Example JSON Structure

{
  "label" : "Chat (stream)",
  "name" : "streamChat",
  "parameters" : {
    "format" : "",
    "userPrompt" : "",
    "systemPrompt" : "",
    "attachments" : [ {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    } ],
    "messages" : [ {
      "role" : "",
      "content" : "",
      "attachments" : [ {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      } ]
    } ],
    "response" : {
      "responseFormat" : "",
      "responseSchema" : ""
    },
    "conversationId" : ""
  },
  "type" : "aiAgent/v1/streamChat"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

On this page