API V3 Documentation – AI
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Data types
AI.GeneratedDependency
This is a structure data contract.
Dependency of a project generated by the LLM.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
minDistance |
int | Minimum acceptable distance for the dependency. | ||
maxDistance |
int? | Maximum acceptable distance for the dependency (null if no upper limit). | ||
predecessorId |
int | Temporary ID of the phase from which the dependency starts. | ||
successorId |
int | Temporary ID of the phase to which the dependency ends. | ||
fromStart |
boolean | Defines if dependency starts from left of starting dependency | ||
toStart |
boolean | Defines if dependency ends to left of ending dependency |
AI.GeneratedPhase
This is a structure data contract.
Phase (task/milestone) of a project generated by the LLM.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
string | The type of phase. | ||
id |
int | The temporary ID of the phase. | ||
name |
string | The name of the phase. | ||
description |
string | The description of the phase. | ||
beg |
date | The starting date of the phase. | ||
end |
date | The ending date of the phase. | ||
duration |
duration | Duration of the phase. | ||
children |
array of GeneratedPhase | Subphases of the phase. | null;non-null (The array is optional. Each element must not be null.) |
AI.GeneratedProject
This is a structure data contract.
Structure of a project generated by the LLM.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
name |
string | The name of the generated project. | ||
tasks |
GeneratedPhase | The tasks of the generated project, as a tree structure. | ||
dependencies |
array of GeneratedDependency | The list of dependencies connecting the tasks and milestone of the generated project. | null;non-null (The array is optional. Each element must not be null.) |
AI.LLMProjectFeedback
This is a structure data contract.
Feedback sent by user to adjust a generated project.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
project |
GeneratedProject | Project generated from an LLM in a previous step. | ||
prompt |
string | User prompt that contains the feedback required to change the generated project. |
AI.LLMProjectResponse
This is a structure data contract.
Response generated from the LLM.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
result |
GeneratedProject | Project generated from the LLM. | ||
message |
string | Translated message sent to the user along with the output. |
AI.UserPrompt
This is a structure data contract.
Info provided by user to AI-generate a project.
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
prompt |
string | The user prompt, used as input by the LLM. |