Skip to content

Commit

Permalink
docs: add assistants endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Dec 1, 2023
1 parent 60d4ee8 commit 69bdfcc
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 59 deletions.
13 changes: 13 additions & 0 deletions docs/openapi/jan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,19 @@ x-webhooks:
application/json:
schema:
$ref: 'specs/models.yaml#/components/schemas/ModelObject'
AssistantObject:
post:
summary: The assistant object
description: |
Build assistants that can call models and use tools to perform tasks. <a href = "https://platform.openai.com/docs/api-reference/assistants"> Equivalent to OpenAI's assistants object. </a>
operationId: AssistantObject
tags:
- Assistants
requestBody:
content:
application/json:
schema:
$ref: 'specs/assistants.yaml#/components/schemas/AssistantObject'
MessageObject:
post:
summary: The message object
Expand Down
59 changes: 0 additions & 59 deletions docs/openapi/specs/assistant.yaml

This file was deleted.

61 changes: 61 additions & 0 deletions docs/openapi/specs/assistants.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
components:
schemas:
AssistantObject:
type: object
properties:
avatar:
type: string
description: "URL of the assistant's avatar. Jan-specific property."
example: "https://lala.png"
id:
type: string
description: "The identifier of the assistant."
example: "asst_abc123"
object:
type: string
description: "Type of the object, indicating it's an assistant."
default: "assistant"
version:
type: integer
description: "Version number of the assistant."
example: 1
created_at:
type: integer
format: int64
description: "Unix timestamp representing the creation time of the assistant."
name:
type: string
description: "Name of the assistant."
example: "Math Tutor"
description:
type: string
description: "Description of the assistant. Can be null."
models:
type: array
description: "List of models associated with the assistant. Jan-specific property."
items:
type: object
properties:
model_id:
type: string
# Additional properties for models can be added here
events:
type: object
description: "Event subscription settings for the assistant."
properties:
in:
type: array
items:
type: string
out:
type: array
items:
type: string
# If there are specific event types, they can be detailed here
metadata:
type: object
description: "Metadata associated with the assistant."
required:
- name
- models
- events

0 comments on commit 69bdfcc

Please sign in to comment.