-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathGPT.yml
More file actions
225 lines (222 loc) · 6.63 KB
/
GPT.yml
File metadata and controls
225 lines (222 loc) · 6.63 KB
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
---
openapi: 3.0.3
info:
description: PlaceOS REST-API description
title: rest-api
version: v2
# The server URL is required to be customised per PlaceOS client
servers:
- url: https://placeos-dev.aca.im
# The System ID's for each path should be changed to applicable one for the client
paths:
/api/engine/v2/chatgpt/plugin/sys-ELNF3KjDuK/capabilities:
get:
summary: obtain the list of capabilities that this API can provide and the users
name, email, phone and wipe card details. Should always be called at least once
so you can understand the options available to you.
tags:
- Plugin
operationId: capabilities
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
prompt:
type: string
capabilities:
type: array
items:
type: object
properties:
id:
type: string
capability:
type: string
required:
- id
- capability
system_id:
type: string
user_information:
type: object
properties:
id:
type: string
name:
type: string
email:
type: string
phone:
type: string
nullable: true
swipe_card_number:
type: string
nullable: true
required:
- id
- name
- email
nullable: true
current_time:
type: string
format: date-time
nullable: true
day_of_week:
type: string
nullable: true
required:
- prompt
- capabilities
- system_id
401:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
nullable: true
backtrace:
type: array
items:
type: string
nullable: true
403:
description: Forbidden
404:
description: Not Found
/api/engine/v2/chatgpt/plugin/sys-ELNF3KjDuK/function_schema/{capability_id}:
get:
summary: if a request could benefit from a capability, obtain the list of function
schemas by providing the id string
tags:
- Plugin
operationId: function_schema
parameters:
- name: capability_id
in: path
description: The ID of the capability, exactly as provided in the capability
list
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
function:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
required:
- function
- description
- parameters
401:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
nullable: true
backtrace:
type: array
items:
type: string
nullable: true
403:
description: Forbidden
404:
description: Not Found
/api/engine/v2/chatgpt/plugin/sys-ELNF3KjDuK/call_function/{capability_id}/{function_name}:
post:
summary: Executes functionality offered by a capability, you'll need to obtain
the function schema to perform requests. Then to use this operation you'll
need to provide the capability id and the function name params
tags:
- Plugin
operationId: call_function
# Don't prompt before calling these functions as the actions are not dangerous
# may also prompt the user to optionally always allow
x-openai-isConsequential: false
requestBody:
content:
application/json:
schema:
type: object
properties:
function_params:
type: string
required:
- function_params
required: true
parameters:
- name: capability_id
in: path
description: The ID of the capability, exactly as provided in the capability
list
required: true
schema:
type: string
- name: function_name
in: path
description: The name of the function to call
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: string
required:
- response
400:
description: Bad Request
content:
application/json:
schema:
type: string
401:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
nullable: true
backtrace:
type: array
items:
type: string
nullable: true
403:
description: Forbidden
404:
description: Not Found