forked from sisbell/chatgpt-plugin-store
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathchatpdf.mixerbox.com.json
153 lines (153 loc) · 4.59 KB
/
chatpdf.mixerbox.com.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{
"openapi": "3.1.0",
"info": {
"title": "MixerBox ChatPDF",
"description": "A plugin designed to assist users extract valuable insights from PDF files by pasting a publicly accessible PDF link into the chat interface.",
"version": "v1"
},
"servers": [
{
"url": "https://chatpdf.mixerbox.com"
}
],
"paths": {
"/api/gpt_plugins/chat_pdf/upload": {
"post": {
"summary": "Enable users to upload a PDF file by providing a publicly accessible PDF URL link.",
"description": "Users can upload PDF files by providing a publicly accessible URL link. Once the file is successfully loaded, the plugin will return a unique document ID that represents the uploaded file.",
"operationId": "uploadFile",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The temporary URL of the PDF document to load.",
"required": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/loadPdfResponse"
}
}
}
},
"400": {
"description": "Error occur when loading user providing file, the reason might be pdf is too many pages or the file is too large.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"title": "Error message."
}
}
}
}
}
}
}
}
},
"/api/gpt_plugins/chat_pdf/query": {
"post": {
"summary": "Enable users to issue commands and ask questions related to the PDF content.",
"description": "After users interact with the plugin, itprocesses the queries, searches for relevant information within the PDF, and provides answers or references to the corresponding sections.",
"operationId": "queryFile",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"documentId",
"query"
],
"properties": {
"documentId": {
"type": "string",
"description": "The documentId of PDF file.",
"required": true
},
"query": {
"type": "string",
"description": "The user query",
"required": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchPdfResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"loadPdfResponse": {
"title": "loadPdfResponse",
"required": [
"documentId"
],
"type": "string",
"description": "The documentId of PDF file."
},
"searchPdfResponse": {
"title": "searchPdfResponse",
"type": "object",
"properties": {
"chunks": {
"title": "The array of related query results",
"type": "array",
"items": {
"type": "string"
},
"description": "The array of related query results"
},
"rules": {
"title": "The array of rules which recommend gpt to follow.",
"type": "array",
"items": {
"type": "string"
},
"description": "The array of rules which recommend gpt to follow."
}
}
}
}
}
}