docs: add response structure
This commit is contained in:
parent
a5446b038d
commit
198cf2e2fc
@ -485,6 +485,13 @@ paths:
|
|||||||
summary: List assistants
|
summary: List assistants
|
||||||
description: |
|
description: |
|
||||||
Return a list of assistants. <a href = "https://platform.openai.com/docs/api-reference/assistants/listAssistants"> Equivalent to OpenAI's list assistants. </a>
|
Return a list of assistants. <a href = "https://platform.openai.com/docs/api-reference/assistants/listAssistants"> Equivalent to OpenAI's list assistants. </a>
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/assistants.yaml#/components/schemas/ListAssistantsResponse"
|
||||||
post:
|
post:
|
||||||
operationId: createAssistant
|
operationId: createAssistant
|
||||||
tags:
|
tags:
|
||||||
@ -492,6 +499,13 @@ paths:
|
|||||||
summary: Create assistant
|
summary: Create assistant
|
||||||
description: |
|
description: |
|
||||||
Create an assistant with a model and instructions. <a href = "https://platform.openai.com/docs/api-reference/assistants/createAssistant"> Equivalent to OpenAI's create assistants. </a>
|
Create an assistant with a model and instructions. <a href = "https://platform.openai.com/docs/api-reference/assistants/createAssistant"> Equivalent to OpenAI's create assistants. </a>
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/assistants.yaml#/components/schemas/CreateAssistantResponse"
|
||||||
|
|
||||||
/assistants/{assistant_id}:
|
/assistants/{assistant_id}:
|
||||||
get:
|
get:
|
||||||
@ -501,6 +515,14 @@ paths:
|
|||||||
summary: Retrieve assistant
|
summary: Retrieve assistant
|
||||||
description: |
|
description: |
|
||||||
Retrieves an assistant. <a href = "https://platform.openai.com/docs/api-reference/assistants/getAssistant"> Equivalent to OpenAI's retrieve assistants. </a>
|
Retrieves an assistant. <a href = "https://platform.openai.com/docs/api-reference/assistants/getAssistant"> Equivalent to OpenAI's retrieve assistants. </a>
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse"
|
||||||
|
|
||||||
post:
|
post:
|
||||||
operationId: modifyAssistant
|
operationId: modifyAssistant
|
||||||
tags:
|
tags:
|
||||||
@ -515,6 +537,13 @@ paths:
|
|||||||
summary: Delete assistant
|
summary: Delete assistant
|
||||||
description: |
|
description: |
|
||||||
Delete an assistant. <a href = "https://platform.openai.com/docs/api-reference/assistants/deleteAssistant"> Equivalent to OpenAI's delete assistant. </a>
|
Delete an assistant. <a href = "https://platform.openai.com/docs/api-reference/assistants/deleteAssistant"> Equivalent to OpenAI's delete assistant. </a>
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "specs/assistants.yaml#/components/schemas/ModifyAssistantResponse"
|
||||||
|
|
||||||
### MESSAGES
|
### MESSAGES
|
||||||
/threads/{thread_id}/messages:
|
/threads/{thread_id}/messages:
|
||||||
|
|||||||
@ -59,3 +59,83 @@ components:
|
|||||||
- name
|
- name
|
||||||
- models
|
- models
|
||||||
- events
|
- events
|
||||||
|
|
||||||
|
ListAssistantsResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: "The identifier of the model that was deleted."
|
||||||
|
example: "model-zephyr-7B"
|
||||||
|
object:
|
||||||
|
type: string
|
||||||
|
description: "Type of the object, indicating it's a model."
|
||||||
|
default: "model"
|
||||||
|
deleted:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether the model was successfully deleted."
|
||||||
|
example: true
|
||||||
|
|
||||||
|
CreateAssistantResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: "The identifier of the model that was deleted."
|
||||||
|
example: "model-zephyr-7B"
|
||||||
|
object:
|
||||||
|
type: string
|
||||||
|
description: "Type of the object, indicating it's a model."
|
||||||
|
default: "model"
|
||||||
|
deleted:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether the model was successfully deleted."
|
||||||
|
example: true
|
||||||
|
|
||||||
|
RetrieveAssistantResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: "The identifier of the model that was deleted."
|
||||||
|
example: "model-zephyr-7B"
|
||||||
|
object:
|
||||||
|
type: string
|
||||||
|
description: "Type of the object, indicating it's a model."
|
||||||
|
default: "model"
|
||||||
|
deleted:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether the model was successfully deleted."
|
||||||
|
example: true
|
||||||
|
|
||||||
|
ModifyAssistantResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: "The identifier of the model that was deleted."
|
||||||
|
example: "model-zephyr-7B"
|
||||||
|
object:
|
||||||
|
type: string
|
||||||
|
description: "Type of the object, indicating it's a model."
|
||||||
|
default: "model"
|
||||||
|
deleted:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether the model was successfully deleted."
|
||||||
|
example: true
|
||||||
|
|
||||||
|
DeleteAssistantResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: "The identifier of the model that was deleted."
|
||||||
|
example: "model-zephyr-7B"
|
||||||
|
object:
|
||||||
|
type: string
|
||||||
|
description: "Type of the object, indicating it's a model."
|
||||||
|
default: "model"
|
||||||
|
deleted:
|
||||||
|
type: boolean
|
||||||
|
description: "Indicates whether the model was successfully deleted."
|
||||||
|
example: true
|
||||||
Loading…
x
Reference in New Issue
Block a user