diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml index 8f5ee08b2..ccf54f2ce 100644 --- a/docs/openapi/jan.yaml +++ b/docs/openapi/jan.yaml @@ -485,6 +485,13 @@ paths: summary: List assistants description: | Return a list of assistants. Equivalent to OpenAI's list assistants. + responses: + "200": + description: + content: + application/json: + schema: + $ref: "specs/assistants.yaml#/components/schemas/ListAssistantsResponse" post: operationId: createAssistant tags: @@ -492,6 +499,13 @@ paths: summary: Create assistant description: | Create an assistant with a model and instructions. Equivalent to OpenAI's create assistants. + responses: + "200": + description: + content: + application/json: + schema: + $ref: "specs/assistants.yaml#/components/schemas/CreateAssistantResponse" /assistants/{assistant_id}: get: @@ -501,6 +515,14 @@ paths: summary: Retrieve assistant description: | Retrieves an assistant. Equivalent to OpenAI's retrieve assistants. + responses: + "200": + description: + content: + application/json: + schema: + $ref: "specs/assistants.yaml#/components/schemas/RetrieveAssistantResponse" + post: operationId: modifyAssistant tags: @@ -515,7 +537,14 @@ paths: summary: Delete assistant description: | Delete an assistant. Equivalent to OpenAI's delete assistant. - + responses: + "200": + description: + content: + application/json: + schema: + $ref: "specs/assistants.yaml#/components/schemas/ModifyAssistantResponse" + ### MESSAGES /threads/{thread_id}/messages: get: diff --git a/docs/openapi/specs/assistants.yaml b/docs/openapi/specs/assistants.yaml index bb9c96455..9db27e308 100644 --- a/docs/openapi/specs/assistants.yaml +++ b/docs/openapi/specs/assistants.yaml @@ -58,4 +58,84 @@ components: required: - name - models - - events \ No newline at end of file + - 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 \ No newline at end of file