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

docs: change OpenAI compatible color

Browse Source
This commit is contained in:
hieu-jan 2023-11-28 08:01:17 +09:00
parent 2877f3234b
commit 28288f972b
5 changed files with 63 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docs/openapi/jan.yaml
View File

@ -56,7 +56,7 @@ paths:
- Chat - Chat
summary: Create chat completion summary: Create chat completion
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/chat/create"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/chat/create"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
and <span style = "color: #fec928"> Jan specified </span> and <span style = "color: #fec928"> Jan specified </span>
Creates a model response for the given chat conversation. Creates a model response for the given chat conversation.
@ -96,7 +96,7 @@ paths:
summary: List models summary: List models
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/models/list"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/models/list"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Lists the currently available models, and provides basic information about each one such as the owner and availability. Lists the currently available models, and provides basic information about each one such as the owner and availability.
responses: responses:
@ -137,7 +137,7 @@ paths:
- Models - Models
summary: Retrieve model summary: Retrieve model
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/models/retrieve"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/models/retrieve"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Get a model instance, providing basic information about the model such as the owner and permissioning. Get a model instance, providing basic information about the model such as the owner and permissioning.
parameters: parameters:
@ -151,7 +151,7 @@ paths:
description: | description: |
The ID of the model to use for this request The ID of the model to use for this request
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: OK description: OK
@ -169,7 +169,7 @@ paths:
- Models - Models
summary: Delete model summary: Delete model
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/models/delete"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/models/delete"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Delete a model. Delete a model.
parameters: parameters:
@ -182,7 +182,7 @@ paths:
description: | description: |
The model to delete The model to delete
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: OK description: OK
@ -264,7 +264,7 @@ paths:
- Threads - Threads
summary: Create thread summary: Create thread
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/threads/createThread"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/threads/createThread"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Create a thread Create a thread
requestBody: requestBody:
@ -344,7 +344,7 @@ paths:
- Threads - Threads
summary: Retrieve thread summary: Retrieve thread
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/threads/getThread"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/threads/getThread"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Retrieves detailed information about a specific thread using its thread_id. Retrieves detailed information about a specific thread using its thread_id.
parameters: parameters:
@ -357,7 +357,7 @@ paths:
description: | description: |
The ID of the thread to retrieve. The ID of the thread to retrieve.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: Thread details retrieved successfully description: Thread details retrieved successfully
@ -375,7 +375,7 @@ paths:
- Threads - Threads
summary: Modify thread summary: Modify thread
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/threads/modifyThread"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/threads/modifyThread"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Modifies a thread Modifies a thread
parameters: parameters:
@ -388,7 +388,7 @@ paths:
description: | description: |
The ID of the thread to be modified. The ID of the thread to be modified.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
requestBody: requestBody:
required: false required: false
content: content:
@ -430,7 +430,7 @@ paths:
- Threads - Threads
summary: Delete thread summary: Delete thread
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/threads/deleteThread"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/threads/deleteThread"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Delete a thread Delete a thread
parameters: parameters:
@ -443,7 +443,7 @@ paths:
description: | description: |
The ID of the thread to be deleted. The ID of the thread to be deleted.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: Thread deleted successfully description: Thread deleted successfully
@ -506,7 +506,7 @@ paths:
summary: List Thread.Messages summary: List Thread.Messages
description: | description: |
<span style = "color: #fec928"> Jan </span> <span style = "color: #fec928"> Jan </span>
Can achieve this goal by calling Get Thread API Can achieve this goal by calling Get Thread API
parameters: parameters:
- in: path - in: path
@ -536,7 +536,7 @@ paths:
- Messages - Messages
summary: List messages summary: List messages
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/listMessages"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/listMessages"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Retrieves all messages from the given thread. Retrieves all messages from the given thread.
parameters: parameters:
@ -549,7 +549,7 @@ paths:
description: | description: |
The ID of the thread from which to retrieve messages. The ID of the thread from which to retrieve messages.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: List of messages retrieved successfully description: List of messages retrieved successfully
@ -568,7 +568,7 @@ paths:
- Messages - Messages
summary: Create message summary: Create message
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/createMessage"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/createMessage"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Create a message Create a message
parameters: parameters:
@ -581,7 +581,7 @@ paths:
description: | description: |
The ID of the thread to which the message will be posted. The ID of the thread to which the message will be posted.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
requestBody: requestBody:
required: true required: true
content: content:
@ -594,7 +594,7 @@ paths:
description: | description: |
"Role of the sender, either 'user' or 'assistant'." "Role of the sender, either 'user' or 'assistant'."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "user" example: "user"
enum: ["user", "assistant"] enum: ["user", "assistant"]
content: content:
@ -602,7 +602,7 @@ paths:
description: | description: |
"Text content of the message." "Text content of the message."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "How does AI work? Explain it in simple terms." example: "How does AI work? Explain it in simple terms."
required: required:
- role - role
@ -631,7 +631,7 @@ paths:
- Messages - Messages
summary: Retrieve message summary: Retrieve message
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/getMessage"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/getMessage"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Retrieve a specific message from a thread using its thread_id and message_id. Retrieve a specific message from a thread using its thread_id and message_id.
parameters: parameters:
@ -644,7 +644,7 @@ paths:
description: | description: |
The ID of the thread containing the message. The ID of the thread containing the message.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
- in: path - in: path
name: message_id name: message_id
required: true required: true
@ -654,7 +654,7 @@ paths:
description: | description: |
The ID of the message to retrieve. The ID of the message to retrieve.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: OK description: OK
@ -675,7 +675,7 @@ paths:
- Messages - Messages
summary: List message files summary: List message files
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/listMessageFiles"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/listMessageFiles"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Returns a list of message files. Returns a list of message files.
parameters: parameters:
@ -688,7 +688,7 @@ paths:
description: | description: |
The ID of the thread containing the message. The ID of the thread containing the message.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
- in: path - in: path
name: message_id name: message_id
required: true required: true
@ -698,7 +698,7 @@ paths:
description: | description: |
The ID of the message whose files are to be listed. The ID of the message whose files are to be listed.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: List of files retrieved successfully description: List of files retrieved successfully
@ -719,7 +719,7 @@ paths:
- Messages - Messages
summary: Retrieve message file summary: Retrieve message file
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/getMessageFile"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/getMessageFile"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Retrieves a file associated with a specific message in a thread. Retrieves a file associated with a specific message in a thread.
parameters: parameters:
@ -732,7 +732,7 @@ paths:
description: | description: |
The ID of the thread containing the message. The ID of the thread containing the message.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
- in: path - in: path
name: message_id name: message_id
required: true required: true
@ -742,7 +742,7 @@ paths:
description: | description: |
The ID of the message associated with the file. The ID of the message associated with the file.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
- in: path - in: path
name: file_id name: file_id
required: true required: true
@ -752,7 +752,7 @@ paths:
description: | description: |
The ID of the file to retrieve. The ID of the file to retrieve.
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
responses: responses:
"200": "200":
description: File retrieved successfully description: File retrieved successfully
@ -771,7 +771,7 @@ x-webhooks:
post: post:
summary: The model object summary: The model object
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/models/object"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/models/object"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Describe a model offering that can be used with the API. Describe a model offering that can be used with the API.
@ -789,7 +789,7 @@ x-webhooks:
post: post:
summary: The message object summary: The message object
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/messages/object"> <button style = "color: #388434"> OpenAI compatible </button></a> <a href = "https://platform.openai.com/docs/api-reference/messages/object"> <button style = "color: #0ca47c"> OpenAI compatible </button></a>
Information about a message in the thread Information about a message in the thread
operationId: MessageObject operationId: MessageObject
@ -805,7 +805,7 @@ x-webhooks:
post: post:
summary: The thread object summary: The thread object
description: | description: |
<a href = "https://platform.openai.com/docs/api-reference/threads/object"> <button style = "color: #388434"> OpenAI compatible </button></a> and <span style = "color: #fec928"> Jan </span> <a href = "https://platform.openai.com/docs/api-reference/threads/object"> <button style = "color: #0ca47c"> OpenAI compatible </button></a> and <span style = "color: #fec928"> Jan </span>
Each `thread` folder contains a `thread.json` file, which is a representation of a thread. Each `thread` folder contains a `thread.json` file, which is a representation of a thread.

