{ "schemes": ["https"], "swagger": "2.0", "info": { "description": "This is the API of the AuxData.ai Platform.", "title": "AuxData.ai API", "contact": { "name": "API Support", "email": "support@auxdata.ai" }, "version": "1.0" }, "host": "auxdata.ai", "basePath": "/api/v1", "paths": { "/agent/{agentid}/chat": { "post": { "security": [ { "Bearer": [] } ], "description": "AI chat request which will be answered automatically by the LLM as datasource all containers of the agent will be used.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "chat" ], "summary": "AI chat request which will be answered automatically by the LLM (Chatbot)", "parameters": [ { "type": "integer", "description": "The id of the agent with which the chat should be conducted.", "name": "agentid", "in": "path", "required": true }, { "description": "chat data", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_domain.ChatCommand" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceStepResult" } }, "400": { "description": "Bad Request" } } } }, "/agent/{agentid}/chat/{comUuid}/summarize": { "post": { "description": "Compresses the given chat conversation via LLM; returns the summary text without persisting anything.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "chatbot" ], "summary": "Summarize chat history into a knowledge document", "parameters": [ { "type": "integer", "description": "Source agent (the one being chatted with)", "name": "agentid", "in": "path", "required": true }, { "type": "string", "description": "Chat conversation UUID", "name": "comUuid", "in": "path", "required": true }, { "description": "Target agent for language lookup", "name": "command", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_auxdata_ai_backend_restservice.SummarizeChatCommand" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_auxdata_ai_backend_restservice.SummarizeChatResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/auxdata_ai_domain.Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/auxdata_ai_domain.Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/auxdata_ai_domain.Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/auxdata_ai_domain.Error" } } } } }, "/agent/{agentid}/container/{containerid}/chat": { "post": { "security": [ { "Bearer": [] } ], "description": "AI chat request which will be answered automatically by the LLM as datasource the specified container will be used", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "chat" ], "summary": "AI chat request which will be answered automatically by the LLM", "parameters": [ { "type": "integer", "description": "The id of the agent with which the chat should be conducted.", "name": "agentid", "in": "path", "required": true }, { "type": "integer", "description": "The Id of the container as datasoruce fo the answer", "name": "containerid", "in": "path", "required": true }, { "description": "chat data", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_domain.ChatCommand" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceStepResult" } }, "500": { "description": "Internal Server Error" } } } }, "/agent/{agentid}/container/{containerid}/document": { "put": { "security": [ { "Bearer": [] } ], "description": "service for uploading files in knowledge db", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "Uploading files in Knowledge DB" ], "summary": "service for uploading files in knowledge db", "parameters": [ { "type": "integer", "description": "The Id of the agent for uploading the data", "name": "agentid", "in": "path", "required": true }, { "type": "integer", "description": "The Id of the container for uploading the data", "name": "containerid", "in": "path", "required": true }, { "type": "string", "description": "Base Link for linking the uploaded files to make the original documents available", "name": "link", "in": "header" }, { "type": "array", "items": { "type": "file" }, "collectionFormat": "csv", "description": "Body with files", "name": "files", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.UploadedFilesResult" } } }, "400": { "description": "Bad Request" } } }, "post": { "security": [ { "Bearer": [] } ], "description": "AI based search in knowledge db for informations as datasource the specified container will be used", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "searching data" ], "summary": "AI based search in knowledge db for informations", "parameters": [ { "type": "integer", "description": "The Id of the agent for searching the data", "name": "agentid", "in": "path", "required": true }, { "type": "integer", "description": "The Id of the container for searching the data", "name": "containerid", "in": "path", "required": true }, { "description": "search data", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_domain.SearchCommand" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_domain.VectorStoreAnalysisResult" } }, "400": { "description": "Bad Request" } } } }, "/agent/{agentid}/container/{containerid}/document/enhanced": { "put": { "security": [ { "Bearer": [] } ], "description": "service for uploading files in knowledge db, with enhanced properties and information handling", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Uploading files in Knowledge DB" ], "summary": "service for uploading files in knowledge db with enhanced information handling", "parameters": [ { "type": "integer", "description": "The Id of the agent for uploading the data", "name": "agentid", "in": "path", "required": true }, { "type": "integer", "description": "The Id of the container for uploading the data", "name": "containerid", "in": "path", "required": true }, { "description": "the file upload configuration", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_domain.UploadDocumentCommandApi" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.UploadDocumentResult" } } }, "400": { "description": "Bad Request" } } } }, "/agent/{agentid}/document": { "post": { "security": [ { "Bearer": [] } ], "description": "AI based search in knowledge db for informations as datasource all containers of the agent will be used", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "searching data" ], "summary": "AI based search in knowledge db for informations", "parameters": [ { "type": "integer", "description": "The Id of the agent for searching the data", "name": "agentid", "in": "path", "required": true }, { "description": "search data", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/auxdata_ai_domain.SearchCommand" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_domain.VectorStoreAnalysisResult" } }, "400": { "description": "Bad Request" } } } }, "/agent/{agentid}/executeservice/{serviceid}": { "post": { "security": [ { "Bearer": [] } ], "description": "Executes an AI Service and returns the result", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AI Service" ], "summary": "Executes an AI Service and returns the result", "parameters": [ { "type": "integer", "description": " The ID of the agent in which the AI service should be executed.", "name": "agentid", "in": "path", "required": true }, { "type": "integer", "description": " The ID of the service which should be executed.", "name": "serviceid", "in": "path", "required": true }, { "description": "service parameters", "name": "request", "in": "body", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceResult" } }, "400": { "description": "Bad Request" } } } } }, "definitions": { "auxdata_ai_auxdata_ai_backend_restservice.SummarizeChatCommand": { "type": "object", "properties": { "targetAgentId": { "type": "integer" } } }, "auxdata_ai_auxdata_ai_backend_restservice.SummarizeChatResult": { "type": "object", "properties": { "summary": { "type": "string" } } }, "auxdata_ai_domain.AgentServiceBaseConfig": { "type": "object", "properties": { "anonymizeractive": { "type": "boolean" }, "chunklimit": { "type": "integer" }, "containers": { "type": "array", "items": { "type": "integer" } }, "customizing": { "type": "string" }, "disablerag": { "type": "boolean" }, "gptfallback": { "type": "boolean" }, "hierarchicalsearch": { "type": "boolean" }, "hierarchicalsearchchunklimit": { "type": "integer" }, "language": { "type": "string" }, "provider": { "type": "string" }, "qualitygate": { "type": "number" }, "role": { "type": "string" }, "temperature": { "description": "0 - 150", "type": "integer" }, "topp": { "description": "0 - 99", "type": "integer" }, "usepersonalknowledgedb": { "type": "boolean" }, "uuid": { "description": "Accesstoken for accessing services over api", "type": "string" } } }, "auxdata_ai_domain.AiServiceConfig": { "type": "object", "properties": { "anonymization": { "type": "boolean" }, "appendinknowledgedb": { "type": "string" }, "baseconfig": { "$ref": "#/definitions/auxdata_ai_domain.AgentServiceBaseConfig" }, "chainofthought": { "type": "boolean" }, "containerforsaveid": { "type": "integer" }, "datasourcedocument": { "$ref": "#/definitions/auxdata_ai_domain.AiWorkflowDataSourceDocument" }, "displaytype": { "$ref": "#/definitions/auxdata_ai_domain.CommandDisplayType" }, "imagesize": { "type": "string" }, "logicrules": { "type": "boolean" }, "maxparametersize": { "description": "1000 - 100000", "type": "integer" }, "palprompting": { "type": "boolean" }, "parameterhandling": { "$ref": "#/definitions/auxdata_ai_domain.ParameterHandling" }, "promptdebugging": { "type": "boolean" }, "reflectionprompting": { "type": "boolean" }, "saveinknowledgedb": { "type": "boolean" }, "textSample": { "type": "string" }, "userProfileConfig": { "type": "boolean" }, "voice": { "type": "string" } } }, "auxdata_ai_domain.AiServiceMultiResult": { "type": "object", "properties": { "answers": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.AiServiceResult" } }, "questions": { "type": "string" } } }, "auxdata_ai_domain.AiServiceResult": { "type": "object", "properties": { "answer": { "type": "string" }, "documents": { "type": "array", "items": { "type": "string" } }, "images": { "type": "array", "items": { "type": "string" } }, "nextQuestion": { "$ref": "#/definitions/auxdata_ai_domain.AiServiceMultiResult" }, "questionObject": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceStepCommand" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.SearchChunkResult" } }, "videos": { "type": "array", "items": { "type": "string" } } } }, "auxdata_ai_domain.AiWorkflowDataSourceDocument": { "type": "object", "properties": { "documentid": { "type": "string" }, "name": { "type": "string" } } }, "auxdata_ai_domain.AnswerMode": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ], "x-enum-varnames": [ "AnswerModeUndefined", "AnswerModeShort", "AnswerModeMedium", "AnswerModeLong", "AnswerModeAutomaticDetection" ] }, "auxdata_ai_domain.ChatCommand": { "type": "object", "properties": { "anonymize": { "type": "boolean" }, "answerMode": { "$ref": "#/definitions/auxdata_ai_domain.AnswerMode" }, "comuuid": { "type": "string" }, "files": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.UploadDocumentCommand" } }, "followUpQuestionMode": { "type": "boolean" }, "internetsearch": { "$ref": "#/definitions/auxdata_ai_domain.InternetSearchMode" }, "orgid": { "type": "integer" }, "question": { "type": "string" }, "stream": { "type": "boolean" }, "usePersonalKnowledgeDb": { "type": "boolean" }, "usermail": { "type": "string" } } }, "auxdata_ai_domain.ChatCommunication": { "type": "object", "properties": { "bot": { "type": "string" }, "details": { "$ref": "#/definitions/auxdata_ai_domain.ChatUsageDetails" }, "inputdocuments": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.DocumentData" } }, "name": { "type": "string" }, "outputdocuments": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.SearchChunkResult" } }, "timestamp": { "type": "string" }, "user": { "type": "string" }, "videos": { "type": "array", "items": { "type": "string" } } } }, "auxdata_ai_domain.ChatUsageDetails": { "type": "object", "properties": { "agentname": { "type": "string" }, "anonymized": { "type": "boolean" }, "anonymizedrequest": { "type": "string" }, "duration": { "type": "integer" }, "gdpr": { "type": "boolean" }, "gdprneededprompt": { "type": "boolean" }, "model": { "type": "string" }, "responsetypeanalyzed": { "$ref": "#/definitions/auxdata_ai_domain.ResponseType" }, "responsetypeexecuted": { "$ref": "#/definitions/auxdata_ai_domain.ResponseType" }, "timestamp": { "type": "string" } } }, "auxdata_ai_domain.ChunkImage": { "type": "object", "properties": { "agentId": { "type": "integer" }, "chunkId": { "type": "integer" }, "documentId": { "type": "string" }, "imageId": { "type": "integer" }, "mimeType": { "type": "string" }, "textPosition": { "type": "integer" } } }, "auxdata_ai_domain.ChunkMetaData": { "type": "object", "properties": { "link": { "type": "string" }, "manualdata": { "type": "string" }, "pagenumber": { "type": "integer" }, "title": { "type": "string" } } }, "auxdata_ai_domain.CommandDisplayType": { "type": "string", "enum": [ "Html", "Text", "Audio", "Image", "Video", "Hidden", "Code", "MarkDown", "JSON", "Docx" ], "x-enum-varnames": [ "COMMAND_DISPLAY_TYPE_HTML", "COMMAND_DISPLAY_TYPE_TEXT", "COMMAND_DISPLAY_TYPE_AUDIO", "COMMAND_DISPLAY_TYPE_IMAGE", "COMMAND_DISPLAY_TYPE_VIDEO", "COMMAND_DISPLAY_TYPE_HIDDEN", "COMMAND_DISPLAY_TYPE_CODE", "COMMAND_DISPLAY_TYPE_MARKDOWN", "COMMAND_DISPLAY_TYPE_JSON", "COMMAND_DISPLAY_TYPE_DOCX" ] }, "auxdata_ai_domain.CommandResultType": { "type": "string", "enum": [ "Multi", "Single", "Command", "Function", "Condition", "Feedback" ], "x-enum-varnames": [ "COMMAND_RESULT_TYPE_MULTI", "COMMAND_RESULT_TYPE_SINGLE", "COMMAND_RESULT_TYPE_COMMAND", "COMMAND_RESULT_TYPE_FUNCTION", "COMMAND_RESULT_TYPE_CONDITION", "COMMAND_RESULT_TYPE_FEEDBACK" ] }, "auxdata_ai_domain.Condition": { "type": "object", "properties": { "field": { "type": "string" }, "functioncall": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" }, "nextStepId": { "type": "integer" }, "not": { "type": "boolean" }, "regex": { "type": "string" } } }, "auxdata_ai_domain.ConditionalBranch": { "type": "object", "properties": { "expression": { "description": "nil = else-Zweig", "allOf": [ { "$ref": "#/definitions/auxdata_ai_domain.Expression" } ] }, "id": { "type": "string" }, "nextStepId": { "type": "integer" } } }, "auxdata_ai_domain.DocumentData": { "type": "object", "properties": { "filecontent": { "type": "string" }, "filetype": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" } } }, "auxdata_ai_domain.DocumentType": { "type": "string", "enum": [ "txt", "bin" ], "x-enum-varnames": [ "DOCUMENT_TYPE_TXT", "DOCUMENT_TYPE_BIN" ] }, "auxdata_ai_domain.Entity": { "type": "object", "properties": { "agentid": { "type": "integer" }, "containerid": { "type": "integer" }, "description": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "score": { "type": "number" }, "type": { "type": "string" } } }, "auxdata_ai_domain.Error": { "type": "object", "properties": { "code": { "type": "integer" }, "errorObj": {}, "message": { "type": "string" }, "service": { "type": "string" }, "user": { "$ref": "#/definitions/auxdata_ai_domain.User" } } }, "auxdata_ai_domain.ExecuteServiceCommand": { "type": "object", "properties": { "backgroundmodepossible": { "type": "boolean" }, "botid": { "type": "integer" }, "commandList": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceStepCommand" } }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "templateid": { "type": "integer" }, "usage": { "$ref": "#/definitions/auxdata_ai_domain.Usage" } } }, "auxdata_ai_domain.ExecuteServiceResult": { "type": "object", "properties": { "answer": { "$ref": "#/definitions/auxdata_ai_domain.AiServiceMultiResult" }, "background": { "type": "boolean" }, "command": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceCommand" }, "error": { "type": "string" }, "tokenusage": { "$ref": "#/definitions/auxdata_ai_domain.TokenUsageStats" }, "usageid": { "type": "integer" } } }, "auxdata_ai_domain.ExecuteServiceStepCommand": { "type": "object", "properties": { "addCompleteDocumentsToContext": { "type": "boolean" }, "answertype": { "$ref": "#/definitions/auxdata_ai_domain.CommandResultType" }, "botid": { "type": "integer" }, "comuuid": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.ConditionalBranch" } }, "displaytype": { "$ref": "#/definitions/auxdata_ai_domain.CommandDisplayType" }, "documentId": { "type": "string" }, "docxtemplateid": { "type": "integer" }, "examples": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.ResultExample" } }, "feedback": { "$ref": "#/definitions/auxdata_ai_domain.WorkflowFeedbackStep" }, "files": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.UploadDocumentCommand" } }, "functioncall": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" }, "history": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.ChatCommunication" } }, "internetDataSource": { "$ref": "#/definitions/auxdata_ai_domain.InternetDataSourceConfig" }, "outputformatdescription": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "postpocessing": { "$ref": "#/definitions/auxdata_ai_domain.PostProcessor" }, "prepocessing": { "$ref": "#/definitions/auxdata_ai_domain.PreProcessor" }, "queryconfig": { "$ref": "#/definitions/auxdata_ai_domain.AiServiceConfig" }, "question": { "type": "string" }, "searchprompt": { "type": "string" }, "serviceCommand": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceCommand" }, "systemprompt": { "type": "string" }, "templateId": { "type": "integer" }, "textSample": { "type": "string" }, "title": { "type": "string" }, "user": { "$ref": "#/definitions/auxdata_ai_domain.User" }, "userMail": { "type": "string" }, "userProfileConfig": { "type": "boolean" } } }, "auxdata_ai_domain.ExecuteServiceStepResult": { "type": "object", "properties": { "answer": { "type": "string" }, "command": { "$ref": "#/definitions/auxdata_ai_domain.ExecuteServiceStepCommand" }, "comuuid": { "type": "string" }, "context": { "type": "string" }, "documents": { "type": "array", "items": { "type": "string" } }, "error": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.SearchChunkResult" } }, "tokenusage": { "$ref": "#/definitions/auxdata_ai_domain.TokenUsageStats" }, "videos": { "type": "array", "items": { "type": "string" } } } }, "auxdata_ai_domain.Expression": { "type": "object", "properties": { "condition": { "description": "für einzelne CONDITION", "allOf": [ { "$ref": "#/definitions/auxdata_ai_domain.Condition" } ] }, "conditions": { "description": "für AND/OR", "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.Condition" } }, "operator": { "description": "\"AND\", \"OR\", \"CONDITION\"", "allOf": [ { "$ref": "#/definitions/auxdata_ai_domain.Operator" } ] } } }, "auxdata_ai_domain.FeedbackStatus": { "type": "string", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ], "x-enum-varnames": [ "FeedbackPending", "FeedbackCompleted", "FeedbackCancelled" ] }, "auxdata_ai_domain.FunctionCall": { "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "mcpdata": { "$ref": "#/definitions/auxdata_ai_domain.McpProcessData" }, "name": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } } }, "auxdata_ai_domain.GraphData": { "type": "object", "properties": { "entities": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.Entity" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.Relationship" } } } }, "auxdata_ai_domain.InternetDataSourceConfig": { "type": "object", "properties": { "internetsearchmode": { "$ref": "#/definitions/auxdata_ai_domain.InternetSearchMode" }, "maxpages": { "type": "integer" }, "websource": { "description": "specific website in which should be searched", "type": "string" } } }, "auxdata_ai_domain.InternetSearchMode": { "type": "integer", "enum": [ 0, 1, 2 ], "x-enum-varnames": [ "InternetSearchMode_Off", "InternetSearchMode_On", "InternetSearchMode_Enhanced" ] }, "auxdata_ai_domain.McpFeatureType": { "type": "string", "enum": [ "tool", "resource", "prompt" ], "x-enum-varnames": [ "McpFeatureTypeTool", "McpFeatureTypeResource", "McpFeatureTypePrompt" ] }, "auxdata_ai_domain.McpProcessData": { "type": "object", "properties": { "featuretype": { "$ref": "#/definitions/auxdata_ai_domain.McpFeatureType" }, "mcpid": { "type": "integer" }, "mcpname": { "type": "string" } } }, "auxdata_ai_domain.Operator": { "type": "string", "enum": [ "AND", "OR", "CONDITION" ], "x-enum-varnames": [ "OperatorAnd", "OperatorOr", "OperatorEquals" ] }, "auxdata_ai_domain.ParameterHandling": { "type": "string", "enum": [ "cherrypick", "stepbystep" ], "x-enum-varnames": [ "ParameterHandlingCherryPicking", "ParameterHandlingStepByStep" ] }, "auxdata_ai_domain.PostProcessor": { "type": "object", "properties": { "call": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" }, "command": { "type": "string" }, "type": { "$ref": "#/definitions/auxdata_ai_domain.PostProcessorType" } } }, "auxdata_ai_domain.PostProcessorType": { "type": "string", "enum": [ "function", "http", "mcp" ], "x-enum-varnames": [ "PostProcessorTypeFunction", "PostProcessorTypeHttpService", "PostProcessorTypeMcp" ] }, "auxdata_ai_domain.PreProcessor": { "type": "object", "properties": { "function": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" } }, "http": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" } }, "mcp": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.FunctionCall" } } } }, "auxdata_ai_domain.Relationship": { "type": "object", "properties": { "agentid": { "type": "integer" }, "containerid": { "type": "integer" }, "description": { "type": "string" }, "entity1": { "$ref": "#/definitions/auxdata_ai_domain.Entity" }, "entity2": { "$ref": "#/definitions/auxdata_ai_domain.Entity" }, "id": { "type": "integer" }, "keywords": { "type": "string" }, "score": { "type": "number" }, "sourceName": { "type": "string" }, "strength": { "type": "string" }, "targetName": { "type": "string" } } }, "auxdata_ai_domain.ResponseType": { "type": "string", "enum": [ "kurzer Text", "Text", "Langer Text", "Bild", "Ton", "Video" ], "x-enum-varnames": [ "ResponseTypeShortText", "ResponseTypeText", "ResponseTypeLongText", "ResponseTypeImage", "ResponseTypeAudio", "ResponseTypeVideo" ] }, "auxdata_ai_domain.ResultExample": { "type": "object", "properties": { "input": { "type": "string" }, "output": { "type": "string" } } }, "auxdata_ai_domain.SERVICE_STATE": { "type": "integer", "enum": [ -2, -1, 0, 1, 2, 3, 4, 5 ], "x-enum-varnames": [ "SERVICE_STATE_CANCELLED_BY_USER", "SERVICE_STATE_CLOSED_WITH_ERROR", "SERVICE_STATE_CLOSED", "SERVICE_STATE_RUNNING", "SERVICE_STATE_ERROR", "SERVICE_STATE_FINISHED", "SERVICE_STATE_INTERNAL_FINISHED", "SERVICE_STATE_FEEDBACK_REQUIRED" ] }, "auxdata_ai_domain.SearchChunkResult": { "type": "object", "properties": { "agentid": { "type": "integer" }, "chunk": { "type": "string" }, "chunkid": { "type": "integer" }, "creationdate": { "type": "string" }, "documentId": { "type": "string" }, "graphdata": { "$ref": "#/definitions/auxdata_ai_domain.GraphData" }, "images": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.ChunkImage" } }, "lastmodifieddate": { "type": "string" }, "link": { "type": "string" }, "metadata": { "$ref": "#/definitions/auxdata_ai_domain.ChunkMetaData" }, "name": { "type": "string" }, "score": { "type": "number" }, "type": { "type": "string" } } }, "auxdata_ai_domain.SearchCommand": { "type": "object", "properties": { "qualitygate": { "type": "number" }, "question": { "type": "string" }, "resultLimit": { "type": "integer" } } }, "auxdata_ai_domain.TokenUsage": { "type": "object", "properties": { "agentid": { "type": "integer" }, "calculatedtokensum": { "type": "integer" }, "factor": { "type": "number" }, "identifier": { "type": "string" }, "inputtoken": { "type": "integer" }, "internaltokenid": { "description": "User or accesstoken of auxdata.ai", "type": "string" }, "model": { "type": "string" }, "organisationid": { "type": "integer" }, "outputtoken": { "type": "integer" }, "step": { "description": "Step in Workflow", "type": "integer" }, "timestamp": { "type": "string" }, "tokensum": { "type": "integer" }, "user": { "$ref": "#/definitions/auxdata_ai_domain.User" }, "userId": { "type": "integer" } } }, "auxdata_ai_domain.TokenUsageStats": { "type": "object", "properties": { "calculatedtokensum": { "type": "integer" }, "details": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.TokenUsage" } }, "identifier": { "type": "string" }, "inputtokensum": { "type": "integer" }, "modelsummary": { "type": "object", "additionalProperties": { "$ref": "#/definitions/auxdata_ai_domain.TokenUsage" } }, "outputtokensum": { "type": "integer" }, "tokensum": { "type": "integer" } } }, "auxdata_ai_domain.UploadDocumentCommand": { "type": "object", "properties": { "botid": { "type": "integer" }, "containerid": { "type": "integer" }, "filecontent": { "type": "string" }, "filetype": { "type": "string" }, "id": { "type": "string" }, "imagelimit": { "type": "integer" }, "link": { "type": "string" }, "manualcontextenrichmentdata": { "type": "string" }, "name": { "type": "string" }, "readimagedata": { "description": "Flag to indicate if image data should be read from PDF documents", "type": "boolean" }, "token": { "type": "string" }, "type": { "$ref": "#/definitions/auxdata_ai_domain.DocumentType" } } }, "auxdata_ai_domain.UploadDocumentCommandApi": { "type": "object", "properties": { "filecontent": { "type": "string", "example": "akhjsd..." }, "filetype": { "type": "string", "example": "application/pdf" }, "id": { "type": "string", "example": "4713af05-9987-4181-a2fd-797c681f6eef" }, "imagelimit": { "type": "integer", "example": 10 }, "link": { "type": "string", "example": "https://example.com/document.pdf" }, "manualcontextenrichmentdata": { "type": "string", "example": "Additional context data" }, "name": { "type": "string", "example": "sample-document.pdf" }, "readimagedata": { "type": "boolean", "example": true }, "type": { "type": "string", "example": "BIN" } } }, "auxdata_ai_domain.UploadDocumentResult": { "type": "object", "properties": { "command": { "$ref": "#/definitions/auxdata_ai_domain.UploadDocumentCommand" }, "documentid": { "type": "string" }, "error": { "type": "string" } } }, "auxdata_ai_domain.UploadedFilesResult": { "type": "object", "properties": { "documentid": { "type": "string" }, "filename": { "type": "string" }, "filetype": { "type": "string" } } }, "auxdata_ai_domain.Usage": { "type": "object", "properties": { "agentid": { "type": "integer" }, "comuuid": { "type": "string" }, "context": { "type": "string" }, "currentstep": { "type": "integer" }, "details": { "$ref": "#/definitions/auxdata_ai_domain.ChatUsageDetails" }, "error": { "type": "string" }, "feedbackdata": { "$ref": "#/definitions/auxdata_ai_domain.WorkflowFeedbackData" }, "finished": { "type": "string" }, "id": { "type": "integer" }, "inputdata": { "type": "string" }, "inputdocuments": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.DocumentData" } }, "name": { "type": "string" }, "outputdata": { "type": "string" }, "outputdocuments": { "type": "array", "items": { "type": "string" } }, "progress": { "type": "integer" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.SearchChunkResult" } }, "started": { "type": "string" }, "state": { "$ref": "#/definitions/auxdata_ai_domain.SERVICE_STATE" }, "stepcount": { "type": "integer" }, "templateid": { "type": "integer" }, "userid": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "string" } } } }, "auxdata_ai_domain.User": { "type": "object", "properties": { "active": { "type": "boolean" }, "config": { "$ref": "#/definitions/auxdata_ai_domain.UserConfig" }, "deactivationDate": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.UserGroup" } }, "id": { "type": "integer" }, "keycloakuserId": { "type": "string" }, "language": { "type": "string" }, "name": { "type": "string" }, "organisationId": { "type": "integer" }, "role": { "$ref": "#/definitions/auxdata_ai_domain.UserRole" }, "thirdpartyid": { "type": "string" }, "twofa": { "type": "boolean" } } }, "auxdata_ai_domain.UserConfig": { "type": "object", "properties": { "behavior": { "type": "string" }, "language": { "type": "string" }, "personalKnowledgeDbEnabled": { "type": "boolean" }, "role": { "type": "string" }, "textsample": { "type": "string" } } }, "auxdata_ai_domain.UserGroup": { "type": "object", "properties": { "active": { "type": "boolean" }, "deactivationDate": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organisationId": { "type": "integer" }, "role": { "type": "integer" }, "users": { "type": "array", "items": { "$ref": "#/definitions/auxdata_ai_domain.User" } } } }, "auxdata_ai_domain.UserRole": { "type": "integer", "enum": [ 1, 2, 3, 4 ], "x-enum-varnames": [ "USER_ROLE_USER", "USER_ROLE_AGENT_ADMIN", "USER_ROLE_ORG_ADMIN", "USER_ROLE_SERVICE_ADMIN" ] }, "auxdata_ai_domain.VectorStoreAnalysisResult": { "type": "object", "properties": { "content": { "type": "string" }, "documentId": { "type": "string" }, "documentSource": { "type": "string" }, "score": { "type": "number" } } }, "auxdata_ai_domain.WorkflowFeedbackData": { "type": "object", "properties": { "agentid": { "type": "integer" }, "parametername": { "type": "string" }, "position": { "description": "index in CommandList of the feedback step", "type": "integer" }, "question": { "type": "string" }, "serviceid": { "type": "integer" } } }, "auxdata_ai_domain.WorkflowFeedbackStep": { "type": "object", "properties": { "createdAt": { "type": "string" }, "definition": { "$ref": "#/definitions/auxdata_ai_domain.WorkflowFeedbackStepDefinition" }, "respondedAt": { "type": "string" }, "status": { "$ref": "#/definitions/auxdata_ai_domain.FeedbackStatus" }, "userResponse": { "type": "string" } } }, "auxdata_ai_domain.WorkflowFeedbackStepDefinition": { "type": "object", "properties": { "parametername": { "type": "string" }, "prompt": { "description": "defined question or prompt which will be used to generate the question", "type": "string" }, "usesmartservice": { "description": "true = uses smartservice to generate the question", "type": "boolean" } } } }, "securityDefinitions": { "Bearer": { "description": "Public Rest-Service for Third Party Systems to interact with AuxData.ai", "type": "apiKey", "name": "Authorization", "in": "header" } }, "externalDocs": { "description": "OpenAPI", "url": "https://swagger.io/resources/open-api/" } }