Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@spikelu2016
spikelu2016 committed Jun 17, 2024
1 parent 40d2404 commit 2823bdb
Show file tree
Hide file tree
Showing 2 changed files with 166 additions and 10 deletions.
1 change: 1 addition & 0 deletions docs/admin.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,7 @@ paths:
description: Event HTTP status code.
responses:
200:
description: Successful retrieval of a v2 event response.
content:
application/json:
schema:
Expand Down
175 changes: 165 additions & 10 deletions docs/proxy.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,6 @@ paths:
required: true
schema:
type: string
description: File identifier

get:
parameters:
Expand All @@ -158,6 +157,12 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: file_id
required: true
schema:
type: string

tags:
- OpenAI
summary: Retrieve a file
Expand All @@ -171,6 +176,11 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: file_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Retrieve file content
Expand Down Expand Up @@ -218,7 +228,6 @@ paths:
required: true
schema:
type: string
description: Batch identifier

post:
parameters:
Expand Down Expand Up @@ -352,10 +361,14 @@ paths:
required: true
schema:
type: string
description: Assistant identifier

post:
parameters:
- in: path
name: assistant_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -368,6 +381,11 @@ paths:

delete:
parameters:
- in: path
name: assistant_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -381,6 +399,11 @@ paths:
/api/providers/openai/v1/assistants/{assistant_id}/files:
post:
parameters:
- in: path
name: assistant_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -393,6 +416,11 @@ paths:

get:
parameters:
- in: path
name: assistant_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -411,13 +439,33 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: assistant_id
required: true
schema:
type: string
- in: path
name: file_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Retrieve assistant file
description: This endpoint is set up for retrieving an OpenAI assistant file. Documentation for this endpoint can be found [here](https://platform.openai.com/docs/api-reference/assistants/getAssistantFile).

delete:
parameters:
- in: path
name: assistant_id
required: true
schema:
type: string
- in: path
name: file_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand Down Expand Up @@ -458,7 +506,6 @@ paths:
required: true
schema:
type: string
description: Thread identifier

post:
parameters:
Expand All @@ -467,6 +514,11 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Modify thread
Expand All @@ -492,6 +544,11 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Create message
Expand All @@ -503,7 +560,13 @@ paths:
name: x-custom-event-id
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.s
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string

tags:
- OpenAI
summary: List messages
Expand All @@ -526,15 +589,28 @@ paths:
required: true
schema:
type: string
description: Message identifier

- in: path
name: thread_id
required: true
schema:
type: string
post:
parameters:
- in: header
name: x-custom-event-id
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: message_id
required: true
schema:
type: string
- in: path
name: thread_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Modify message
Expand All @@ -557,11 +633,30 @@ paths:
required: true
schema:
type: string
description: File identifier
- in: path
name: message_id
required: true
schema:
type: string
- in: path
name: thread_id
required: true
schema:
type: string

/api/providers/openai/v1/threads/{thread_id}/messages/{message_id}/files:
get:
parameters:
- in: path
name: thread_id
required: true
schema:
type: string
- in: path
name: message_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -580,6 +675,11 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Create run
Expand All @@ -591,6 +691,11 @@ paths:
name: x-custom-event-id
schema:
type: string
- in: path
name: thread_id
required: true
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
tags:
- OpenAI
Expand All @@ -615,9 +720,24 @@ paths:
schema:
type: string
description: Run identifier
- in: path
name: thread_id
required: true
schema:
type: string

post:
parameters:
- in: path
name: thread_id
required: true
schema:
type: string
- in: path
name: run_id
required: true
schema:
type: string
- in: header
name: x-custom-event-id
schema:
Expand All @@ -636,6 +756,16 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string
- in: path
name: run_id
required: true
schema:
type: string
tags:
- OpenAI
summary: Cancel a run
Expand Down Expand Up @@ -672,6 +802,16 @@ paths:
schema:
type: string
description: Step identifier
- in: path
name: thread_id
required: true
schema:
type: string
- in: path
name: run_id
required: true
schema:
type: string

/api/providers/openai/v1/threads/{thread_id}/runs/{run_id}/steps:
get:
Expand All @@ -681,6 +821,16 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: thread_id
required: true
schema:
type: string
- in: path
name: run_id
required: true
schema:
type: string
tags:
- OpenAI
summary: List run steps
Expand Down Expand Up @@ -835,11 +985,16 @@ paths:
schema:
type: string
description: Custom Id that can be used to retrieve an event associated with each proxy request.
- in: path
name: provider
required: true
schema:
type: string
tags:
- Custom Providers
summary: Call custom providers
description: First you need to use create custom providers endpoint to create custom providers. Then create corresponding provider setting for the newly created custom provider. |
Afterward, you can start creating keys associated with the custom provider, and use the keys to access this endpoint by placing the created key in `Authorization: Bearer YOUR_BRICKSLLM_KEY` as part of your HTTP request headers.
description: >
First you need to use create custom providers endpoint to create custom providers. Then create corresponding provider setting for the newly created custom provider. Afterward, you can start creating keys associated with the custom provider, and use the keys to access this endpoint by placing the created key in `Authorization: Bearer YOUR_BRICKSLLM_KEY` as part of your HTTP request headers.

/api/route/*:
post:
Expand Down

0 comments on commit 2823bdb

Please sign in to comment.