18
docs/openapi/specs/chat.yaml
View File

@ -60,7 +60,7 @@ components:
description: | description: |
Contains input data or prompts for the model to process Contains input data or prompts for the model to process
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: example:
[ [
{ "content": "Hello there :wave:", "role": "assistant" }, { "content": "Hello there :wave:", "role": "assistant" },
@ -72,42 +72,42 @@ components:
description: | description: |
Specifies the model being used for inference or processing tasks Specifies the model being used for inference or processing tasks
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
stream: stream:
type: boolean type: boolean
default: true default: true
description: | description: |
Enables continuous output generation, allowing for streaming of model responses Enables continuous output generation, allowing for streaming of model responses
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
max_tokens: max_tokens:
type: number type: number
default: 2048 default: 2048
description: | description: |
The maximum number of tokens the model will generate in a single response The maximum number of tokens the model will generate in a single response
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
stop: stop:
type: arrays type: arrays
example: ["hello"] example: ["hello"]
description: | description: |
Defines specific tokens or phrases at which the model will stop generating further output Defines specific tokens or phrases at which the model will stop generating further output
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
frequency_penalty: frequency_penalty:
type: number type: number
default: 0 default: 0
description: | description: |
Adjusts the likelihood of the model repeating words or phrases in its output Adjusts the likelihood of the model repeating words or phrases in its output
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
presence_penalty: presence_penalty:
type: number type: number
default: 0 default: 0
description: | description: |
Influences the generation of new and varied concepts in the model's output Influences the generation of new and varied concepts in the model's output
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
temperature: temperature:
type: number type: number
default: 0.7 default: 0.7
@ -116,7 +116,7 @@ components:
description: | description: |
Controls the randomness of the model's output Controls the randomness of the model's output
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
top_p: top_p:
type: number type: number
default: 0.95 default: 0.95
@ -125,7 +125,7 @@ components:
description: | description: |
Set probability threshold for more relevant outputs Set probability threshold for more relevant outputs
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
ChatCompletionResponse: ChatCompletionResponse:
type: object type: object

20
docs/openapi/specs/messages.yaml
View File

@ -8,14 +8,14 @@ components:
description: | description: |
"Sequential or UUID identifier of the message." "Sequential or UUID identifier of the message."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: 0 example: 0
object: object:
type: string type: string
description: | description: |
"Type of the object, defaults to 'thread.message'." "Type of the object, defaults to 'thread.message'."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: thread.message example: thread.message
created_at: created_at:
type: integer type: integer
@ -23,20 +23,20 @@ components:
description: | description: |
"Unix timestamp representing the creation time of the message." "Unix timestamp representing the creation time of the message."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
thread_id: thread_id:
type: string type: string
description: | description: |
"Identifier of the thread to which this message belongs. Defaults to parent thread." "Identifier of the thread to which this message belongs. Defaults to parent thread."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "thread_asdf" example: "thread_asdf"
assistant_id: assistant_id:
type: string type: string
description: | description: |
"Identifier of the assistant involved in the message. Defaults to parent thread." "Identifier of the assistant involved in the message. Defaults to parent thread."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: jan example: jan
role: role:
type: string type: string
@ -44,7 +44,7 @@ components:
description: | description: |
"Role of the sender, either 'user' or 'assistant'." "Role of the sender, either 'user' or 'assistant'."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
content: content:
type: array type: array
items: items:
@ -55,7 +55,7 @@ components:
description: | description: |
"Type of content, e.g., 'text'." "Type of content, e.g., 'text'."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
text: text:
type: object type: object
properties: properties:
@ -64,7 +64,7 @@ components:
description: | description: |
"Text content of the message." "Text content of the message."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "Hi!?" example: "Hi!?"
annotations: annotations:
type: array type: array
@ -73,14 +73,14 @@ components:
description: | description: |
"Annotations for the text content, if any." "Annotations for the text content, if any."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: [] example: []
metadata: metadata:
type: object type: object
description: | description: |
"Metadata associated with the message, defaults to an empty object." "Metadata associated with the message, defaults to an empty object."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: {} example: {}
GetMessageResponse: GetMessageResponse:

8
docs/openapi/specs/models.yaml
View File

@ -120,14 +120,14 @@ components:
description: | description: |
"The identifier of the model." "The identifier of the model."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "zephyr-7b" example: "zephyr-7b"
object: object:
type: string type: string
description: | description: |
"The type of the object, indicating it's a model." "The type of the object, indicating it's a model."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
default: "model" default: "model"
created: created:
type: integer type: integer
@ -135,14 +135,14 @@ components:
description: | description: |
"Unix timestamp representing the creation time of the model." "Unix timestamp representing the creation time of the model."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "1253935178" example: "1253935178"
owned_by: owned_by:
type: string type: string
description: | description: |
"The entity that owns the model." "The entity that owns the model."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: "_" example: "_"
GetModelResponse: GetModelResponse:

14
docs/openapi/specs/threads.yaml
View File

@ -8,14 +8,14 @@ components:
description: | description: |
"The identifier of the thread, defaults to foldername." "The identifier of the thread, defaults to foldername."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: thread_.... example: thread_....
object: object:
type: string type: string
description: | description: |
"Type of the object, defaults to thread." "Type of the object, defaults to thread."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: thread example: thread
title: title:
type: string type: string
@ -63,14 +63,14 @@ components:
description: | description: |
"Unix timestamp representing the creation time of the thread, defaults to file creation time." "Unix timestamp representing the creation time of the thread, defaults to file creation time."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: 1231231 example: 1231231
metadata: metadata:
type: object type: object
description: | description: |
"Metadata associated with the thread, defaults to an empty object." "Metadata associated with the thread, defaults to an empty object."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
example: {} example: {}
GetThreadResponse: GetThreadResponse:
@ -135,14 +135,14 @@ components:
description: | description: |
"Role of the sender, either 'user' or 'assistant'." "Role of the sender, either 'user' or 'assistant'."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
enum: ["user", "assistant"] enum: ["user", "assistant"]
content: content:
type: string type: string
description: | description: |
"Text content of the message." "Text content of the message."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
file_ids: file_ids:
type: array type: array
items: items:
@ -150,7 +150,7 @@ components:
description: | description: |
"Array of file IDs associated with the message, if any." "Array of file IDs associated with the message, if any."
<span style="color:#388434">OpenAI compatible</span> <span style="color:#0ca47c">OpenAI compatible</span>
ModifyThreadResponse: ModifyThreadResponse:
type: object type: object