@inductiv/node-red-openai-api 1.103.0 → 6.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +213 -86
  2. package/examples/realtime/client-secrets.json +182 -0
  3. package/examples/responses/computer-use.json +142 -0
  4. package/examples/responses/mcp.json +1 -1
  5. package/examples/responses/phase.json +102 -0
  6. package/examples/responses/tool-search.json +107 -0
  7. package/examples/responses/websocket.json +172 -0
  8. package/internals/openai-api-features-v6.23.0-v6.27.0.md +96 -0
  9. package/lib.js +12696 -15003
  10. package/locales/en-US/node.json +50 -1
  11. package/node.html +1723 -1012
  12. package/node.js +204 -54
  13. package/package.json +9 -7
  14. package/src/assistants/help.html +1 -77
  15. package/src/audio/help.html +1 -37
  16. package/src/batch/help.html +3 -17
  17. package/src/chat/help.html +11 -89
  18. package/src/container-files/help.html +1 -27
  19. package/src/containers/help.html +8 -18
  20. package/src/conversations/help.html +135 -0
  21. package/src/conversations/methods.js +73 -0
  22. package/src/conversations/template.html +10 -0
  23. package/src/embeddings/help.html +1 -11
  24. package/src/evals/help.html +249 -0
  25. package/src/evals/methods.js +114 -0
  26. package/src/evals/template.html +14 -0
  27. package/src/files/help.html +4 -17
  28. package/src/fine-tuning/help.html +1 -35
  29. package/src/images/help.html +1 -45
  30. package/src/lib.js +53 -1
  31. package/src/messages/help.html +19 -39
  32. package/src/messages/methods.js +13 -0
  33. package/src/messages/template.html +7 -18
  34. package/src/models/help.html +1 -5
  35. package/src/moderations/help.html +1 -5
  36. package/src/node.html +126 -37
  37. package/src/realtime/help.html +209 -0
  38. package/src/realtime/methods.js +45 -0
  39. package/src/realtime/template.html +7 -0
  40. package/src/responses/help.html +286 -63
  41. package/src/responses/methods.js +234 -16
  42. package/src/responses/template.html +21 -1
  43. package/src/responses/websocket.js +150 -0
  44. package/src/runs/help.html +1 -123
  45. package/src/skills/help.html +183 -0
  46. package/src/skills/methods.js +99 -0
  47. package/src/skills/template.html +13 -0
  48. package/src/threads/help.html +1 -15
  49. package/src/uploads/help.html +1 -21
  50. package/src/vector-store-file-batches/help.html +1 -27
  51. package/src/vector-store-file-batches/methods.js +5 -5
  52. package/src/vector-store-files/help.html +1 -25
  53. package/src/vector-store-files/methods.js +4 -7
  54. package/src/vector-stores/help.html +2 -31
  55. package/src/vector-stores/methods.js +5 -11
  56. package/src/vector-stores/template.html +7 -22
  57. package/src/videos/help.html +113 -0
  58. package/src/videos/methods.js +50 -0
  59. package/src/videos/template.html +8 -0
  60. package/src/webhooks/help.html +61 -0
  61. package/src/webhooks/methods.js +40 -0
  62. package/src/webhooks/template.html +4 -0
  63. package/test/openai-methods-mapping.test.js +1559 -0
  64. package/test/openai-node-auth-routing.test.js +206 -0
  65. package/test/openai-responses-websocket.test.js +472 -0
  66. package/test/service-host-editor-template.test.js +56 -0
  67. package/test/service-host-node.test.js +185 -0
  68. package/test/services.test.js +150 -0
  69. package/test/utils.test.js +78 -0
package/src/audio/help.html CHANGED
@@ -1,7 +1,7 @@
1
1
  <section>
2
2
  <details>
3
3
  <summary style="font-weight: bold;">🔉 Audio</summary>
4
- <a href="https://platform.openai.com/docs/api-reference/audio" target="_blank">Official Documentation
4
+ <a href="https://developers.openai.com/api/reference/typescript/resources/audio/" target="_blank">Official Documentation
5
5
  <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
6
6
  <h4 style="font-weight: bolder;"> ⋙ Create Speech</h4>
7
7
  <p>Generates audio from the input text.</p>
