openai/openai-dotnet
Publicmirrored from https://github.com/openai/openai-dotnetAvailable
schema/ConfigurationSchema.json
271lines · modecode
| 1 | { |
| 2 | "definitions": { |
| 3 | "openAIClientOptions": { |
| 4 | "allOf": [ |
| 5 | { "$ref": "#/definitions/options" }, |
| 6 | { |
| 7 | "type": "object", |
| 8 | "description": "Options for configuring the OpenAI client.", |
| 9 | "properties": { |
| 10 | "Endpoint": { |
| 11 | "type": "string", |
| 12 | "format": "uri", |
| 13 | "description": "The service endpoint that the client will send requests to. If not set, the default OpenAI endpoint (https://api.openai.com/v1) will be used." |
| 14 | }, |
| 15 | "OrganizationId": { |
| 16 | "type": "string", |
| 17 | "description": "The value to use for the OpenAI-Organization request header. Users who belong to multiple organizations can set this value to specify which organization is used for an API request." |
| 18 | }, |
| 19 | "ProjectId": { |
| 20 | "type": "string", |
| 21 | "description": "The value to use for the OpenAI-Project request header. Users who are accessing their projects through their legacy user API key can set this value to specify which project is used for an API request." |
| 22 | }, |
| 23 | "UserAgentApplicationId": { |
| 24 | "type": "string", |
| 25 | "description": "An optional application ID to use as part of the request User-Agent header." |
| 26 | } |
| 27 | } |
| 28 | } |
| 29 | ] |
| 30 | }, |
| 31 | "chatModel": { |
| 32 | "anyOf": [ |
| 33 | { |
| 34 | "enum": [ |
| 35 | "gpt-5.4", |
| 36 | "gpt-5.4-mini", |
| 37 | "gpt-5.4-nano", |
| 38 | "gpt-4.1", |
| 39 | "gpt-4.1-mini", |
| 40 | "gpt-4.1-nano", |
| 41 | "o4-mini" |
| 42 | ], |
| 43 | "type": "string" |
| 44 | }, |
| 45 | { |
| 46 | "type": "string" |
| 47 | } |
| 48 | ], |
| 49 | "description": "The model to use in the chat completions APIs. Enum contains the most popular models, for a full list see https://developers.openai.com/api/docs/models/all." |
| 50 | }, |
| 51 | "audioModel": { |
| 52 | "anyOf": [ |
| 53 | { |
| 54 | "enum": [ |
| 55 | "gpt-4o-mini-tts", |
| 56 | "gpt-4o-transcribe", |
| 57 | "gpt-4o-mini-transcribe" |
| 58 | ], |
| 59 | "type": "string" |
| 60 | }, |
| 61 | { |
| 62 | "type": "string" |
| 63 | } |
| 64 | ], |
| 65 | "description": "The model to use in the audio APIs. Enum contains the most popular models, for a full list see https://developers.openai.com/api/docs/models/all." |
| 66 | }, |
| 67 | "embeddingModel": { |
| 68 | "anyOf": [ |
| 69 | { |
| 70 | "enum": [ |
| 71 | "text-embedding-3-large", |
| 72 | "text-embedding-3-small" |
| 73 | ], |
| 74 | "type": "string" |
| 75 | }, |
| 76 | { |
| 77 | "type": "string" |
| 78 | } |
| 79 | ], |
| 80 | "description": "The model to use in the embeddings APIs. Enum contains the most popular models, for a full list see https://developers.openai.com/api/docs/models/all." |
| 81 | }, |
| 82 | "imageModel": { |
| 83 | "anyOf": [ |
| 84 | { |
| 85 | "enum": [ |
| 86 | "gpt-image-1.5", |
| 87 | "gpt-image-1", |
| 88 | "gpt-image-1-mini" |
| 89 | ], |
| 90 | "type": "string" |
| 91 | }, |
| 92 | { |
| 93 | "type": "string" |
| 94 | } |
| 95 | ], |
| 96 | "description": "The model to use in the image generation APIs. Enum contains the most popular models, for a full list see https://developers.openai.com/api/docs/models/all." |
| 97 | }, |
| 98 | "moderationModel": { |
| 99 | "anyOf": [ |
| 100 | { |
| 101 | "enum": [ |
| 102 | "text-moderation-latest", |
| 103 | "text-moderation-stable" |
| 104 | ], |
| 105 | "type": "string" |
| 106 | }, |
| 107 | { |
| 108 | "type": "string" |
| 109 | } |
| 110 | ], |
| 111 | "description": "The model to use in the content moderation APIs. Enum contains the most popular models, for a full list see https://developers.openai.com/api/docs/models/all." |
| 112 | } |
| 113 | }, |
| 114 | "type": "object", |
| 115 | "properties": { |
| 116 | "Clients": { |
| 117 | "type": "object", |
| 118 | "properties": { |
| 119 | "ChatClient": { |
| 120 | "type": "object", |
| 121 | "description": "Configuration for the OpenAI ChatClient.", |
| 122 | "properties": { |
| 123 | "Credential": { "$ref": "#/definitions/credential" }, |
| 124 | "Model": { "$ref": "#/definitions/chatModel" }, |
| 125 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 126 | } |
| 127 | }, |
| 128 | "AudioClient": { |
| 129 | "type": "object", |
| 130 | "description": "Configuration for the OpenAI AudioClient.", |
| 131 | "properties": { |
| 132 | "Credential": { "$ref": "#/definitions/credential" }, |
| 133 | "Model": { "$ref": "#/definitions/audioModel" }, |
| 134 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 135 | } |
| 136 | }, |
| 137 | "EmbeddingClient": { |
| 138 | "type": "object", |
| 139 | "description": "Configuration for the OpenAI EmbeddingClient.", |
| 140 | "properties": { |
| 141 | "Credential": { "$ref": "#/definitions/credential" }, |
| 142 | "Model": { "$ref": "#/definitions/embeddingModel" }, |
| 143 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 144 | } |
| 145 | }, |
| 146 | "ImageClient": { |
| 147 | "type": "object", |
| 148 | "description": "Configuration for the OpenAI ImageClient.", |
| 149 | "properties": { |
| 150 | "Credential": { "$ref": "#/definitions/credential" }, |
| 151 | "Model": { "$ref": "#/definitions/imageModel" }, |
| 152 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 153 | } |
| 154 | }, |
| 155 | "ModerationClient": { |
| 156 | "type": "object", |
| 157 | "description": "Configuration for the OpenAI ModerationClient.", |
| 158 | "properties": { |
| 159 | "Credential": { "$ref": "#/definitions/credential" }, |
| 160 | "Model": { "$ref": "#/definitions/moderationModel" }, |
| 161 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 162 | } |
| 163 | }, |
| 164 | "ResponsesClient": { |
| 165 | "type": "object", |
| 166 | "description": "Configuration for the OpenAI ResponsesClient.", |
| 167 | "properties": { |
| 168 | "Credential": { "$ref": "#/definitions/credential" }, |
| 169 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 170 | } |
| 171 | }, |
| 172 | "AssistantClient": { |
| 173 | "type": "object", |
| 174 | "description": "Configuration for the OpenAI AssistantClient.", |
| 175 | "properties": { |
| 176 | "Credential": { "$ref": "#/definitions/credential" }, |
| 177 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 178 | } |
| 179 | }, |
| 180 | "BatchClient": { |
| 181 | "type": "object", |
| 182 | "description": "Configuration for the OpenAI BatchClient.", |
| 183 | "properties": { |
| 184 | "Credential": { "$ref": "#/definitions/credential" }, |
| 185 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 186 | } |
| 187 | }, |
| 188 | "OpenAIFileClient": { |
| 189 | "type": "object", |
| 190 | "description": "Configuration for the OpenAIFileClient.", |
| 191 | "properties": { |
| 192 | "Credential": { "$ref": "#/definitions/credential" }, |
| 193 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 194 | } |
| 195 | }, |
| 196 | "FineTuningClient": { |
| 197 | "type": "object", |
| 198 | "description": "Configuration for the OpenAI FineTuningClient.", |
| 199 | "properties": { |
| 200 | "Credential": { "$ref": "#/definitions/credential" }, |
| 201 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 202 | } |
| 203 | }, |
| 204 | "OpenAIModelClient": { |
| 205 | "type": "object", |
| 206 | "description": "Configuration for the OpenAIModelClient.", |
| 207 | "properties": { |
| 208 | "Credential": { "$ref": "#/definitions/credential" }, |
| 209 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 210 | } |
| 211 | }, |
| 212 | "VectorStoreClient": { |
| 213 | "type": "object", |
| 214 | "description": "Configuration for the OpenAI VectorStoreClient.", |
| 215 | "properties": { |
| 216 | "Credential": { "$ref": "#/definitions/credential" }, |
| 217 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 218 | } |
| 219 | }, |
| 220 | "RealtimeClient": { |
| 221 | "type": "object", |
| 222 | "description": "Configuration for the OpenAI RealtimeClient.", |
| 223 | "properties": { |
| 224 | "Credential": { "$ref": "#/definitions/credential" }, |
| 225 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 226 | } |
| 227 | }, |
| 228 | "ContainerClient": { |
| 229 | "type": "object", |
| 230 | "description": "Configuration for the OpenAI ContainerClient.", |
| 231 | "properties": { |
| 232 | "Credential": { "$ref": "#/definitions/credential" }, |
| 233 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 234 | } |
| 235 | }, |
| 236 | "ConversationClient": { |
| 237 | "type": "object", |
| 238 | "description": "Configuration for the OpenAI ConversationClient.", |
| 239 | "properties": { |
| 240 | "Credential": { "$ref": "#/definitions/credential" }, |
| 241 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 242 | } |
| 243 | }, |
| 244 | "EvaluationClient": { |
| 245 | "type": "object", |
| 246 | "description": "Configuration for the OpenAI EvaluationClient.", |
| 247 | "properties": { |
| 248 | "Credential": { "$ref": "#/definitions/credential" }, |
| 249 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 250 | } |
| 251 | }, |
| 252 | "GraderClient": { |
| 253 | "type": "object", |
| 254 | "description": "Configuration for the OpenAI GraderClient.", |
| 255 | "properties": { |
| 256 | "Credential": { "$ref": "#/definitions/credential" }, |
| 257 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 258 | } |
| 259 | }, |
| 260 | "VideoClient": { |
| 261 | "type": "object", |
| 262 | "description": "Configuration for the OpenAI VideoClient.", |
| 263 | "properties": { |
| 264 | "Credential": { "$ref": "#/definitions/credential" }, |
| 265 | "Options": { "$ref": "#/definitions/openAIClientOptions" } |
| 266 | } |
| 267 | } |
| 268 | } |
| 269 | } |
| 270 | } |
| 271 | } |
| 272 | |