Add Comment Feedback

POST

/chat/comment/{id}

Chat APIs

Allows users to add or retrieve comments associated with chat messages, providing context or feedback related to specific interactions.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/chat/comment/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "This response wasn'\''t helpful",
    "created_by": "alex@example.com"
}'

Response Example

{
    "id": 1,
    "comments": [
        {
            "id": 81,
            "comment": "This response wasn't helpful",
            "created_by": "alex@example.com",
            "created_on": "2024-09-19T21:19:39.217733Z",
            "chat_log": 1
        }
    ],
    "feedback": [
        null
    ],
    "question": "What are some strategies for conflict resolution?",
    "response": {
        "query": "Effective conflict resolution strategies",
        "answer": "To prioritize the relationship during conflict resolution, focus on clear communication, being willing to compromise, and avoiding personal attacks.",
        "sources": [
            "conflict-resolution-guide.pdf"
        ],
        "thoughts": "Resolved based on resources and strategies found in provided documents.",
        "cache_hit": false
    },
    "created_by": "john.doe@example.com",
    "created_on": "2024-01-20T01:47:19.751813Z",
    "is_deleted": true,
    "total_tokens": 5299,
    "prompt_tokens": 4955,
    "completion_tokens": 344,
    "cache_hit": false,
    "query_source": "web",
    "message_id": null,
    "chat_thread": 4,
    "agent": 16,
    "user": 2,
    "llm_config": 8
}

Request

Path Params

integer

required

ID of the chat message

Body Params application/json

comment

string

optional

Example:

This response wasn't helpful

created_by

string <email>

optional

Example:

alex@example.com

Examples

Responses

🟢200OK

application/json

Successfully added comment feedback.

Body

integer

optional

Example:

comments

array [object {5}]

optional

integer

optional

Example:

comment

string

optional

Example:

This response wasn't helpful

created_by

string <email>

optional

Example:

alex@example.com

created_on

string <date-time>

optional

Example:

2024-09-19T21:19:39.217733Z

chat_log

integer

optional

Example:

feedback

array

optional

question

string

optional

Example:

What are some strategies for conflict resolution?

response

object

optional

query

string

optional

Example:

Effective conflict resolution strategies

answer

string

optional

Example:

To prioritize the relationship during conflict resolution, focus on clear communication, being willing to compromise, and avoiding personal attacks.

sources

array[string]

optional

thoughts

string

optional

Example:

Resolved based on resources and strategies found in provided documents.

cache_hit

boolean

optional

Example:

false

created_by

string <email>

optional

Example:

john.doe@example.com

created_on

string <date-time>

optional

Example:

2024-01-20T01:47:19.751813Z

is_deleted

boolean

optional

Example:

true

total_tokens

integer

optional

Example:

5299

prompt_tokens

integer

optional

Example:

4955

completion_tokens

integer

optional

Example:

344

cache_hit

boolean

optional

Example:

false

query_source

string

optional

Example:

web

message_id

integer | null

optional

Example:

null

chat_thread

integer

optional

Example:

agent

integer

optional

Example:

user

integer

optional

Example:

llm_config

integer

optional

Example:

🟠400Bad Request

🟠404Record Not Found

Create Custom Instructions

Add Upvote Feedback