@@ -10,16 +10,12 @@
10
10
 
11
11
  <dt>
12
12
  input
13
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input"
14
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
15
13
  <span class="property-type">string</span>
16
14
  </dt>
17
15
  <dd>The text to generate audio for.</dd>
18
16
 
19
17
  <dt>
20
18
  model
21
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model"
22
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
23
19
  <span class="property-type">string</span>
24
20
  </dt>
25
21
  <dd>One of the available TTS models: <code>tts-1</code>, <code>tts-1-hd</code> or
@@ -27,8 +23,6 @@
27
23
 
28
24
  <dt>
29
25
  voice
30
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice"
31
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
32
26
  <span class="property-type">string</span>
33
27
  </dt>
34
28
  <dd>
@@ -39,8 +33,6 @@
39
33
 
40
34
  <dt class="optional">
41
35
  instructions
42
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-instructions"
43
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
44
36
  <span class="property-type">string</span>
45
37
  </dt>
46
38
  <dd>
@@ -50,8 +42,6 @@
50
42
 
51
43
  <dt class="optional">
52
44
  response_format
53
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-response_format"
54
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
55
45
  <span class="property-type">string</span>
56
46
  </dt>
57
47
  <dd>
@@ -60,8 +50,6 @@
60
50
 
61
51
  <dt class="optional">
62
52
  speed
63
- <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-speed"
64
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
65
53
  <span class="property-type">number</span>
66
54
  </dt>
67
55
  <dd>
@@ -77,8 +65,6 @@
77
65
 
78
66
  <dt>
79
67
  file
80
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-file"
81
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
82
68
  <span class="property-type">file</span>
83
69
  </dt>
84
70
  <dd>
@@ -87,22 +73,16 @@
87
73
  </dd>
88
74
  <dt>
89
75
  model
90
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-model"
91
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
92
76
  <span class="property-type">string</span>
93
77
  </dt>
94
78
  <dd>ID of the model to use.</dd>
95
79
  <dt class="optional">
96
80
  language
97
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-language"
98
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
99
81
  <span class="property-type">string</span>
100
82
  </dt>
101
83
  <dd>The language of the input audio.</dd>
102
84
  <dt class="optional">
103
85
  prompt
104
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-prompt"
105
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
106
86
  <span class="property-type">string</span>
107
87
  </dt>
108
88
  <dd>
@@ -111,8 +91,6 @@
111
91
  </dd>
112
92
  <dt class="optional">
113
93
  response_format
114
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-response_format"
115
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
116
94
  <span class="property-type">string</span>
117
95
  </dt>
118
96
  <dd>
@@ -121,16 +99,12 @@
121
99
  </dd>
122
100
  <dt class="optional">
123
101
  temperature
124
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-temperature"
125
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
126
102
  <span class="property-type">number</span>
127
103
  </dt>
128
104
  <dd>The sampling temperature, between 0 and 1.</dd>
129
105
 
130
106
  <dt class="optional">
131
107
  timestamp_granularities
132
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-timestamp_granularities"
133
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
134
108
  <span class="property-type">array</span>
135
109
  </dt>
136
110
  <dd>The timestamp granularities to populate for this transcription. <code>response_format</code> must be set
@@ -145,8 +119,6 @@
145
119
 
146
120
  <dt>
147
121
  file
148
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-file"
149
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
150
122
  <span class="property-type">file</span>
151
123
  </dt>
152
124
  <dd>
@@ -155,15 +127,11 @@
155
127
  </dd>
156
128
  <dt>
157
129
  model
158
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-model"
159
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
160
130
  <span class="property-type"></span>
161
131
  </dt>
162
132
  <dd>ID of the model to use.</dd>
163
133
  <dt class="optional">
164
134
  prompt
165
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-prompt"
166
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
167
135
  <span class="property-type">string</span>
168
136
  </dt>
169
137
  <dd>
@@ -172,8 +140,6 @@
172
140
  </dd>
173
141
  <dt class="optional">
174
142
  response_format
175
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-response_format"
176
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
177
143
  <span class="property-type">string</span>
178
144
  </dt>
179
145
  <dd>
@@ -182,8 +148,6 @@
182
148
  </dd>
183
149
  <dt class="optional">
184
150
  temperature
