From 3770a7a13d735d507ebe17f098c8eb05e67a5894 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Thu, 23 Nov 2023 15:08:39 +0900 Subject: [PATCH] comment spec/messages --- docs/docs/specs/messages.md | 158 ------------------------------------ 1 file changed, 158 deletions(-) diff --git a/docs/docs/specs/messages.md b/docs/docs/specs/messages.md index db54f7782..049e190c6 100644 --- a/docs/docs/specs/messages.md +++ b/docs/docs/specs/messages.md @@ -256,161 +256,3 @@ See [Jan Messages API](https://jan.ai/api-reference#tag/Messages) "message_id": "msg_abc123" } ``` --> -### Get list message - -> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/getMessage - -- Example request - -```shell - curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \ - -H "Content-Type: application/json" -``` - -- Example response - -```json -{ - "id": "msg_abc123", - "object": "thread.message", - "created_at": 1699017614, - "thread_id": "thread_abc123", - "role": "user", - "content": [ - { - "type": "text", - "text": { - "value": "How does AI work? Explain it in simple terms.", - "annotations": [] - } - } - ], - "file_ids": [], - "assistant_id": null, - "run_id": null, - "metadata": {} -} -``` - -### Create message - -> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/createMessage - -- Example request - -```shell - curl -X POST {JAN_URL}/v1/threads/{thread_id}/messages \ - -H "Content-Type: application/json" \ - -d '{ - "role": "user", - "content": "How does AI work? Explain it in simple terms." - }' -``` - -- Example response - -```json -{ - "id": "msg_abc123", - "object": "thread.message", - "created_at": 1699017614, - "thread_id": "thread_abc123", - "role": "user", - "content": [ - { - "type": "text", - "text": { - "value": "How does AI work? Explain it in simple terms.", - "annotations": [] - } - } - ], - "file_ids": [], - "assistant_id": null, - "run_id": null, - "metadata": {} -} -``` - -### Get message - -> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/assistants/listAssistants - -- Example request - -```shell - curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \ - -H "Content-Type: application/json" -``` - -- Example response - -```json -{ - "id": "msg_abc123", - "object": "thread.message", - "created_at": 1699017614, - "thread_id": "thread_abc123", - "role": "user", - "content": [ - { - "type": "text", - "text": { - "value": "How does AI work? Explain it in simple terms.", - "annotations": [] - } - } - ], - "file_ids": [], - "assistant_id": null, - "run_id": null, - "metadata": {} -} -``` - -### Modify message - -> Jan: TODO: Do we need to modify message? Or let user create new message? - -# Get message file - -> OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} - -- Example request - -```shell - curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \ - -H "Content-Type: application/json" -``` - -- Example response - -```json -{ - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" -} -``` - -# List message files - -> OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files - -```` -- Example request -```shell - curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \ - -H "Content-Type: application/json" -```` - -- Example response - -```json -{ - "id": "file-abc123", - "object": "thread.message.file", - "created_at": 1699061776, - "message_id": "msg_abc123" -} \ No newline at end of file