From d7bf98b68aed9e1c07f54c9015339373e01e93ed Mon Sep 17 00:00:00 2001
From: avb-is-me <104213687+avb-is-me@users.noreply.github.com>
Date: Tue, 27 Feb 2024 00:43:57 +0000
Subject: [PATCH] adds code samples for list models
---
docs/openapi/jan.yaml | 119 ++++++++++++++++++++++++++----------------
1 file changed, 74 insertions(+), 45 deletions(-)
diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml
index 864c80fdf..e58c6a4f2 100644
--- a/docs/openapi/jan.yaml
+++ b/docs/openapi/jan.yaml
@@ -1,11 +1,11 @@
----
openapi: 3.0.0
info:
title: API Reference
description: >
# Introduction
- Jan API is compatible with the [OpenAI API](https://platform.openai.com/docs/api-reference).
+ Jan API is compatible with the [OpenAI
+ API](https://platform.openai.com/docs/api-reference).
version: 0.1.8
contact:
name: Jan Discord
@@ -20,12 +20,12 @@ tags:
description: List and describe the various models available in the API.
- name: Chat
description: >
- Given a list of messages comprising a conversation, the model will
- return a response.
+ Given a list of messages comprising a conversation, the model will return
+ a response.
- name: Messages
description: >
- Messages capture a conversation's content. This can include the
- content from LLM responses and other metadata from [chat
+ Messages capture a conversation's content. This can include the content
+ from LLM responses and other metadata from [chat
completions](/specs/chats).
- name: Threads
- name: Assistants
@@ -49,16 +49,16 @@ paths:
summary: |
Create chat completion
description: >
- Creates a model response for the given chat conversation.
- Equivalent to OpenAI's create chat completion.
+ Creates a model response for the given chat conversation. Equivalent
+ to OpenAI's create chat completion.
requestBody:
content:
application/json:
schema:
$ref: specs/chat.yaml#/components/schemas/ChatCompletionRequest
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -100,12 +100,12 @@ paths:
- Models
summary: List models
description: >
- Lists the currently available models, and provides basic
- information about each one such as the owner and availability.
- Equivalent to OpenAI's list model.
+ Lists the currently available models, and provides basic information
+ about each one such as the owner and availability. Equivalent
+ to OpenAI's list model.
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -113,11 +113,39 @@ paths:
$ref: specs/models.yaml#/components/schemas/ListModelsResponse
x-codeSamples:
- lang: cURL
- source: |
+ source: |-
curl -X 'GET' \
'http://localhost:1337/v1/models' \
-H 'accept: application/json'
- "/models/download/{model_id}":
+ - lang: JavaScript
+ source: |-
+ const response = await fetch('http://localhost:1337/v1/models', {
+ method: 'GET',
+ headers: {Accept: 'application/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
+ source: |-
+ const fetch = require('node-fetch');
+
+ const url = 'http://localhost:1337/v1/models';
+ const options = {
+ method: 'GET',
+ headers: { Accept: 'application/json' }
+ };
+
+ fetch(url, options)
+ .then(res => res.json())
+ .then(json => console.log(json));
+ /models/download/{model_id}:
get:
operationId: downloadModel
tags:
@@ -135,7 +163,7 @@ paths:
description: |
The ID of the model to use for this request.
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -147,15 +175,15 @@ paths:
curl -X 'GET' \
'http://localhost:1337/v1/models/download/{model_id}' \
-H 'accept: application/json'
- "/models/{model_id}":
+ /models/{model_id}:
get:
operationId: retrieveModel
tags:
- Models
summary: Retrieve model
description: >
- Get a model instance, providing basic information about the model
- such as the owner and permissioning.
Equivalent to OpenAI's retrieve model.
parameters:
@@ -168,7 +196,7 @@ paths:
description: |
The ID of the model to use for this request.
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -199,7 +227,7 @@ paths:
description: |
The model id to delete
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -228,7 +256,7 @@ paths:
schema:
$ref: specs/threads.yaml#/components/schemas/CreateThreadObject
responses:
- "200":
+ '200':
description: Thread created successfully
content:
application/json:
@@ -257,7 +285,7 @@ paths:
description: |
Retrieves a list of all threads available in the system.
responses:
- "200":
+ '200':
description: List of threads retrieved successfully
content:
application/json:
@@ -285,7 +313,7 @@ paths:
source: |
curl http://localhost:1337/v1/threads \
-H "Content-Type: application/json" \
- "/threads/{thread_id}":
+ /threads/{thread_id}:
get:
operationId: getThread
tags:
@@ -305,7 +333,7 @@ paths:
description: |
The ID of the thread to retrieve.
responses:
- "200":
+ '200':
description: Thread details retrieved successfully
content:
application/json:
@@ -345,7 +373,7 @@ paths:
items:
$ref: specs/threads.yaml#/components/schemas/ThreadMessageObject
responses:
- "200":
+ '200':
description: Thread modified successfully
content:
application/json:
@@ -384,7 +412,7 @@ paths:
description: |
The ID of the thread to be deleted.
responses:
- "200":
+ '200':
description: Thread deleted successfully
content:
application/json:
@@ -405,7 +433,7 @@ paths:
"https://platform.openai.com/docs/api-reference/assistants/listAssistants">
Equivalent to OpenAI's list assistants.
responses:
- "200":
+ '200':
description: List of assistants retrieved successfully
content:
application/json:
@@ -445,7 +473,7 @@ paths:
source: |
curl http://localhost:1337/v1/assistants \
-H "Content-Type: application/json" \
- "/assistants/{assistant_id}":
+ /assistants/{assistant_id}:
get:
operationId: getAssistant
tags:
@@ -465,18 +493,19 @@ paths:
description: |
The ID of the assistant to retrieve.
responses:
- "200":
+ '200':
description: null
content:
application/json:
schema:
- $ref: specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse
+ $ref: >-
+ specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse
x-codeSamples:
- lang: cURL
source: |
curl http://localhost:1337/v1/assistants/{assistant_id} \
-H "Content-Type: application/json" \
- "/threads/{thread_id}/messages":
+ /threads/{thread_id}/messages:
get:
operationId: listMessages
tags:
@@ -495,7 +524,7 @@ paths:
description: |
The ID of the thread from which to retrieve messages.
responses:
- "200":
+ '200':
description: List of messages retrieved successfully
content:
application/json:
@@ -547,7 +576,7 @@ paths:
- role
- content
responses:
- "200":
+ '200':
description: Message created successfully
content:
application/json:
@@ -562,7 +591,7 @@ paths:
"role": "user",
"content": "How does AI work? Explain it in simple terms."
}'
- "/threads/{thread_id}/messages/{message_id}":
+ /threads/{thread_id}/messages/{message_id}:
get:
operationId: retrieveMessage
tags:
@@ -589,7 +618,7 @@ paths:
description: |
The ID of the message to retrieve.
responses:
- "200":
+ '200':
description: OK
content:
application/json:
@@ -598,8 +627,8 @@ paths:
x-codeSamples:
- lang: cURL
source: >
- curl http://localhost:1337/v1/threads/{thread_id}/messages/{message_id}
- \
+ curl
+ http://localhost:1337/v1/threads/{thread_id}/messages/{message_id} \
-H "Content-Type: application/json"
x-webhooks:
ModelObject:
@@ -621,10 +650,9 @@ x-webhooks:
post:
summary: The assistant object
description: >
- Build assistants that can call models and use tools to perform
- tasks. Equivalent
- to OpenAI's assistants object.
+ Build assistants that can call models and use tools to perform tasks.
+
+ Equivalent to OpenAI's assistants object.
operationId: AssistantObjects
tags:
- Assistants
@@ -651,7 +679,8 @@ x-webhooks:
ThreadObject:
post:
summary: The thread object
- description: Represents a thread that contains messages. -
+ Represents a thread that contains messages.
Equivalent to OpenAI's thread object.
operationId: ThreadObject