185
- <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-temperature"
186
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
187
151
  <span class="property-type">number</span>
188
152
  </dt>
189
153
  <dd>The sampling temperature, between 0 and 1.</dd>
package/src/batch/help.html CHANGED
@@ -1,7 +1,7 @@
1
1
  <section>
2
2
  <details>
3
3
  <summary style="font-weight: bold;">📦 Batch</summary>
4
- <a href="https://platform.openai.com/docs/api-reference/batch" target="_blank">Official Documentation
4
+ <a href="https://developers.openai.com/api/reference/typescript/resources/batches/" target="_blank">Official Documentation
5
5
  <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
6
6
  <h4 style="font-weight: bolder;"> ⋙ Create Batch</h4>
7
7
  <p>Creates and executes a batch from an uploaded file of requests.</p>
@@ -10,23 +10,17 @@
10
10
 
11
11
  <dt>
12
12
  input_file_id
13
- <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-input_file_id"
14
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
15
13
  <span class="property-type">string</span>
16
14
  </dt>
17
15
  <dd>The ID of an uploaded file that contains requests for the new batch.</dd>
18
16
  <dt>
19
17
  endpoint
20
- <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-endpoint"
21
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
22
18
  <span class="property-type">string</span>
23
19
  </dt>
24
20
  <dd>The endpoint to be used for all requests in the batch. Currently only /v1/chat/completions is supported.
25
21
  </dd>
26
22
  <dt>
27
23
  completion_window
28
- <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-completion_window"
29
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
30
24
  <span class="property-type">string</span>
31
25
  </dt>
32
26
  <dd>
@@ -34,8 +28,6 @@
34
28
  </dd>
35
29
  <dt class="optional">
36
30
  metadata
37
- <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-metadata"
38
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
39
31
  <span class="property-type">string</span>
40
32
  </dt>
41
33
  <dd>
@@ -50,8 +42,6 @@
50
42
 
51
43
  <dt>
52
44
  batch_id
53
- <a href="https://platform.openai.com/docs/api-reference/batch/retrieve#batch-retrieve-batch_id"
54
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
55
45
  <span class="property-type">string</span>
56
46
  </dt>
57
47
  <dd>The ID of the batch to retrieve.</dd>
@@ -63,8 +53,6 @@
63
53
  <h4>msg.payload Properties</h4>
64
54
  <dt>
65
55
  batch_id
66
- <a href="https://platform.openai.com/docs/api-reference/batch/cancel#batch-cancel-batch_id"
67
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
68
56
  <span class="property-type">string</span>
69
57
  </dt>
70
58
  <dd>The ID of the batch to cancel.</dd>
@@ -76,16 +64,14 @@
76
64
  <h4>msg.payload Properties</h4>
77
65
  <dt class="optional">
78
66
  after
79
- <a href="https://platform.openai.com/docs/api-reference/batch/list#batch-list-after" target="_blank"><i
80
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
67
+
81
68
  <span class="property-type">string</span>
82
69
  </dt>
83
70
  <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
84
71
 
85
72
  <dt class="optional">
86
73
  limit
87
- <a href="https://platform.openai.com/docs/api-reference/batch/list#batch-list-limit" target="_blank"><i
88
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
74
+
89
75
  <span class="property-type">integer</span>
90
76
  </dt>
91
77
  <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is
package/src/chat/help.html CHANGED
@@ -1,66 +1,52 @@
1
1
  <section>
2
2
  <details>
3
3
  <summary style="font-weight: bold;">💬 Chat</summary>
4
- <a href="https://platform.openai.com/docs/api-reference/chat" target="_blank">Official Documentation
4
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Official Documentation
5
5
  <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
6
6
  <h4 style="font-weight: bolder;"> ⋙ Create Chat Completion</h4>
7
7
  <p>
8
8
  Creates a model response for the given chat conversation.
9
- <a href="https://platform.openai.com/docs/api-reference/chat/create" target="_blank">Full documentation.</a>
9
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full documentation.</a>
10
10
  </p>
11
11
  <dl class="message-properties">
12
12
  <h4>msg.payload Properties</h4>
13
13
 
14
14
  <dt>
15
15
  messages
16
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages"
17
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
18
16
  <span class="property-type">array</span>
