Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update API Reference assistants_id endpoint from DevDocs (#2195)

Browse Source 
docs: update API Reference assistants_id endpoint from DevDocs
This commit is contained in:
Henry 2024-03-03 07:40:44 +09:00 committed by GitHub
commit 7f2513fe3e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 91 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
docs/openapi/jan.yaml
View File

@ -1,11 +1,11 @@
---
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: API Reference title: API Reference
description: > description: >
# Introduction # Introduction
Jan API is compatible with the [OpenAI Jan API is compatible with the [OpenAI API](https://platform.openai.com/docs/api-reference).
API](https://platform.openai.com/docs/api-reference).
version: 0.1.8 version: 0.1.8
contact: contact:
name: Jan Discord name: Jan Discord
@ -20,12 +20,12 @@ tags:
description: List and describe the various models available in the API. description: List and describe the various models available in the API.
- name: Chat - name: Chat
description: > description: >
Given a list of messages comprising a conversation, the model will return Given a list of messages comprising a conversation, the model will
a response. return a response.
- name: Messages - name: Messages
description: > description: >
Messages capture a conversation's content. This can include the content Messages capture a conversation's content. This can include the
from LLM responses and other metadata from [chat content from LLM responses and other metadata from [chat
completions](/specs/chats). completions](/specs/chats).
- name: Threads - name: Threads
- name: Assistants - name: Assistants
@ -49,16 +49,16 @@ paths:
summary: | summary: |
Create chat completion Create chat completion
description: > description: >
Creates a model response for the given chat conversation. <a href = Creates a model response for the given chat conversation. <a href
"https://platform.openai.com/docs/api-reference/chat/create"> Equivalent = "https://platform.openai.com/docs/api-reference/chat/create">
to OpenAI's create chat completion. </a> Equivalent to OpenAI's create chat completion. </a>
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: specs/chat.yaml#/components/schemas/ChatCompletionRequest $ref: specs/chat.yaml#/components/schemas/ChatCompletionRequest
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -192,9 +192,7 @@ paths:
} }
response = response = requests.post('http://localhost:1337/v1/chat/completions', json=data)
requests.post('http://localhost:1337/v1/chat/completions',
json=data)
print(response.json()) print(response.json())
/models: /models:
@ -204,12 +202,12 @@ paths:
- Models - Models
summary: List models summary: List models
description: > description: >
Lists the currently available models, and provides basic information Lists the currently available models, and provides basic
about each one such as the owner and availability. <a href = information about each one such as the owner and availability. <a href
"https://platform.openai.com/docs/api-reference/models/list"> Equivalent = "https://platform.openai.com/docs/api-reference/models/list">
to OpenAI's list model. </a> Equivalent to OpenAI's list model. </a>
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -228,14 +226,6 @@ paths:
headers: {Accept: 'application/json'} headers: {Accept: 'application/json'}
}); });
const data = await response.json(); const data = await response.json();
- lang: Python
source: |-
import requests
url = 'http://localhost:1337/v1/models'
headers = {'Accept': 'application/json'}
response = requests.get(url, headers=headers)
data = response.json()
- lang: Node.js - lang: Node.js
source: |- source: |-
const fetch = require('node-fetch'); const fetch = require('node-fetch');
@ -249,7 +239,15 @@ paths:
fetch(url, options) fetch(url, options)
.then(res => res.json()) .then(res => res.json())
.then(json => console.log(json)); .then(json => console.log(json));
/models/download/{model_id}: - lang: Python
source: |-
import requests
url = 'http://localhost:1337/v1/models'
headers = {'Accept': 'application/json'}
response = requests.get(url, headers=headers)
data = response.json()
"/models/download/{model_id}":
get: get:
operationId: downloadModel operationId: downloadModel
tags: tags:
@ -267,7 +265,7 @@ paths:
description: | description: |
The ID of the model to use for this request. The ID of the model to use for this request.
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -304,20 +302,18 @@ paths:
import requests import requests
response = response = requests.get('http://localhost:1337/v1/models/download/{model_id}', headers={'accept': 'application/json'})
requests.get('http://localhost:1337/v1/models/download/{model_id}',
headers={'accept': 'application/json'})
data = response.json() data = response.json()
/models/{model_id}: "/models/{model_id}":
get: get:
operationId: retrieveModel operationId: retrieveModel
tags: tags:
- Models - Models
summary: Retrieve model summary: Retrieve model
description: > description: >
Get a model instance, providing basic information about the model such Get a model instance, providing basic information about the model
as the owner and permissioning. <a href = such as the owner and permissioning. <a href =
"https://platform.openai.com/docs/api-reference/models/retrieve"> "https://platform.openai.com/docs/api-reference/models/retrieve">
Equivalent to OpenAI's retrieve model. </a> Equivalent to OpenAI's retrieve model. </a>
parameters: parameters:
@ -330,7 +326,7 @@ paths:
description: | description: |
The ID of the model to use for this request. The ID of the model to use for this request.
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -374,9 +370,7 @@ paths:
model_id = 'mistral-ins-7b-q4' model_id = 'mistral-ins-7b-q4'
response = response = requests.get(f'http://localhost:1337/v1/models/{model_id}', headers={'accept': 'application/json'})
requests.get(f'http://localhost:1337/v1/models/{model_id}',
headers={'accept': 'application/json'})
print(response.json()) print(response.json())
delete: delete:
@ -398,7 +392,7 @@ paths:
description: | description: |
The model id to delete The model id to delete
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -442,9 +436,7 @@ paths:
model_id = 'mistral-ins-7b-q4' model_id = 'mistral-ins-7b-q4'
response = response = requests.delete(f'http://localhost:1337/v1/models/{model_id}', headers={'accept': 'application/json'})
requests.delete(f'http://localhost:1337/v1/models/{model_id}',
headers={'accept': 'application/json'})
/threads: /threads:
post: post:
operationId: createThread operationId: createThread
@ -462,7 +454,7 @@ paths:
schema: schema:
$ref: specs/threads.yaml#/components/schemas/CreateThreadObject $ref: specs/threads.yaml#/components/schemas/CreateThreadObject
responses: responses:
'200': "200":
description: Thread created successfully description: Thread created successfully
content: content:
application/json: application/json:
@ -558,7 +550,7 @@ paths:
description: | description: |
Retrieves a list of all threads available in the system. Retrieves a list of all threads available in the system.
responses: responses:
'200': "200":
description: List of threads retrieved successfully description: List of threads retrieved successfully
content: content:
application/json: application/json:
@ -613,7 +605,7 @@ paths:
response = requests.get(url, headers=headers) response = requests.get(url, headers=headers)
print(response.json()) print(response.json())
/threads/{thread_id}: "/threads/{thread_id}":
get: get:
operationId: getThread operationId: getThread
tags: tags:
@ -633,7 +625,7 @@ paths:
description: | description: |
The ID of the thread to retrieve. The ID of the thread to retrieve.
responses: responses:
'200': "200":
description: Thread details retrieved successfully description: Thread details retrieved successfully
content: content:
application/json: application/json:
@ -673,7 +665,7 @@ paths:
items: items:
$ref: specs/threads.yaml#/components/schemas/ThreadMessageObject $ref: specs/threads.yaml#/components/schemas/ThreadMessageObject
responses: responses:
'200': "200":
description: Thread modified successfully description: Thread modified successfully
content: content:
application/json: application/json:
@ -712,7 +704,7 @@ paths:
description: | description: |
The ID of the thread to be deleted. The ID of the thread to be deleted.
responses: responses:
'200': "200":
description: Thread deleted successfully description: Thread deleted successfully
content: content:
application/json: application/json:
@ -733,7 +725,7 @@ paths:
"https://platform.openai.com/docs/api-reference/assistants/listAssistants"> "https://platform.openai.com/docs/api-reference/assistants/listAssistants">
Equivalent to OpenAI's list assistants. </a> Equivalent to OpenAI's list assistants. </a>
responses: responses:
'200': "200":
description: List of assistants retrieved successfully description: List of assistants retrieved successfully
content: content:
application/json: application/json:
@ -799,7 +791,7 @@ paths:
headers = {'Content-Type': 'application/json'} headers = {'Content-Type': 'application/json'}
response = requests.get(url, headers=headers) response = requests.get(url, headers=headers)
/assistants/{assistant_id}: "/assistants/{assistant_id}":
get: get:
operationId: getAssistant operationId: getAssistant
tags: tags:
@ -819,19 +811,51 @@ paths:
description: | description: |
The ID of the assistant to retrieve. The ID of the assistant to retrieve.
responses: responses:
'200': "200":
description: null description: null
content: content:
application/json: application/json:
schema: schema:
$ref: >- $ref: specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse
specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse
x-codeSamples: x-codeSamples:
- lang: cURL - lang: cURL
source: | source: |-
curl http://localhost:1337/v1/assistants/{assistant_id} \ curl http://localhost:1337/v1/assistants/{assistant_id} \
-H "Content-Type: application/json" \ -H "Content-Type: application/json"
/threads/{thread_id}/messages: - lang: JavaScript
source: |-
const fetch = require('node-fetch');
let assistantId = 'abc123';
fetch(`http://localhost:1337/v1/assistants/${assistantId}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
})
- lang: Node.js
source: |-
const fetch = require('node-fetch');
let assistantId = 'abc123';
fetch(`http://localhost:1337/v1/assistants/${assistantId}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
})
- lang: Python
source: >-
import requests
assistant_id = 'abc123'
response = requests.get(f'http://localhost:1337/v1/assistants/{assistant_id}', headers={'Content-Type': 'application/json'})
"/threads/{thread_id}/messages":
get: get:
operationId: listMessages operationId: listMessages
tags: tags:
@ -850,7 +874,7 @@ paths:
description: | description: |
The ID of the thread from which to retrieve messages. The ID of the thread from which to retrieve messages.
responses: responses:
'200': "200":
description: List of messages retrieved successfully description: List of messages retrieved successfully
content: content:
application/json: application/json:
@ -902,7 +926,7 @@ paths:
- role - role
- content - content
responses: responses:
'200': "200":
description: Message created successfully description: Message created successfully
content: content:
application/json: application/json:
@ -917,7 +941,7 @@ paths:
"role": "user", "role": "user",
"content": "How does AI work? Explain it in simple terms." "content": "How does AI work? Explain it in simple terms."
}' }'
/threads/{thread_id}/messages/{message_id}: "/threads/{thread_id}/messages/{message_id}":
get: get:
operationId: retrieveMessage operationId: retrieveMessage
tags: tags:
@ -944,7 +968,7 @@ paths:
description: | description: |
The ID of the message to retrieve. The ID of the message to retrieve.
responses: responses:
'200': "200":
description: OK description: OK
content: content:
application/json: application/json:
@ -953,8 +977,8 @@ paths:
x-codeSamples: x-codeSamples:
- lang: cURL - lang: cURL
source: > source: >
curl curl http://localhost:1337/v1/threads/{thread_id}/messages/{message_id}
http://localhost:1337/v1/threads/{thread_id}/messages/{message_id} \ \
-H "Content-Type: application/json" -H "Content-Type: application/json"
x-webhooks: x-webhooks:
ModelObject: ModelObject:
@ -976,9 +1000,10 @@ x-webhooks:
post: post:
summary: The assistant object summary: The assistant object
description: > description: >
Build assistants that can call models and use tools to perform tasks. Build assistants that can call models and use tools to perform
<a href = "https://platform.openai.com/docs/api-reference/assistants"> tasks. <a href =
Equivalent to OpenAI's assistants object. </a> "https://platform.openai.com/docs/api-reference/assistants"> Equivalent
to OpenAI's assistants object. </a>
operationId: AssistantObjects operationId: AssistantObjects
tags: tags:
- Assistants - Assistants
@ -1005,8 +1030,7 @@ x-webhooks:
ThreadObject: ThreadObject:
post: post:
summary: The thread object summary: The thread object
description: >- description: Represents a thread that contains messages. <a href =
Represents a thread that contains messages. <a href =
"https://platform.openai.com/docs/api-reference/threads/object"> "https://platform.openai.com/docs/api-reference/threads/object">
Equivalent to OpenAI's thread object. </a> Equivalent to OpenAI's thread object. </a>
operationId: ThreadObject operationId: ThreadObject