Suggest Edits Endpoint

POST 
/api/v1/reports/:report_id/suggest_edits

Suggest edits to a report based on user query and chat history.

Request

Path Parameters

report_id uuidrequired

Query Parameters

project_id any
organization_id any

Cookie Parameters

session any

application/json

Body

required

user_query User Query (string)required

chat_history

object[]

required

Array [

role MessageRole (string)

Message role.

Possible values: [system, user, assistant, function, tool, chatbot, model]

Default value: user

additional_kwargs object

blocks

object[]

Array [

oneOf

TextBlock

block_type Block Type (string)

Default value: text

text Text (string)required

ImageBlock

block_type Block Type (string)

Default value: image

image

object

anyOf

MOD1

string

path

object

anyOf

MOD1

string

url

object

anyOf

MOD1

string

Possible values: non-empty

MOD2

string

image_mimetype

object

anyOf

MOD1

string

detail

object

anyOf

MOD1

string

]

]

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

justification Justification (string)required
start_line Start Line (integer)required
end_line End Line (integer)required

blocks

object[]

required

Array [

idx Idx (integer)required

The index of the block

template Template (string)required

The content of the block

sources

object[]

The sources for the block

Array [

node

object

required

Provided for backward compatibility.

Note: we keep the field with the typo "seperator" to maintain backward compatibility for serialized objects.

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

metadata_template Metadata Template (string)

Template for how metadata is formatted, with {key} and {value} placeholders.

Default value: {key}: {value}

metadata_separator Metadata Separator (string)

Separator between metadata fields when converting to string.

Default value:

text Text (string)

Text content of the node.

Default value:

mimetype Mimetype (string)

MIME type of the node content.

Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

metadata_seperator Metadata Seperator (string)

Separator between metadata fields when converting to string.

Default value:

text_template Text Template (string)

Template for how text is formatted, with {content} and {metadata_str} placeholders.

Default value: {metadata_str} {content}

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: TextNodeWithScore

]

]

• ]

Example (from schema)

[
  {
    "justification": "string",
    "start_line": 0,
    "end_line": 0,
    "blocks": [
      {
        "idx": 0,
        "template": "string",
        "sources": [
          {
            "node": {
              "id_": "string",
              "embedding": [
                null
              ],
              "extra_info": {},
              "excluded_embed_metadata_keys": [
                "string"
              ],
              "excluded_llm_metadata_keys": [
                "string"
              ],
              "relationships": {},
              "metadata_template": "{key}: {value}",
              "metadata_separator": "\n",
              "text": "string",
              "mimetype": "text/plain",
              "start_char_idx": 0,
              "end_char_idx": 0,
              "metadata_seperator": "\n",
              "text_template": "{metadata_str}\n\n{content}",
              "class_name": "TextNode"
            },
            "score": 0,
            "class_name": "TextNodeWithScore"
          }
        ]
      }
    ]
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}