19
17
  </dt>
20
18
  <dd>A list of messages comprising the conversation so far.</dd>
21
19
  <dt>
22
20
  model
23
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-model"
24
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
25
21
  <span class="property-type">string</span>
26
22
  </dt>
27
23
  <dd>ID of the model to use.</dd>
28
24
 
29
25
  <dt class="optional">
30
26
  store
31
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-store"
32
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
33
27
  <span class="property-type">boolean | null</span>
34
28
  </dt>
35
29
  <dd>Whether to store the output of this chat completion request.</dd>
36
30
 
37
31
  <dt class="optional">
38
32
  reasoning_effort
39
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-reasoning_effort"
40
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
41
33
  <span class="property-type">string</span>
42
34
  </dt>
43
35
  <dd>Constrains effort on reasoning for reasoning models.</dd>
44
36
 
45
37
  <dt class="optional">
46
38
  metadata
47
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-metadata"
48
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
49
39
  <span class="property-type">object or null</span>
50
40
  </dt>
51
41
  <dd>Developer-defined tags and values used for filtering completions in the dashboard.</dd>
52
42
 
53
43
  <dt class="optional">
54
44
  frequency_penalty
55
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-frequency_penalty"
56
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
57
45
  <span class="property-type">number</span>
58
46
  </dt>
59
47
  <dd>Number between -2.0 and 2.0.</dd>
60
48
  <dt class="optional">
61
49
  logit_bias
62
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logit_bias"
63
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
64
50
  <span class="property-type">object</span>
65
51
  </dt>
66
52
  <dd>
@@ -68,15 +54,11 @@
68
54
  </dd>
69
55
  <dt class="optional">
70
56
  logprobs
71
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logprobs"
72
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
73
57
  <span class="property-type">boolean</span>
74
58
  </dt>
75
59
  <dd>Whether to return log probabilities of the output tokens or not.</dd>
76
60
  <dt class="optional">
77
61
  top_logprobs
78
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_logprobs"
79
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
80
62
  <span class="property-type">integer</span>
81
63
  </dt>
82
64
  <dd>
@@ -86,8 +68,6 @@
86
68
  </dd>
87
69
  <dt class="optional">
88
70
  max_tokens [Deprecated]
89
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_tokens"
90
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
91
71
  <span class="property-type">integer</span>
92
72
  </dt>
93
73
  <dd>
@@ -98,8 +78,6 @@
98
78
 
99
79
  <dt class="optional">
100
80
  max_completion_tokens
101
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_completion_tokens"
102
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
103
81
  <span class="property-type">integer</span>
104
82
  </dt>
105
83
  <dd>
@@ -109,8 +87,7 @@
109
87
 
110
88
  <dt class="optional">
111
89
  n
112
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-n" target="_blank"><i
113
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
90
+
114
91
  <span class="property-type">integer</span>
115
92
  </dt>
116
93
  <dd>
@@ -119,8 +96,6 @@
119
96
 
120
97
  <dt class="optional">
121
98
  modalities
122
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-modalities"
123
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
124
99
  <span class="property-type">array or null</span>
125
100
  </dt>
126
101
  <dd>
@@ -129,8 +104,6 @@
129
104
 
130
105
  <dt class="optional">
131
106
  prediction
132
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-prediction"
133
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
134
107
  <span class="property-type">object</span>
135
108
  </dt>
136
109
  <dd>
@@ -139,8 +112,6 @@
139
112
 
140
113
  <dt class="optional">
141
114
  audio
142
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-audio"
143
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
144
115
  <span class="property-type">object or null</span>
145
116
  </dt>
146
117
  <dd>
@@ -149,24 +120,19 @@
149
120
 
150
121
  <dt class="optional">
151
122
  presence_penalty
152
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-presence_penalty"
153
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
154
123
  <span class="property-type">number</span>
155
124
  </dt>
156
125
  <dd>Number between -2.0 and 2.0.</dd>
157
126
 
158
127
  <dt class="optional">
159
128
  response_format
160
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format"
161
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
162
129
  <span class="property-type">object</span>
163
130
  </dt>
164
131
  <dd>An object specifying the format that the model must output.</dd>
165
132
 
166
133
  <dt class="optional">
167
134
  seed
