POST api/document-creator/turn

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SkippedSlots	Collection of string	None.
ReopenSlots	Collection of string	None.
DocumentType	string	None.
CompanyID	integer	None.
CurrentStateID	integer	None.
Lines	Collection of Collection of Object	None.
ActiveIndex	integer	None.
History	Collection of DocumentCreatorMessage	None.
UserMessage	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SkippedSlots": [
    "sample string 1",
    "sample string 2"
  ],
  "ReopenSlots": [
    "sample string 1",
    "sample string 2"
  ],
  "DocumentType": "sample string 1",
  "CompanyID": 2,
  "CurrentStateID": 3,
  "Lines": null,
  "ActiveIndex": 4,
  "History": [
    {
      "Role": "sample string 1",
      "Text": "sample string 2"
    },
    {
      "Role": "sample string 1",
      "Text": "sample string 2"
    }
  ],
  "UserMessage": "sample string 5"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentCreatorTurnResponse

Name	Type	Additional information
Lines	Collection of Collection of Object	None.
ActiveIndex	integer	None.
Captured	Collection of string	None.
ChangedLines	Collection of integer	None.
ToolRuns	Collection of ToolRunDto	None.
AssistantMessage	string	None.
Blocks	Collection of Object	None.
Suggestions	Collection of string	None.
RequiredFields	Collection of string	None.
StillMissing	Collection of string	None.
LineStatus	Collection of LineStatusDto	None.
ReadyToSubmit	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Lines": null,
  "ActiveIndex": 1,
  "Captured": [
    "sample string 1",
    "sample string 2"
  ],
  "ChangedLines": [
    1,
    2
  ],
  "ToolRuns": [
    {
      "Tool": "sample string 1",
      "Summary": "sample string 2"
    },
    {
      "Tool": "sample string 1",
      "Summary": "sample string 2"
    }
  ],
  "AssistantMessage": "sample string 2",
  "Blocks": [
    {},
    {}
  ],
  "Suggestions": [
    "sample string 1",
    "sample string 2"
  ],
  "RequiredFields": [
    "sample string 1",
    "sample string 2"
  ],
  "StillMissing": [
    "sample string 1",
    "sample string 2"
  ],
  "LineStatus": [
    {
      "Index": 1,
      "IsEmpty": true,
      "Complete": true,
      "StillMissing": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Index": 1,
      "IsEmpty": true,
      "Complete": true,
      "StillMissing": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "ReadyToSubmit": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.