314 lines
14 KiB
Markdown
314 lines
14 KiB
Markdown
| Field Name | Type Pattern | Models Using It |
|
|
|------------|--------------|-----------------|
|
|
| `accumulatedJsonString` | str | JsonAccumulationState |
|
|
| `action` | str | ActionDefinition |
|
|
| `actionId` | str | ChatDocument, ChatMessage |
|
|
| `actionList` | List | TaskItem |
|
|
| `actionMethod` | str | ChatMessage |
|
|
| `actionName` | str | ChatMessage |
|
|
| `actionNumber` | int | ChatLog, ChatDocument, ChatMessage |
|
|
| `actionObjective` | str | ActionDefinition, TaskContext |
|
|
| `actionProgress` | str | ChatMessage |
|
|
| `actionResult` | Any | TaskResult |
|
|
| `active` | bool | AutomationDefinition |
|
|
| `additionalData` | Dict | AiResponseMetadata |
|
|
| `aiPrompt` | str | AiProcessParameters |
|
|
| `allSections` | List | JsonAccumulationState |
|
|
| `apiUrl` | str | AiModel |
|
|
| `authenticationAuthority` | AuthAuthority | User |
|
|
| `authority` | AuthAuthority | UserConnection, Token |
|
|
| `availableConnections` | list | TaskContext |
|
|
| `availableDocuments` | str | TaskContext |
|
|
| `base64Encoded` | bool | ContentMetadata, FileData |
|
|
| `bytesSent` | int | ChatStat, AiCallResponse |
|
|
| `bytesReceived` | int | ChatStat, AiCallResponse |
|
|
| `classes` | List | CodeContentPromptArgs |
|
|
| `colorMode` | str | ContentMetadata |
|
|
| `compressContext` | bool | AiCallOptions |
|
|
| `compressPrompt` | bool | AiCallOptions |
|
|
| `condition` | str | SelectionRule |
|
|
| `confidence` | float | ReviewResult |
|
|
| `connectedAt` | float | UserConnection |
|
|
| `connectionId` | str | Token |
|
|
| `connectionReference` | str | ActionDefinition |
|
|
| `connectorType` | str | AiModel |
|
|
| `content` | str | Prompt, ContentItem, AiResponse, AiCallResponse, FilePreview |
|
|
| `contentAnalysis` | Dict | Observation |
|
|
| `contentParts` | List | AiCallRequest, AiProcessParameters, SectionPromptArgs, ChapterStructurePromptArgs, CodeContentPromptArgs, CodeStructurePromptArgs |
|
|
| `contentSize` | str | ObservationPreview |
|
|
| `contentValidation` | Dict | Observation |
|
|
| `contents` | List | ChatContentExtracted |
|
|
| `context` | Dict, AccessRuleContext | TaskHandover, UnderstandingResult, AccessRule |
|
|
| `contextInfo` | str | CodeContentPromptArgs |
|
|
| `costPer1kTokensInput` | float | AiModel |
|
|
| `costPer1kTokensOutput` | float | AiModel |
|
|
| `country` | str | AiCallPromptWebSearch |
|
|
| `create` | AccessLevel | AccessRule, UserPermissions |
|
|
| `created` | str | ObservationPreview |
|
|
| `createdAt` | float | Token |
|
|
| `creationDate` | float | FileItem |
|
|
| `criteriaProgress` | dict | TaskContext |
|
|
| `currentAction` | int | ChatWorkflow |
|
|
| `currentRound` | int | ChatWorkflow |
|
|
| `currentTask` | int | ChatWorkflow |
|
|
| `data` | str | ContentItem, FileData |
|
|
| `dataType` | str | TaskStep |
|
|
| `delete` | AccessLevel | AccessRule, UserPermissions |
|
|
| `deliverable` | Dict | TaskDefinition |
|
|
| `delivered_summary` | str | ContinuationContext |
|
|
| `dependencies` | List | TaskItem, TaskStep, CodeContentPromptArgs |
|
|
| `description` | TextMultilingual | Role |
|
|
| `details` | str | AuthEvent |
|
|
| `detectedComplexity` | str | RequestContext |
|
|
| `displayName` | str | AiModel |
|
|
| `documentData` | Any | ActionDocument, DocumentData |
|
|
| `documentId` | str | ObservationPreview |
|
|
| `documentList` | DocumentReferenceList | ActionDefinition, ExtractContentParameters |
|
|
| `documentName` | str | ActionDocument, DocumentData |
|
|
| `documentReferences` | List | UnderstandingResult |
|
|
| `documents` | List | ChatMessage, ActionResult, AiResponse |
|
|
| `documentsCount` | int | Observation |
|
|
| `documentsLabel` | str | ChatMessage, DocumentExchange |
|
|
| `durationSec` | float | ContentMetadata |
|
|
| `email` | EmailStr | User |
|
|
| `enabled` | bool | Mandate, User |
|
|
| `encoding` | str | FilePreview |
|
|
| `engine` | str | ChatStat |
|
|
| `error` | str | ContentMetadata, ActionResult, ActionItem, TaskItem, TaskResult |
|
|
| `errorCount` | int | ChatStat, AiCallResponse |
|
|
| `estimatedComplexity` | str | TaskStep |
|
|
| `eventId` | str | AutomationDefinition |
|
|
| `eventType` | str | AuthEvent |
|
|
| `execAction` | str | ActionItem |
|
|
| `execMethod` | str | ActionItem |
|
|
| `execParameters` | Dict | ActionItem |
|
|
| `execResultLabel` | str | ActionItem |
|
|
| `executedActions` | list | TaskContext |
|
|
| `executionLogs` | List | AutomationDefinition |
|
|
| `expectedDocumentFormats` | List | ActionItem |
|
|
| `expectedFormats` | List | ChatWorkflow, TaskStep |
|
|
| `expectedOutputFormat` | str | RequestContext |
|
|
| `expectedOutputType` | str | RequestContext |
|
|
| `expiresAt` | float | UserConnection, Token |
|
|
| `externalEmail` | EmailStr | UserConnection |
|
|
| `externalId` | str | UserConnection |
|
|
| `externalUsername` | str | UserConnection |
|
|
| `extractionMethod` | str | AiResponseMetadata |
|
|
| `extractionOptions` | Any | TaskDefinition, ExtractContentParameters |
|
|
| `failedActions` | list | TaskContext |
|
|
| `failurePatterns` | list | TaskContext |
|
|
| `feedback` | str | TaskResult, TaskItem |
|
|
| `fileHash` | str | FileItem |
|
|
| `fileId` | str | ChatDocument |
|
|
| `fileName` | str | FileItem, FilePreview, ChatDocument |
|
|
| `fileSize` | int | FileItem, ChatDocument |
|
|
| `fileType` | str | CodeContentPromptArgs |
|
|
| `filename` | str | AiResponseMetadata, CodeContentPromptArgs |
|
|
| `finishedAt` | float | TaskItem |
|
|
| `fps` | float | ContentMetadata |
|
|
| `fullName` | str | User |
|
|
| `functionCall` | Callable | AiModel |
|
|
| `functions` | List | CodeContentPromptArgs |
|
|
| `generationHint` | str | SectionPromptArgs |
|
|
| `handoverType` | str | TaskHandover |
|
|
| `hashedPassword` | str | UserInDB |
|
|
| `height` | int | ContentMetadata |
|
|
| `hierarchyContext` | str | JsonContinuationContexts |
|
|
| `hierarchyContextForPrompt` | str | JsonContinuationContexts |
|
|
| `id` | str | *Most models* |
|
|
| `improvements` | List | TaskHandover, TaskContext, ReviewResult |
|
|
| `incomplete_part` | str | ContinuationContext |
|
|
| `inputDocuments` | List | TaskHandover |
|
|
| `instruction` | str | AiCallPromptWebSearch, AiCallPromptWebCrawl |
|
|
| `intention` | Dict | UnderstandingResult |
|
|
| `ipAddress` | str | AuthEvent |
|
|
| `isAccumulationMode` | bool | JsonAccumulationState |
|
|
| `isAggregation` | bool | SectionPromptArgs |
|
|
| `isAvailable` | bool | AiModel |
|
|
| `isRegeneration` | bool | TaskContext |
|
|
| `isSystemRole` | bool | Role |
|
|
| `isText` | bool | FilePreview |
|
|
| `item` | str | AccessRule |
|
|
| `jsonParsingSuccess` | bool | JsonContinuationContexts |
|
|
| `kpis` | List | JsonAccumulationState |
|
|
| `label` | str | ContentItem, AutomationDefinition |
|
|
| `language` | str | Mandate, User, SectionPromptArgs, AiCallPromptWebSearch |
|
|
| `last_complete_part` | str | ContinuationContext |
|
|
| `last_raw_json` | str | ContinuationContext |
|
|
| `lastActivity` | float | ChatWorkflow |
|
|
| `lastChecked` | float | UserConnection |
|
|
| `lastParsedResult` | Dict | JsonAccumulationState |
|
|
| `lastUpdated` | str | AiModel |
|
|
| `learnings` | List | ActionDefinition, TaskContext |
|
|
| `listFileId` | List | UserInputRequest |
|
|
| `logs` | List | ChatWorkflow |
|
|
| `mandateId` | str | ChatWorkflow, FileItem, Prompt, User, AutomationDefinition, Token |
|
|
| `maxCost` | float | SelectionRule, AiCallOptions |
|
|
| `maxDepth` | int | AiCallPromptWebCrawl |
|
|
| `maxNumberPages` | int | AiCallPromptWebSearch |
|
|
| `maxParts` | int | AiCallOptions |
|
|
| `maxProcessingTime` | int | AiCallOptions |
|
|
| `maxSteps` | int | ChatWorkflow |
|
|
| `maxTokens` | int | AiModel |
|
|
| `maxWidth` | int | AiCallPromptWebCrawl |
|
|
| `message` | str | ChatLog, ChatMessage |
|
|
| `messageHistory` | List | TaskHandover |
|
|
| `messageId` | str | ChatDocument |
|
|
| `messages` | List | ChatWorkflow, AiModelCall |
|
|
| `metadata` | ContentMetadata, AiResponseMetadata, Dict | ContentItem, AiResponse, AiModelResponse, CodeContentPromptArgs |
|
|
| `metCriteria` | List | ReviewResult |
|
|
| `method` | str | ActionSelection |
|
|
| `mime` | str | ObservationPreview |
|
|
| `mimeType` | str | ContentMetadata, FileItem, FilePreview, ChatDocument, ActionDocument, DocumentData |
|
|
| `minContextLength` | int | AiModel, SelectionRule |
|
|
| `minQualityRating` | int | SelectionRule |
|
|
| `missingOutputs` | List | ReviewResult |
|
|
| `model` | AiModel | AiModelCall |
|
|
| `modelId` | str | AiModelResponse |
|
|
| `modelName` | str | AiCallResponse |
|
|
| `modified` | str | ObservationPreview |
|
|
| `name` | str | Mandate, Prompt, ActionSelection, AiModel, SelectionRule, ObservationPreview |
|
|
| `nextAction` | str | ReviewResult |
|
|
| `nextActionGuidance` | Dict | TaskContext |
|
|
| `nextActionObjective` | str | ReviewResult |
|
|
| `nextActionParameters` | Dict | ReviewResult |
|
|
| `notes` | List | Observation |
|
|
| `objective` | str | TaskStep, TaskDefinition |
|
|
| `operationId` | str | ChatLog |
|
|
| `operationType` | OperationTypeEnum, str | OperationTypeRating, AiCallOptions, AiResponseMetadata |
|
|
| `operationTypes` | List | AiModel, SelectionRule |
|
|
| `options` | AiCallOptions | AiCallRequest, AiModelCall |
|
|
| `originalPrompt` | str | RequestContext |
|
|
| `outputDocuments` | List | TaskHandover |
|
|
| `outputFormat` | str | ChapterStructurePromptArgs |
|
|
| `overlapContext` | str | JsonContinuationContexts |
|
|
| `overlap_context` | str | ContinuationContext |
|
|
| `overview` | str | TaskPlan |
|
|
| `pages` | int | ContentMetadata |
|
|
| `parameters` | Dict | ActionParameters, UnderstandingResult, ActionDefinition |
|
|
| `parametersContext` | str | ActionDefinition, TaskContext |
|
|
| `parentId` | str | ChatLog |
|
|
| `parentMessageId` | str | ChatMessage |
|
|
| `performance` | Dict | ChatLog |
|
|
| `placeholders` | List, Dict | PromptBundle, AutomationDefinition |
|
|
| `priceUsd` | float | ChatStat, AiCallResponse |
|
|
| `previews` | List | Observation |
|
|
| `previousActionResults` | list | TaskContext |
|
|
| `previousHandover` | TaskHandover | TaskContext |
|
|
| `previousResults` | List | TaskHandover, TaskContext, ReviewContext |
|
|
| `previousReviewResult` | dict | TaskContext |
|
|
| `priority` | PriorityEnum | AiModel, SelectionRule, AiCallOptions |
|
|
| `process` | str | ChatStat |
|
|
| `processDocumentsIndividually` | bool | AiCallOptions |
|
|
| `processingMode` | ProcessingModeEnum | AiModel, AiCallOptions |
|
|
| `processingTime` | float | ChatStat, ActionItem, TaskItem, AiCallResponse, AiModelResponse |
|
|
| `progress` | float | ChatLog |
|
|
| `prompt` | str | UserInputRequest, PromptBundle, AiCallPromptImage |
|
|
| `publishedAt` | float | ChatMessage |
|
|
| `qualityRating` | int | AiModel |
|
|
| `qualityRequirements` | Dict | TaskStep |
|
|
| `qualityScore` | float | ReviewResult |
|
|
| `quality` | str | AiCallPromptImage |
|
|
| `rating` | int | OperationTypeRating |
|
|
| `read` | AccessLevel | AccessRule, UserPermissions |
|
|
| `reason` | str | Token, ReviewResult |
|
|
| `reference` | str | ObservationPreview |
|
|
| `requiredDocuments` | List | TaskDefinition |
|
|
| `requiresAnalysis` | bool | RequestContext |
|
|
| `requiresContentGeneration` | bool | TaskDefinition |
|
|
| `requiresDocumentAnalysis` | bool | TaskDefinition |
|
|
| `requiresDocuments` | bool | RequestContext |
|
|
| `requiresWebResearch` | bool | RequestContext, TaskDefinition |
|
|
| `researchDepth` | str | AiCallPromptWebSearch |
|
|
| `resetToken` | str | UserInDB |
|
|
| `resetTokenExpires` | float | UserInDB |
|
|
| `result` | str | ActionItem |
|
|
| `resultFormat` | str | AiCallOptions |
|
|
| `resultLabel` | str | ActionResult, Observation |
|
|
| `resultLabels` | Dict | TaskItem |
|
|
| `resultType` | str | AiProcessParameters |
|
|
| `retryCount` | int | ActionItem, TaskItem, TaskContext |
|
|
| `retryMax` | int | ActionItem, TaskItem |
|
|
| `revokedAt` | float | Token |
|
|
| `revokedBy` | str | Token |
|
|
| `role` | str | ChatMessage |
|
|
| `roleLabel` | str | Role, AccessRule |
|
|
| `roleLabels` | List | User |
|
|
| `rollbackOnFailure` | bool | TaskItem |
|
|
| `roundNumber` | int | ChatLog, ChatDocument, ChatMessage |
|
|
| `safetyMargin` | float | AiCallOptions |
|
|
| `schedule` | str | AutomationDefinition |
|
|
| `schemaVersion` | str | AiResponseMetadata |
|
|
| `section` | Dict | SectionPromptArgs |
|
|
| `section_count` | int | ContinuationContext |
|
|
| `sectionIndex` | int | SectionPromptArgs |
|
|
| `sequenceNr` | int | ChatMessage |
|
|
| `sessionId` | str | Token |
|
|
| `size` | int, str | ContentMetadata, FilePreview, AiCallPromptImage, ObservationPreview |
|
|
| `snippet` | str | ObservationPreview |
|
|
| `sourceDocuments` | List | AiResponseMetadata |
|
|
| `sourceJson` | Dict | ActionDocument, DocumentData |
|
|
| `sourceTask` | str | TaskHandover |
|
|
| `speedRating` | int | AiModel |
|
|
| `stage1Selection` | dict | TaskContext |
|
|
| `startedAt` | float | ChatWorkflow, TaskItem |
|
|
| `stats` | List | ChatWorkflow |
|
|
| `status` | str, TokenStatus, TaskStatus, ConnectionStatus | ChatLog, ChatWorkflow, ChatMessage, UserConnection, AutomationDefinition, ActionItem, TaskItem, TaskResult, ReviewResult, Token |
|
|
| `style` | str | AiCallPromptImage |
|
|
| `success` | bool | ChatMessage, ActionResult, Observation, TaskResult, AuthEvent, AiModelResponse |
|
|
| `successCriteria` | list | TaskStep |
|
|
| `successfulActions` | list | TaskContext |
|
|
| `summary` | str | ChatMessage |
|
|
| `summaryAllowed` | bool | PromptPlaceholder |
|
|
| `taskActions` | list | ReviewContext |
|
|
| `taskId` | str | TaskResult, TaskHandover |
|
|
| `taskNumber` | int | ChatLog, ChatDocument, ChatMessage |
|
|
| `taskProgress` | str | ChatMessage |
|
|
| `tasks` | List | ChatWorkflow, TaskPlan, UnderstandingResult |
|
|
| `taskStep` | TaskStep | TaskContext, ReviewContext |
|
|
| `temperature` | float | AiModel, AiCallOptions |
|
|
| `template` | str | AutomationDefinition |
|
|
| `template_structure` | str | ContinuationContext |
|
|
| `timestamp` | float | ChatLog, ActionItem, TaskHandover, AuthEvent |
|
|
| `title` | str | AiResponseMetadata |
|
|
| `tokenAccess` | str | Token |
|
|
| `tokenExpiresAt` | float | UserConnection |
|
|
| `tokenRefresh` | str | Token |
|
|
| `tokensUsed` | Dict | AiModelResponse |
|
|
| `tokenStatus` | str | UserConnection |
|
|
| `tokenType` | str | Token |
|
|
| `totalActions` | int | ChatWorkflow |
|
|
| `totalTasks` | int | ChatWorkflow |
|
|
| `type` | str | ChatLog |
|
|
| `typeGroup` | str | ObservationPreview |
|
|
| `unmetCriteria` | List | ReviewResult |
|
|
| `update` | AccessLevel | AccessRule, UserPermissions |
|
|
| `url` | str | AiCallPromptWebCrawl |
|
|
| `userAgent` | str | AuthEvent |
|
|
| `userId` | str | UserConnection, Token, AuthEvent |
|
|
| `userInput` | str | TaskItem |
|
|
| `userLanguage` | str | UserInputRequest, RequestContext |
|
|
| `userMessage` | str | ActionItem, TaskStep, ReviewResult, TaskPlan, ActionDefinition |
|
|
| `userPrompt` | str | SectionPromptArgs, ChapterStructurePromptArgs, CodeContentPromptArgs, CodeStructurePromptArgs |
|
|
| `username` | str | User |
|
|
| `validationMetadata` | Dict | ActionDocument |
|
|
| `version` | str | AiModel |
|
|
| `view` | bool | AccessRule, UserPermissions |
|
|
| `weight` | float | SelectionRule |
|
|
| `width` | int | ContentMetadata |
|
|
| `workflow` | ChatWorkflow | TaskContext |
|
|
| `workflowId` | str | ChatStat, ChatLog, ChatMessage, ChatWorkflow, TaskItem, TaskContext, ReviewContext |
|
|
| `workflowMode` | WorkflowModeEnum | ChatWorkflow |
|
|
| `workflowSummary` | str | TaskHandover |
|
|
|
|
|
|
|
|
---
|
|
|
|
Can you adapt following fields to Multilingual Fields (`TextMultilingual`):
|
|
|
|
| Field Name | Models |
|
|
|------------|--------|
|
|
| `description` | Role | (is already)
|
|
|
|
|