168
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-seed" target="_blank"><i
169
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
135
+
170
136
  <span class="property-type">integer</span>
171
137
  </dt>
172
138
  <dd>
@@ -177,8 +143,6 @@
177
143
 
178
144
  <dt class="optional">
179
145
  service_tier
180
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-service_tier"
181
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
182
146
  <span class="property-type">string or null</span>
183
147
  </dt>
184
148
  <dd>
@@ -187,8 +151,7 @@
187
151
 
188
152
  <dt class="optional">
189
153
  stop
190
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stop" target="_blank"><i
191
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
154
+
192
155
  <span class="property-type">string | array</span>
193
156
  </dt>
194
157
  <dd>
@@ -197,32 +160,24 @@
197
160
 
198
161
  <dt class="optional">
199
162
  stream
200
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream"
201
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
202
163
  <span class="property-type">boolean</span>
203
164
  </dt>
204
165
  <dd>If set, partial message deltas will be sent, like in ChatGPT.</dd>
205
166
 
206
167
  <dt class="optional">
207
168
  stream_options
208
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream_options"
209
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
210
169
  <span class="property-type">object</span>
211
170
  </dt>
212
171
  <dd>Options for streaming response. Only set this when you set ```stream: true```.</dd>
213
172
 
214
173
  <dt class="optional">
215
174
  temperature
216
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature"
217
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
218
175
  <span class="property-type">number</span>
219
176
  </dt>
220
177
  <dd>What sampling temperature to use, between 0 and 2.</dd>
221
178
 
222
179
  <dt class="optional">
223
180
  top_p
224
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_p"
225
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
226
181
  <span class="property-type">number</span>
227
182
  </dt>
228
183
  <dd>
@@ -233,32 +188,25 @@
233
188
 
234
189
  <dt class="optional">
235
190
  tools
236
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools"
237
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
238
191
  <span class="property-type">array</span>
239
192
  </dt>
240
193
  <dd>A list of tools the model may call.</dd>
241
194
 
242
195
  <dt class="optional">
243
196
  tool_choice
244
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice"
245
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
246
197
  <span class="property-type">string | object</span>
247
198
  </dt>
248
199
  <dd>Whether to enable parallel function calling during tool use.</dd>
249
200
 
250
201
  <dt class="optional">
251
202
  parallel_tool_calls
252
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-parallel_tool_calls"
253
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
254
203
  <span class="property-type">string | object</span>
255
204
  </dt>
256
205
  <dd>Whether to enable parallel function calling during tool use.</dd>
257
206
 
258
207
  <dt class="optional">
259
208
  user
260
- <a href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-user" target="_blank"><i
261
- class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
209
+
262
210
  <span class="property-type">string</span>
263
211
  </dt>
264
212
  <dd>
@@ -272,15 +220,13 @@
272
220
  <h4 style="font-weight: bolder;"> ⋙ Get Chat Completion</h4>
273
221
  <p>
274
222
  Get a stored chat completion.
275
- <a href="https://platform.openai.com/docs/api-reference/chat/get" target="_blank">Full documentation.</a>
223
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full documentation.</a>
276
224
  </p>
277
225
  <dl class="message-properties">
278
226
  <h4>msg.payload Properties</h4>
279
227
 
280
228
  <dt>
281
229
  completion_id
282
- <a href="https://platform.openai.com/docs/api-reference/chat/get#chat-get-completion_id"
283
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
284
230
  <span class="property-type">string</span>
285
231
  </dt>
286
232
  <dd>The ID of the chat completion to retrieve.</dd>
@@ -290,7 +236,7 @@
290
236
  <h4 style="font-weight: bolder;"> ⋙ Get Chat Messages</h4>
291
237
  <p>
292
238
  Get the messages in a stored chat completion.
293
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages" target="_blank">Full
239
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full
294
240
  documentation.</a>
295
241
  </p>
296
242
  <dl class="message-properties">
@@ -298,32 +244,24 @@
298
244
 
299
245
  <dt>
300
246
  completion_id
301
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-completion_id"
302
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
303
247
  <span class="property-type">string</span>
304
248
  </dt>
305
249
  <dd>The ID of the chat completion to retrieve messages from.</dd>
306
250
 
