SystemSh0cker/private-gpt
1
0
Fork 0
mirror of https://github.com/zylon-ai/private-gpt.git synced 2025-12-22 17:05:41 +01:00
Code Issues Projects Releases Packages Activity

docs: update openapi reference

Browse source
This commit is contained in:
Javier Martinez 2024-07-30 16:29:50 +02:00
parent 98408b59bb
commit 292d6e895a
No known key found for this signature in database
1 changed files with 158 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

158
fern/openapi/openapi.json
View file

@ -339,6 +339,48 @@
} }
} }
}, },
"/v1/summarize": {
"post": {
"tags": [
"Recipes"
],
"summary": "Summarize",
"description": "Given a text, the model will return a summary.\n\nOptionally include `instructions` to influence the way the summary is generated.\n\nIf `use_context`\nis set to `true`, the model will also use the content coming from the ingested\ndocuments in the summary. The documents being used can\nbe filtered by their metadata using the `context_filter`.\nIngested documents metadata can be found using `/ingest/list` endpoint.\nIf you want all ingested documents to be used, remove `context_filter` altogether.\n\nIf `prompt` is set, it will be used as the prompt for the summarization,\notherwise the default prompt will be used.\n\nWhen using `'stream': true`, the API will return data chunks following [OpenAI's\nstreaming model](https://platform.openai.com/docs/api-reference/chat/streaming):\n```\n{\"id\":\"12345\",\"object\":\"completion.chunk\",\"created\":1694268190,\n\"model\":\"private-gpt\",\"choices\":[{\"index\":0,\"delta\":{\"content\":\"Hello\"},\n\"finish_reason\":null}]}\n```",
"operationId": "summarize_v1_summarize_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummarizeBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummarizeResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/embeddings": { "/v1/embeddings": {
"post": { "post": {
"tags": [ "tags": [
@ -500,6 +542,10 @@
"Chunk": { "Chunk": {
"properties": { "properties": {
"object": { "object": {
"type": "string",
"enum": [
"context.chunk"
],
"const": "context.chunk", "const": "context.chunk",
"title": "Object" "title": "Object"
}, },
@ -612,10 +658,18 @@
"ChunksResponse": { "ChunksResponse": {
"properties": { "properties": {
"object": { "object": {
"type": "string",
"enum": [
"list"
],
"const": "list", "const": "list",
"title": "Object" "title": "Object"
}, },
"model": { "model": {
"type": "string",
"enum": [
"private-gpt"
],
"const": "private-gpt", "const": "private-gpt",
"title": "Model" "title": "Model"
}, },
@ -728,6 +782,10 @@
"title": "Index" "title": "Index"
}, },
"object": { "object": {
"type": "string",
"enum": [
"embedding"
],
"const": "embedding", "const": "embedding",
"title": "Object" "title": "Object"
}, },
@ -779,10 +837,18 @@
"EmbeddingsResponse": { "EmbeddingsResponse": {
"properties": { "properties": {
"object": { "object": {
"type": "string",
"enum": [
"list"
],
"const": "list", "const": "list",
"title": "Object" "title": "Object"
}, },
"model": { "model": {
"type": "string",
"enum": [
"private-gpt"
],
"const": "private-gpt", "const": "private-gpt",
"title": "Model" "title": "Model"
}, },
@ -818,6 +884,10 @@
"HealthResponse": { "HealthResponse": {
"properties": { "properties": {
"status": { "status": {
"type": "string",
"enum": [
"ok"
],
"const": "ok", "const": "ok",
"title": "Status", "title": "Status",
"default": "ok" "default": "ok"
@ -829,10 +899,18 @@
"IngestResponse": { "IngestResponse": {
"properties": { "properties": {
"object": { "object": {
"type": "string",
"enum": [
"list"
],
"const": "list", "const": "list",
"title": "Object" "title": "Object"
}, },
"model": { "model": {
"type": "string",
"enum": [
"private-gpt"
],
"const": "private-gpt", "const": "private-gpt",
"title": "Model" "title": "Model"
}, },
@ -879,6 +957,10 @@
"IngestedDoc": { "IngestedDoc": {
"properties": { "properties": {
"object": { "object": {
"type": "string",
"enum": [
"ingest.document"
],
"const": "ingest.document", "const": "ingest.document",
"title": "Object" "title": "Object"
}, },
@ -1001,6 +1083,10 @@
] ]
}, },
"model": { "model": {
"type": "string",
"enum": [
"private-gpt"
],
"const": "private-gpt", "const": "private-gpt",
"title": "Model" "title": "Model"
}, },
@ -1074,6 +1160,78 @@
"title": "OpenAIMessage", "title": "OpenAIMessage",
"description": "Inference result, with the source of the message.\n\nRole could be the assistant or system\n(providing a default response, not AI generated)." "description": "Inference result, with the source of the message.\n\nRole could be the assistant or system\n(providing a default response, not AI generated)."
}, },
"SummarizeBody": {
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
},
"use_context": {
"type": "boolean",
"title": "Use Context",
"default": false
},
"context_filter": {
"anyOf": [
{
"$ref": "#/components/schemas/ContextFilter"
},
{
"type": "null"
}
]
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions"
},
"stream": {
"type": "boolean",
"title": "Stream",
"default": false
}
},
"type": "object",
"title": "SummarizeBody"
},
"SummarizeResponse": {
"properties": {
"summary": {
"type": "string",
"title": "Summary"
}
},
"type": "object",
"required": [
"summary"
],
"title": "SummarizeResponse"
},
"ValidationError": { "ValidationError": {
"properties": { "properties": {
"loc": { "loc": {