Skip to content

Commit cf42064

Browse files
committed
update notes
1 parent 7097330 commit cf42064

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

docs/Integration-OpenAI-Plugin.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ The goal is to turn ChatGPT into a more useful, interactive assistant that can b
66

77
>For example, in large companies, it can be remarkably hard to find corporate systems via an Intranet, and use different user interfaces. ChatGPT can simplify finding these, and interacting with Natural Language.
88
9-
109
This is to explore:
1110

1211
| Explore | Status |
@@ -30,14 +29,14 @@ This exploration is changing rapidly. For updates, replace `integration/mcp` fr
3029

3130
## Nat Lang ALS Access using OpenAI Plugin
3231

33-
3432
Requires tunnel to local host such as [ngrok](https://ngrok.com/downloads/mac-os?tab=download), then
3533

3634
```
3735
ngrok config add-authtoken <obtain from https://dashboard.ngrok.com/get-started/setup/macos>
3836
```
3937

4038
then start the tunnel
39+
4140
```
4241
ngrok http 5656
4342
```
@@ -94,13 +93,15 @@ In path /Product, method post is missing operationId; skipping
9493
```
9594

9695
<br>
96+
9797
### Custom endpoint for openapi
9898

9999
OpenAI requires a openai document, so observe the custom endpoint - `api/api_discovery/openapi` - eg, to test locally: `http://localhost:5656/api/openai`
100100

101101
Note: the url for use in ChatGPT is the tunnelled version, from the env variable.
102102

103103
<br>
104+
104105
### Configure in ChatGPT
105106

106107
Then, upload it to the Web version of ChatGPT:
@@ -114,15 +115,31 @@ Provide the url of the openai endpoint:
114115

115116
https://tunnel_url.ngrok-free.app/api/openapi
116117

117-
118118
Retrieval worked:
119119

120-
* list customers
121-
122-
* list the items of order 1 with their product names
120+
- list customers
121+
- list the items of order 1 with their product names
123122

124123
<br>
125124

125+
126+
127+
### Update: failed to load
128+
129+
We also experimented with update, using `integration/openai_plugin/swagger_3_genai_demo_with_update.json`.
130+
131+
It failed to load with
132+
133+
```
134+
In context=('paths', '/Customer/{CustomerId}/', 'patch', 'requestBody', 'content', 'application/json', 'schema'), reference to unknown component Customer_inst; using empty schema
135+
136+
In path /Customer/{CustomerId}/, method patch, operationId UpdateCustomer_0, request body schema is not an object schema; skipping
137+
138+
In path /Customer/{CustomerId}/, method patch, operationId UpdateCustomer_0, skipping function due to errors
139+
```
140+
141+
142+
126143
## Appendices
127144

128145
<br>
@@ -133,8 +150,8 @@ Prepare `ai_plug_in.json` as shown in this directory. Observe that it It identi
133150

134151
Note: both ALS and and `ai_plug_in.json` presume the swagger and api are consistent:
135152

136-
* swagger is at `http://localhost:5656/api/swagger.json`,
137-
* typical API at `http://localhost:5656/api/Category`
153+
- swagger is at `http://localhost:5656/api/swagger.json`,
154+
- typical API at `http://localhost:5656/api/Category`
138155

139156
Not required for function - **Settings / Beta / Plugins > Plugin install → expects the ai-plugin.json manifest URL**
140157

0 commit comments

Comments
 (0)