307
251
  <dt class="optional">
308
252
  after
309
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-afterf"
310
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
311
253
  <span class="property-type">string</span>
312
254
  </dt>
313
255
  <dd>Identifier for the last message from the previous pagination request.</dd>
314
256
 
315
257
  <dt class="optional">
316
258
  limit
317
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
318
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
319
259
  <span class="property-type">integer</span>
320
260
  </dt>
321
261
  <dd>Number of messages to retrieve.</dd>
322
262
 
323
263
  <dt class="optional">
324
264
  order
325
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-order"
326
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
327
265
  <span class="property-type">string</span>
328
266
  </dt>
329
267
  <dd>Sort order for messages by timestamp.</dd>
@@ -335,7 +273,7 @@
335
273
  <h4 style="font-weight: bolder;"> ⋙ List Chat Completions</h4>
336
274
  <p>
337
275
  List stored chat completions.
338
- <a href="https://platform.openai.com/docs/api-reference/chat/list" target="_blank">Full
276
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full
339
277
  documentation.</a>
340
278
  </p>
341
279
  <dl class="message-properties">
@@ -343,40 +281,30 @@
343
281
 
344
282
  <dt class="optional">
345
283
  model
346
- <a href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-model"
347
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
348
284
  <span class="property-type">string</span>
349
285
  </dt>
350
286
  <dd>The model used to generate the chat completions.</dd>
351
287
 
352
288
  <dt class="optional">
353
289
  metadata
354
- <a href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-metadata"
355
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
356
290
  <span class="property-type">object</span>
357
291
  </dt>
358
292
  <dd>A list of metadata keys to filter the chat completions by.</dd>
359
293
 
360
294
  <dt class="optional">
361
295
  after
362
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
363
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
364
296
  <span class="property-type">string</span>
365
297
  </dt>
366
298
  <dd>Identifier for the last chat completion from the previous pagination request.</dd>
367
299
 
368
300
  <dt class="optional">
369
301
  limit
370
- <a href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-limit"
371
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
372
302
  <span class="property-type">integer</span>
373
303
  </dt>
374
304
  <dd>Number of chat completions to retrieve.</dd>
375
305
 
376
306
  <dt class="optional">
377
307
  order
378
- <a href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-order"
379
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
380
308
  <span class="property-type">string</span>
381
309
  </dt>
382
310
  <dd>Sort order for chat completions by timestamp.</dd>
@@ -388,7 +316,7 @@
388
316
  <h4 style="font-weight: bolder;"> ⋙ Update Chat Completion</h4>
389
317
  <p>
390
318
  Modify a stored chat completion.
391
- <a href="https://platform.openai.com/docs/api-reference/chat/update" target="_blank">Full
319
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full
392
320
  documentation.</a>
393
321
  </p>
394
322
  <dl class="message-properties">
@@ -396,16 +324,12 @@
396
324
 
397
325
  <dt>
398
326
  completion_id
399
- <a href="https://platform.openai.com/docs/api-reference/chat/update#chat-update-completion_id"
400
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
401
327
  <span class="property-type">string</span>
402
328
  </dt>
403
329
  <dd>The ID of the chat completion to update.</dd>
404
330
 
405
331
  <dt>
406
332
  metadata
407
- <a href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
408
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
409
333
  <span class="property-type">object</span>
410
334
  </dt>
411
335
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
@@ -417,7 +341,7 @@
417
341
  <h4 style="font-weight: bolder;"> ⋙ Delete Chat Completion</h4>
418
342
  <p>
419
343
  Delete a stored chat completion.
420
- <a href="https://platform.openai.com/docs/api-reference/chat/delete" target="_blank">Full
344
+ <a href="https://developers.openai.com/api/reference/typescript/resources/chat/completions/" target="_blank">Full
421
345
  documentation.</a>
422
346
  </p>
423
347
  <dl class="message-properties">
@@ -425,8 +349,6 @@
425
349
 
426
350
  <dt>
427
351
  completion_id
428
- <a href="https://platform.openai.com/docs/api-reference/chat/delete#chat-delete-completion_id"
429
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
430
352
  <span class="property-type">string</span>
431
353
  </dt>
432
354
  <dd>The ID of the chat completion to delete.</dd>