{ "name": "OpenAI", "apiVersions": [], "enums": [ { "$id": "1", "kind": "enum", "name": "AssistantToolDefinitionType", "crossLanguageDefinitionId": "OpenAI.AssistantToolDefinitionType", "valueType": { "$id": "2", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "3", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "2" }, "enumType": { "$ref": "1" }, "decorators": [] }, { "$id": "4", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "2" }, "enumType": { "$ref": "1" }, "decorators": [] }, { "$id": "5", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "2" }, "enumType": { "$ref": "1" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "6", "kind": "enum", "name": "FileSearchRanker", "crossLanguageDefinitionId": "OpenAI.FileSearchRanker", "valueType": { "$id": "7", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "8", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "7" }, "enumType": { "$ref": "6" }, "decorators": [] }, { "$id": "9", "kind": "enumvalue", "name": "default_2024_08_21", "value": "default_2024_08_21", "valueType": { "$ref": "7" }, "enumType": { "$ref": "6" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "The ranker to use for the file search. If not specified will use the `auto` ranker.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "10", "kind": "enum", "name": "ResponseFormatType", "crossLanguageDefinitionId": "OpenAI.ResponseFormat.type.anonymous", "valueType": { "$id": "11", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "12", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "11" }, "enumType": { "$ref": "10" }, "decorators": [] }, { "$id": "13", "kind": "enumvalue", "name": "json_object", "value": "json_object", "valueType": { "$ref": "11" }, "enumType": { "$ref": "10" }, "decorators": [] }, { "$id": "14", "kind": "enumvalue", "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "11" }, "enumType": { "$ref": "10" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "15", "kind": "enum", "name": "AssistantSupportedModels", "crossLanguageDefinitionId": "OpenAI.AssistantSupportedModels", "valueType": { "$id": "16", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "17", "kind": "enumvalue", "name": "gpt-4.1", "value": "gpt-4.1", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "18", "kind": "enumvalue", "name": "gpt-4.1-mini", "value": "gpt-4.1-mini", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "19", "kind": "enumvalue", "name": "gpt-4.1-nano", "value": "gpt-4.1-nano", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "20", "kind": "enumvalue", "name": "gpt-4.1-2025-04-14", "value": "gpt-4.1-2025-04-14", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "21", "kind": "enumvalue", "name": "gpt-4.1-mini-2025-04-14", "value": "gpt-4.1-mini-2025-04-14", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "22", "kind": "enumvalue", "name": "gpt-4.1-nano-2025-04-14", "value": "gpt-4.1-nano-2025-04-14", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "23", "kind": "enumvalue", "name": "o3-mini", "value": "o3-mini", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "24", "kind": "enumvalue", "name": "o3-mini-2025-01-31", "value": "o3-mini-2025-01-31", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "25", "kind": "enumvalue", "name": "o1", "value": "o1", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "26", "kind": "enumvalue", "name": "o1-2024-12-17", "value": "o1-2024-12-17", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "27", "kind": "enumvalue", "name": "gpt-4o", "value": "gpt-4o", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "28", "kind": "enumvalue", "name": "gpt-4o-2024-11-20", "value": "gpt-4o-2024-11-20", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "29", "kind": "enumvalue", "name": "gpt-4o-2024-08-06", "value": "gpt-4o-2024-08-06", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "30", "kind": "enumvalue", "name": "gpt-4o-2024-05-13", "value": "gpt-4o-2024-05-13", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "31", "kind": "enumvalue", "name": "gpt-4o-mini", "value": "gpt-4o-mini", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "32", "kind": "enumvalue", "name": "gpt-4o-mini-2024-07-18", "value": "gpt-4o-mini-2024-07-18", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "33", "kind": "enumvalue", "name": "gpt-4.5-preview", "value": "gpt-4.5-preview", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "34", "kind": "enumvalue", "name": "gpt-4.5-preview-2025-02-27", "value": "gpt-4.5-preview-2025-02-27", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "35", "kind": "enumvalue", "name": "gpt-4-turbo", "value": "gpt-4-turbo", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "36", "kind": "enumvalue", "name": "gpt-4-turbo-2024-04-09", "value": "gpt-4-turbo-2024-04-09", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "37", "kind": "enumvalue", "name": "gpt-4-0125-preview", "value": "gpt-4-0125-preview", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "38", "kind": "enumvalue", "name": "gpt-4-turbo-preview", "value": "gpt-4-turbo-preview", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "39", "kind": "enumvalue", "name": "gpt-4-1106-preview", "value": "gpt-4-1106-preview", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "40", "kind": "enumvalue", "name": "gpt-4-vision-preview", "value": "gpt-4-vision-preview", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "41", "kind": "enumvalue", "name": "gpt-4", "value": "gpt-4", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "42", "kind": "enumvalue", "name": "gpt-4-0314", "value": "gpt-4-0314", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "43", "kind": "enumvalue", "name": "gpt-4-0613", "value": "gpt-4-0613", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "44", "kind": "enumvalue", "name": "gpt-4-32k", "value": "gpt-4-32k", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "45", "kind": "enumvalue", "name": "gpt-4-32k-0314", "value": "gpt-4-32k-0314", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "46", "kind": "enumvalue", "name": "gpt-4-32k-0613", "value": "gpt-4-32k-0613", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "47", "kind": "enumvalue", "name": "gpt-3.5-turbo", "value": "gpt-3.5-turbo", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "48", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k", "value": "gpt-3.5-turbo-16k", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "49", "kind": "enumvalue", "name": "gpt-3.5-turbo-0613", "value": "gpt-3.5-turbo-0613", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "50", "kind": "enumvalue", "name": "gpt-3.5-turbo-1106", "value": "gpt-3.5-turbo-1106", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "51", "kind": "enumvalue", "name": "gpt-3.5-turbo-0125", "value": "gpt-3.5-turbo-0125", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] }, { "$id": "52", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k-0613", "value": "gpt-3.5-turbo-16k-0613", "valueType": { "$ref": "16" }, "enumType": { "$ref": "15" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "53", "kind": "enum", "name": "ReasoningEffort", "crossLanguageDefinitionId": "OpenAI.ReasoningEffort", "valueType": { "$id": "54", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "55", "kind": "enumvalue", "name": "minimal", "value": "minimal", "valueType": { "$ref": "54" }, "enumType": { "$ref": "53" }, "decorators": [] }, { "$id": "56", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "54" }, "enumType": { "$ref": "53" }, "decorators": [] }, { "$id": "57", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "54" }, "enumType": { "$ref": "53" }, "decorators": [] }, { "$id": "58", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "54" }, "enumType": { "$ref": "53" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "**o-series models only**\n\nConstrains effort on reasoning for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `minimal`, `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "59", "kind": "enum", "name": "ChunkingStrategyRequestParamType", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyRequestParam.type.anonymous", "valueType": { "$id": "60", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "61", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "60" }, "enumType": { "$ref": "59" }, "decorators": [] }, { "$id": "62", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "60" }, "enumType": { "$ref": "59" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "63", "kind": "enum", "name": "CreateSpeechRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.model.anonymous", "valueType": { "$id": "64", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "65", "kind": "enumvalue", "name": "tts-1", "value": "tts-1", "valueType": { "$ref": "64" }, "enumType": { "$ref": "63" }, "decorators": [] }, { "$id": "66", "kind": "enumvalue", "name": "tts-1-hd", "value": "tts-1-hd", "valueType": { "$ref": "64" }, "enumType": { "$ref": "63" }, "decorators": [] }, { "$id": "67", "kind": "enumvalue", "name": "gpt-4o-mini-tts", "value": "gpt-4o-mini-tts", "valueType": { "$ref": "64" }, "enumType": { "$ref": "63" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "68", "kind": "enum", "name": "VoiceIdsShared", "crossLanguageDefinitionId": "OpenAI.VoiceIdsShared", "valueType": { "$id": "69", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "70", "kind": "enumvalue", "name": "alloy", "value": "alloy", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "71", "kind": "enumvalue", "name": "ash", "value": "ash", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "72", "kind": "enumvalue", "name": "ballad", "value": "ballad", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "73", "kind": "enumvalue", "name": "coral", "value": "coral", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "74", "kind": "enumvalue", "name": "echo", "value": "echo", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "75", "kind": "enumvalue", "name": "fable", "value": "fable", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "76", "kind": "enumvalue", "name": "onyx", "value": "onyx", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "77", "kind": "enumvalue", "name": "nova", "value": "nova", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "78", "kind": "enumvalue", "name": "sage", "value": "sage", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "79", "kind": "enumvalue", "name": "shimmer", "value": "shimmer", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] }, { "$id": "80", "kind": "enumvalue", "name": "verse", "value": "verse", "valueType": { "$ref": "69" }, "enumType": { "$ref": "68" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "81", "kind": "enum", "name": "CreateSpeechRequestResponseFormat", "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.response_format.anonymous", "valueType": { "$id": "82", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "83", "kind": "enumvalue", "name": "mp3", "value": "mp3", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] }, { "$id": "84", "kind": "enumvalue", "name": "opus", "value": "opus", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] }, { "$id": "85", "kind": "enumvalue", "name": "aac", "value": "aac", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] }, { "$id": "86", "kind": "enumvalue", "name": "flac", "value": "flac", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] }, { "$id": "87", "kind": "enumvalue", "name": "wav", "value": "wav", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] }, { "$id": "88", "kind": "enumvalue", "name": "pcm", "value": "pcm", "valueType": { "$ref": "82" }, "enumType": { "$ref": "81" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "89", "kind": "enum", "name": "CreateTranscriptionRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.model.anonymous", "valueType": { "$id": "90", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "91", "kind": "enumvalue", "name": "whisper-1", "value": "whisper-1", "valueType": { "$ref": "90" }, "enumType": { "$ref": "89" }, "decorators": [] }, { "$id": "92", "kind": "enumvalue", "name": "gpt-4o-transcribe", "value": "gpt-4o-transcribe", "valueType": { "$ref": "90" }, "enumType": { "$ref": "89" }, "decorators": [] }, { "$id": "93", "kind": "enumvalue", "name": "gpt-4o-mini-transcribe", "value": "gpt-4o-mini-transcribe", "valueType": { "$ref": "90" }, "enumType": { "$ref": "89" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "94", "kind": "enum", "name": "TranscriptionAudioResponseFormat", "crossLanguageDefinitionId": "OpenAI.TranscriptionAudioResponseFormat", "valueType": { "$id": "95", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "96", "kind": "enumvalue", "name": "json", "value": "json", "valueType": { "$ref": "95" }, "enumType": { "$ref": "94" }, "decorators": [] }, { "$id": "97", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "95" }, "enumType": { "$ref": "94" }, "decorators": [] }, { "$id": "98", "kind": "enumvalue", "name": "srt", "value": "srt", "valueType": { "$ref": "95" }, "enumType": { "$ref": "94" }, "decorators": [] }, { "$id": "99", "kind": "enumvalue", "name": "verbose_json", "value": "verbose_json", "valueType": { "$ref": "95" }, "enumType": { "$ref": "94" }, "decorators": [] }, { "$id": "100", "kind": "enumvalue", "name": "vtt", "value": "vtt", "valueType": { "$ref": "95" }, "enumType": { "$ref": "94" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "101", "kind": "enum", "name": "TranscriptionInclude", "crossLanguageDefinitionId": "OpenAI.TranscriptionInclude", "valueType": { "$id": "102", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "103", "kind": "enumvalue", "name": "logprobs", "value": "logprobs", "valueType": { "$ref": "102" }, "enumType": { "$ref": "101" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "104", "kind": "enum", "name": "CreateTranscriptionRequestTimestampGranularities", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.timestamp_granularities[].anonymous", "valueType": { "$id": "105", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "106", "kind": "enumvalue", "name": "word", "value": "word", "valueType": { "$ref": "105" }, "enumType": { "$ref": "104" }, "decorators": [] }, { "$id": "107", "kind": "enumvalue", "name": "segment", "value": "segment", "valueType": { "$ref": "105" }, "enumType": { "$ref": "104" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "108", "kind": "enum", "name": "CreateTranscriptionResponseStreamEventType", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseStreamEventType", "valueType": { "$id": "109", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "110", "kind": "enumvalue", "name": "transcript_text_delta", "value": "transcript.text.delta", "valueType": { "$ref": "109" }, "enumType": { "$ref": "108" }, "decorators": [] }, { "$id": "111", "kind": "enumvalue", "name": "transcript_text_done", "value": "transcript.text.done", "valueType": { "$ref": "109" }, "enumType": { "$ref": "108" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "112", "kind": "enum", "name": "CreateTranslationRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.model.anonymous", "valueType": { "$id": "113", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "114", "kind": "enumvalue", "name": "whisper-1", "value": "whisper-1", "valueType": { "$ref": "113" }, "enumType": { "$ref": "112" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "115", "kind": "enum", "name": "TranslationAudioResponseFormat", "crossLanguageDefinitionId": "OpenAI.TranslationAudioResponseFormat", "valueType": { "$id": "116", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "117", "kind": "enumvalue", "name": "json", "value": "json", "valueType": { "$ref": "116" }, "enumType": { "$ref": "115" }, "decorators": [] }, { "$id": "118", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "116" }, "enumType": { "$ref": "115" }, "decorators": [] }, { "$id": "119", "kind": "enumvalue", "name": "srt", "value": "srt", "valueType": { "$ref": "116" }, "enumType": { "$ref": "115" }, "decorators": [] }, { "$id": "120", "kind": "enumvalue", "name": "verbose_json", "value": "verbose_json", "valueType": { "$ref": "116" }, "enumType": { "$ref": "115" }, "decorators": [] }, { "$id": "121", "kind": "enumvalue", "name": "vtt", "value": "vtt", "valueType": { "$ref": "116" }, "enumType": { "$ref": "115" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "122", "kind": "enum", "name": "CreateBatchRequestEndpoint", "crossLanguageDefinitionId": "OpenAI.createBatch.Request.endpoint.anonymous", "valueType": { "$id": "123", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "124", "kind": "enumvalue", "name": "/v1/chat/completions", "value": "/v1/chat/completions", "valueType": { "$ref": "123" }, "enumType": { "$ref": "122" }, "decorators": [] }, { "$id": "125", "kind": "enumvalue", "name": "/v1/embeddings", "value": "/v1/embeddings", "valueType": { "$ref": "123" }, "enumType": { "$ref": "122" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "126", "kind": "enum", "name": "BatchErrorsObject", "crossLanguageDefinitionId": "", "valueType": { "$id": "127", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "128", "kind": "enumvalue", "name": "list", "value": "list", "valueType": { "$id": "129", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "126" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "130", "kind": "enum", "name": "BatchStatus", "crossLanguageDefinitionId": "OpenAI.Batch.status.anonymous", "valueType": { "$id": "131", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "132", "kind": "enumvalue", "name": "validating", "value": "validating", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "133", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "134", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "135", "kind": "enumvalue", "name": "finalizing", "value": "finalizing", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "136", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "137", "kind": "enumvalue", "name": "expired", "value": "expired", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "138", "kind": "enumvalue", "name": "cancelling", "value": "cancelling", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] }, { "$id": "139", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "131" }, "enumType": { "$ref": "130" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "140", "kind": "enum", "name": "CreateChatCompletionResponseChoiceFinishReason", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.finish_reason.anonymous", "valueType": { "$id": "141", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "142", "kind": "enumvalue", "name": "stop", "value": "stop", "valueType": { "$ref": "141" }, "enumType": { "$ref": "140" }, "decorators": [] }, { "$id": "143", "kind": "enumvalue", "name": "length", "value": "length", "valueType": { "$ref": "141" }, "enumType": { "$ref": "140" }, "decorators": [] }, { "$id": "144", "kind": "enumvalue", "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "141" }, "enumType": { "$ref": "140" }, "decorators": [] }, { "$id": "145", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "141" }, "enumType": { "$ref": "140" }, "decorators": [] }, { "$id": "146", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "141" }, "enumType": { "$ref": "140" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "147", "kind": "enum", "name": "DotNetChatServiceTier", "crossLanguageDefinitionId": "OpenAI.DotNetChatServiceTier", "valueType": { "$id": "148", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "149", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "148" }, "enumType": { "$ref": "147" }, "decorators": [] }, { "$id": "150", "kind": "enumvalue", "name": "default", "value": "default", "valueType": { "$ref": "148" }, "enumType": { "$ref": "147" }, "decorators": [] }, { "$id": "151", "kind": "enumvalue", "name": "flex", "value": "flex", "valueType": { "$ref": "148" }, "enumType": { "$ref": "147" }, "decorators": [] }, { "$id": "152", "kind": "enumvalue", "name": "scale", "value": "scale", "valueType": { "$ref": "148" }, "enumType": { "$ref": "147" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "153", "kind": "enum", "name": "ChatCompletionRole", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRole", "valueType": { "$id": "154", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "155", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] }, { "$id": "156", "kind": "enumvalue", "name": "developer", "value": "developer", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] }, { "$id": "157", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] }, { "$id": "158", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] }, { "$id": "159", "kind": "enumvalue", "name": "tool", "value": "tool", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] }, { "$id": "160", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "154" }, "enumType": { "$ref": "153" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "The role of the author of a message", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "161", "kind": "enum", "name": "ChatCompletionRequestMessageContentPartType", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartType", "valueType": { "$id": "162", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "163", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "162" }, "enumType": { "$ref": "161" }, "decorators": [] }, { "$id": "164", "kind": "enumvalue", "name": "file", "value": "file", "valueType": { "$ref": "162" }, "enumType": { "$ref": "161" }, "decorators": [] }, { "$id": "165", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "162" }, "enumType": { "$ref": "161" }, "decorators": [] }, { "$id": "166", "kind": "enumvalue", "name": "image_url", "value": "image_url", "valueType": { "$ref": "162" }, "enumType": { "$ref": "161" }, "decorators": [] }, { "$id": "167", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "162" }, "enumType": { "$ref": "161" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "168", "kind": "enum", "name": "ChatCompletionRequestMessageContentPartImageImageUrlDetail", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.image_url.detail.anonymous", "valueType": { "$id": "169", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "170", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "169" }, "enumType": { "$ref": "168" }, "decorators": [] }, { "$id": "171", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "169" }, "enumType": { "$ref": "168" }, "decorators": [] }, { "$id": "172", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "169" }, "enumType": { "$ref": "168" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "173", "kind": "enum", "name": "ChatCompletionRequestMessageContentPartAudioInputAudioFormat", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.input_audio.format.anonymous", "valueType": { "$id": "174", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "175", "kind": "enumvalue", "name": "wav", "value": "wav", "valueType": { "$ref": "174" }, "enumType": { "$ref": "173" }, "decorators": [] }, { "$id": "176", "kind": "enumvalue", "name": "mp3", "value": "mp3", "valueType": { "$ref": "174" }, "enumType": { "$ref": "173" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "177", "kind": "enum", "name": "ModelIdsShared", "crossLanguageDefinitionId": "OpenAI.ModelIdsShared", "valueType": { "$id": "178", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "179", "kind": "enumvalue", "name": "gpt-4.1", "value": "gpt-4.1", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "180", "kind": "enumvalue", "name": "gpt-4.1-mini", "value": "gpt-4.1-mini", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "181", "kind": "enumvalue", "name": "gpt-4.1-nano", "value": "gpt-4.1-nano", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "182", "kind": "enumvalue", "name": "gpt-4.1-2025-04-14", "value": "gpt-4.1-2025-04-14", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "183", "kind": "enumvalue", "name": "gpt-4.1-mini-2025-04-14", "value": "gpt-4.1-mini-2025-04-14", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "184", "kind": "enumvalue", "name": "gpt-4.1-nano-2025-04-14", "value": "gpt-4.1-nano-2025-04-14", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "185", "kind": "enumvalue", "name": "o4-mini", "value": "o4-mini", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "186", "kind": "enumvalue", "name": "o4-mini-2025-04-16", "value": "o4-mini-2025-04-16", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "187", "kind": "enumvalue", "name": "o3", "value": "o3", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "188", "kind": "enumvalue", "name": "o3-2025-04-16", "value": "o3-2025-04-16", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "189", "kind": "enumvalue", "name": "o3-mini", "value": "o3-mini", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "190", "kind": "enumvalue", "name": "o3-mini-2025-01-31", "value": "o3-mini-2025-01-31", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "191", "kind": "enumvalue", "name": "o1", "value": "o1", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "192", "kind": "enumvalue", "name": "o1-2024-12-17", "value": "o1-2024-12-17", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "193", "kind": "enumvalue", "name": "o1-preview", "value": "o1-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "194", "kind": "enumvalue", "name": "o1-preview-2024-09-12", "value": "o1-preview-2024-09-12", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "195", "kind": "enumvalue", "name": "o1-mini", "value": "o1-mini", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "196", "kind": "enumvalue", "name": "o1-mini-2024-09-12", "value": "o1-mini-2024-09-12", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "197", "kind": "enumvalue", "name": "gpt-4o", "value": "gpt-4o", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "198", "kind": "enumvalue", "name": "gpt-4o-2024-11-20", "value": "gpt-4o-2024-11-20", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "199", "kind": "enumvalue", "name": "gpt-4o-2024-08-06", "value": "gpt-4o-2024-08-06", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "200", "kind": "enumvalue", "name": "gpt-4o-2024-05-13", "value": "gpt-4o-2024-05-13", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "201", "kind": "enumvalue", "name": "gpt-4o-audio-preview", "value": "gpt-4o-audio-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "202", "kind": "enumvalue", "name": "gpt-4o-audio-preview-2024-10-01", "value": "gpt-4o-audio-preview-2024-10-01", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "203", "kind": "enumvalue", "name": "gpt-4o-audio-preview-2024-12-17", "value": "gpt-4o-audio-preview-2024-12-17", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "204", "kind": "enumvalue", "name": "gpt-4o-audio-preview-2025-06-03", "value": "gpt-4o-audio-preview-2025-06-03", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "205", "kind": "enumvalue", "name": "gpt-4o-mini-audio-preview", "value": "gpt-4o-mini-audio-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "206", "kind": "enumvalue", "name": "gpt-4o-mini-audio-preview-2024-12-17", "value": "gpt-4o-mini-audio-preview-2024-12-17", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "207", "kind": "enumvalue", "name": "gpt-4o-search-preview", "value": "gpt-4o-search-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "208", "kind": "enumvalue", "name": "gpt-4o-mini-search-preview", "value": "gpt-4o-mini-search-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "209", "kind": "enumvalue", "name": "gpt-4o-search-preview-2025-03-11", "value": "gpt-4o-search-preview-2025-03-11", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "210", "kind": "enumvalue", "name": "gpt-4o-mini-search-preview-2025-03-11", "value": "gpt-4o-mini-search-preview-2025-03-11", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "211", "kind": "enumvalue", "name": "chatgpt-4o-latest", "value": "chatgpt-4o-latest", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "212", "kind": "enumvalue", "name": "codex-mini-latest", "value": "codex-mini-latest", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "213", "kind": "enumvalue", "name": "gpt-4o-mini", "value": "gpt-4o-mini", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "214", "kind": "enumvalue", "name": "gpt-4o-mini-2024-07-18", "value": "gpt-4o-mini-2024-07-18", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "215", "kind": "enumvalue", "name": "gpt-4-turbo", "value": "gpt-4-turbo", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "216", "kind": "enumvalue", "name": "gpt-4-turbo-2024-04-09", "value": "gpt-4-turbo-2024-04-09", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "217", "kind": "enumvalue", "name": "gpt-4-0125-preview", "value": "gpt-4-0125-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "218", "kind": "enumvalue", "name": "gpt-4-turbo-preview", "value": "gpt-4-turbo-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "219", "kind": "enumvalue", "name": "gpt-4-1106-preview", "value": "gpt-4-1106-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "220", "kind": "enumvalue", "name": "gpt-4-vision-preview", "value": "gpt-4-vision-preview", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "221", "kind": "enumvalue", "name": "gpt-4", "value": "gpt-4", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "222", "kind": "enumvalue", "name": "gpt-4-0314", "value": "gpt-4-0314", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "223", "kind": "enumvalue", "name": "gpt-4-0613", "value": "gpt-4-0613", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "224", "kind": "enumvalue", "name": "gpt-4-32k", "value": "gpt-4-32k", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "225", "kind": "enumvalue", "name": "gpt-4-32k-0314", "value": "gpt-4-32k-0314", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "226", "kind": "enumvalue", "name": "gpt-4-32k-0613", "value": "gpt-4-32k-0613", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "227", "kind": "enumvalue", "name": "gpt-3.5-turbo", "value": "gpt-3.5-turbo", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "228", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k", "value": "gpt-3.5-turbo-16k", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "229", "kind": "enumvalue", "name": "gpt-3.5-turbo-0301", "value": "gpt-3.5-turbo-0301", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "230", "kind": "enumvalue", "name": "gpt-3.5-turbo-0613", "value": "gpt-3.5-turbo-0613", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "231", "kind": "enumvalue", "name": "gpt-3.5-turbo-1106", "value": "gpt-3.5-turbo-1106", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "232", "kind": "enumvalue", "name": "gpt-3.5-turbo-0125", "value": "gpt-3.5-turbo-0125", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] }, { "$id": "233", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k-0613", "value": "gpt-3.5-turbo-16k-0613", "valueType": { "$ref": "178" }, "enumType": { "$ref": "177" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "234", "kind": "enum", "name": "CreateChatCompletionRequestModality", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.modality.anonymous", "valueType": { "$id": "235", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "236", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "235" }, "enumType": { "$ref": "234" }, "decorators": [] }, { "$id": "237", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "235" }, "enumType": { "$ref": "234" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "238", "kind": "enum", "name": "WebSearchContextSize", "crossLanguageDefinitionId": "OpenAI.WebSearchContextSize", "valueType": { "$id": "239", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "240", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "239" }, "enumType": { "$ref": "238" }, "decorators": [] }, { "$id": "241", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "239" }, "enumType": { "$ref": "238" }, "decorators": [] }, { "$id": "242", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "239" }, "enumType": { "$ref": "238" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "High level guidance for the amount of context window space to use for the\nsearch. One of `low`, `medium`, or `high`. `medium` is the default.", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "243", "kind": "enum", "name": "CreateChatCompletionRequestAudioFormat", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.audio.format.anonymous", "valueType": { "$id": "244", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "245", "kind": "enumvalue", "name": "wav", "value": "wav", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] }, { "$id": "246", "kind": "enumvalue", "name": "aac", "value": "aac", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] }, { "$id": "247", "kind": "enumvalue", "name": "mp3", "value": "mp3", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] }, { "$id": "248", "kind": "enumvalue", "name": "flac", "value": "flac", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] }, { "$id": "249", "kind": "enumvalue", "name": "opus", "value": "opus", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] }, { "$id": "250", "kind": "enumvalue", "name": "pcm16", "value": "pcm16", "valueType": { "$ref": "244" }, "enumType": { "$ref": "243" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "251", "kind": "enum", "name": "ChatOutputPredictionType", "crossLanguageDefinitionId": "OpenAI.ChatOutputPredictionType", "valueType": { "$id": "252", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "253", "kind": "enumvalue", "name": "static_content", "value": "content", "valueType": { "$ref": "252" }, "enumType": { "$ref": "251" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "254", "kind": "enum", "name": "CreateChatCompletionRequestToolChoice", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.tool_choice.anonymous", "valueType": { "$id": "255", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "256", "kind": "enumvalue", "name": "none", "value": "none", "valueType": { "$ref": "255" }, "enumType": { "$ref": "254" }, "decorators": [] }, { "$id": "257", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "255" }, "enumType": { "$ref": "254" }, "decorators": [] }, { "$id": "258", "kind": "enumvalue", "name": "required", "value": "required", "valueType": { "$ref": "255" }, "enumType": { "$ref": "254" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "259", "kind": "enum", "name": "ChatCompletionMessageToolCallChunkType", "crossLanguageDefinitionId": "", "valueType": { "$id": "260", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "261", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$id": "262", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "259" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "263", "kind": "enum", "name": "CreateChatCompletionStreamResponseChoiceFinishReason", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.finish_reason.anonymous", "valueType": { "$id": "264", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "265", "kind": "enumvalue", "name": "stop", "value": "stop", "valueType": { "$ref": "264" }, "enumType": { "$ref": "263" }, "decorators": [] }, { "$id": "266", "kind": "enumvalue", "name": "length", "value": "length", "valueType": { "$ref": "264" }, "enumType": { "$ref": "263" }, "decorators": [] }, { "$id": "267", "kind": "enumvalue", "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "264" }, "enumType": { "$ref": "263" }, "decorators": [] }, { "$id": "268", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "264" }, "enumType": { "$ref": "263" }, "decorators": [] }, { "$id": "269", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "264" }, "enumType": { "$ref": "263" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "270", "kind": "enum", "name": "ContainerResourceExpiresAfterAnchor", "crossLanguageDefinitionId": "", "valueType": { "$id": "271", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "272", "kind": "enumvalue", "name": "last_active_at", "value": "last_active_at", "valueType": { "$id": "273", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "270" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "274", "kind": "enum", "name": "CreateEmbeddingRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.model.anonymous", "valueType": { "$id": "275", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "276", "kind": "enumvalue", "name": "text-embedding-ada-002", "value": "text-embedding-ada-002", "valueType": { "$ref": "275" }, "enumType": { "$ref": "274" }, "decorators": [] }, { "$id": "277", "kind": "enumvalue", "name": "text-embedding-3-small", "value": "text-embedding-3-small", "valueType": { "$ref": "275" }, "enumType": { "$ref": "274" }, "decorators": [] }, { "$id": "278", "kind": "enumvalue", "name": "text-embedding-3-large", "value": "text-embedding-3-large", "valueType": { "$ref": "275" }, "enumType": { "$ref": "274" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "279", "kind": "enum", "name": "CreateEmbeddingRequestEncodingFormat", "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.encoding_format.anonymous", "valueType": { "$id": "280", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "281", "kind": "enumvalue", "name": "float", "value": "float", "valueType": { "$ref": "280" }, "enumType": { "$ref": "279" }, "decorators": [] }, { "$id": "282", "kind": "enumvalue", "name": "base64", "value": "base64", "valueType": { "$ref": "280" }, "enumType": { "$ref": "279" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "283", "kind": "enum", "name": "OpenAIFilePurpose", "crossLanguageDefinitionId": "OpenAI.OpenAIFile.purpose.anonymous", "valueType": { "$id": "284", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "285", "kind": "enumvalue", "name": "assistants", "value": "assistants", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "286", "kind": "enumvalue", "name": "assistants_output", "value": "assistants_output", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "287", "kind": "enumvalue", "name": "batch", "value": "batch", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "288", "kind": "enumvalue", "name": "batch_output", "value": "batch_output", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "289", "kind": "enumvalue", "name": "fine-tune", "value": "fine-tune", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "290", "kind": "enumvalue", "name": "fine-tune-results", "value": "fine-tune-results", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "291", "kind": "enumvalue", "name": "vision", "value": "vision", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "292", "kind": "enumvalue", "name": "user_data", "value": "user_data", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] }, { "$id": "293", "kind": "enumvalue", "name": "evals", "value": "evals", "valueType": { "$ref": "284" }, "enumType": { "$ref": "283" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "294", "kind": "enum", "name": "OpenAIFileStatus", "crossLanguageDefinitionId": "OpenAI.OpenAIFile.status.anonymous", "valueType": { "$id": "295", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "296", "kind": "enumvalue", "name": "uploaded", "value": "uploaded", "valueType": { "$ref": "295" }, "enumType": { "$ref": "294" }, "decorators": [] }, { "$id": "297", "kind": "enumvalue", "name": "processed", "value": "processed", "valueType": { "$ref": "295" }, "enumType": { "$ref": "294" }, "decorators": [] }, { "$id": "298", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "295" }, "enumType": { "$ref": "294" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "299", "kind": "enum", "name": "CreateFileRequestPurpose", "crossLanguageDefinitionId": "OpenAI.CreateFileRequest.purpose.anonymous", "valueType": { "$id": "300", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "301", "kind": "enumvalue", "name": "assistants", "value": "assistants", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] }, { "$id": "302", "kind": "enumvalue", "name": "batch", "value": "batch", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] }, { "$id": "303", "kind": "enumvalue", "name": "fine-tune", "value": "fine-tune", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] }, { "$id": "304", "kind": "enumvalue", "name": "vision", "value": "vision", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] }, { "$id": "305", "kind": "enumvalue", "name": "user_data", "value": "user_data", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] }, { "$id": "306", "kind": "enumvalue", "name": "evals", "value": "evals", "valueType": { "$ref": "300" }, "enumType": { "$ref": "299" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "307", "kind": "enum", "name": "CreateFineTuningJobRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.model.anonymous", "valueType": { "$id": "308", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "309", "kind": "enumvalue", "name": "babbage-002", "value": "babbage-002", "valueType": { "$ref": "308" }, "enumType": { "$ref": "307" }, "decorators": [] }, { "$id": "310", "kind": "enumvalue", "name": "davinci-002", "value": "davinci-002", "valueType": { "$ref": "308" }, "enumType": { "$ref": "307" }, "decorators": [] }, { "$id": "311", "kind": "enumvalue", "name": "gpt-3.5-turbo", "value": "gpt-3.5-turbo", "valueType": { "$ref": "308" }, "enumType": { "$ref": "307" }, "decorators": [] }, { "$id": "312", "kind": "enumvalue", "name": "gpt-4o-mini", "value": "gpt-4o-mini", "valueType": { "$ref": "308" }, "enumType": { "$ref": "307" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "313", "kind": "enum", "name": "CreateFineTuningJobRequestIntegrationType", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestIntegration.type.anonymous", "valueType": { "$id": "314", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "315", "kind": "enumvalue", "name": "wandb", "value": "wandb", "valueType": { "$ref": "314" }, "enumType": { "$ref": "313" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "316", "kind": "enum", "name": "FineTuneMethodType", "crossLanguageDefinitionId": "OpenAI.FineTuneMethod.type.anonymous", "valueType": { "$id": "317", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "318", "kind": "enumvalue", "name": "supervised", "value": "supervised", "valueType": { "$ref": "317" }, "enumType": { "$ref": "316" }, "decorators": [] }, { "$id": "319", "kind": "enumvalue", "name": "dpo", "value": "dpo", "valueType": { "$ref": "317" }, "enumType": { "$ref": "316" }, "decorators": [] }, { "$id": "320", "kind": "enumvalue", "name": "reinforcement", "value": "reinforcement", "valueType": { "$ref": "317" }, "enumType": { "$ref": "316" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "321", "kind": "enum", "name": "GraderStringCheckOperation", "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.operation.anonymous", "valueType": { "$id": "322", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "323", "kind": "enumvalue", "name": "eq", "value": "eq", "valueType": { "$ref": "322" }, "enumType": { "$ref": "321" }, "decorators": [] }, { "$id": "324", "kind": "enumvalue", "name": "ne", "value": "ne", "valueType": { "$ref": "322" }, "enumType": { "$ref": "321" }, "decorators": [] }, { "$id": "325", "kind": "enumvalue", "name": "like", "value": "like", "valueType": { "$ref": "322" }, "enumType": { "$ref": "321" }, "decorators": [] }, { "$id": "326", "kind": "enumvalue", "name": "ilike", "value": "ilike", "valueType": { "$ref": "322" }, "enumType": { "$ref": "321" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "327", "kind": "enum", "name": "GraderType", "crossLanguageDefinitionId": "OpenAI.GraderType", "valueType": { "$id": "328", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "329", "kind": "enumvalue", "name": "string_check", "value": "string_check", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] }, { "$id": "330", "kind": "enumvalue", "name": "text_similarity", "value": "text_similarity", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] }, { "$id": "331", "kind": "enumvalue", "name": "score_model", "value": "score_model", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] }, { "$id": "332", "kind": "enumvalue", "name": "label_model", "value": "label_model", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] }, { "$id": "333", "kind": "enumvalue", "name": "python", "value": "python", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] }, { "$id": "334", "kind": "enumvalue", "name": "multi", "value": "multi", "valueType": { "$ref": "328" }, "enumType": { "$ref": "327" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "335", "kind": "enum", "name": "GraderTextSimilarityEvaluationMetric", "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.evaluation_metric.anonymous", "valueType": { "$id": "336", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "337", "kind": "enumvalue", "name": "fuzzy_match", "value": "fuzzy_match", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "338", "kind": "enumvalue", "name": "bleu", "value": "bleu", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "339", "kind": "enumvalue", "name": "gleu", "value": "gleu", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "340", "kind": "enumvalue", "name": "meteor", "value": "meteor", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "341", "kind": "enumvalue", "name": "rouge_1", "value": "rouge_1", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "342", "kind": "enumvalue", "name": "rouge_2", "value": "rouge_2", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "343", "kind": "enumvalue", "name": "rouge_3", "value": "rouge_3", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "344", "kind": "enumvalue", "name": "rouge_4", "value": "rouge_4", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "345", "kind": "enumvalue", "name": "rouge_5", "value": "rouge_5", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] }, { "$id": "346", "kind": "enumvalue", "name": "rouge_l", "value": "rouge_l", "valueType": { "$ref": "336" }, "enumType": { "$ref": "335" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "347", "kind": "enum", "name": "EvalItemRole", "crossLanguageDefinitionId": "OpenAI.EvalItem.role.anonymous", "valueType": { "$id": "348", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "349", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "348" }, "enumType": { "$ref": "347" }, "decorators": [] }, { "$id": "350", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "348" }, "enumType": { "$ref": "347" }, "decorators": [] }, { "$id": "351", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "348" }, "enumType": { "$ref": "347" }, "decorators": [] }, { "$id": "352", "kind": "enumvalue", "name": "developer", "value": "developer", "valueType": { "$ref": "348" }, "enumType": { "$ref": "347" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "353", "kind": "enum", "name": "EvalItemContentType", "crossLanguageDefinitionId": "OpenAI.EvalItemContentType", "valueType": { "$id": "354", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "355", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "354" }, "enumType": { "$ref": "353" }, "decorators": [] }, { "$id": "356", "kind": "enumvalue", "name": "output_text", "value": "output_text", "valueType": { "$ref": "354" }, "enumType": { "$ref": "353" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "357", "kind": "enum", "name": "EvalItemType", "crossLanguageDefinitionId": "", "valueType": { "$id": "358", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "359", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$id": "360", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "357" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "361", "kind": "enum", "name": "FineTuneReinforcementHyperparametersReasoningEffort", "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.reasoning_effort.anonymous", "valueType": { "$id": "362", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "363", "kind": "enumvalue", "name": "default", "value": "default", "valueType": { "$ref": "362" }, "enumType": { "$ref": "361" }, "decorators": [] }, { "$id": "364", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "362" }, "enumType": { "$ref": "361" }, "decorators": [] }, { "$id": "365", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "362" }, "enumType": { "$ref": "361" }, "decorators": [] }, { "$id": "366", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "362" }, "enumType": { "$ref": "361" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "367", "kind": "enum", "name": "FineTuningJobStatus", "crossLanguageDefinitionId": "OpenAI.FineTuningJob.status.anonymous", "valueType": { "$id": "368", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "369", "kind": "enumvalue", "name": "validating_files", "value": "validating_files", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] }, { "$id": "370", "kind": "enumvalue", "name": "queued", "value": "queued", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] }, { "$id": "371", "kind": "enumvalue", "name": "running", "value": "running", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] }, { "$id": "372", "kind": "enumvalue", "name": "succeeded", "value": "succeeded", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] }, { "$id": "373", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] }, { "$id": "374", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "368" }, "enumType": { "$ref": "367" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "375", "kind": "enum", "name": "FineTuningIntegrationType", "crossLanguageDefinitionId": "OpenAI.FineTuningIntegration.type.anonymous", "valueType": { "$id": "376", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "377", "kind": "enumvalue", "name": "wandb", "value": "wandb", "valueType": { "$ref": "376" }, "enumType": { "$ref": "375" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "378", "kind": "enum", "name": "FineTuningJobEventLevel", "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.level.anonymous", "valueType": { "$id": "379", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "380", "kind": "enumvalue", "name": "info", "value": "info", "valueType": { "$ref": "379" }, "enumType": { "$ref": "378" }, "decorators": [] }, { "$id": "381", "kind": "enumvalue", "name": "warn", "value": "warn", "valueType": { "$ref": "379" }, "enumType": { "$ref": "378" }, "decorators": [] }, { "$id": "382", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "379" }, "enumType": { "$ref": "378" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "383", "kind": "enum", "name": "FineTuningJobEventType", "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.type.anonymous", "valueType": { "$id": "384", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "385", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$ref": "384" }, "enumType": { "$ref": "383" }, "decorators": [] }, { "$id": "386", "kind": "enumvalue", "name": "metrics", "value": "metrics", "valueType": { "$ref": "384" }, "enumType": { "$ref": "383" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "387", "kind": "enum", "name": "EvalDataSourceConfigType", "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigType", "valueType": { "$id": "388", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "389", "kind": "enumvalue", "name": "custom", "value": "custom", "valueType": { "$ref": "388" }, "enumType": { "$ref": "387" }, "decorators": [] }, { "$id": "390", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "388" }, "enumType": { "$ref": "387" }, "decorators": [] }, { "$id": "391", "kind": "enumvalue", "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "388" }, "enumType": { "$ref": "387" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "392", "kind": "enum", "name": "EvalRunDataSourceType", "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceType", "valueType": { "$id": "393", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "394", "kind": "enumvalue", "name": "jsonl", "value": "jsonl", "valueType": { "$ref": "393" }, "enumType": { "$ref": "392" }, "decorators": [] }, { "$id": "395", "kind": "enumvalue", "name": "completions", "value": "completions", "valueType": { "$ref": "393" }, "enumType": { "$ref": "392" }, "decorators": [] }, { "$id": "396", "kind": "enumvalue", "name": "responses", "value": "responses", "valueType": { "$ref": "393" }, "enumType": { "$ref": "392" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "397", "kind": "enum", "name": "EvalRunDataContentSourceType", "crossLanguageDefinitionId": "OpenAI.EvalRunDataContentSourceType", "valueType": { "$id": "398", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "399", "kind": "enumvalue", "name": "file_id", "value": "file_id", "valueType": { "$ref": "398" }, "enumType": { "$ref": "397" }, "decorators": [] }, { "$id": "400", "kind": "enumvalue", "name": "file_content", "value": "file_content", "valueType": { "$ref": "398" }, "enumType": { "$ref": "397" }, "decorators": [] }, { "$id": "401", "kind": "enumvalue", "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "398" }, "enumType": { "$ref": "397" }, "decorators": [] }, { "$id": "402", "kind": "enumvalue", "name": "responses", "value": "responses", "valueType": { "$ref": "398" }, "enumType": { "$ref": "397" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "403", "kind": "enum", "name": "ResponseTextFormatConfigurationType", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationType", "valueType": { "$id": "404", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "405", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "404" }, "enumType": { "$ref": "403" }, "decorators": [] }, { "$id": "406", "kind": "enumvalue", "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "404" }, "enumType": { "$ref": "403" }, "decorators": [] }, { "$id": "407", "kind": "enumvalue", "name": "json_object", "value": "json_object", "valueType": { "$ref": "404" }, "enumType": { "$ref": "403" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "408", "kind": "enum", "name": "ToolType", "crossLanguageDefinitionId": "OpenAI.ToolType", "valueType": { "$id": "409", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "410", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "411", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "412", "kind": "enumvalue", "name": "computer_use_preview", "value": "computer_use_preview", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "413", "kind": "enumvalue", "name": "web_search", "value": "web_search", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "414", "kind": "enumvalue", "name": "web_search_preview", "value": "web_search_preview", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "415", "kind": "enumvalue", "name": "mcp", "value": "mcp", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "416", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "417", "kind": "enumvalue", "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] }, { "$id": "418", "kind": "enumvalue", "name": "local_shell", "value": "local_shell", "valueType": { "$ref": "409" }, "enumType": { "$ref": "408" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "A tool that can be used to generate a response.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "419", "kind": "enum", "name": "RankingOptionsRanker", "crossLanguageDefinitionId": "OpenAI.RankingOptions.ranker.anonymous", "valueType": { "$id": "420", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "421", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "420" }, "enumType": { "$ref": "419" }, "decorators": [] }, { "$id": "422", "kind": "enumvalue", "name": "default-2024-11-15", "value": "default-2024-11-15", "valueType": { "$ref": "420" }, "enumType": { "$ref": "419" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "423", "kind": "enum", "name": "ComparisonFilterType", "crossLanguageDefinitionId": "OpenAI.ComparisonFilter.type.anonymous", "valueType": { "$id": "424", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "425", "kind": "enumvalue", "name": "eq", "value": "eq", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] }, { "$id": "426", "kind": "enumvalue", "name": "ne", "value": "ne", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] }, { "$id": "427", "kind": "enumvalue", "name": "gt", "value": "gt", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] }, { "$id": "428", "kind": "enumvalue", "name": "gte", "value": "gte", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] }, { "$id": "429", "kind": "enumvalue", "name": "lt", "value": "lt", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] }, { "$id": "430", "kind": "enumvalue", "name": "lte", "value": "lte", "valueType": { "$ref": "424" }, "enumType": { "$ref": "423" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "431", "kind": "enum", "name": "CompoundFilterType", "crossLanguageDefinitionId": "OpenAI.CompoundFilter.type.anonymous", "valueType": { "$id": "432", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "433", "kind": "enumvalue", "name": "and", "value": "and", "valueType": { "$ref": "432" }, "enumType": { "$ref": "431" }, "decorators": [] }, { "$id": "434", "kind": "enumvalue", "name": "or", "value": "or", "valueType": { "$ref": "432" }, "enumType": { "$ref": "431" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "435", "kind": "enum", "name": "ComputerUsePreviewToolEnvironment", "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool.environment.anonymous", "valueType": { "$id": "436", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "437", "kind": "enumvalue", "name": "windows", "value": "windows", "valueType": { "$ref": "436" }, "enumType": { "$ref": "435" }, "decorators": [] }, { "$id": "438", "kind": "enumvalue", "name": "mac", "value": "mac", "valueType": { "$ref": "436" }, "enumType": { "$ref": "435" }, "decorators": [] }, { "$id": "439", "kind": "enumvalue", "name": "linux", "value": "linux", "valueType": { "$ref": "436" }, "enumType": { "$ref": "435" }, "decorators": [] }, { "$id": "440", "kind": "enumvalue", "name": "ubuntu", "value": "ubuntu", "valueType": { "$ref": "436" }, "enumType": { "$ref": "435" }, "decorators": [] }, { "$id": "441", "kind": "enumvalue", "name": "browser", "value": "browser", "valueType": { "$ref": "436" }, "enumType": { "$ref": "435" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "442", "kind": "enum", "name": "LocationType", "crossLanguageDefinitionId": "OpenAI.LocationType", "valueType": { "$id": "443", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "444", "kind": "enumvalue", "name": "approximate", "value": "approximate", "valueType": { "$ref": "443" }, "enumType": { "$ref": "442" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "445", "kind": "enum", "name": "SearchContextSize", "crossLanguageDefinitionId": "OpenAI.SearchContextSize", "valueType": { "$id": "446", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "447", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "446" }, "enumType": { "$ref": "445" }, "decorators": [] }, { "$id": "448", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "446" }, "enumType": { "$ref": "445" }, "decorators": [] }, { "$id": "449", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "446" }, "enumType": { "$ref": "445" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "450", "kind": "enum", "name": "CodeInterpreterContainerConfigurationType", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterContainerConfigurationType", "valueType": { "$id": "451", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "452", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "451" }, "enumType": { "$ref": "450" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "453", "kind": "enum", "name": "ImageGenToolModel", "crossLanguageDefinitionId": "", "valueType": { "$id": "454", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "455", "kind": "enumvalue", "name": "gpt-image-1", "value": "gpt-image-1", "valueType": { "$id": "456", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "453" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "457", "kind": "enum", "name": "ImageGenToolQuality", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.quality.anonymous", "valueType": { "$id": "458", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "459", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "458" }, "enumType": { "$ref": "457" }, "decorators": [] }, { "$id": "460", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "458" }, "enumType": { "$ref": "457" }, "decorators": [] }, { "$id": "461", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "458" }, "enumType": { "$ref": "457" }, "decorators": [] }, { "$id": "462", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "458" }, "enumType": { "$ref": "457" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "463", "kind": "enum", "name": "ImageGenToolSize", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.size.anonymous", "valueType": { "$id": "464", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "465", "kind": "enumvalue", "name": "1024x1024", "value": "1024x1024", "valueType": { "$ref": "464" }, "enumType": { "$ref": "463" }, "decorators": [] }, { "$id": "466", "kind": "enumvalue", "name": "1024x1536", "value": "1024x1536", "valueType": { "$ref": "464" }, "enumType": { "$ref": "463" }, "decorators": [] }, { "$id": "467", "kind": "enumvalue", "name": "1536x1024", "value": "1536x1024", "valueType": { "$ref": "464" }, "enumType": { "$ref": "463" }, "decorators": [] }, { "$id": "468", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "464" }, "enumType": { "$ref": "463" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "469", "kind": "enum", "name": "ImageGenToolOutputFormat", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.output_format.anonymous", "valueType": { "$id": "470", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "471", "kind": "enumvalue", "name": "png", "value": "png", "valueType": { "$ref": "470" }, "enumType": { "$ref": "469" }, "decorators": [] }, { "$id": "472", "kind": "enumvalue", "name": "webp", "value": "webp", "valueType": { "$ref": "470" }, "enumType": { "$ref": "469" }, "decorators": [] }, { "$id": "473", "kind": "enumvalue", "name": "jpeg", "value": "jpeg", "valueType": { "$ref": "470" }, "enumType": { "$ref": "469" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "474", "kind": "enum", "name": "ImageGenToolModeration", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.moderation.anonymous", "valueType": { "$id": "475", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "476", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "475" }, "enumType": { "$ref": "474" }, "decorators": [] }, { "$id": "477", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "475" }, "enumType": { "$ref": "474" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "478", "kind": "enum", "name": "ImageGenToolBackground", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.background.anonymous", "valueType": { "$id": "479", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "480", "kind": "enumvalue", "name": "transparent", "value": "transparent", "valueType": { "$ref": "479" }, "enumType": { "$ref": "478" }, "decorators": [] }, { "$id": "481", "kind": "enumvalue", "name": "opaque", "value": "opaque", "valueType": { "$ref": "479" }, "enumType": { "$ref": "478" }, "decorators": [] }, { "$id": "482", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "479" }, "enumType": { "$ref": "478" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "483", "kind": "enum", "name": "ImageGenToolInputFidelity", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_fidelity.anonymous", "valueType": { "$id": "484", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "485", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "484" }, "enumType": { "$ref": "483" }, "decorators": [] }, { "$id": "486", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "484" }, "enumType": { "$ref": "483" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "487", "kind": "enum", "name": "MCPToolConnectorId", "crossLanguageDefinitionId": "OpenAI.MCPTool.connector_id.anonymous", "valueType": { "$id": "488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "489", "kind": "enumvalue", "name": "connector_dropbox", "value": "connector_dropbox", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "490", "kind": "enumvalue", "name": "connector_gmail", "value": "connector_gmail", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "491", "kind": "enumvalue", "name": "connector_googlecalendar", "value": "connector_googlecalendar", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "492", "kind": "enumvalue", "name": "connector_googledrive", "value": "connector_googledrive", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "493", "kind": "enumvalue", "name": "connector_microsoftteams", "value": "connector_microsoftteams", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "494", "kind": "enumvalue", "name": "connector_outlookcalendar", "value": "connector_outlookcalendar", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "495", "kind": "enumvalue", "name": "connector_outlookemail", "value": "connector_outlookemail", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] }, { "$id": "496", "kind": "enumvalue", "name": "connector_sharepoint", "value": "connector_sharepoint", "valueType": { "$ref": "488" }, "enumType": { "$ref": "487" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "497", "kind": "enum", "name": "DotNetResponseServiceTier", "crossLanguageDefinitionId": "OpenAI.DotNetResponseServiceTier", "valueType": { "$id": "498", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "499", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "498" }, "enumType": { "$ref": "497" }, "decorators": [] }, { "$id": "500", "kind": "enumvalue", "name": "default", "value": "default", "valueType": { "$ref": "498" }, "enumType": { "$ref": "497" }, "decorators": [] }, { "$id": "501", "kind": "enumvalue", "name": "flex", "value": "flex", "valueType": { "$ref": "498" }, "enumType": { "$ref": "497" }, "decorators": [] }, { "$id": "502", "kind": "enumvalue", "name": "scale", "value": "scale", "valueType": { "$ref": "498" }, "enumType": { "$ref": "497" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "503", "kind": "enum", "name": "ReasoningSummary", "crossLanguageDefinitionId": "OpenAI.Reasoning.summary.anonymous", "valueType": { "$id": "504", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "505", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "504" }, "enumType": { "$ref": "503" }, "decorators": [] }, { "$id": "506", "kind": "enumvalue", "name": "concise", "value": "concise", "valueType": { "$ref": "504" }, "enumType": { "$ref": "503" }, "decorators": [] }, { "$id": "507", "kind": "enumvalue", "name": "detailed", "value": "detailed", "valueType": { "$ref": "504" }, "enumType": { "$ref": "503" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "508", "kind": "enum", "name": "ReasoningGenerateSummary", "crossLanguageDefinitionId": "OpenAI.Reasoning.generate_summary.anonymous", "valueType": { "$id": "509", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "510", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "509" }, "enumType": { "$ref": "508" }, "decorators": [] }, { "$id": "511", "kind": "enumvalue", "name": "concise", "value": "concise", "valueType": { "$ref": "509" }, "enumType": { "$ref": "508" }, "decorators": [] }, { "$id": "512", "kind": "enumvalue", "name": "detailed", "value": "detailed", "valueType": { "$ref": "509" }, "enumType": { "$ref": "508" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "513", "kind": "enum", "name": "ToolChoiceOptions", "crossLanguageDefinitionId": "OpenAI.ToolChoiceOptions", "valueType": { "$id": "514", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "515", "kind": "enumvalue", "name": "none", "value": "none", "valueType": { "$ref": "514" }, "enumType": { "$ref": "513" }, "decorators": [] }, { "$id": "516", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "514" }, "enumType": { "$ref": "513" }, "decorators": [] }, { "$id": "517", "kind": "enumvalue", "name": "required", "value": "required", "valueType": { "$ref": "514" }, "enumType": { "$ref": "513" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "518", "kind": "enum", "name": "ToolChoiceObjectType", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectType", "valueType": { "$id": "519", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "520", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "521", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "522", "kind": "enumvalue", "name": "computer", "value": "computer_use_preview", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "523", "kind": "enumvalue", "name": "web_search", "value": "web_search_preview", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "524", "kind": "enumvalue", "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "525", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] }, { "$id": "526", "kind": "enumvalue", "name": "mcp", "value": "mcp", "valueType": { "$ref": "519" }, "enumType": { "$ref": "518" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "527", "kind": "enum", "name": "CreateResponseTruncation", "crossLanguageDefinitionId": "OpenAI.CreateResponse.truncation.anonymous", "valueType": { "$id": "528", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "529", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "528" }, "enumType": { "$ref": "527" }, "decorators": [] }, { "$id": "530", "kind": "enumvalue", "name": "disabled", "value": "disabled", "valueType": { "$ref": "528" }, "enumType": { "$ref": "527" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "531", "kind": "enum", "name": "ItemContentType", "crossLanguageDefinitionId": "OpenAI.ItemContentType", "valueType": { "$id": "532", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "533", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "534", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "535", "kind": "enumvalue", "name": "input_image", "value": "input_image", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "536", "kind": "enumvalue", "name": "input_file", "value": "input_file", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "537", "kind": "enumvalue", "name": "output_text", "value": "output_text", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "538", "kind": "enumvalue", "name": "output_audio", "value": "output_audio", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] }, { "$id": "539", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "532" }, "enumType": { "$ref": "531" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "Multi-modal input and output contents.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "540", "kind": "enum", "name": "ItemContentInputAudioFormat", "crossLanguageDefinitionId": "OpenAI.ItemContentInputAudio.format.anonymous", "valueType": { "$id": "541", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "542", "kind": "enumvalue", "name": "mp3", "value": "mp3", "valueType": { "$ref": "541" }, "enumType": { "$ref": "540" }, "decorators": [] }, { "$id": "543", "kind": "enumvalue", "name": "wav", "value": "wav", "valueType": { "$ref": "541" }, "enumType": { "$ref": "540" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "544", "kind": "enum", "name": "ItemContentInputImageDetail", "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage.detail.anonymous", "valueType": { "$id": "545", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "546", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "545" }, "enumType": { "$ref": "544" }, "decorators": [] }, { "$id": "547", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "545" }, "enumType": { "$ref": "544" }, "decorators": [] }, { "$id": "548", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "545" }, "enumType": { "$ref": "544" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "549", "kind": "enum", "name": "AnnotationType", "crossLanguageDefinitionId": "OpenAI.AnnotationType", "valueType": { "$id": "550", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "551", "kind": "enumvalue", "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "550" }, "enumType": { "$ref": "549" }, "decorators": [] }, { "$id": "552", "kind": "enumvalue", "name": "url_citation", "value": "url_citation", "valueType": { "$ref": "550" }, "enumType": { "$ref": "549" }, "decorators": [] }, { "$id": "553", "kind": "enumvalue", "name": "file_path", "value": "file_path", "valueType": { "$ref": "550" }, "enumType": { "$ref": "549" }, "decorators": [] }, { "$id": "554", "kind": "enumvalue", "name": "container_file_citation", "value": "container_file_citation", "valueType": { "$ref": "550" }, "enumType": { "$ref": "549" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "555", "kind": "enum", "name": "ItemType", "crossLanguageDefinitionId": "OpenAI.ItemType", "valueType": { "$id": "556", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "557", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "558", "kind": "enumvalue", "name": "file_search_call", "value": "file_search_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "559", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "560", "kind": "enumvalue", "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "561", "kind": "enumvalue", "name": "computer_call", "value": "computer_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "562", "kind": "enumvalue", "name": "computer_call_output", "value": "computer_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "563", "kind": "enumvalue", "name": "web_search_call", "value": "web_search_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "564", "kind": "enumvalue", "name": "reasoning", "value": "reasoning", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "565", "kind": "enumvalue", "name": "item_reference", "value": "item_reference", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "566", "kind": "enumvalue", "name": "image_generation_call", "value": "image_generation_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "567", "kind": "enumvalue", "name": "code_interpreter_call", "value": "code_interpreter_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "568", "kind": "enumvalue", "name": "local_shell_call", "value": "local_shell_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "569", "kind": "enumvalue", "name": "local_shell_call_output", "value": "local_shell_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "570", "kind": "enumvalue", "name": "mcp_list_tools", "value": "mcp_list_tools", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "571", "kind": "enumvalue", "name": "mcp_approval_request", "value": "mcp_approval_request", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "572", "kind": "enumvalue", "name": "mcp_approval_response", "value": "mcp_approval_response", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] }, { "$id": "573", "kind": "enumvalue", "name": "mcp_call", "value": "mcp_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "555" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "574", "kind": "enum", "name": "ResponsesMessageRole", "crossLanguageDefinitionId": "OpenAI.ResponsesMessageRole", "valueType": { "$id": "575", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "576", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "575" }, "enumType": { "$ref": "574" }, "decorators": [] }, { "$id": "577", "kind": "enumvalue", "name": "developer", "value": "developer", "valueType": { "$ref": "575" }, "enumType": { "$ref": "574" }, "decorators": [] }, { "$id": "578", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "575" }, "enumType": { "$ref": "574" }, "decorators": [] }, { "$id": "579", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "575" }, "enumType": { "$ref": "574" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "The collection of valid roles for responses message items.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "580", "kind": "enum", "name": "ComputerActionType", "crossLanguageDefinitionId": "OpenAI.ComputerActionType", "valueType": { "$id": "581", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "582", "kind": "enumvalue", "name": "screenshot", "value": "screenshot", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "583", "kind": "enumvalue", "name": "click", "value": "click", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "584", "kind": "enumvalue", "name": "double_click", "value": "double_click", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "585", "kind": "enumvalue", "name": "scroll", "value": "scroll", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "586", "kind": "enumvalue", "name": "type", "value": "type", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "587", "kind": "enumvalue", "name": "wait", "value": "wait", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "588", "kind": "enumvalue", "name": "keypress", "value": "keypress", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "589", "kind": "enumvalue", "name": "drag", "value": "drag", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] }, { "$id": "590", "kind": "enumvalue", "name": "move", "value": "move", "valueType": { "$ref": "581" }, "enumType": { "$ref": "580" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "591", "kind": "enum", "name": "ComputerActionClickButton", "crossLanguageDefinitionId": "OpenAI.ComputerActionClick.button.anonymous", "valueType": { "$id": "592", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "593", "kind": "enumvalue", "name": "left", "value": "left", "valueType": { "$ref": "592" }, "enumType": { "$ref": "591" }, "decorators": [] }, { "$id": "594", "kind": "enumvalue", "name": "right", "value": "right", "valueType": { "$ref": "592" }, "enumType": { "$ref": "591" }, "decorators": [] }, { "$id": "595", "kind": "enumvalue", "name": "wheel", "value": "wheel", "valueType": { "$ref": "592" }, "enumType": { "$ref": "591" }, "decorators": [] }, { "$id": "596", "kind": "enumvalue", "name": "back", "value": "back", "valueType": { "$ref": "592" }, "enumType": { "$ref": "591" }, "decorators": [] }, { "$id": "597", "kind": "enumvalue", "name": "forward", "value": "forward", "valueType": { "$ref": "592" }, "enumType": { "$ref": "591" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "598", "kind": "enum", "name": "ComputerToolCallOutputItemOutputType", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputType", "valueType": { "$id": "599", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "600", "kind": "enumvalue", "name": "screenshot", "value": "computer_screenshot", "valueType": { "$ref": "599" }, "enumType": { "$ref": "598" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "A computer screenshot image used with the computer use tool.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "601", "kind": "enum", "name": "ReasoningItemSummaryPartType", "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryPartType", "valueType": { "$id": "602", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "603", "kind": "enumvalue", "name": "summary_text", "value": "summary_text", "valueType": { "$ref": "602" }, "enumType": { "$ref": "601" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "604", "kind": "enum", "name": "CodeInterpreterToolOutputType", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolOutputType", "valueType": { "$id": "605", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "606", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "605" }, "enumType": { "$ref": "604" }, "decorators": [] }, { "$id": "607", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "605" }, "enumType": { "$ref": "604" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "608", "kind": "enum", "name": "Includable", "crossLanguageDefinitionId": "OpenAI.Includable", "valueType": { "$id": "609", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "610", "kind": "enumvalue", "name": "file_search_call.results", "value": "file_search_call.results", "valueType": { "$ref": "609" }, "enumType": { "$ref": "608" }, "decorators": [] }, { "$id": "611", "kind": "enumvalue", "name": "message.input_image.image_url", "value": "message.input_image.image_url", "valueType": { "$ref": "609" }, "enumType": { "$ref": "608" }, "decorators": [] }, { "$id": "612", "kind": "enumvalue", "name": "computer_call_output.output.image_url", "value": "computer_call_output.output.image_url", "valueType": { "$ref": "609" }, "enumType": { "$ref": "608" }, "decorators": [] }, { "$id": "613", "kind": "enumvalue", "name": "reasoning.encrypted_content", "value": "reasoning.encrypted_content", "valueType": { "$ref": "609" }, "enumType": { "$ref": "608" }, "decorators": [] }, { "$id": "614", "kind": "enumvalue", "name": "code_interpreter_call.outputs", "value": "code_interpreter_call.outputs", "valueType": { "$ref": "609" }, "enumType": { "$ref": "608" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "Specify additional output data to include in the model response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning\n tokens in reasoning item outputs. This enables reasoning items to be used in\n multi-turn conversations when using the Responses API statelessly (like\n when the `store` parameter is set to `false`, or when an organization is\n enrolled in the zero data retention program).\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution\n in code interpreter tool call items.", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "615", "kind": "enum", "name": "ResponseStatus", "crossLanguageDefinitionId": "OpenAI.Response.status.anonymous", "valueType": { "$id": "616", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "617", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] }, { "$id": "618", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] }, { "$id": "619", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] }, { "$id": "620", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] }, { "$id": "621", "kind": "enumvalue", "name": "queued", "value": "queued", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] }, { "$id": "622", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "616" }, "enumType": { "$ref": "615" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "623", "kind": "enum", "name": "ResponseErrorCode", "crossLanguageDefinitionId": "OpenAI.ResponseErrorCode", "valueType": { "$id": "624", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "625", "kind": "enumvalue", "name": "server_error", "value": "server_error", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "626", "kind": "enumvalue", "name": "rate_limit_exceeded", "value": "rate_limit_exceeded", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "627", "kind": "enumvalue", "name": "invalid_prompt", "value": "invalid_prompt", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "628", "kind": "enumvalue", "name": "vector_store_timeout", "value": "vector_store_timeout", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "629", "kind": "enumvalue", "name": "invalid_image", "value": "invalid_image", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "630", "kind": "enumvalue", "name": "invalid_image_format", "value": "invalid_image_format", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "631", "kind": "enumvalue", "name": "invalid_base64_image", "value": "invalid_base64_image", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "632", "kind": "enumvalue", "name": "invalid_image_url", "value": "invalid_image_url", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "633", "kind": "enumvalue", "name": "image_too_large", "value": "image_too_large", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "634", "kind": "enumvalue", "name": "image_too_small", "value": "image_too_small", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "635", "kind": "enumvalue", "name": "image_parse_error", "value": "image_parse_error", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "636", "kind": "enumvalue", "name": "image_content_policy_violation", "value": "image_content_policy_violation", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "637", "kind": "enumvalue", "name": "invalid_image_mode", "value": "invalid_image_mode", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "638", "kind": "enumvalue", "name": "image_file_too_large", "value": "image_file_too_large", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "639", "kind": "enumvalue", "name": "unsupported_image_media_type", "value": "unsupported_image_media_type", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "640", "kind": "enumvalue", "name": "empty_image_file", "value": "empty_image_file", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "641", "kind": "enumvalue", "name": "failed_to_download_image", "value": "failed_to_download_image", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] }, { "$id": "642", "kind": "enumvalue", "name": "image_file_not_found", "value": "image_file_not_found", "valueType": { "$ref": "624" }, "enumType": { "$ref": "623" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "The error code for the response.", "isFixed": true, "isFlags": false, "usage": "Output,Json,Exception", "decorators": [] }, { "$id": "643", "kind": "enum", "name": "ResponseIncompleteDetailsReason", "crossLanguageDefinitionId": "OpenAI.Response.incomplete_details.reason.anonymous", "valueType": { "$id": "644", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "645", "kind": "enumvalue", "name": "max_output_tokens", "value": "max_output_tokens", "valueType": { "$ref": "644" }, "enumType": { "$ref": "643" }, "decorators": [] }, { "$id": "646", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "644" }, "enumType": { "$ref": "643" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "647", "kind": "enum", "name": "ResponsesMessageItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemResource.status.anonymous", "valueType": { "$id": "648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "649", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "648" }, "enumType": { "$ref": "647" }, "decorators": [] }, { "$id": "650", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "648" }, "enumType": { "$ref": "647" }, "decorators": [] }, { "$id": "651", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "648" }, "enumType": { "$ref": "647" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "652", "kind": "enum", "name": "ComputerToolCallOutputItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.status.anonymous", "valueType": { "$id": "653", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "654", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "653" }, "enumType": { "$ref": "652" }, "decorators": [] }, { "$id": "655", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "653" }, "enumType": { "$ref": "652" }, "decorators": [] }, { "$id": "656", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "653" }, "enumType": { "$ref": "652" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "657", "kind": "enum", "name": "FunctionToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.status.anonymous", "valueType": { "$id": "658", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "659", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "658" }, "enumType": { "$ref": "657" }, "decorators": [] }, { "$id": "660", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "658" }, "enumType": { "$ref": "657" }, "decorators": [] }, { "$id": "661", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "658" }, "enumType": { "$ref": "657" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "662", "kind": "enum", "name": "FunctionToolCallOutputItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource.status.anonymous", "valueType": { "$id": "663", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "664", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "663" }, "enumType": { "$ref": "662" }, "decorators": [] }, { "$id": "665", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "663" }, "enumType": { "$ref": "662" }, "decorators": [] }, { "$id": "666", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "663" }, "enumType": { "$ref": "662" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "667", "kind": "enum", "name": "FileSearchToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.status.anonymous", "valueType": { "$id": "668", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "669", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "668" }, "enumType": { "$ref": "667" }, "decorators": [] }, { "$id": "670", "kind": "enumvalue", "name": "searching", "value": "searching", "valueType": { "$ref": "668" }, "enumType": { "$ref": "667" }, "decorators": [] }, { "$id": "671", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "668" }, "enumType": { "$ref": "667" }, "decorators": [] }, { "$id": "672", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "668" }, "enumType": { "$ref": "667" }, "decorators": [] }, { "$id": "673", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "668" }, "enumType": { "$ref": "667" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "674", "kind": "enum", "name": "ComputerToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.status.anonymous", "valueType": { "$id": "675", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "676", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "675" }, "enumType": { "$ref": "674" }, "decorators": [] }, { "$id": "677", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "675" }, "enumType": { "$ref": "674" }, "decorators": [] }, { "$id": "678", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "675" }, "enumType": { "$ref": "674" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "679", "kind": "enum", "name": "WebSearchToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemResource.status.anonymous", "valueType": { "$id": "680", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "681", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "680" }, "enumType": { "$ref": "679" }, "decorators": [] }, { "$id": "682", "kind": "enumvalue", "name": "searching", "value": "searching", "valueType": { "$ref": "680" }, "enumType": { "$ref": "679" }, "decorators": [] }, { "$id": "683", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "680" }, "enumType": { "$ref": "679" }, "decorators": [] }, { "$id": "684", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "680" }, "enumType": { "$ref": "679" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "685", "kind": "enum", "name": "ReasoningItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource.status.anonymous", "valueType": { "$id": "686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "687", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "686" }, "enumType": { "$ref": "685" }, "decorators": [] }, { "$id": "688", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "686" }, "enumType": { "$ref": "685" }, "decorators": [] }, { "$id": "689", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "686" }, "enumType": { "$ref": "685" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "690", "kind": "enum", "name": "ImageGenToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemResource.status.anonymous", "valueType": { "$id": "691", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "692", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "691" }, "enumType": { "$ref": "690" }, "decorators": [] }, { "$id": "693", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "691" }, "enumType": { "$ref": "690" }, "decorators": [] }, { "$id": "694", "kind": "enumvalue", "name": "generating", "value": "generating", "valueType": { "$ref": "691" }, "enumType": { "$ref": "690" }, "decorators": [] }, { "$id": "695", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "691" }, "enumType": { "$ref": "690" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "696", "kind": "enum", "name": "CodeInterpreterToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.status.anonymous", "valueType": { "$id": "697", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "698", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "697" }, "enumType": { "$ref": "696" }, "decorators": [] }, { "$id": "699", "kind": "enumvalue", "name": "interpreting", "value": "interpreting", "valueType": { "$ref": "697" }, "enumType": { "$ref": "696" }, "decorators": [] }, { "$id": "700", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "697" }, "enumType": { "$ref": "696" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "701", "kind": "enum", "name": "LocalShellToolCallItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource.status.anonymous", "valueType": { "$id": "702", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "703", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "702" }, "enumType": { "$ref": "701" }, "decorators": [] }, { "$id": "704", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "702" }, "enumType": { "$ref": "701" }, "decorators": [] }, { "$id": "705", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "702" }, "enumType": { "$ref": "701" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "706", "kind": "enum", "name": "LocalShellToolCallOutputItemResourceStatus", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemResource.status.anonymous", "valueType": { "$id": "707", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "708", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "707" }, "enumType": { "$ref": "706" }, "decorators": [] }, { "$id": "709", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "707" }, "enumType": { "$ref": "706" }, "decorators": [] }, { "$id": "710", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "707" }, "enumType": { "$ref": "706" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "711", "kind": "enum", "name": "ResponseStreamEventType", "crossLanguageDefinitionId": "OpenAI.ResponseStreamEventType", "valueType": { "$id": "712", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "713", "kind": "enumvalue", "name": "response_audio_delta", "value": "response.audio.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "714", "kind": "enumvalue", "name": "response_audio_done", "value": "response.audio.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "715", "kind": "enumvalue", "name": "response_audio_transcript_delta", "value": "response.audio_transcript.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "716", "kind": "enumvalue", "name": "response_audio_transcript_done", "value": "response.audio_transcript.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "717", "kind": "enumvalue", "name": "response_code_interpreter_call_code_delta", "value": "response.code_interpreter_call_code.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "718", "kind": "enumvalue", "name": "response_code_interpreter_call_code_done", "value": "response.code_interpreter_call_code.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "719", "kind": "enumvalue", "name": "response_code_interpreter_call_completed", "value": "response.code_interpreter_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "720", "kind": "enumvalue", "name": "response_code_interpreter_call_in_progress", "value": "response.code_interpreter_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "721", "kind": "enumvalue", "name": "response_code_interpreter_call_interpreting", "value": "response.code_interpreter_call.interpreting", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "722", "kind": "enumvalue", "name": "response_completed", "value": "response.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "723", "kind": "enumvalue", "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "724", "kind": "enumvalue", "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "725", "kind": "enumvalue", "name": "response_created", "value": "response.created", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "726", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "727", "kind": "enumvalue", "name": "response_file_search_call_completed", "value": "response.file_search_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "728", "kind": "enumvalue", "name": "response_file_search_call_in_progress", "value": "response.file_search_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "729", "kind": "enumvalue", "name": "response_file_search_call_searching", "value": "response.file_search_call.searching", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "730", "kind": "enumvalue", "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "731", "kind": "enumvalue", "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "732", "kind": "enumvalue", "name": "response_in_progress", "value": "response.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "733", "kind": "enumvalue", "name": "response_failed", "value": "response.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "734", "kind": "enumvalue", "name": "response_incomplete", "value": "response.incomplete", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "735", "kind": "enumvalue", "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "736", "kind": "enumvalue", "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "737", "kind": "enumvalue", "name": "response_refusal_delta", "value": "response.refusal.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "738", "kind": "enumvalue", "name": "response_refusal_done", "value": "response.refusal.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "739", "kind": "enumvalue", "name": "response_output_text_annotation_added", "value": "response.output_text.annotation.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "740", "kind": "enumvalue", "name": "response_output_text_delta", "value": "response.output_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "741", "kind": "enumvalue", "name": "response_output_text_done", "value": "response.output_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "742", "kind": "enumvalue", "name": "response_reasoning_summary_part_added", "value": "response.reasoning_summary_part.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "743", "kind": "enumvalue", "name": "response_reasoning_summary_part_done", "value": "response.reasoning_summary_part.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "744", "kind": "enumvalue", "name": "response_reasoning_summary_text_delta", "value": "response.reasoning_summary_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "745", "kind": "enumvalue", "name": "response_reasoning_summary_text_done", "value": "response.reasoning_summary_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "746", "kind": "enumvalue", "name": "response_web_search_call_completed", "value": "response.web_search_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "747", "kind": "enumvalue", "name": "response_web_search_call_in_progress", "value": "response.web_search_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "748", "kind": "enumvalue", "name": "response_web_search_call_searching", "value": "response.web_search_call.searching", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "749", "kind": "enumvalue", "name": "response_image_generation_call_completed", "value": "response.image_generation_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "750", "kind": "enumvalue", "name": "response_image_generation_call_generating", "value": "response.image_generation_call.generating", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "751", "kind": "enumvalue", "name": "response_image_generation_call_in_progress", "value": "response.image_generation_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "752", "kind": "enumvalue", "name": "response_image_generation_call_partial_image", "value": "response.image_generation_call.partial_image", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "753", "kind": "enumvalue", "name": "response_mcp_call_arguments_delta", "value": "response.mcp_call_arguments.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "754", "kind": "enumvalue", "name": "response_mcp_call_arguments_done", "value": "response.mcp_call_arguments.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "755", "kind": "enumvalue", "name": "response_mcp_call_completed", "value": "response.mcp_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "756", "kind": "enumvalue", "name": "response_mcp_call_failed", "value": "response.mcp_call.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "757", "kind": "enumvalue", "name": "response_mcp_call_in_progress", "value": "response.mcp_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "758", "kind": "enumvalue", "name": "response_mcp_list_tools_completed", "value": "response.mcp_list_tools.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "759", "kind": "enumvalue", "name": "response_mcp_list_tools_failed", "value": "response.mcp_list_tools.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "760", "kind": "enumvalue", "name": "response_mcp_list_tools_in_progress", "value": "response.mcp_list_tools.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "761", "kind": "enumvalue", "name": "response_queued", "value": "response.queued", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "762", "kind": "enumvalue", "name": "response_reasoning_delta", "value": "response.reasoning.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "763", "kind": "enumvalue", "name": "response_reasoning_done", "value": "response.reasoning.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "764", "kind": "enumvalue", "name": "response_reasoning_summary_delta", "value": "response.reasoning_summary.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "765", "kind": "enumvalue", "name": "response_reasoning_summary_done", "value": "response.reasoning_summary.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "766", "kind": "enumvalue", "name": "response_reasoning_text_delta", "value": "response.reasoning_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] }, { "$id": "767", "kind": "enumvalue", "name": "response_reasoning_text_done", "value": "response.reasoning_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "711" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "768", "kind": "enum", "name": "CreateImageRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.model.anonymous", "valueType": { "$id": "769", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "770", "kind": "enumvalue", "name": "dall-e-2", "value": "dall-e-2", "valueType": { "$ref": "769" }, "enumType": { "$ref": "768" }, "decorators": [] }, { "$id": "771", "kind": "enumvalue", "name": "dall-e-3", "value": "dall-e-3", "valueType": { "$ref": "769" }, "enumType": { "$ref": "768" }, "decorators": [] }, { "$id": "772", "kind": "enumvalue", "name": "gpt-image-1", "value": "gpt-image-1", "valueType": { "$ref": "769" }, "enumType": { "$ref": "768" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "773", "kind": "enum", "name": "CreateImageRequestQuality", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.quality.anonymous", "valueType": { "$id": "774", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "775", "kind": "enumvalue", "name": "standard", "value": "standard", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] }, { "$id": "776", "kind": "enumvalue", "name": "hd", "value": "hd", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] }, { "$id": "777", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] }, { "$id": "778", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] }, { "$id": "779", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] }, { "$id": "780", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "774" }, "enumType": { "$ref": "773" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "781", "kind": "enum", "name": "CreateImageRequestResponseFormat", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.response_format.anonymous", "valueType": { "$id": "782", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "783", "kind": "enumvalue", "name": "url", "value": "url", "valueType": { "$ref": "782" }, "enumType": { "$ref": "781" }, "decorators": [] }, { "$id": "784", "kind": "enumvalue", "name": "b64_json", "value": "b64_json", "valueType": { "$ref": "782" }, "enumType": { "$ref": "781" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "785", "kind": "enum", "name": "CreateImageRequestOutputFormat", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.output_format.anonymous", "valueType": { "$id": "786", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "787", "kind": "enumvalue", "name": "png", "value": "png", "valueType": { "$ref": "786" }, "enumType": { "$ref": "785" }, "decorators": [] }, { "$id": "788", "kind": "enumvalue", "name": "jpeg", "value": "jpeg", "valueType": { "$ref": "786" }, "enumType": { "$ref": "785" }, "decorators": [] }, { "$id": "789", "kind": "enumvalue", "name": "webp", "value": "webp", "valueType": { "$ref": "786" }, "enumType": { "$ref": "785" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "790", "kind": "enum", "name": "CreateImageRequestSize", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.size.anonymous", "valueType": { "$id": "791", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "792", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "793", "kind": "enumvalue", "name": "1024x1024", "value": "1024x1024", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "794", "kind": "enumvalue", "name": "1536x1024", "value": "1536x1024", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "795", "kind": "enumvalue", "name": "1024x1536", "value": "1024x1536", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "796", "kind": "enumvalue", "name": "256x256", "value": "256x256", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "797", "kind": "enumvalue", "name": "512x512", "value": "512x512", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "798", "kind": "enumvalue", "name": "1792x1024", "value": "1792x1024", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] }, { "$id": "799", "kind": "enumvalue", "name": "1024x1792", "value": "1024x1792", "valueType": { "$ref": "791" }, "enumType": { "$ref": "790" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "800", "kind": "enum", "name": "CreateImageRequestModeration", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.moderation.anonymous", "valueType": { "$id": "801", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "802", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "801" }, "enumType": { "$ref": "800" }, "decorators": [] }, { "$id": "803", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "801" }, "enumType": { "$ref": "800" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "804", "kind": "enum", "name": "CreateImageRequestBackground", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.background.anonymous", "valueType": { "$id": "805", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "806", "kind": "enumvalue", "name": "transparent", "value": "transparent", "valueType": { "$ref": "805" }, "enumType": { "$ref": "804" }, "decorators": [] }, { "$id": "807", "kind": "enumvalue", "name": "opaque", "value": "opaque", "valueType": { "$ref": "805" }, "enumType": { "$ref": "804" }, "decorators": [] }, { "$id": "808", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "805" }, "enumType": { "$ref": "804" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "809", "kind": "enum", "name": "CreateImageRequestStyle", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.style.anonymous", "valueType": { "$id": "810", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "811", "kind": "enumvalue", "name": "vivid", "value": "vivid", "valueType": { "$ref": "810" }, "enumType": { "$ref": "809" }, "decorators": [] }, { "$id": "812", "kind": "enumvalue", "name": "natural", "value": "natural", "valueType": { "$ref": "810" }, "enumType": { "$ref": "809" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "813", "kind": "enum", "name": "CreateImageEditRequestBackground", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.background.anonymous", "valueType": { "$id": "814", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "815", "kind": "enumvalue", "name": "transparent", "value": "transparent", "valueType": { "$ref": "814" }, "enumType": { "$ref": "813" }, "decorators": [] }, { "$id": "816", "kind": "enumvalue", "name": "opaque", "value": "opaque", "valueType": { "$ref": "814" }, "enumType": { "$ref": "813" }, "decorators": [] }, { "$id": "817", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "814" }, "enumType": { "$ref": "813" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "818", "kind": "enum", "name": "CreateImageEditRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.model.anonymous", "valueType": { "$id": "819", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "820", "kind": "enumvalue", "name": "dall-e-2", "value": "dall-e-2", "valueType": { "$ref": "819" }, "enumType": { "$ref": "818" }, "decorators": [] }, { "$id": "821", "kind": "enumvalue", "name": "gpt-image-1", "value": "gpt-image-1", "valueType": { "$ref": "819" }, "enumType": { "$ref": "818" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "822", "kind": "enum", "name": "CreateImageEditRequestSize", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.size.anonymous", "valueType": { "$id": "823", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "824", "kind": "enumvalue", "name": "256x256", "value": "256x256", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] }, { "$id": "825", "kind": "enumvalue", "name": "512x512", "value": "512x512", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] }, { "$id": "826", "kind": "enumvalue", "name": "1024x1024", "value": "1024x1024", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] }, { "$id": "827", "kind": "enumvalue", "name": "1536x1024", "value": "1536x1024", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] }, { "$id": "828", "kind": "enumvalue", "name": "1024x1536", "value": "1024x1536", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] }, { "$id": "829", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "823" }, "enumType": { "$ref": "822" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "830", "kind": "enum", "name": "CreateImageEditRequestResponseFormat", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.response_format.anonymous", "valueType": { "$id": "831", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "832", "kind": "enumvalue", "name": "url", "value": "url", "valueType": { "$ref": "831" }, "enumType": { "$ref": "830" }, "decorators": [] }, { "$id": "833", "kind": "enumvalue", "name": "b64_json", "value": "b64_json", "valueType": { "$ref": "831" }, "enumType": { "$ref": "830" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "834", "kind": "enum", "name": "CreateImageEditRequestQuality", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.quality.anonymous", "valueType": { "$id": "835", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "836", "kind": "enumvalue", "name": "standard", "value": "standard", "valueType": { "$ref": "835" }, "enumType": { "$ref": "834" }, "decorators": [] }, { "$id": "837", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "835" }, "enumType": { "$ref": "834" }, "decorators": [] }, { "$id": "838", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "835" }, "enumType": { "$ref": "834" }, "decorators": [] }, { "$id": "839", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "835" }, "enumType": { "$ref": "834" }, "decorators": [] }, { "$id": "840", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "835" }, "enumType": { "$ref": "834" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "841", "kind": "enum", "name": "CreateImageVariationRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.model.anonymous", "valueType": { "$id": "842", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "843", "kind": "enumvalue", "name": "dall-e-2", "value": "dall-e-2", "valueType": { "$ref": "842" }, "enumType": { "$ref": "841" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "844", "kind": "enum", "name": "CreateImageVariationRequestResponseFormat", "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.response_format.anonymous", "valueType": { "$id": "845", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "846", "kind": "enumvalue", "name": "url", "value": "url", "valueType": { "$ref": "845" }, "enumType": { "$ref": "844" }, "decorators": [] }, { "$id": "847", "kind": "enumvalue", "name": "b64_json", "value": "b64_json", "valueType": { "$ref": "845" }, "enumType": { "$ref": "844" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "848", "kind": "enum", "name": "CreateImageVariationRequestSize", "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.size.anonymous", "valueType": { "$id": "849", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "850", "kind": "enumvalue", "name": "256x256", "value": "256x256", "valueType": { "$ref": "849" }, "enumType": { "$ref": "848" }, "decorators": [] }, { "$id": "851", "kind": "enumvalue", "name": "512x512", "value": "512x512", "valueType": { "$ref": "849" }, "enumType": { "$ref": "848" }, "decorators": [] }, { "$id": "852", "kind": "enumvalue", "name": "1024x1024", "value": "1024x1024", "valueType": { "$ref": "849" }, "enumType": { "$ref": "848" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "853", "kind": "enum", "name": "CreateMessageRequestRole", "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.role.anonymous", "valueType": { "$id": "854", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "855", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "854" }, "enumType": { "$ref": "853" }, "decorators": [] }, { "$id": "856", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "854" }, "enumType": { "$ref": "853" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "857", "kind": "enum", "name": "MessageContentType", "crossLanguageDefinitionId": "OpenAI.MessageContentType", "valueType": { "$id": "858", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "859", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "858" }, "enumType": { "$ref": "857" }, "doc": "The content is a text message.", "decorators": [] }, { "$id": "860", "kind": "enumvalue", "name": "image_file", "value": "image_file", "valueType": { "$ref": "858" }, "enumType": { "$ref": "857" }, "doc": "The content is an image file.", "decorators": [] }, { "$id": "861", "kind": "enumvalue", "name": "image_url", "value": "image_url", "valueType": { "$ref": "858" }, "enumType": { "$ref": "857" }, "doc": "The content is an image URL.", "decorators": [] }, { "$id": "862", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "858" }, "enumType": { "$ref": "857" }, "doc": "The content is a refusal message.", "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "863", "kind": "enum", "name": "MessageContentImageFileObjectImageFileDetail", "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.image_file.detail.anonymous", "valueType": { "$id": "864", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "865", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "864" }, "enumType": { "$ref": "863" }, "decorators": [] }, { "$id": "866", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "864" }, "enumType": { "$ref": "863" }, "decorators": [] }, { "$id": "867", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "864" }, "enumType": { "$ref": "863" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "868", "kind": "enum", "name": "MessageContentTextAnnotationType", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationType", "valueType": { "$id": "869", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "870", "kind": "enumvalue", "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "869" }, "enumType": { "$ref": "868" }, "decorators": [] }, { "$id": "871", "kind": "enumvalue", "name": "file_path", "value": "file_path", "valueType": { "$ref": "869" }, "enumType": { "$ref": "868" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "872", "kind": "enum", "name": "MessageContentImageUrlObjectImageUrlDetail", "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.image_url.detail.anonymous", "valueType": { "$id": "873", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "874", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "873" }, "enumType": { "$ref": "872" }, "decorators": [] }, { "$id": "875", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "873" }, "enumType": { "$ref": "872" }, "decorators": [] }, { "$id": "876", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "873" }, "enumType": { "$ref": "872" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "877", "kind": "enum", "name": "MessageObjectStatus", "crossLanguageDefinitionId": "OpenAI.MessageObject.status.anonymous", "valueType": { "$id": "878", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "879", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "878" }, "enumType": { "$ref": "877" }, "decorators": [] }, { "$id": "880", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "878" }, "enumType": { "$ref": "877" }, "decorators": [] }, { "$id": "881", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "878" }, "enumType": { "$ref": "877" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "882", "kind": "enum", "name": "MessageObjectIncompleteDetailsReason", "crossLanguageDefinitionId": "OpenAI.MessageObject.incomplete_details.reason.anonymous", "valueType": { "$id": "883", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "884", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "883" }, "enumType": { "$ref": "882" }, "decorators": [] }, { "$id": "885", "kind": "enumvalue", "name": "max_tokens", "value": "max_tokens", "valueType": { "$ref": "883" }, "enumType": { "$ref": "882" }, "decorators": [] }, { "$id": "886", "kind": "enumvalue", "name": "run_cancelled", "value": "run_cancelled", "valueType": { "$ref": "883" }, "enumType": { "$ref": "882" }, "decorators": [] }, { "$id": "887", "kind": "enumvalue", "name": "run_expired", "value": "run_expired", "valueType": { "$ref": "883" }, "enumType": { "$ref": "882" }, "decorators": [] }, { "$id": "888", "kind": "enumvalue", "name": "run_failed", "value": "run_failed", "valueType": { "$ref": "883" }, "enumType": { "$ref": "882" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "889", "kind": "enum", "name": "MessageObjectRole", "crossLanguageDefinitionId": "OpenAI.MessageObject.role.anonymous", "valueType": { "$id": "890", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "891", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "890" }, "enumType": { "$ref": "889" }, "decorators": [] }, { "$id": "892", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "890" }, "enumType": { "$ref": "889" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "893", "kind": "enum", "name": "CreateModerationRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.model.anonymous", "valueType": { "$id": "894", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "895", "kind": "enumvalue", "name": "omni-moderation-latest", "value": "omni-moderation-latest", "valueType": { "$ref": "894" }, "enumType": { "$ref": "893" }, "decorators": [] }, { "$id": "896", "kind": "enumvalue", "name": "omni-moderation-2024-09-26", "value": "omni-moderation-2024-09-26", "valueType": { "$ref": "894" }, "enumType": { "$ref": "893" }, "decorators": [] }, { "$id": "897", "kind": "enumvalue", "name": "text-moderation-latest", "value": "text-moderation-latest", "valueType": { "$ref": "894" }, "enumType": { "$ref": "893" }, "decorators": [] }, { "$id": "898", "kind": "enumvalue", "name": "text-moderation-stable", "value": "text-moderation-stable", "valueType": { "$ref": "894" }, "enumType": { "$ref": "893" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "899", "kind": "enum", "name": "CreateThreadAndRunRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.model.anonymous", "valueType": { "$id": "900", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "901", "kind": "enumvalue", "name": "gpt-4.1", "value": "gpt-4.1", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "902", "kind": "enumvalue", "name": "gpt-4.1-mini", "value": "gpt-4.1-mini", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "903", "kind": "enumvalue", "name": "gpt-4.1-nano", "value": "gpt-4.1-nano", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "904", "kind": "enumvalue", "name": "gpt-4.1-2025-04-14", "value": "gpt-4.1-2025-04-14", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "905", "kind": "enumvalue", "name": "gpt-4.1-mini-2025-04-14", "value": "gpt-4.1-mini-2025-04-14", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "906", "kind": "enumvalue", "name": "gpt-4.1-nano-2025-04-14", "value": "gpt-4.1-nano-2025-04-14", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "907", "kind": "enumvalue", "name": "gpt-4o", "value": "gpt-4o", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "908", "kind": "enumvalue", "name": "gpt-4o-2024-11-20", "value": "gpt-4o-2024-11-20", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "909", "kind": "enumvalue", "name": "gpt-4o-2024-08-06", "value": "gpt-4o-2024-08-06", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "910", "kind": "enumvalue", "name": "gpt-4o-2024-05-13", "value": "gpt-4o-2024-05-13", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "911", "kind": "enumvalue", "name": "gpt-4o-mini", "value": "gpt-4o-mini", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "912", "kind": "enumvalue", "name": "gpt-4o-mini-2024-07-18", "value": "gpt-4o-mini-2024-07-18", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "913", "kind": "enumvalue", "name": "gpt-4.5-preview", "value": "gpt-4.5-preview", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "914", "kind": "enumvalue", "name": "gpt-4.5-preview-2025-02-27", "value": "gpt-4.5-preview-2025-02-27", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "915", "kind": "enumvalue", "name": "gpt-4-turbo", "value": "gpt-4-turbo", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "916", "kind": "enumvalue", "name": "gpt-4-turbo-2024-04-09", "value": "gpt-4-turbo-2024-04-09", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "917", "kind": "enumvalue", "name": "gpt-4-0125-preview", "value": "gpt-4-0125-preview", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "918", "kind": "enumvalue", "name": "gpt-4-turbo-preview", "value": "gpt-4-turbo-preview", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "919", "kind": "enumvalue", "name": "gpt-4-1106-preview", "value": "gpt-4-1106-preview", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "920", "kind": "enumvalue", "name": "gpt-4-vision-preview", "value": "gpt-4-vision-preview", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "921", "kind": "enumvalue", "name": "gpt-4", "value": "gpt-4", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "922", "kind": "enumvalue", "name": "gpt-4-0314", "value": "gpt-4-0314", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "923", "kind": "enumvalue", "name": "gpt-4-0613", "value": "gpt-4-0613", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "924", "kind": "enumvalue", "name": "gpt-4-32k", "value": "gpt-4-32k", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "925", "kind": "enumvalue", "name": "gpt-4-32k-0314", "value": "gpt-4-32k-0314", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "926", "kind": "enumvalue", "name": "gpt-4-32k-0613", "value": "gpt-4-32k-0613", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "927", "kind": "enumvalue", "name": "gpt-3.5-turbo", "value": "gpt-3.5-turbo", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "928", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k", "value": "gpt-3.5-turbo-16k", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "929", "kind": "enumvalue", "name": "gpt-3.5-turbo-0613", "value": "gpt-3.5-turbo-0613", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "930", "kind": "enumvalue", "name": "gpt-3.5-turbo-1106", "value": "gpt-3.5-turbo-1106", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "931", "kind": "enumvalue", "name": "gpt-3.5-turbo-0125", "value": "gpt-3.5-turbo-0125", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] }, { "$id": "932", "kind": "enumvalue", "name": "gpt-3.5-turbo-16k-0613", "value": "gpt-3.5-turbo-16k-0613", "valueType": { "$ref": "900" }, "enumType": { "$ref": "899" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "933", "kind": "enum", "name": "TruncationObjectType", "crossLanguageDefinitionId": "OpenAI.TruncationObject.type.anonymous", "valueType": { "$id": "934", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "935", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "934" }, "enumType": { "$ref": "933" }, "decorators": [] }, { "$id": "936", "kind": "enumvalue", "name": "last_messages", "value": "last_messages", "valueType": { "$ref": "934" }, "enumType": { "$ref": "933" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "937", "kind": "enum", "name": "CreateThreadAndRunRequestToolChoice1", "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_choice.anonymous", "valueType": { "$id": "938", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "939", "kind": "enumvalue", "name": "none", "value": "none", "valueType": { "$ref": "938" }, "enumType": { "$ref": "937" }, "decorators": [] }, { "$id": "940", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "938" }, "enumType": { "$ref": "937" }, "decorators": [] }, { "$id": "941", "kind": "enumvalue", "name": "required", "value": "required", "valueType": { "$ref": "938" }, "enumType": { "$ref": "937" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "942", "kind": "enum", "name": "AssistantsNamedToolChoiceType", "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice.type.anonymous", "valueType": { "$id": "943", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "944", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "943" }, "enumType": { "$ref": "942" }, "decorators": [] }, { "$id": "945", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "943" }, "enumType": { "$ref": "942" }, "decorators": [] }, { "$id": "946", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "943" }, "enumType": { "$ref": "942" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "947", "kind": "enum", "name": "RunObjectStatus", "crossLanguageDefinitionId": "OpenAI.RunObject.status.anonymous", "valueType": { "$id": "948", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "949", "kind": "enumvalue", "name": "queued", "value": "queued", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "950", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "951", "kind": "enumvalue", "name": "requires_action", "value": "requires_action", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "952", "kind": "enumvalue", "name": "cancelling", "value": "cancelling", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "953", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "954", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "955", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "956", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] }, { "$id": "957", "kind": "enumvalue", "name": "expired", "value": "expired", "valueType": { "$ref": "948" }, "enumType": { "$ref": "947" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "958", "kind": "enum", "name": "RunObjectLastErrorCode", "crossLanguageDefinitionId": "OpenAI.RunObject.last_error.code.anonymous", "valueType": { "$id": "959", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "960", "kind": "enumvalue", "name": "server_error", "value": "server_error", "valueType": { "$ref": "959" }, "enumType": { "$ref": "958" }, "decorators": [] }, { "$id": "961", "kind": "enumvalue", "name": "rate_limit_exceeded", "value": "rate_limit_exceeded", "valueType": { "$ref": "959" }, "enumType": { "$ref": "958" }, "decorators": [] }, { "$id": "962", "kind": "enumvalue", "name": "invalid_prompt", "value": "invalid_prompt", "valueType": { "$ref": "959" }, "enumType": { "$ref": "958" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "963", "kind": "enum", "name": "RunObjectIncompleteDetailsReason", "crossLanguageDefinitionId": "OpenAI.RunObject.incomplete_details.reason.anonymous", "valueType": { "$id": "964", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "965", "kind": "enumvalue", "name": "max_completion_tokens", "value": "max_completion_tokens", "valueType": { "$ref": "964" }, "enumType": { "$ref": "963" }, "decorators": [] }, { "$id": "966", "kind": "enumvalue", "name": "max_prompt_tokens", "value": "max_prompt_tokens", "valueType": { "$ref": "964" }, "enumType": { "$ref": "963" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "967", "kind": "enum", "name": "RunStepObjectType", "crossLanguageDefinitionId": "OpenAI.RunStepObject.type.anonymous", "valueType": { "$id": "968", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "969", "kind": "enumvalue", "name": "message_creation", "value": "message_creation", "valueType": { "$ref": "968" }, "enumType": { "$ref": "967" }, "decorators": [] }, { "$id": "970", "kind": "enumvalue", "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "968" }, "enumType": { "$ref": "967" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "971", "kind": "enum", "name": "RunStepObjectStatus", "crossLanguageDefinitionId": "OpenAI.RunStepObject.status.anonymous", "valueType": { "$id": "972", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "973", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "972" }, "enumType": { "$ref": "971" }, "decorators": [] }, { "$id": "974", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "972" }, "enumType": { "$ref": "971" }, "decorators": [] }, { "$id": "975", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "972" }, "enumType": { "$ref": "971" }, "decorators": [] }, { "$id": "976", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "972" }, "enumType": { "$ref": "971" }, "decorators": [] }, { "$id": "977", "kind": "enumvalue", "name": "expired", "value": "expired", "valueType": { "$ref": "972" }, "enumType": { "$ref": "971" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "978", "kind": "enum", "name": "RunStepDetailsType", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsType", "valueType": { "$id": "979", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "980", "kind": "enumvalue", "name": "message_creation", "value": "message_creation", "valueType": { "$ref": "979" }, "enumType": { "$ref": "978" }, "decorators": [] }, { "$id": "981", "kind": "enumvalue", "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "979" }, "enumType": { "$ref": "978" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "982", "kind": "enum", "name": "RunStepDetailsToolCallType", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallType", "valueType": { "$id": "983", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "984", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "983" }, "enumType": { "$ref": "982" }, "decorators": [] }, { "$id": "985", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "983" }, "enumType": { "$ref": "982" }, "decorators": [] }, { "$id": "986", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "983" }, "enumType": { "$ref": "982" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "987", "kind": "enum", "name": "RunStepDetailsCodeInterpreterOutputType", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsCodeInterpreterOutputType", "valueType": { "$id": "988", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "989", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "988" }, "enumType": { "$ref": "987" }, "decorators": [] }, { "$id": "990", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "988" }, "enumType": { "$ref": "987" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "991", "kind": "enum", "name": "RunStepObjectLastErrorCode", "crossLanguageDefinitionId": "OpenAI.RunStepObject.last_error.code.anonymous", "valueType": { "$id": "992", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "993", "kind": "enumvalue", "name": "server_error", "value": "server_error", "valueType": { "$ref": "992" }, "enumType": { "$ref": "991" }, "decorators": [] }, { "$id": "994", "kind": "enumvalue", "name": "rate_limit_exceeded", "value": "rate_limit_exceeded", "valueType": { "$ref": "992" }, "enumType": { "$ref": "991" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "995", "kind": "enum", "name": "VectorStoreObjectStatus", "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.status.anonymous", "valueType": { "$id": "996", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "997", "kind": "enumvalue", "name": "expired", "value": "expired", "valueType": { "$ref": "996" }, "enumType": { "$ref": "995" }, "decorators": [] }, { "$id": "998", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "996" }, "enumType": { "$ref": "995" }, "decorators": [] }, { "$id": "999", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "996" }, "enumType": { "$ref": "995" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1000", "kind": "enum", "name": "VectorStoreFileBatchObjectStatus", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.status.anonymous", "valueType": { "$id": "1001", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1002", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "1001" }, "enumType": { "$ref": "1000" }, "decorators": [] }, { "$id": "1003", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1001" }, "enumType": { "$ref": "1000" }, "decorators": [] }, { "$id": "1004", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1001" }, "enumType": { "$ref": "1000" }, "decorators": [] }, { "$id": "1005", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1001" }, "enumType": { "$ref": "1000" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1006", "kind": "enum", "name": "VectorStoreFileObjectStatus", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.status.anonymous", "valueType": { "$id": "1007", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1008", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "1007" }, "enumType": { "$ref": "1006" }, "decorators": [] }, { "$id": "1009", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1007" }, "enumType": { "$ref": "1006" }, "decorators": [] }, { "$id": "1010", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1007" }, "enumType": { "$ref": "1006" }, "decorators": [] }, { "$id": "1011", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1007" }, "enumType": { "$ref": "1006" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1012", "kind": "enum", "name": "VectorStoreFileObjectLastErrorCode", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.last_error.code.anonymous", "valueType": { "$id": "1013", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1014", "kind": "enumvalue", "name": "server_error", "value": "server_error", "valueType": { "$ref": "1013" }, "enumType": { "$ref": "1012" }, "decorators": [] }, { "$id": "1015", "kind": "enumvalue", "name": "unsupported_file", "value": "unsupported_file", "valueType": { "$ref": "1013" }, "enumType": { "$ref": "1012" }, "decorators": [] }, { "$id": "1016", "kind": "enumvalue", "name": "invalid_file", "value": "invalid_file", "valueType": { "$ref": "1013" }, "enumType": { "$ref": "1012" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1017", "kind": "enum", "name": "ChunkingStrategyResponseParamType", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyResponseParam.type.anonymous", "valueType": { "$id": "1018", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1019", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "1018" }, "enumType": { "$ref": "1017" }, "decorators": [] }, { "$id": "1020", "kind": "enumvalue", "name": "other", "value": "other", "valueType": { "$ref": "1018" }, "enumType": { "$ref": "1017" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1021", "kind": "enum", "name": "VectorStoreSearchRequestRankingOptionsRanker", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.ranking_options.ranker.anonymous", "valueType": { "$id": "1022", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1023", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1022" }, "enumType": { "$ref": "1021" }, "decorators": [] }, { "$id": "1024", "kind": "enumvalue", "name": "default-2024-11-15", "value": "default-2024-11-15", "valueType": { "$ref": "1022" }, "enumType": { "$ref": "1021" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1025", "kind": "enum", "name": "CreateCompletionRequestModel", "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.model.anonymous", "valueType": { "$id": "1026", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1027", "kind": "enumvalue", "name": "gpt-3.5-turbo-instruct", "value": "gpt-3.5-turbo-instruct", "valueType": { "$ref": "1026" }, "enumType": { "$ref": "1025" }, "decorators": [] }, { "$id": "1028", "kind": "enumvalue", "name": "davinci-002", "value": "davinci-002", "valueType": { "$ref": "1026" }, "enumType": { "$ref": "1025" }, "decorators": [] }, { "$id": "1029", "kind": "enumvalue", "name": "babbage-002", "value": "babbage-002", "valueType": { "$ref": "1026" }, "enumType": { "$ref": "1025" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1030", "kind": "enum", "name": "CreateCompletionResponseChoiceFinishReason", "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.finish_reason.anonymous", "valueType": { "$id": "1031", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1032", "kind": "enumvalue", "name": "stop", "value": "stop", "valueType": { "$ref": "1031" }, "enumType": { "$ref": "1030" }, "decorators": [] }, { "$id": "1033", "kind": "enumvalue", "name": "length", "value": "length", "valueType": { "$ref": "1031" }, "enumType": { "$ref": "1030" }, "decorators": [] }, { "$id": "1034", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "1031" }, "enumType": { "$ref": "1030" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1035", "kind": "enum", "name": "RealtimeClientEventType", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventType", "valueType": { "$id": "1036", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1037", "kind": "enumvalue", "name": "session_update", "value": "session.update", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1038", "kind": "enumvalue", "name": "input_audio_buffer_append", "value": "input_audio_buffer.append", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1039", "kind": "enumvalue", "name": "input_audio_buffer_commit", "value": "input_audio_buffer.commit", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1040", "kind": "enumvalue", "name": "input_audio_buffer_clear", "value": "input_audio_buffer.clear", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1041", "kind": "enumvalue", "name": "output_audio_buffer_clear", "value": "output_audio_buffer.clear", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1042", "kind": "enumvalue", "name": "conversation_item_create", "value": "conversation.item.create", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1043", "kind": "enumvalue", "name": "conversation_item_retrieve", "value": "conversation.item.retrieve", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1044", "kind": "enumvalue", "name": "conversation_item_truncate", "value": "conversation.item.truncate", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1045", "kind": "enumvalue", "name": "conversation_item_delete", "value": "conversation.item.delete", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1046", "kind": "enumvalue", "name": "response_create", "value": "response.create", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1047", "kind": "enumvalue", "name": "response_cancel", "value": "response.cancel", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] }, { "$id": "1048", "kind": "enumvalue", "name": "transcription_session_update", "value": "transcription_session.update", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "1035" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1049", "kind": "enum", "name": "RealtimeModality", "crossLanguageDefinitionId": "OpenAI.RealtimeModality", "valueType": { "$id": "1050", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1051", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1050" }, "enumType": { "$ref": "1049" }, "decorators": [] }, { "$id": "1052", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1050" }, "enumType": { "$ref": "1049" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1053", "kind": "enum", "name": "RealtimeRequestSessionModel", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.model.anonymous", "valueType": { "$id": "1054", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1055", "kind": "enumvalue", "name": "gpt-4o-realtime-preview", "value": "gpt-4o-realtime-preview", "valueType": { "$ref": "1054" }, "enumType": { "$ref": "1053" }, "decorators": [] }, { "$id": "1056", "kind": "enumvalue", "name": "gpt-4o-realtime-preview-2024-10-01", "value": "gpt-4o-realtime-preview-2024-10-01", "valueType": { "$ref": "1054" }, "enumType": { "$ref": "1053" }, "decorators": [] }, { "$id": "1057", "kind": "enumvalue", "name": "gpt-4o-realtime-preview-2024-12-17", "value": "gpt-4o-realtime-preview-2024-12-17", "valueType": { "$ref": "1054" }, "enumType": { "$ref": "1053" }, "decorators": [] }, { "$id": "1058", "kind": "enumvalue", "name": "gpt-4o-mini-realtime-preview", "value": "gpt-4o-mini-realtime-preview", "valueType": { "$ref": "1054" }, "enumType": { "$ref": "1053" }, "decorators": [] }, { "$id": "1059", "kind": "enumvalue", "name": "gpt-4o-mini-realtime-preview-2024-12-17", "value": "gpt-4o-mini-realtime-preview-2024-12-17", "valueType": { "$ref": "1054" }, "enumType": { "$ref": "1053" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1060", "kind": "enum", "name": "RealtimeAudioFormat", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioFormat", "valueType": { "$id": "1061", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1062", "kind": "enumvalue", "name": "pcm16", "value": "pcm16", "valueType": { "$ref": "1061" }, "enumType": { "$ref": "1060" }, "decorators": [] }, { "$id": "1063", "kind": "enumvalue", "name": "g711_ulaw", "value": "g711_ulaw", "valueType": { "$ref": "1061" }, "enumType": { "$ref": "1060" }, "decorators": [] }, { "$id": "1064", "kind": "enumvalue", "name": "g711_alaw", "value": "g711_alaw", "valueType": { "$ref": "1061" }, "enumType": { "$ref": "1060" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1065", "kind": "enum", "name": "RealtimeAudioInputTranscriptionModel", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioInputTranscriptionModel", "valueType": { "$id": "1066", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1067", "kind": "enumvalue", "name": "whisper_1", "value": "whisper-1", "valueType": { "$ref": "1066" }, "enumType": { "$ref": "1065" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1068", "kind": "enum", "name": "RealtimeTurnDetectionType", "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetectionType", "valueType": { "$id": "1069", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1070", "kind": "enumvalue", "name": "server_vad", "value": "server_vad", "valueType": { "$ref": "1069" }, "enumType": { "$ref": "1068" }, "doc": "Indicates that server-side voice activity detection (VAD) should be enabled, allowing the server to determine when\nadd_user_audio commands present ends of speech and should be automatically committed.\n\nThe API will also detect when the user begins talking, sending a generation_canceled command.", "decorators": [] }, { "$id": "1071", "kind": "enumvalue", "name": "semantic_vad", "value": "semantic_vad", "valueType": { "$ref": "1069" }, "enumType": { "$ref": "1068" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1072", "kind": "enum", "name": "RealtimeSemanticVadTurnDetectionEagerness", "crossLanguageDefinitionId": "OpenAI.RealtimeSemanticVadTurnDetection.eagerness.anonymous", "valueType": { "$id": "1073", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1074", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1073" }, "enumType": { "$ref": "1072" }, "decorators": [] }, { "$id": "1075", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "1073" }, "enumType": { "$ref": "1072" }, "decorators": [] }, { "$id": "1076", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1073" }, "enumType": { "$ref": "1072" }, "decorators": [] }, { "$id": "1077", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1073" }, "enumType": { "$ref": "1072" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1078", "kind": "enum", "name": "RealtimeAudioNoiseReductionType", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNoiseReductionType", "valueType": { "$id": "1079", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1080", "kind": "enumvalue", "name": "near_field", "value": "near_field", "valueType": { "$ref": "1079" }, "enumType": { "$ref": "1078" }, "decorators": [] }, { "$id": "1081", "kind": "enumvalue", "name": "far_field", "value": "far_field", "valueType": { "$ref": "1079" }, "enumType": { "$ref": "1078" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1082", "kind": "enum", "name": "RealtimeToolType", "crossLanguageDefinitionId": "OpenAI.RealtimeToolType", "valueType": { "$id": "1083", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1084", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1083" }, "enumType": { "$ref": "1082" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "The supported tool type discriminators for realtime tools.\nCurrently, only 'function' tools are supported.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1085", "kind": "enum", "name": "RealtimeToolChoiceLiteral", "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceLiteral", "valueType": { "$id": "1086", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1087", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1086" }, "enumType": { "$ref": "1085" }, "doc": "Specifies that the model should freely determine which tool or tools, if any, to call.", "decorators": [] }, { "$id": "1088", "kind": "enumvalue", "name": "none", "value": "none", "valueType": { "$ref": "1086" }, "enumType": { "$ref": "1085" }, "doc": "Specifies that the model should call no tools whatsoever.", "decorators": [] }, { "$id": "1089", "kind": "enumvalue", "name": "required", "value": "required", "valueType": { "$ref": "1086" }, "enumType": { "$ref": "1085" }, "doc": "Specifies that the model should call at least one tool.", "decorators": [] } ], "namespace": "OpenAI", "doc": "The available set of mode-level, string literal tool_choice options for the realtime endpoint.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1090", "kind": "enum", "name": "RealtimeItemType", "crossLanguageDefinitionId": "OpenAI.RealtimeItemType", "valueType": { "$id": "1091", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1092", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$ref": "1091" }, "enumType": { "$ref": "1090" }, "decorators": [] }, { "$id": "1093", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "1091" }, "enumType": { "$ref": "1090" }, "decorators": [] }, { "$id": "1094", "kind": "enumvalue", "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "1091" }, "enumType": { "$ref": "1090" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1095", "kind": "enum", "name": "RealtimeMessageRole", "crossLanguageDefinitionId": "OpenAI.RealtimeMessageRole", "valueType": { "$id": "1096", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1097", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "1096" }, "enumType": { "$ref": "1095" }, "decorators": [] }, { "$id": "1098", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "1096" }, "enumType": { "$ref": "1095" }, "decorators": [] }, { "$id": "1099", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "1096" }, "enumType": { "$ref": "1095" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1100", "kind": "enum", "name": "RealtimeItemStatus", "crossLanguageDefinitionId": "OpenAI.RealtimeItemStatus", "valueType": { "$id": "1101", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1102", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "1101" }, "enumType": { "$ref": "1100" }, "decorators": [] }, { "$id": "1103", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1101" }, "enumType": { "$ref": "1100" }, "decorators": [] }, { "$id": "1104", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "1101" }, "enumType": { "$ref": "1100" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1105", "kind": "enum", "name": "RealtimeContentPartType", "crossLanguageDefinitionId": "OpenAI.RealtimeContentPartType", "valueType": { "$id": "1106", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1107", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "1105" }, "decorators": [] }, { "$id": "1108", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "1105" }, "decorators": [] }, { "$id": "1109", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "1105" }, "decorators": [] }, { "$id": "1110", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "1105" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1111", "kind": "enum", "name": "RealtimeResponseCreateParamsConversation", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.conversation.anonymous", "valueType": { "$id": "1112", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1113", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1112" }, "enumType": { "$ref": "1111" }, "decorators": [] }, { "$id": "1114", "kind": "enumvalue", "name": "none", "value": "none", "valueType": { "$ref": "1112" }, "enumType": { "$ref": "1111" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1115", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestModality", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.modality.anonymous", "valueType": { "$id": "1116", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1117", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1116" }, "enumType": { "$ref": "1115" }, "decorators": [] }, { "$id": "1118", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1116" }, "enumType": { "$ref": "1115" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1119", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestInputAudioFormat", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_format.anonymous", "valueType": { "$id": "1120", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1121", "kind": "enumvalue", "name": "pcm16", "value": "pcm16", "valueType": { "$ref": "1120" }, "enumType": { "$ref": "1119" }, "decorators": [] }, { "$id": "1122", "kind": "enumvalue", "name": "g711_ulaw", "value": "g711_ulaw", "valueType": { "$ref": "1120" }, "enumType": { "$ref": "1119" }, "decorators": [] }, { "$id": "1123", "kind": "enumvalue", "name": "g711_alaw", "value": "g711_alaw", "valueType": { "$ref": "1120" }, "enumType": { "$ref": "1119" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1124", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestInputAudioTranscriptionModel", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription.model.anonymous", "valueType": { "$id": "1125", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1126", "kind": "enumvalue", "name": "gpt-4o-transcribe", "value": "gpt-4o-transcribe", "valueType": { "$ref": "1125" }, "enumType": { "$ref": "1124" }, "decorators": [] }, { "$id": "1127", "kind": "enumvalue", "name": "gpt-4o-mini-transcribe", "value": "gpt-4o-mini-transcribe", "valueType": { "$ref": "1125" }, "enumType": { "$ref": "1124" }, "decorators": [] }, { "$id": "1128", "kind": "enumvalue", "name": "whisper-1", "value": "whisper-1", "valueType": { "$ref": "1125" }, "enumType": { "$ref": "1124" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1129", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestTurnDetectionType", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.type.anonymous", "valueType": { "$id": "1130", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1131", "kind": "enumvalue", "name": "server_vad", "value": "server_vad", "valueType": { "$ref": "1130" }, "enumType": { "$ref": "1129" }, "decorators": [] }, { "$id": "1132", "kind": "enumvalue", "name": "semantic_vad", "value": "semantic_vad", "valueType": { "$ref": "1130" }, "enumType": { "$ref": "1129" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1133", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestTurnDetectionEagerness", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.eagerness.anonymous", "valueType": { "$id": "1134", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1135", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1134" }, "enumType": { "$ref": "1133" }, "decorators": [] }, { "$id": "1136", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "1134" }, "enumType": { "$ref": "1133" }, "decorators": [] }, { "$id": "1137", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1134" }, "enumType": { "$ref": "1133" }, "decorators": [] }, { "$id": "1138", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1134" }, "enumType": { "$ref": "1133" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1139", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReductionType", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_noise_reduction.type.anonymous", "valueType": { "$id": "1140", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1141", "kind": "enumvalue", "name": "near_field", "value": "near_field", "valueType": { "$ref": "1140" }, "enumType": { "$ref": "1139" }, "decorators": [] }, { "$id": "1142", "kind": "enumvalue", "name": "far_field", "value": "far_field", "valueType": { "$ref": "1140" }, "enumType": { "$ref": "1139" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1143", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateRequestClientSecretExpiresAtAnchor", "crossLanguageDefinitionId": "", "valueType": { "$id": "1144", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1145", "kind": "enumvalue", "name": "created_at", "value": "created_at", "valueType": { "$id": "1146", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "1143" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1147", "kind": "enum", "name": "RealtimeServerEventType", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventType", "valueType": { "$id": "1148", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1149", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1150", "kind": "enumvalue", "name": "session_created", "value": "session.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1151", "kind": "enumvalue", "name": "session_updated", "value": "session.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1152", "kind": "enumvalue", "name": "conversation_created", "value": "conversation.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1153", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_completed", "value": "conversation.item.input_audio_transcription.completed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1154", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_delta", "value": "conversation.item.input_audio_transcription.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1155", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_failed", "value": "conversation.item.input_audio_transcription.failed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1156", "kind": "enumvalue", "name": "conversation_item_created", "value": "conversation.item.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1157", "kind": "enumvalue", "name": "conversation_item_retrieved", "value": "conversation.item.retrieved", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1158", "kind": "enumvalue", "name": "conversation_item_truncated", "value": "conversation.item.truncated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1159", "kind": "enumvalue", "name": "conversation_item_deleted", "value": "conversation.item.deleted", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1160", "kind": "enumvalue", "name": "input_audio_buffer_committed", "value": "input_audio_buffer.committed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1161", "kind": "enumvalue", "name": "input_audio_buffer_cleared", "value": "input_audio_buffer.cleared", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1162", "kind": "enumvalue", "name": "input_audio_buffer_speech_started", "value": "input_audio_buffer.speech_started", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1163", "kind": "enumvalue", "name": "input_audio_buffer_speech_stopped", "value": "input_audio_buffer.speech_stopped", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1164", "kind": "enumvalue", "name": "output_audio_buffer_cleared", "value": "output_audio_buffer.cleared", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1165", "kind": "enumvalue", "name": "output_audio_buffer_started", "value": "output_audio_buffer.started", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1166", "kind": "enumvalue", "name": "output_audio_buffer_stopped", "value": "output_audio_buffer.stopped", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1167", "kind": "enumvalue", "name": "response_created", "value": "response.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1168", "kind": "enumvalue", "name": "response_done", "value": "response.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1169", "kind": "enumvalue", "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1170", "kind": "enumvalue", "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1171", "kind": "enumvalue", "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1172", "kind": "enumvalue", "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1173", "kind": "enumvalue", "name": "response_text_delta", "value": "response.text.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1174", "kind": "enumvalue", "name": "response_text_done", "value": "response.text.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1175", "kind": "enumvalue", "name": "response_audio_transcript_delta", "value": "response.audio_transcript.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1176", "kind": "enumvalue", "name": "response_audio_transcript_done", "value": "response.audio_transcript.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1177", "kind": "enumvalue", "name": "response_audio_delta", "value": "response.audio.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1178", "kind": "enumvalue", "name": "response_audio_done", "value": "response.audio.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1179", "kind": "enumvalue", "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1180", "kind": "enumvalue", "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1181", "kind": "enumvalue", "name": "transcription_session_updated", "value": "transcription_session.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] }, { "$id": "1182", "kind": "enumvalue", "name": "rate_limits_updated", "value": "rate_limits.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "1147" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1183", "kind": "enum", "name": "RealtimeResponseObject", "crossLanguageDefinitionId": "", "valueType": { "$id": "1184", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1185", "kind": "enumvalue", "name": "realtime.response", "value": "realtime.response", "valueType": { "$id": "1186", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "1183" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1187", "kind": "enum", "name": "RealtimeResponseStatus", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status.anonymous", "valueType": { "$id": "1188", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1189", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1188" }, "enumType": { "$ref": "1187" }, "decorators": [] }, { "$id": "1190", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1188" }, "enumType": { "$ref": "1187" }, "decorators": [] }, { "$id": "1191", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1188" }, "enumType": { "$ref": "1187" }, "decorators": [] }, { "$id": "1192", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "1188" }, "enumType": { "$ref": "1187" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1193", "kind": "enum", "name": "RealtimeResponseStatusDetailsType", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.type.anonymous", "valueType": { "$id": "1194", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1195", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1194" }, "enumType": { "$ref": "1193" }, "decorators": [] }, { "$id": "1196", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1194" }, "enumType": { "$ref": "1193" }, "decorators": [] }, { "$id": "1197", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1194" }, "enumType": { "$ref": "1193" }, "decorators": [] }, { "$id": "1198", "kind": "enumvalue", "name": "incomplete", "value": "incomplete", "valueType": { "$ref": "1194" }, "enumType": { "$ref": "1193" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1199", "kind": "enum", "name": "RealtimeResponseStatusDetailsReason", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.reason.anonymous", "valueType": { "$id": "1200", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1201", "kind": "enumvalue", "name": "turn_detected", "value": "turn_detected", "valueType": { "$ref": "1200" }, "enumType": { "$ref": "1199" }, "decorators": [] }, { "$id": "1202", "kind": "enumvalue", "name": "client_cancelled", "value": "client_cancelled", "valueType": { "$ref": "1200" }, "enumType": { "$ref": "1199" }, "decorators": [] }, { "$id": "1203", "kind": "enumvalue", "name": "max_output_tokens", "value": "max_output_tokens", "valueType": { "$ref": "1200" }, "enumType": { "$ref": "1199" }, "decorators": [] }, { "$id": "1204", "kind": "enumvalue", "name": "content_filter", "value": "content_filter", "valueType": { "$ref": "1200" }, "enumType": { "$ref": "1199" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1205", "kind": "enum", "name": "RealtimeResponseModality", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.modality.anonymous", "valueType": { "$id": "1206", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1207", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1206" }, "enumType": { "$ref": "1205" }, "decorators": [] }, { "$id": "1208", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1206" }, "enumType": { "$ref": "1205" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1209", "kind": "enum", "name": "RealtimeResponseOutputAudioFormat", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.output_audio_format.anonymous", "valueType": { "$id": "1210", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1211", "kind": "enumvalue", "name": "pcm16", "value": "pcm16", "valueType": { "$ref": "1210" }, "enumType": { "$ref": "1209" }, "decorators": [] }, { "$id": "1212", "kind": "enumvalue", "name": "g711_ulaw", "value": "g711_ulaw", "valueType": { "$ref": "1210" }, "enumType": { "$ref": "1209" }, "decorators": [] }, { "$id": "1213", "kind": "enumvalue", "name": "g711_alaw", "value": "g711_alaw", "valueType": { "$ref": "1210" }, "enumType": { "$ref": "1209" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1214", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateResponseModality", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.modality.anonymous", "valueType": { "$id": "1215", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1216", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1215" }, "enumType": { "$ref": "1214" }, "decorators": [] }, { "$id": "1217", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1215" }, "enumType": { "$ref": "1214" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1218", "kind": "enum", "name": "RealtimeTranscriptionSessionCreateResponseInputAudioTranscriptionModel", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription.model.anonymous", "valueType": { "$id": "1219", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1220", "kind": "enumvalue", "name": "gpt-4o-transcribe", "value": "gpt-4o-transcribe", "valueType": { "$ref": "1219" }, "enumType": { "$ref": "1218" }, "decorators": [] }, { "$id": "1221", "kind": "enumvalue", "name": "gpt-4o-mini-transcribe", "value": "gpt-4o-mini-transcribe", "valueType": { "$ref": "1219" }, "enumType": { "$ref": "1218" }, "decorators": [] }, { "$id": "1222", "kind": "enumvalue", "name": "whisper-1", "value": "whisper-1", "valueType": { "$ref": "1219" }, "enumType": { "$ref": "1218" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1223", "kind": "enum", "name": "RealtimeSessionCreateRequestModel", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.model.anonymous", "valueType": { "$id": "1224", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1225", "kind": "enumvalue", "name": "gpt-4o-realtime-preview", "value": "gpt-4o-realtime-preview", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] }, { "$id": "1226", "kind": "enumvalue", "name": "gpt-4o-realtime-preview-2024-10-01", "value": "gpt-4o-realtime-preview-2024-10-01", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] }, { "$id": "1227", "kind": "enumvalue", "name": "gpt-4o-realtime-preview-2024-12-17", "value": "gpt-4o-realtime-preview-2024-12-17", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] }, { "$id": "1228", "kind": "enumvalue", "name": "gpt-4o-realtime-preview-2025-06-03", "value": "gpt-4o-realtime-preview-2025-06-03", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] }, { "$id": "1229", "kind": "enumvalue", "name": "gpt-4o-mini-realtime-preview", "value": "gpt-4o-mini-realtime-preview", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] }, { "$id": "1230", "kind": "enumvalue", "name": "gpt-4o-mini-realtime-preview-2024-12-17", "value": "gpt-4o-mini-realtime-preview-2024-12-17", "valueType": { "$ref": "1224" }, "enumType": { "$ref": "1223" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1231", "kind": "enum", "name": "RealtimeSessionCreateRequestTurnDetectionType", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.type.anonymous", "valueType": { "$id": "1232", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1233", "kind": "enumvalue", "name": "server_vad", "value": "server_vad", "valueType": { "$ref": "1232" }, "enumType": { "$ref": "1231" }, "decorators": [] }, { "$id": "1234", "kind": "enumvalue", "name": "semantic_vad", "value": "semantic_vad", "valueType": { "$ref": "1232" }, "enumType": { "$ref": "1231" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1235", "kind": "enum", "name": "RealtimeSessionCreateRequestTurnDetectionEagerness", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.eagerness.anonymous", "valueType": { "$id": "1236", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1237", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1236" }, "enumType": { "$ref": "1235" }, "decorators": [] }, { "$id": "1238", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "1236" }, "enumType": { "$ref": "1235" }, "decorators": [] }, { "$id": "1239", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1236" }, "enumType": { "$ref": "1235" }, "decorators": [] }, { "$id": "1240", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1236" }, "enumType": { "$ref": "1235" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1241", "kind": "enum", "name": "RealtimeSessionCreateRequestInputAudioNoiseReductionType", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_noise_reduction.type.anonymous", "valueType": { "$id": "1242", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1243", "kind": "enumvalue", "name": "near_field", "value": "near_field", "valueType": { "$ref": "1242" }, "enumType": { "$ref": "1241" }, "decorators": [] }, { "$id": "1244", "kind": "enumvalue", "name": "far_field", "value": "far_field", "valueType": { "$ref": "1242" }, "enumType": { "$ref": "1241" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1245", "kind": "enum", "name": "RealtimeSessionCreateRequestClientSecretExpiresAtAnchor", "crossLanguageDefinitionId": "", "valueType": { "$id": "1246", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1247", "kind": "enumvalue", "name": "created_at", "value": "created_at", "valueType": { "$id": "1248", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "1245" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1249", "kind": "enum", "name": "CreateUploadRequestPurpose", "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest.purpose.anonymous", "valueType": { "$id": "1250", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1251", "kind": "enumvalue", "name": "assistants", "value": "assistants", "valueType": { "$ref": "1250" }, "enumType": { "$ref": "1249" }, "decorators": [] }, { "$id": "1252", "kind": "enumvalue", "name": "batch", "value": "batch", "valueType": { "$ref": "1250" }, "enumType": { "$ref": "1249" }, "decorators": [] }, { "$id": "1253", "kind": "enumvalue", "name": "fine-tune", "value": "fine-tune", "valueType": { "$ref": "1250" }, "enumType": { "$ref": "1249" }, "decorators": [] }, { "$id": "1254", "kind": "enumvalue", "name": "vision", "value": "vision", "valueType": { "$ref": "1250" }, "enumType": { "$ref": "1249" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1255", "kind": "enum", "name": "UploadStatus", "crossLanguageDefinitionId": "OpenAI.Upload.status.anonymous", "valueType": { "$id": "1256", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1257", "kind": "enumvalue", "name": "pending", "value": "pending", "valueType": { "$ref": "1256" }, "enumType": { "$ref": "1255" }, "decorators": [] }, { "$id": "1258", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1256" }, "enumType": { "$ref": "1255" }, "decorators": [] }, { "$id": "1259", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1256" }, "enumType": { "$ref": "1255" }, "decorators": [] }, { "$id": "1260", "kind": "enumvalue", "name": "expired", "value": "expired", "valueType": { "$ref": "1256" }, "enumType": { "$ref": "1255" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1261", "kind": "enum", "name": "UploadObject", "crossLanguageDefinitionId": "", "valueType": { "$id": "1262", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1263", "kind": "enumvalue", "name": "upload", "value": "upload", "valueType": { "$id": "1264", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "1261" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1265", "kind": "enum", "name": "BatchRequestInputMethod", "crossLanguageDefinitionId": "", "valueType": { "$id": "1266", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1267", "kind": "enumvalue", "name": "POST", "value": "POST", "valueType": { "$id": "1268", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "enumType": { "$ref": "1265" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1269", "kind": "enum", "name": "FineTuneChatCompletionRequestAssistantMessageWeight", "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.weight.anonymous", "valueType": { "$id": "1270", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1271", "kind": "enumvalue", "name": "0", "value": "0", "valueType": { "$ref": "1270" }, "enumType": { "$ref": "1269" }, "decorators": [] }, { "$id": "1272", "kind": "enumvalue", "name": "1", "value": "1", "valueType": { "$ref": "1270" }, "enumType": { "$ref": "1269" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1273", "kind": "enum", "name": "MessageDeltaContentImageFileObjectImageFileDetail", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.image_file.detail.anonymous", "valueType": { "$id": "1274", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1275", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1274" }, "enumType": { "$ref": "1273" }, "decorators": [] }, { "$id": "1276", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1274" }, "enumType": { "$ref": "1273" }, "decorators": [] }, { "$id": "1277", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1274" }, "enumType": { "$ref": "1273" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "1278", "kind": "enum", "name": "MessageDeltaContentImageUrlObjectImageUrlDetail", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.image_url.detail.anonymous", "valueType": { "$id": "1279", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1280", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1279" }, "enumType": { "$ref": "1278" }, "decorators": [] }, { "$id": "1281", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1279" }, "enumType": { "$ref": "1278" }, "decorators": [] }, { "$id": "1282", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1279" }, "enumType": { "$ref": "1278" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "1283", "kind": "enum", "name": "MessageDeltaObjectDeltaRole", "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.delta.role.anonymous", "valueType": { "$id": "1284", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1285", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "1284" }, "enumType": { "$ref": "1283" }, "decorators": [] }, { "$id": "1286", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "1284" }, "enumType": { "$ref": "1283" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output", "decorators": [] }, { "$id": "1287", "kind": "enum", "name": "AssistantCollectionOrder", "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOrder", "valueType": { "$id": "1288", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1289", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1288" }, "enumType": { "$ref": "1287" }, "decorators": [] }, { "$id": "1290", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1288" }, "enumType": { "$ref": "1287" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1291", "kind": "enum", "name": "MessageCollectionOrder", "crossLanguageDefinitionId": "OpenAI.MessageCollectionOrder", "valueType": { "$id": "1292", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1293", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1292" }, "enumType": { "$ref": "1291" }, "decorators": [] }, { "$id": "1294", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1292" }, "enumType": { "$ref": "1291" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1295", "kind": "enum", "name": "RunCollectionOrder", "crossLanguageDefinitionId": "OpenAI.RunCollectionOrder", "valueType": { "$id": "1296", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1297", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1296" }, "enumType": { "$ref": "1295" }, "decorators": [] }, { "$id": "1298", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1296" }, "enumType": { "$ref": "1295" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1299", "kind": "enum", "name": "RunStepCollectionOrder", "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOrder", "valueType": { "$id": "1300", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1301", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1300" }, "enumType": { "$ref": "1299" }, "decorators": [] }, { "$id": "1302", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1300" }, "enumType": { "$ref": "1299" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1303", "kind": "enum", "name": "ChatCompletionCollectionOrder", "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOrder", "valueType": { "$id": "1304", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1305", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1304" }, "enumType": { "$ref": "1303" }, "decorators": [] }, { "$id": "1306", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1304" }, "enumType": { "$ref": "1303" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1307", "kind": "enum", "name": "ChatCompletionMessageCollectionOrder", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageCollectionOrder", "valueType": { "$id": "1308", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1309", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1308" }, "enumType": { "$ref": "1307" }, "decorators": [] }, { "$id": "1310", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1308" }, "enumType": { "$ref": "1307" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1311", "kind": "enum", "name": "ContainerCollectionOrder", "crossLanguageDefinitionId": "OpenAI.ContainerCollectionOrder", "valueType": { "$id": "1312", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1313", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1312" }, "enumType": { "$ref": "1311" }, "decorators": [] }, { "$id": "1314", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1312" }, "enumType": { "$ref": "1311" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1315", "kind": "enum", "name": "ConversationItemCollectionOrder", "crossLanguageDefinitionId": "OpenAI.ConversationItemCollectionOrder", "valueType": { "$id": "1316", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1317", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1316" }, "enumType": { "$ref": "1315" }, "decorators": [] }, { "$id": "1318", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1316" }, "enumType": { "$ref": "1315" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1319", "kind": "enum", "name": "DotNetResponseItemCollectionOrder", "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOrder", "valueType": { "$id": "1320", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1321", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1320" }, "enumType": { "$ref": "1319" }, "decorators": [] }, { "$id": "1322", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1320" }, "enumType": { "$ref": "1319" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1323", "kind": "enum", "name": "DotNetGlobalToolCallApprovalPolicy", "crossLanguageDefinitionId": "OpenAI.DotNetGlobalToolCallApprovalPolicy", "valueType": { "$id": "1324", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1325", "kind": "enumvalue", "name": "AlwaysRequireApproval", "value": "always", "valueType": { "$ref": "1324" }, "enumType": { "$ref": "1323" }, "decorators": [] }, { "$id": "1326", "kind": "enumvalue", "name": "NeverRequireApproval", "value": "never", "valueType": { "$ref": "1324" }, "enumType": { "$ref": "1323" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1327", "kind": "enum", "name": "DotNetCombinedChunkingStrategyParamType", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedChunkingStrategyParam.type.anonymous", "valueType": { "$id": "1328", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1329", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1328" }, "enumType": { "$ref": "1327" }, "decorators": [] }, { "$id": "1330", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "1328" }, "enumType": { "$ref": "1327" }, "decorators": [] }, { "$id": "1331", "kind": "enumvalue", "name": "other", "value": "other", "valueType": { "$ref": "1328" }, "enumType": { "$ref": "1327" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output", "decorators": [] }, { "$id": "1332", "kind": "enum", "name": "PageOrderOptions", "crossLanguageDefinitionId": "OpenAI.PageOrderOptions", "valueType": { "$id": "1333", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1334", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "1333" }, "enumType": { "$ref": "1332" }, "decorators": [] }, { "$id": "1335", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "1333" }, "enumType": { "$ref": "1332" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1336", "kind": "enum", "name": "VectorStoreFileCollectionOrder", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOrder", "valueType": { "$id": "1337", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1338", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1337" }, "enumType": { "$ref": "1336" }, "decorators": [] }, { "$id": "1339", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1337" }, "enumType": { "$ref": "1336" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1340", "kind": "enum", "name": "ListVectorStoreFilesFilter", "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesFilter", "valueType": { "$id": "1341", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1342", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "1341" }, "enumType": { "$ref": "1340" }, "decorators": [] }, { "$id": "1343", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1341" }, "enumType": { "$ref": "1340" }, "decorators": [] }, { "$id": "1344", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1341" }, "enumType": { "$ref": "1340" }, "decorators": [] }, { "$id": "1345", "kind": "enumvalue", "name": "cancelled", "value": "cancelled", "valueType": { "$ref": "1341" }, "enumType": { "$ref": "1340" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1346", "kind": "enum", "name": "VideoCollectionOrder", "crossLanguageDefinitionId": "OpenAI.VideoCollectionOrder", "valueType": { "$id": "1347", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1348", "kind": "enumvalue", "name": "Ascending", "value": "asc", "valueType": { "$ref": "1347" }, "enumType": { "$ref": "1346" }, "decorators": [] }, { "$id": "1349", "kind": "enumvalue", "name": "Descending", "value": "desc", "valueType": { "$ref": "1347" }, "enumType": { "$ref": "1346" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1350", "kind": "enum", "name": "CreateTranscriptionRequestAccept", "crossLanguageDefinitionId": "OpenAI.createTranscription.RequestAccept.anonymous", "valueType": { "$id": "1351", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1352", "kind": "enumvalue", "name": "application/json", "value": "application/json", "valueType": { "$ref": "1351" }, "enumType": { "$ref": "1350" }, "decorators": [] }, { "$id": "1353", "kind": "enumvalue", "name": "text/event-stream", "value": "text/event-stream", "valueType": { "$ref": "1351" }, "enumType": { "$ref": "1350" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1354", "kind": "enum", "name": "ChatToolCallKind", "crossLanguageDefinitionId": "OpenAI.ChatToolCallKind", "valueType": { "$id": "1355", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1356", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1355" }, "enumType": { "$ref": "1354" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1357", "kind": "enum", "name": "ChatToolKind", "crossLanguageDefinitionId": "OpenAI.ChatToolKind", "valueType": { "$id": "1358", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1359", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1358" }, "enumType": { "$ref": "1357" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Json", "decorators": [] }, { "$id": "1360", "kind": "enum", "name": "ListEvalsRequestOrder", "crossLanguageDefinitionId": "OpenAI.listEvals.RequestOrder.anonymous", "valueType": { "$id": "1361", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1362", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "1361" }, "enumType": { "$ref": "1360" }, "decorators": [] }, { "$id": "1363", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "1361" }, "enumType": { "$ref": "1360" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1364", "kind": "enum", "name": "ListEvalsRequestOrderBy", "crossLanguageDefinitionId": "OpenAI.listEvals.RequestOrderBy.anonymous", "valueType": { "$id": "1365", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1366", "kind": "enumvalue", "name": "created_at", "value": "created_at", "valueType": { "$ref": "1365" }, "enumType": { "$ref": "1364" }, "decorators": [] }, { "$id": "1367", "kind": "enumvalue", "name": "updated_at", "value": "updated_at", "valueType": { "$ref": "1365" }, "enumType": { "$ref": "1364" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1368", "kind": "enum", "name": "GetEvalRunsRequestOrder", "crossLanguageDefinitionId": "OpenAI.getEvalRuns.RequestOrder.anonymous", "valueType": { "$id": "1369", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1370", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "1369" }, "enumType": { "$ref": "1368" }, "decorators": [] }, { "$id": "1371", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "1369" }, "enumType": { "$ref": "1368" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1372", "kind": "enum", "name": "GetEvalRunsRequestStatus", "crossLanguageDefinitionId": "OpenAI.getEvalRuns.RequestStatus.anonymous", "valueType": { "$id": "1373", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1374", "kind": "enumvalue", "name": "queued", "value": "queued", "valueType": { "$ref": "1373" }, "enumType": { "$ref": "1372" }, "decorators": [] }, { "$id": "1375", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "1373" }, "enumType": { "$ref": "1372" }, "decorators": [] }, { "$id": "1376", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "1373" }, "enumType": { "$ref": "1372" }, "decorators": [] }, { "$id": "1377", "kind": "enumvalue", "name": "canceled", "value": "canceled", "valueType": { "$ref": "1373" }, "enumType": { "$ref": "1372" }, "decorators": [] }, { "$id": "1378", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "1373" }, "enumType": { "$ref": "1372" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1379", "kind": "enum", "name": "GetEvalRunOutputItemsRequestStatus", "crossLanguageDefinitionId": "OpenAI.getEvalRunOutputItems.RequestStatus.anonymous", "valueType": { "$id": "1380", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1381", "kind": "enumvalue", "name": "fail", "value": "fail", "valueType": { "$ref": "1380" }, "enumType": { "$ref": "1379" }, "decorators": [] }, { "$id": "1382", "kind": "enumvalue", "name": "pass", "value": "pass", "valueType": { "$ref": "1380" }, "enumType": { "$ref": "1379" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1383", "kind": "enum", "name": "GetEvalRunOutputItemsRequestOrder", "crossLanguageDefinitionId": "OpenAI.getEvalRunOutputItems.RequestOrder.anonymous", "valueType": { "$id": "1384", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1385", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "1384" }, "enumType": { "$ref": "1383" }, "decorators": [] }, { "$id": "1386", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "1384" }, "enumType": { "$ref": "1383" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1387", "kind": "enum", "name": "ModerationAppliedInputType", "crossLanguageDefinitionId": "OpenAI.ModerationAppliedInputType", "valueType": { "$id": "1388", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1389", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1388" }, "enumType": { "$ref": "1387" }, "decorators": [] }, { "$id": "1390", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "1388" }, "enumType": { "$ref": "1387" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1391", "kind": "enum", "name": "IncludedRunStepProperty", "crossLanguageDefinitionId": "OpenAI.IncludedRunStepProperty", "valueType": { "$id": "1392", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1393", "kind": "enumvalue", "name": "file_search_result_content", "value": "step_details.tool_calls[*].file_search.results[*].content", "valueType": { "$ref": "1392" }, "enumType": { "$ref": "1391" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1394", "kind": "enum", "name": "RunStepDetailsToolCallsFileSearchResultObjectContentType", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContentType", "valueType": { "$id": "1395", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1396", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1395" }, "enumType": { "$ref": "1394" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Output,Json", "decorators": [] }, { "$id": "1397", "kind": "enum", "name": "VectorStoreExpirationAnchor", "crossLanguageDefinitionId": "OpenAI.VectorStoreExpirationAnchor", "valueType": { "$id": "1398", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1399", "kind": "enumvalue", "name": "last_active_at", "value": "last_active_at", "valueType": { "$ref": "1398" }, "enumType": { "$ref": "1397" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "decorators": [] }, { "$id": "1400", "kind": "enum", "name": "CreateFineTuningJobRequestHyperparametersBatchSizeChoiceEnum", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestHyperparametersBatchSizeChoiceEnum", "valueType": { "$id": "1401", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1402", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1401" }, "enumType": { "$ref": "1400" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1403", "kind": "enum", "name": "CreateFineTuningJobRequestHyperparametersLearningRateMultiplierChoiceEnum", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestHyperparametersLearningRateMultiplierChoiceEnum", "valueType": { "$id": "1404", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1405", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1404" }, "enumType": { "$ref": "1403" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1406", "kind": "enum", "name": "CreateFineTuningJobRequestHyperparametersNEpochsChoiceEnum", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestHyperparametersNEpochsChoiceEnum", "valueType": { "$id": "1407", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1408", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1407" }, "enumType": { "$ref": "1406" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1409", "kind": "enum", "name": "CreateFineTuningJobRequestHyperparametersBetaChoiceEnum", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestHyperparametersBetaChoiceEnum", "valueType": { "$id": "1410", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1411", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1410" }, "enumType": { "$ref": "1409" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input", "decorators": [] }, { "$id": "1412", "kind": "enum", "name": "DotNetResponseReasoningEffortLevel", "crossLanguageDefinitionId": "OpenAI.DotNetResponseReasoningEffortLevel", "valueType": { "$id": "1413", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1414", "kind": "enumvalue", "name": "minimal", "value": "minimal", "valueType": { "$ref": "1413" }, "enumType": { "$ref": "1412" }, "decorators": [] }, { "$id": "1415", "kind": "enumvalue", "name": "low", "value": "low", "valueType": { "$ref": "1413" }, "enumType": { "$ref": "1412" }, "decorators": [] }, { "$id": "1416", "kind": "enumvalue", "name": "medium", "value": "medium", "valueType": { "$ref": "1413" }, "enumType": { "$ref": "1412" }, "decorators": [] }, { "$id": "1417", "kind": "enumvalue", "name": "high", "value": "high", "valueType": { "$ref": "1413" }, "enumType": { "$ref": "1412" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1418", "kind": "enum", "name": "DotNetAudioVoiceIds", "crossLanguageDefinitionId": "OpenAI.DotNetAudioVoiceIds", "valueType": { "$id": "1419", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1420", "kind": "enumvalue", "name": "alloy", "value": "alloy", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1421", "kind": "enumvalue", "name": "ash", "value": "ash", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1422", "kind": "enumvalue", "name": "ballad", "value": "ballad", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1423", "kind": "enumvalue", "name": "coral", "value": "coral", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1424", "kind": "enumvalue", "name": "echo", "value": "echo", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1425", "kind": "enumvalue", "name": "fable", "value": "fable", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1426", "kind": "enumvalue", "name": "onyx", "value": "onyx", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1427", "kind": "enumvalue", "name": "nova", "value": "nova", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1428", "kind": "enumvalue", "name": "sage", "value": "sage", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1429", "kind": "enumvalue", "name": "shimmer", "value": "shimmer", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] }, { "$id": "1430", "kind": "enumvalue", "name": "verse", "value": "verse", "valueType": { "$ref": "1419" }, "enumType": { "$ref": "1418" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output", "decorators": [] }, { "$id": "1431", "kind": "enum", "name": "DotNetChatVoiceIds", "crossLanguageDefinitionId": "OpenAI.DotNetChatVoiceIds", "valueType": { "$id": "1432", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1433", "kind": "enumvalue", "name": "alloy", "value": "alloy", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1434", "kind": "enumvalue", "name": "ash", "value": "ash", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1435", "kind": "enumvalue", "name": "ballad", "value": "ballad", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1436", "kind": "enumvalue", "name": "coral", "value": "coral", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1437", "kind": "enumvalue", "name": "echo", "value": "echo", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1438", "kind": "enumvalue", "name": "fable", "value": "fable", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1439", "kind": "enumvalue", "name": "onyx", "value": "onyx", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1440", "kind": "enumvalue", "name": "nova", "value": "nova", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1441", "kind": "enumvalue", "name": "sage", "value": "sage", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1442", "kind": "enumvalue", "name": "shimmer", "value": "shimmer", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] }, { "$id": "1443", "kind": "enumvalue", "name": "verse", "value": "verse", "valueType": { "$ref": "1432" }, "enumType": { "$ref": "1431" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, { "$id": "1444", "kind": "enum", "name": "DotNetRealtimeVoiceIds", "crossLanguageDefinitionId": "OpenAI.DotNetRealtimeVoiceIds", "valueType": { "$id": "1445", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "1446", "kind": "enumvalue", "name": "alloy", "value": "alloy", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1447", "kind": "enumvalue", "name": "ash", "value": "ash", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1448", "kind": "enumvalue", "name": "ballad", "value": "ballad", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1449", "kind": "enumvalue", "name": "coral", "value": "coral", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1450", "kind": "enumvalue", "name": "echo", "value": "echo", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1451", "kind": "enumvalue", "name": "fable", "value": "fable", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1452", "kind": "enumvalue", "name": "onyx", "value": "onyx", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1453", "kind": "enumvalue", "name": "nova", "value": "nova", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1454", "kind": "enumvalue", "name": "sage", "value": "sage", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1455", "kind": "enumvalue", "name": "shimmer", "value": "shimmer", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] }, { "$id": "1456", "kind": "enumvalue", "name": "verse", "value": "verse", "valueType": { "$ref": "1445" }, "enumType": { "$ref": "1444" }, "decorators": [] } ], "access": "public", "namespace": "OpenAI", "isFixed": false, "isFlags": false, "usage": "Input,Output", "decorators": [] } ], "constants": [ { "$id": "1457", "kind": "constant", "name": "ListAssistantsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1458", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1459", "kind": "constant", "name": "AssistantObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1460", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistant", "decorators": [] }, { "$id": "1461", "kind": "constant", "name": "FileSearchRankingOptionsRanker", "namespace": "", "usage": "None", "valueType": { "$id": "1462", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1463", "kind": "constant", "name": "DeleteAssistantResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1464", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistant.deleted", "decorators": [] }, { "$id": "1465", "kind": "constant", "name": "VadConfigType", "namespace": "OpenAI", "usage": "Input", "valueType": { "$id": "1466", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "server_vad", "decorators": [] }, { "$id": "1467", "kind": "constant", "name": "CreateTranscriptionResponseVerboseJsonTask", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1468", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "transcribe", "decorators": [] }, { "$id": "1469", "kind": "constant", "name": "CreateTranslationResponseVerboseJsonTask", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1470", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "translate", "decorators": [] }, { "$id": "1471", "kind": "constant", "name": "CreateBatchRequestCompletion_window", "namespace": "", "usage": "Spread,Json", "valueType": { "$id": "1472", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "24h", "decorators": [] }, { "$id": "1473", "kind": "constant", "name": "BatchObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1474", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "batch", "decorators": [] }, { "$id": "1475", "kind": "constant", "name": "ListBatchesResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1476", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1477", "kind": "constant", "name": "ChatCompletionListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1478", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1479", "kind": "constant", "name": "ChatCompletionResponseMessageAnnotationType", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1480", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "url_citation", "decorators": [] }, { "$id": "1481", "kind": "constant", "name": "CreateChatCompletionResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1482", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "chat.completion", "decorators": [] }, { "$id": "1483", "kind": "constant", "name": "CreateChatCompletionRequestWebSearchOptionsUserLocation1Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1484", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "approximate", "decorators": [] }, { "$id": "1485", "kind": "constant", "name": "ChatCompletionNamedToolChoiceType", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1486", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "function", "decorators": [] }, { "$id": "1487", "kind": "constant", "name": "CreateChatCompletionRequestToolChoice1", "namespace": "", "usage": "None", "valueType": { "$id": "1488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "none", "decorators": [] }, { "$id": "1489", "kind": "constant", "name": "FileSearchRankingOptionsRanker1", "namespace": "", "usage": "None", "valueType": { "$id": "1490", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1491", "kind": "constant", "name": "CreateChatCompletionStreamResponseObject", "namespace": "OpenAI", "access": "public", "usage": "Output", "valueType": { "$id": "1492", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "chat.completion.chunk", "decorators": [] }, { "$id": "1493", "kind": "constant", "name": "ChatCompletionDeletedObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1494", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "chat.completion.deleted", "decorators": [] }, { "$id": "1495", "kind": "constant", "name": "ChatCompletionMessageListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1496", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1497", "kind": "constant", "name": "ContainerListResourceObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1498", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1499", "kind": "constant", "name": "CreateContainerBodyExpiresAfterAnchor", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1500", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "last_active_at", "decorators": [] }, { "$id": "1501", "kind": "constant", "name": "DeleteContainerResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1502", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "container.deleted", "decorators": [] }, { "$id": "1503", "kind": "constant", "name": "DeleteContainerResponseDeleted", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1504", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "value": true, "decorators": [] }, { "$id": "1505", "kind": "constant", "name": "ContainerFileListResourceObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1506", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1507", "kind": "constant", "name": "DeleteContainerFileResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1508", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "container.file.deleted", "decorators": [] }, { "$id": "1509", "kind": "constant", "name": "DeleteContainerFileResponseDeleted", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1510", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "value": true, "decorators": [] }, { "$id": "1511", "kind": "constant", "name": "EmbeddingObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1512", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "embedding", "decorators": [] }, { "$id": "1513", "kind": "constant", "name": "CreateEmbeddingResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1514", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1515", "kind": "constant", "name": "ListFilesResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1516", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1517", "kind": "constant", "name": "OpenAIFileObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1518", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "file", "decorators": [] }, { "$id": "1519", "kind": "constant", "name": "DeleteFileResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1520", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "file", "decorators": [] }, { "$id": "1521", "kind": "constant", "name": "FineTuningCheckpointPermissionObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1522", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "checkpoint.permission", "decorators": [] }, { "$id": "1523", "kind": "constant", "name": "ListFineTuningCheckpointPermissionResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1524", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1525", "kind": "constant", "name": "DeleteFineTuningCheckpointPermissionResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1526", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "checkpoint.permission", "decorators": [] }, { "$id": "1527", "kind": "constant", "name": "FileSearchRankingOptionsRanker2", "namespace": "", "usage": "None", "valueType": { "$id": "1528", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1529", "kind": "constant", "name": "FileSearchRankingOptionsRanker3", "namespace": "", "usage": "None", "valueType": { "$id": "1530", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1531", "kind": "constant", "name": "FileSearchRankingOptionsRanker4", "namespace": "", "usage": "None", "valueType": { "$id": "1532", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1533", "kind": "constant", "name": "FileSearchRankingOptionsRanker5", "namespace": "", "usage": "None", "valueType": { "$id": "1534", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1535", "kind": "constant", "name": "FileSearchRankingOptionsRanker6", "namespace": "", "usage": "None", "valueType": { "$id": "1536", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1537", "kind": "constant", "name": "FileSearchRankingOptionsRanker7", "namespace": "", "usage": "None", "valueType": { "$id": "1538", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1539", "kind": "constant", "name": "FileSearchRankingOptionsRanker8", "namespace": "", "usage": "None", "valueType": { "$id": "1540", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1541", "kind": "constant", "name": "FileSearchRankingOptionsRanker9", "namespace": "", "usage": "None", "valueType": { "$id": "1542", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1543", "kind": "constant", "name": "FileSearchRankingOptionsRanker10", "namespace": "", "usage": "None", "valueType": { "$id": "1544", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1545", "kind": "constant", "name": "FileSearchRankingOptionsRanker11", "namespace": "", "usage": "None", "valueType": { "$id": "1546", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1547", "kind": "constant", "name": "FileSearchRankingOptionsRanker12", "namespace": "", "usage": "None", "valueType": { "$id": "1548", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1549", "kind": "constant", "name": "FileSearchRankingOptionsRanker13", "namespace": "", "usage": "None", "valueType": { "$id": "1550", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1551", "kind": "constant", "name": "FileSearchRankingOptionsRanker14", "namespace": "", "usage": "None", "valueType": { "$id": "1552", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1553", "kind": "constant", "name": "FileSearchRankingOptionsRanker15", "namespace": "", "usage": "None", "valueType": { "$id": "1554", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1555", "kind": "constant", "name": "FileSearchRankingOptionsRanker16", "namespace": "", "usage": "None", "valueType": { "$id": "1556", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1557", "kind": "constant", "name": "FileSearchRankingOptionsRanker17", "namespace": "", "usage": "None", "valueType": { "$id": "1558", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1559", "kind": "constant", "name": "FileSearchRankingOptionsRanker18", "namespace": "", "usage": "None", "valueType": { "$id": "1560", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1561", "kind": "constant", "name": "FileSearchRankingOptionsRanker19", "namespace": "", "usage": "None", "valueType": { "$id": "1562", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1563", "kind": "constant", "name": "FileSearchRankingOptionsRanker20", "namespace": "", "usage": "None", "valueType": { "$id": "1564", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1565", "kind": "constant", "name": "FineTuningJobObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1566", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "fine_tuning.job", "decorators": [] }, { "$id": "1567", "kind": "constant", "name": "ListPaginatedFineTuningJobsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1568", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1569", "kind": "constant", "name": "FineTuningJobCheckpointObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1570", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "fine_tuning.job.checkpoint", "decorators": [] }, { "$id": "1571", "kind": "constant", "name": "ListFineTuningJobCheckpointsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1572", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1573", "kind": "constant", "name": "FineTuningJobEventObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1574", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "fine_tuning.job.event", "decorators": [] }, { "$id": "1575", "kind": "constant", "name": "ListFineTuningJobEventsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1576", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1577", "kind": "constant", "name": "EvalListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1578", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1579", "kind": "constant", "name": "EvalObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1580", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "eval", "decorators": [] }, { "$id": "1581", "kind": "constant", "name": "DeleteEvalResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1582", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "eval.deleted", "decorators": [] }, { "$id": "1583", "kind": "constant", "name": "EvalRunListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1584", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1585", "kind": "constant", "name": "EvalRunObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1586", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "eval.run", "decorators": [] }, { "$id": "1587", "kind": "constant", "name": "EvalCompletionsRunDataSourceParamsInputMessages1Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1588", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "template", "decorators": [] }, { "$id": "1589", "kind": "constant", "name": "EvalCompletionsRunDataSourceParamsInputMessages2Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1590", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "item_reference", "decorators": [] }, { "$id": "1591", "kind": "constant", "name": "EvalResponsesRunDataSourceParamsInputMessages1Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1592", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "template", "decorators": [] }, { "$id": "1593", "kind": "constant", "name": "EvalResponsesRunDataSourceParamsInputMessages2Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1594", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "item_reference", "decorators": [] }, { "$id": "1595", "kind": "constant", "name": "MCPToolRequireApproval2", "namespace": "", "usage": "None", "valueType": { "$id": "1596", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "always", "decorators": [] }, { "$id": "1597", "kind": "constant", "name": "MCPToolRequireApproval3", "namespace": "", "usage": "None", "valueType": { "$id": "1598", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "never", "decorators": [] }, { "$id": "1599", "kind": "constant", "name": "DeleteEvalRunResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1600", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "eval_run.deleted", "decorators": [] }, { "$id": "1601", "kind": "constant", "name": "EvalRunOutputItemListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1602", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1603", "kind": "constant", "name": "EvalRunOutputItemObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1604", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "eval.run.output_item", "decorators": [] }, { "$id": "1605", "kind": "constant", "name": "LocalShellExecActionType", "namespace": "OpenAI", "usage": "Input,Output,Json", "valueType": { "$id": "1606", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "exec", "decorators": [] }, { "$id": "1607", "kind": "constant", "name": "ResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1608", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "response", "decorators": [] }, { "$id": "1609", "kind": "constant", "name": "DeleteResponseResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1610", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "response.deleted", "decorators": [] }, { "$id": "1611", "kind": "constant", "name": "ResponseItemListObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1612", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1613", "kind": "constant", "name": "AssistantToolsFileSearchTypeOnlyType", "namespace": "OpenAI", "usage": "Input,Output,Json", "valueType": { "$id": "1614", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "file_search", "decorators": [] }, { "$id": "1615", "kind": "constant", "name": "MessageObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1616", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.message", "decorators": [] }, { "$id": "1617", "kind": "constant", "name": "ListMessagesResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1618", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1619", "kind": "constant", "name": "DeleteMessageResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1620", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.message.deleted", "decorators": [] }, { "$id": "1621", "kind": "constant", "name": "CreateModerationRequestInput2Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1622", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "image_url", "decorators": [] }, { "$id": "1623", "kind": "constant", "name": "CreateModerationRequestInput3Type", "namespace": "OpenAI", "usage": "Input,Json", "valueType": { "$id": "1624", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text", "decorators": [] }, { "$id": "1625", "kind": "constant", "name": "RunObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1626", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.run", "decorators": [] }, { "$id": "1627", "kind": "constant", "name": "RunObjectRequiredAction1Type", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1628", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "submit_tool_outputs", "decorators": [] }, { "$id": "1629", "kind": "constant", "name": "RunToolCallObjectType", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1630", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "function", "decorators": [] }, { "$id": "1631", "kind": "constant", "name": "ListRunsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1632", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1633", "kind": "constant", "name": "ListRunStepsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1634", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1635", "kind": "constant", "name": "RunStepObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1636", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.run.step", "decorators": [] }, { "$id": "1637", "kind": "constant", "name": "ThreadObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1638", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread", "decorators": [] }, { "$id": "1639", "kind": "constant", "name": "DeleteThreadResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1640", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.deleted", "decorators": [] }, { "$id": "1641", "kind": "constant", "name": "ListVectorStoresResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1642", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1643", "kind": "constant", "name": "VectorStoreObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1644", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store", "decorators": [] }, { "$id": "1645", "kind": "constant", "name": "DeleteVectorStoreResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1646", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.deleted", "decorators": [] }, { "$id": "1647", "kind": "constant", "name": "VectorStoreFileBatchObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.files_batch", "decorators": [] }, { "$id": "1649", "kind": "constant", "name": "ListVectorStoreFilesResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1650", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1651", "kind": "constant", "name": "VectorStoreFileObjectObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1652", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.file", "decorators": [] }, { "$id": "1653", "kind": "constant", "name": "DeleteVectorStoreFileResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1654", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.file.deleted", "decorators": [] }, { "$id": "1655", "kind": "constant", "name": "VectorStoreFileContentResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1656", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.file_content.page", "decorators": [] }, { "$id": "1657", "kind": "constant", "name": "VectorStoreSearchResultsPageObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1658", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "vector_store.search_results.page", "decorators": [] }, { "$id": "1659", "kind": "constant", "name": "VectorStoreSearchResultContentObjectType", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1660", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text", "decorators": [] }, { "$id": "1661", "kind": "constant", "name": "CreateCompletionResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1662", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text_completion", "decorators": [] }, { "$id": "1663", "kind": "constant", "name": "ListModelsResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1664", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "1665", "kind": "constant", "name": "ModelObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1666", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "model", "decorators": [] }, { "$id": "1667", "kind": "constant", "name": "DeleteModelResponseObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1668", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "model", "decorators": [] }, { "$id": "1669", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens1", "namespace": "", "usage": "None", "valueType": { "$id": "1670", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1671", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens11", "namespace": "", "usage": "None", "valueType": { "$id": "1672", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1673", "kind": "constant", "name": "RealtimeResponseSessionObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1674", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "realtime.session", "decorators": [] }, { "$id": "1675", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens12", "namespace": "", "usage": "None", "valueType": { "$id": "1676", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1677", "kind": "constant", "name": "RealtimeConversationResponseItemObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1678", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "realtime.item", "decorators": [] }, { "$id": "1679", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens13", "namespace": "", "usage": "None", "valueType": { "$id": "1680", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1681", "kind": "constant", "name": "FileSearchRankingOptionsRanker21", "namespace": "", "usage": "None", "valueType": { "$id": "1682", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1683", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens14", "namespace": "", "usage": "None", "valueType": { "$id": "1684", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1685", "kind": "constant", "name": "FileSearchRankingOptionsRanker22", "namespace": "", "usage": "None", "valueType": { "$id": "1686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "auto", "decorators": [] }, { "$id": "1687", "kind": "constant", "name": "RealtimeRequestSessionMaxResponseOutputTokens15", "namespace": "", "usage": "None", "valueType": { "$id": "1688", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "inf", "decorators": [] }, { "$id": "1689", "kind": "constant", "name": "UploadPartObject", "namespace": "OpenAI", "usage": "Output,Json", "valueType": { "$id": "1690", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "upload.part", "decorators": [] }, { "$id": "1691", "kind": "constant", "name": "MessageDeltaObjectObject", "namespace": "OpenAI", "access": "public", "usage": "Output", "valueType": { "$id": "1692", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.message.delta", "decorators": [] }, { "$id": "1693", "kind": "constant", "name": "RunStepDeltaObjectObject", "namespace": "OpenAI", "access": "public", "usage": "Output", "valueType": { "$id": "1694", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "thread.run.step.delta", "decorators": [] }, { "$id": "1695", "kind": "constant", "name": "DotNetCombinedJsonTranscriptionResponseTask", "namespace": "OpenAI", "access": "public", "usage": "Output", "valueType": { "$id": "1696", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "transcribe", "decorators": [] }, { "$id": "1697", "kind": "constant", "name": "ListAssistantsRequestAccept", "namespace": "", "usage": "None", "valueType": { "$id": "1698", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1699", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta", "namespace": "", "usage": "None", "valueType": { "$id": "1700", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1701", "kind": "constant", "name": "ListAssistantsRequestAccept1", "namespace": "", "usage": "None", "valueType": { "$id": "1702", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1703", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta1", "namespace": "", "usage": "None", "valueType": { "$id": "1704", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1705", "kind": "constant", "name": "ListAssistantsRequestAccept2", "namespace": "", "usage": "None", "valueType": { "$id": "1706", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1707", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta2", "namespace": "", "usage": "None", "valueType": { "$id": "1708", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1709", "kind": "constant", "name": "createAssistantContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1710", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1711", "kind": "constant", "name": "ListAssistantsRequestAccept3", "namespace": "", "usage": "None", "valueType": { "$id": "1712", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1713", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta3", "namespace": "", "usage": "None", "valueType": { "$id": "1714", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1715", "kind": "constant", "name": "ListAssistantsRequestAccept4", "namespace": "", "usage": "None", "valueType": { "$id": "1716", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1717", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta4", "namespace": "", "usage": "None", "valueType": { "$id": "1718", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1719", "kind": "constant", "name": "ListAssistantsRequestAccept5", "namespace": "", "usage": "None", "valueType": { "$id": "1720", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1721", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta5", "namespace": "", "usage": "None", "valueType": { "$id": "1722", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1723", "kind": "constant", "name": "ListAssistantsRequestAccept6", "namespace": "", "usage": "None", "valueType": { "$id": "1724", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1725", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta6", "namespace": "", "usage": "None", "valueType": { "$id": "1726", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1727", "kind": "constant", "name": "modifyAssistantContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1728", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1729", "kind": "constant", "name": "ListAssistantsRequestAccept7", "namespace": "", "usage": "None", "valueType": { "$id": "1730", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1731", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta7", "namespace": "", "usage": "None", "valueType": { "$id": "1732", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1733", "kind": "constant", "name": "ListAssistantsRequestAccept8", "namespace": "", "usage": "None", "valueType": { "$id": "1734", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1735", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta8", "namespace": "", "usage": "None", "valueType": { "$id": "1736", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1737", "kind": "constant", "name": "ListAssistantsRequestAccept9", "namespace": "", "usage": "None", "valueType": { "$id": "1738", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1739", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta9", "namespace": "", "usage": "None", "valueType": { "$id": "1740", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1741", "kind": "constant", "name": "CreateSpeechRequestAccept", "namespace": "", "usage": "None", "valueType": { "$id": "1742", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/octet-stream", "decorators": [] }, { "$id": "1743", "kind": "constant", "name": "createSpeechContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1744", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1745", "kind": "constant", "name": "CreateSpeechRequestAccept1", "namespace": "", "usage": "None", "valueType": { "$id": "1746", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/octet-stream", "decorators": [] }, { "$id": "1747", "kind": "constant", "name": "CreateSpeechRequestAccept2", "namespace": "", "usage": "None", "valueType": { "$id": "1748", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/octet-stream", "decorators": [] }, { "$id": "1749", "kind": "constant", "name": "CreateTranscriptionRequestContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1750", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1751", "kind": "constant", "name": "CreateTranscriptionRequestAccept1", "namespace": "", "usage": "None", "valueType": { "$id": "1752", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text/event-stream", "decorators": [] }, { "$id": "1753", "kind": "constant", "name": "CreateTranscriptionRequestContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1754", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1755", "kind": "constant", "name": "ListAssistantsRequestAccept10", "namespace": "", "usage": "None", "valueType": { "$id": "1756", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1757", "kind": "constant", "name": "CreateTranscriptionRequestContentType2", "namespace": "", "usage": "None", "valueType": { "$id": "1758", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1759", "kind": "constant", "name": "CreateTranslationResponseContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1760", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text/plain", "decorators": [] }, { "$id": "1761", "kind": "constant", "name": "ListAssistantsRequestAccept11", "namespace": "", "usage": "None", "valueType": { "$id": "1762", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1763", "kind": "constant", "name": "CreateTranscriptionRequestContentType3", "namespace": "", "usage": "None", "valueType": { "$id": "1764", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1765", "kind": "constant", "name": "ListAssistantsRequestAccept12", "namespace": "", "usage": "None", "valueType": { "$id": "1766", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1767", "kind": "constant", "name": "createBatchContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1768", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1769", "kind": "constant", "name": "ListAssistantsRequestAccept13", "namespace": "", "usage": "None", "valueType": { "$id": "1770", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1771", "kind": "constant", "name": "CreateBatchRequestCompletionWindow", "namespace": "", "usage": "None", "valueType": { "$id": "1772", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "24h", "decorators": [] }, { "$id": "1773", "kind": "constant", "name": "ListAssistantsRequestAccept14", "namespace": "", "usage": "None", "valueType": { "$id": "1774", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1775", "kind": "constant", "name": "ListAssistantsRequestAccept15", "namespace": "", "usage": "None", "valueType": { "$id": "1776", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1777", "kind": "constant", "name": "ListAssistantsRequestAccept16", "namespace": "", "usage": "None", "valueType": { "$id": "1778", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1779", "kind": "constant", "name": "ListAssistantsRequestAccept17", "namespace": "", "usage": "None", "valueType": { "$id": "1780", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1781", "kind": "constant", "name": "ListAssistantsRequestAccept18", "namespace": "", "usage": "None", "valueType": { "$id": "1782", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1783", "kind": "constant", "name": "ListAssistantsRequestAccept19", "namespace": "", "usage": "None", "valueType": { "$id": "1784", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1785", "kind": "constant", "name": "listChatCompletionsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1786", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1787", "kind": "constant", "name": "ListAssistantsRequestAccept20", "namespace": "", "usage": "None", "valueType": { "$id": "1788", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1789", "kind": "constant", "name": "createChatCompletionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1790", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1791", "kind": "constant", "name": "CreateTranscriptionRequestAccept11", "namespace": "", "usage": "None", "valueType": { "$id": "1792", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text/event-stream", "decorators": [] }, { "$id": "1793", "kind": "constant", "name": "ListAssistantsRequestAccept21", "namespace": "", "usage": "None", "valueType": { "$id": "1794", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1795", "kind": "constant", "name": "getChatCompletionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1796", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1797", "kind": "constant", "name": "updateChatCompletionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1798", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1799", "kind": "constant", "name": "updateChatCompletionContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1800", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1801", "kind": "constant", "name": "deleteChatCompletionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1802", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1803", "kind": "constant", "name": "getChatCompletionMessagesContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1804", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1805", "kind": "constant", "name": "listContainersContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1806", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1807", "kind": "constant", "name": "createContainerContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1808", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1809", "kind": "constant", "name": "createContainerContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1810", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1811", "kind": "constant", "name": "retrieveContainerContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1812", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1813", "kind": "constant", "name": "deleteContainerContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1814", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1815", "kind": "constant", "name": "CreateTranscriptionRequestContentType4", "namespace": "", "usage": "None", "valueType": { "$id": "1816", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1817", "kind": "constant", "name": "createContainerFileContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1818", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1819", "kind": "constant", "name": "CreateTranscriptionRequestContentType5", "namespace": "", "usage": "None", "valueType": { "$id": "1820", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1821", "kind": "constant", "name": "listContainerFilesContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1822", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1823", "kind": "constant", "name": "retrieveContainerFileContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1824", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1825", "kind": "constant", "name": "deleteContainerFileContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1826", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1827", "kind": "constant", "name": "retrieveContainerFileContentContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1828", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/octet-stream", "decorators": [] }, { "$id": "1829", "kind": "constant", "name": "ListAssistantsRequestAccept22", "namespace": "", "usage": "None", "valueType": { "$id": "1830", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1831", "kind": "constant", "name": "createEmbeddingContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1832", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1833", "kind": "constant", "name": "ListAssistantsRequestAccept23", "namespace": "", "usage": "None", "valueType": { "$id": "1834", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1835", "kind": "constant", "name": "ListAssistantsRequestAccept24", "namespace": "", "usage": "None", "valueType": { "$id": "1836", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1837", "kind": "constant", "name": "ListAssistantsRequestAccept25", "namespace": "", "usage": "None", "valueType": { "$id": "1838", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1839", "kind": "constant", "name": "ListAssistantsRequestAccept26", "namespace": "", "usage": "None", "valueType": { "$id": "1840", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1841", "kind": "constant", "name": "CreateTranscriptionRequestContentType6", "namespace": "", "usage": "None", "valueType": { "$id": "1842", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1843", "kind": "constant", "name": "ListAssistantsRequestAccept27", "namespace": "", "usage": "None", "valueType": { "$id": "1844", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1845", "kind": "constant", "name": "CreateTranscriptionRequestContentType7", "namespace": "", "usage": "None", "valueType": { "$id": "1846", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1847", "kind": "constant", "name": "ListAssistantsRequestAccept28", "namespace": "", "usage": "None", "valueType": { "$id": "1848", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1849", "kind": "constant", "name": "ListAssistantsRequestAccept29", "namespace": "", "usage": "None", "valueType": { "$id": "1850", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1851", "kind": "constant", "name": "ListAssistantsRequestAccept30", "namespace": "", "usage": "None", "valueType": { "$id": "1852", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1853", "kind": "constant", "name": "ListAssistantsRequestAccept31", "namespace": "", "usage": "None", "valueType": { "$id": "1854", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1855", "kind": "constant", "name": "ListAssistantsRequestAccept32", "namespace": "", "usage": "None", "valueType": { "$id": "1856", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1857", "kind": "constant", "name": "ListAssistantsRequestAccept33", "namespace": "", "usage": "None", "valueType": { "$id": "1858", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1859", "kind": "constant", "name": "listFineTuningCheckpointPermissionsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1860", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1861", "kind": "constant", "name": "createFineTuningCheckpointPermissionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1862", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1863", "kind": "constant", "name": "createFineTuningCheckpointPermissionContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1864", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1865", "kind": "constant", "name": "deleteFineTuningCheckpointPermissionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1866", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1867", "kind": "constant", "name": "ListAssistantsRequestAccept34", "namespace": "", "usage": "None", "valueType": { "$id": "1868", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1869", "kind": "constant", "name": "createFineTuningJobContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1870", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1871", "kind": "constant", "name": "ListAssistantsRequestAccept35", "namespace": "", "usage": "None", "valueType": { "$id": "1872", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1873", "kind": "constant", "name": "ListAssistantsRequestAccept36", "namespace": "", "usage": "None", "valueType": { "$id": "1874", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1875", "kind": "constant", "name": "ListAssistantsRequestAccept37", "namespace": "", "usage": "None", "valueType": { "$id": "1876", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1877", "kind": "constant", "name": "ListAssistantsRequestAccept38", "namespace": "", "usage": "None", "valueType": { "$id": "1878", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1879", "kind": "constant", "name": "ListAssistantsRequestAccept39", "namespace": "", "usage": "None", "valueType": { "$id": "1880", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1881", "kind": "constant", "name": "ListAssistantsRequestAccept40", "namespace": "", "usage": "None", "valueType": { "$id": "1882", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1883", "kind": "constant", "name": "ListAssistantsRequestAccept41", "namespace": "", "usage": "None", "valueType": { "$id": "1884", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1885", "kind": "constant", "name": "ListAssistantsRequestAccept42", "namespace": "", "usage": "None", "valueType": { "$id": "1886", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1887", "kind": "constant", "name": "ListAssistantsRequestAccept43", "namespace": "", "usage": "None", "valueType": { "$id": "1888", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1889", "kind": "constant", "name": "ListAssistantsRequestAccept44", "namespace": "", "usage": "None", "valueType": { "$id": "1890", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1891", "kind": "constant", "name": "ListAssistantsRequestAccept45", "namespace": "", "usage": "None", "valueType": { "$id": "1892", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1893", "kind": "constant", "name": "pauseFineTuningJobContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1894", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1895", "kind": "constant", "name": "resumeFineTuningJobContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1896", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1897", "kind": "constant", "name": "runGraderContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1898", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1899", "kind": "constant", "name": "runGraderContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1900", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1901", "kind": "constant", "name": "validateGraderContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1902", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1903", "kind": "constant", "name": "validateGraderContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1904", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1905", "kind": "constant", "name": "listEvalsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1906", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1907", "kind": "constant", "name": "createEvalContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1908", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1909", "kind": "constant", "name": "createEvalContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1910", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1911", "kind": "constant", "name": "getEvalContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1912", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1913", "kind": "constant", "name": "updateEvalContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1914", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1915", "kind": "constant", "name": "updateEvalContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1916", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1917", "kind": "constant", "name": "deleteEvalContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1918", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1919", "kind": "constant", "name": "getEvalRunsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1920", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1921", "kind": "constant", "name": "createEvalRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1922", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1923", "kind": "constant", "name": "createEvalRunContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "1924", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1925", "kind": "constant", "name": "getEvalRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1926", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1927", "kind": "constant", "name": "cancelEvalRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1928", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1929", "kind": "constant", "name": "deleteEvalRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1930", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1931", "kind": "constant", "name": "getEvalRunOutputItemsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1932", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1933", "kind": "constant", "name": "getEvalRunOutputItemContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1934", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1935", "kind": "constant", "name": "createResponseContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1936", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1937", "kind": "constant", "name": "CreateTranscriptionRequestAccept12", "namespace": "", "usage": "None", "valueType": { "$id": "1938", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text/event-stream", "decorators": [] }, { "$id": "1939", "kind": "constant", "name": "CreateTranscriptionRequestAccept13", "namespace": "", "usage": "None", "valueType": { "$id": "1940", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "text/event-stream", "decorators": [] }, { "$id": "1941", "kind": "constant", "name": "deleteResponseContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1942", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1943", "kind": "constant", "name": "cancelResponseContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1944", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1945", "kind": "constant", "name": "listInputItemsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1946", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1947", "kind": "constant", "name": "ListAssistantsRequestAccept46", "namespace": "", "usage": "None", "valueType": { "$id": "1948", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1949", "kind": "constant", "name": "createImageContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1950", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1951", "kind": "constant", "name": "ListAssistantsRequestAccept47", "namespace": "", "usage": "None", "valueType": { "$id": "1952", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1953", "kind": "constant", "name": "ListAssistantsRequestAccept48", "namespace": "", "usage": "None", "valueType": { "$id": "1954", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1955", "kind": "constant", "name": "CreateTranscriptionRequestContentType8", "namespace": "", "usage": "None", "valueType": { "$id": "1956", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1957", "kind": "constant", "name": "ListAssistantsRequestAccept49", "namespace": "", "usage": "None", "valueType": { "$id": "1958", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1959", "kind": "constant", "name": "CreateTranscriptionRequestContentType9", "namespace": "", "usage": "None", "valueType": { "$id": "1960", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1961", "kind": "constant", "name": "ListAssistantsRequestAccept50", "namespace": "", "usage": "None", "valueType": { "$id": "1962", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1963", "kind": "constant", "name": "CreateTranscriptionRequestContentType10", "namespace": "", "usage": "None", "valueType": { "$id": "1964", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1965", "kind": "constant", "name": "ListAssistantsRequestAccept51", "namespace": "", "usage": "None", "valueType": { "$id": "1966", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1967", "kind": "constant", "name": "CreateTranscriptionRequestContentType11", "namespace": "", "usage": "None", "valueType": { "$id": "1968", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "1969", "kind": "constant", "name": "ListAssistantsRequestAccept52", "namespace": "", "usage": "None", "valueType": { "$id": "1970", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1971", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta10", "namespace": "", "usage": "None", "valueType": { "$id": "1972", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1973", "kind": "constant", "name": "createMessageContentType", "namespace": "", "usage": "None", "valueType": { "$id": "1974", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1975", "kind": "constant", "name": "ListAssistantsRequestAccept53", "namespace": "", "usage": "None", "valueType": { "$id": "1976", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1977", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta11", "namespace": "", "usage": "None", "valueType": { "$id": "1978", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1979", "kind": "constant", "name": "ListAssistantsRequestAccept54", "namespace": "", "usage": "None", "valueType": { "$id": "1980", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1981", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta12", "namespace": "", "usage": "None", "valueType": { "$id": "1982", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1983", "kind": "constant", "name": "ListAssistantsRequestAccept55", "namespace": "", "usage": "None", "valueType": { "$id": "1984", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1985", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta13", "namespace": "", "usage": "None", "valueType": { "$id": "1986", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1987", "kind": "constant", "name": "ListAssistantsRequestAccept56", "namespace": "", "usage": "None", "valueType": { "$id": "1988", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1989", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta14", "namespace": "", "usage": "None", "valueType": { "$id": "1990", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1991", "kind": "constant", "name": "ListAssistantsRequestAccept57", "namespace": "", "usage": "None", "valueType": { "$id": "1992", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1993", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta15", "namespace": "", "usage": "None", "valueType": { "$id": "1994", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1995", "kind": "constant", "name": "ListAssistantsRequestAccept58", "namespace": "", "usage": "None", "valueType": { "$id": "1996", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "1997", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta16", "namespace": "", "usage": "None", "valueType": { "$id": "1998", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "1999", "kind": "constant", "name": "modifyMessageContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2000", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2001", "kind": "constant", "name": "ListAssistantsRequestAccept59", "namespace": "", "usage": "None", "valueType": { "$id": "2002", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2003", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta17", "namespace": "", "usage": "None", "valueType": { "$id": "2004", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2005", "kind": "constant", "name": "ListAssistantsRequestAccept60", "namespace": "", "usage": "None", "valueType": { "$id": "2006", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2007", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta18", "namespace": "", "usage": "None", "valueType": { "$id": "2008", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2009", "kind": "constant", "name": "ListAssistantsRequestAccept61", "namespace": "", "usage": "None", "valueType": { "$id": "2010", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2011", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta19", "namespace": "", "usage": "None", "valueType": { "$id": "2012", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2013", "kind": "constant", "name": "ListAssistantsRequestAccept62", "namespace": "", "usage": "None", "valueType": { "$id": "2014", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2015", "kind": "constant", "name": "createModerationContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2016", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2017", "kind": "constant", "name": "ListAssistantsRequestAccept63", "namespace": "", "usage": "None", "valueType": { "$id": "2018", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2019", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta20", "namespace": "", "usage": "None", "valueType": { "$id": "2020", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2021", "kind": "constant", "name": "createThreadAndRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2022", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2023", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta21", "namespace": "", "usage": "None", "valueType": { "$id": "2024", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2025", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta22", "namespace": "", "usage": "None", "valueType": { "$id": "2026", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2027", "kind": "constant", "name": "createRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2028", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2029", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta23", "namespace": "", "usage": "None", "valueType": { "$id": "2030", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2031", "kind": "constant", "name": "ListAssistantsRequestAccept64", "namespace": "", "usage": "None", "valueType": { "$id": "2032", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2033", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta24", "namespace": "", "usage": "None", "valueType": { "$id": "2034", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2035", "kind": "constant", "name": "ListAssistantsRequestAccept65", "namespace": "", "usage": "None", "valueType": { "$id": "2036", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2037", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta25", "namespace": "", "usage": "None", "valueType": { "$id": "2038", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2039", "kind": "constant", "name": "ListAssistantsRequestAccept66", "namespace": "", "usage": "None", "valueType": { "$id": "2040", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2041", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta26", "namespace": "", "usage": "None", "valueType": { "$id": "2042", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2043", "kind": "constant", "name": "ListAssistantsRequestAccept67", "namespace": "", "usage": "None", "valueType": { "$id": "2044", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2045", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta27", "namespace": "", "usage": "None", "valueType": { "$id": "2046", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2047", "kind": "constant", "name": "ListAssistantsRequestAccept68", "namespace": "", "usage": "None", "valueType": { "$id": "2048", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2049", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta28", "namespace": "", "usage": "None", "valueType": { "$id": "2050", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2051", "kind": "constant", "name": "modifyRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2052", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2053", "kind": "constant", "name": "ListAssistantsRequestAccept69", "namespace": "", "usage": "None", "valueType": { "$id": "2054", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2055", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta29", "namespace": "", "usage": "None", "valueType": { "$id": "2056", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2057", "kind": "constant", "name": "ListAssistantsRequestAccept70", "namespace": "", "usage": "None", "valueType": { "$id": "2058", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2059", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta30", "namespace": "", "usage": "None", "valueType": { "$id": "2060", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2061", "kind": "constant", "name": "ListAssistantsRequestAccept71", "namespace": "", "usage": "None", "valueType": { "$id": "2062", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2063", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta31", "namespace": "", "usage": "None", "valueType": { "$id": "2064", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2065", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta32", "namespace": "", "usage": "None", "valueType": { "$id": "2066", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2067", "kind": "constant", "name": "submitToolOutputsToRunContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2068", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2069", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta33", "namespace": "", "usage": "None", "valueType": { "$id": "2070", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2071", "kind": "constant", "name": "ListAssistantsRequestAccept72", "namespace": "", "usage": "None", "valueType": { "$id": "2072", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2073", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta34", "namespace": "", "usage": "None", "valueType": { "$id": "2074", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2075", "kind": "constant", "name": "ListAssistantsRequestAccept73", "namespace": "", "usage": "None", "valueType": { "$id": "2076", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2077", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta35", "namespace": "", "usage": "None", "valueType": { "$id": "2078", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2079", "kind": "constant", "name": "ListAssistantsRequestAccept74", "namespace": "", "usage": "None", "valueType": { "$id": "2080", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2081", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta36", "namespace": "", "usage": "None", "valueType": { "$id": "2082", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2083", "kind": "constant", "name": "ListAssistantsRequestAccept75", "namespace": "", "usage": "None", "valueType": { "$id": "2084", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2085", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta37", "namespace": "", "usage": "None", "valueType": { "$id": "2086", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2087", "kind": "constant", "name": "ListAssistantsRequestAccept76", "namespace": "", "usage": "None", "valueType": { "$id": "2088", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2089", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta38", "namespace": "", "usage": "None", "valueType": { "$id": "2090", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2091", "kind": "constant", "name": "createThreadContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2092", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2093", "kind": "constant", "name": "ListAssistantsRequestAccept77", "namespace": "", "usage": "None", "valueType": { "$id": "2094", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2095", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta39", "namespace": "", "usage": "None", "valueType": { "$id": "2096", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2097", "kind": "constant", "name": "ListAssistantsRequestAccept78", "namespace": "", "usage": "None", "valueType": { "$id": "2098", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2099", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta40", "namespace": "", "usage": "None", "valueType": { "$id": "2100", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2101", "kind": "constant", "name": "ListAssistantsRequestAccept79", "namespace": "", "usage": "None", "valueType": { "$id": "2102", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2103", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta41", "namespace": "", "usage": "None", "valueType": { "$id": "2104", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2105", "kind": "constant", "name": "ListAssistantsRequestAccept80", "namespace": "", "usage": "None", "valueType": { "$id": "2106", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2107", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta42", "namespace": "", "usage": "None", "valueType": { "$id": "2108", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2109", "kind": "constant", "name": "modifyThreadContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2110", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2111", "kind": "constant", "name": "ListAssistantsRequestAccept81", "namespace": "", "usage": "None", "valueType": { "$id": "2112", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2113", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta43", "namespace": "", "usage": "None", "valueType": { "$id": "2114", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2115", "kind": "constant", "name": "ListAssistantsRequestAccept82", "namespace": "", "usage": "None", "valueType": { "$id": "2116", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2117", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta44", "namespace": "", "usage": "None", "valueType": { "$id": "2118", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2119", "kind": "constant", "name": "ListAssistantsRequestAccept83", "namespace": "", "usage": "None", "valueType": { "$id": "2120", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2121", "kind": "constant", "name": "ListAssistantsRequestOpenAiBeta45", "namespace": "", "usage": "None", "valueType": { "$id": "2122", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "assistants=v2", "decorators": [] }, { "$id": "2123", "kind": "constant", "name": "ListAssistantsRequestAccept84", "namespace": "", "usage": "None", "valueType": { "$id": "2124", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2125", "kind": "constant", "name": "ListAssistantsRequestAccept85", "namespace": "", "usage": "None", "valueType": { "$id": "2126", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2127", "kind": "constant", "name": "ListAssistantsRequestAccept86", "namespace": "", "usage": "None", "valueType": { "$id": "2128", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2129", "kind": "constant", "name": "createVectorStoreContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2130", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2131", "kind": "constant", "name": "ListAssistantsRequestAccept87", "namespace": "", "usage": "None", "valueType": { "$id": "2132", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2133", "kind": "constant", "name": "ListAssistantsRequestAccept88", "namespace": "", "usage": "None", "valueType": { "$id": "2134", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2135", "kind": "constant", "name": "ListAssistantsRequestAccept89", "namespace": "", "usage": "None", "valueType": { "$id": "2136", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2137", "kind": "constant", "name": "ListAssistantsRequestAccept90", "namespace": "", "usage": "None", "valueType": { "$id": "2138", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2139", "kind": "constant", "name": "modifyVectorStoreContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2140", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2141", "kind": "constant", "name": "ListAssistantsRequestAccept91", "namespace": "", "usage": "None", "valueType": { "$id": "2142", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2143", "kind": "constant", "name": "ListAssistantsRequestAccept92", "namespace": "", "usage": "None", "valueType": { "$id": "2144", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2145", "kind": "constant", "name": "ListAssistantsRequestAccept93", "namespace": "", "usage": "None", "valueType": { "$id": "2146", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2147", "kind": "constant", "name": "ListAssistantsRequestAccept94", "namespace": "", "usage": "None", "valueType": { "$id": "2148", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2149", "kind": "constant", "name": "createVectorStoreFileBatchContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2150", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2151", "kind": "constant", "name": "ListAssistantsRequestAccept95", "namespace": "", "usage": "None", "valueType": { "$id": "2152", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2153", "kind": "constant", "name": "ListAssistantsRequestAccept96", "namespace": "", "usage": "None", "valueType": { "$id": "2154", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2155", "kind": "constant", "name": "ListAssistantsRequestAccept97", "namespace": "", "usage": "None", "valueType": { "$id": "2156", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2157", "kind": "constant", "name": "ListAssistantsRequestAccept98", "namespace": "", "usage": "None", "valueType": { "$id": "2158", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2159", "kind": "constant", "name": "ListAssistantsRequestAccept99", "namespace": "", "usage": "None", "valueType": { "$id": "2160", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2161", "kind": "constant", "name": "ListAssistantsRequestAccept100", "namespace": "", "usage": "None", "valueType": { "$id": "2162", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2163", "kind": "constant", "name": "ListAssistantsRequestAccept101", "namespace": "", "usage": "None", "valueType": { "$id": "2164", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2165", "kind": "constant", "name": "ListAssistantsRequestAccept102", "namespace": "", "usage": "None", "valueType": { "$id": "2166", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2167", "kind": "constant", "name": "ListAssistantsRequestAccept103", "namespace": "", "usage": "None", "valueType": { "$id": "2168", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2169", "kind": "constant", "name": "ListAssistantsRequestAccept104", "namespace": "", "usage": "None", "valueType": { "$id": "2170", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2171", "kind": "constant", "name": "createVectorStoreFileContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2172", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2173", "kind": "constant", "name": "ListAssistantsRequestAccept105", "namespace": "", "usage": "None", "valueType": { "$id": "2174", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2175", "kind": "constant", "name": "ListAssistantsRequestAccept106", "namespace": "", "usage": "None", "valueType": { "$id": "2176", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2177", "kind": "constant", "name": "ListAssistantsRequestAccept107", "namespace": "", "usage": "None", "valueType": { "$id": "2178", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2179", "kind": "constant", "name": "ListAssistantsRequestAccept108", "namespace": "", "usage": "None", "valueType": { "$id": "2180", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2181", "kind": "constant", "name": "ListAssistantsRequestAccept109", "namespace": "", "usage": "None", "valueType": { "$id": "2182", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2183", "kind": "constant", "name": "updateVectorStoreFileAttributesContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2184", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2185", "kind": "constant", "name": "updateVectorStoreFileAttributesContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2186", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2187", "kind": "constant", "name": "retrieveVectorStoreFileContentContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2188", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2189", "kind": "constant", "name": "searchVectorStoreContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2190", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2191", "kind": "constant", "name": "searchVectorStoreContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2192", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2193", "kind": "constant", "name": "ListAssistantsRequestAccept110", "namespace": "", "usage": "None", "valueType": { "$id": "2194", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2195", "kind": "constant", "name": "createCompletionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2196", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2197", "kind": "constant", "name": "ListAssistantsRequestAccept111", "namespace": "", "usage": "None", "valueType": { "$id": "2198", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2199", "kind": "constant", "name": "ListAssistantsRequestAccept112", "namespace": "", "usage": "None", "valueType": { "$id": "2200", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2201", "kind": "constant", "name": "ListAssistantsRequestAccept113", "namespace": "", "usage": "None", "valueType": { "$id": "2202", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2203", "kind": "constant", "name": "ListAssistantsRequestAccept114", "namespace": "", "usage": "None", "valueType": { "$id": "2204", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2205", "kind": "constant", "name": "ListAssistantsRequestAccept115", "namespace": "", "usage": "None", "valueType": { "$id": "2206", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2207", "kind": "constant", "name": "ListAssistantsRequestAccept116", "namespace": "", "usage": "None", "valueType": { "$id": "2208", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2209", "kind": "constant", "name": "ListAssistantsRequestAccept117", "namespace": "", "usage": "None", "valueType": { "$id": "2210", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2211", "kind": "constant", "name": "StartRealtimeSessionRequestOpenAiBeta", "namespace": "", "usage": "None", "valueType": { "$id": "2212", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "realtime=v1", "decorators": [] }, { "$id": "2213", "kind": "constant", "name": "startRealtimeSessionContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2214", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2215", "kind": "constant", "name": "startRealtimeSessionContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2216", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2217", "kind": "constant", "name": "StartRealtimeSessionRequestOpenAiBeta1", "namespace": "", "usage": "None", "valueType": { "$id": "2218", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "realtime=v1", "decorators": [] }, { "$id": "2219", "kind": "constant", "name": "createEphemeralTokenContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2220", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2221", "kind": "constant", "name": "createEphemeralTokenContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2222", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2223", "kind": "constant", "name": "createEphemeralTranscriptionTokenContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2224", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2225", "kind": "constant", "name": "createEphemeralTranscriptionTokenContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2226", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2227", "kind": "constant", "name": "ListAssistantsRequestAccept118", "namespace": "", "usage": "None", "valueType": { "$id": "2228", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2229", "kind": "constant", "name": "createUploadContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2230", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2231", "kind": "constant", "name": "ListAssistantsRequestAccept119", "namespace": "", "usage": "None", "valueType": { "$id": "2232", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2233", "kind": "constant", "name": "ListAssistantsRequestAccept120", "namespace": "", "usage": "None", "valueType": { "$id": "2234", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2235", "kind": "constant", "name": "CreateTranscriptionRequestContentType12", "namespace": "", "usage": "None", "valueType": { "$id": "2236", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "2237", "kind": "constant", "name": "ListAssistantsRequestAccept121", "namespace": "", "usage": "None", "valueType": { "$id": "2238", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2239", "kind": "constant", "name": "CreateTranscriptionRequestContentType13", "namespace": "", "usage": "None", "valueType": { "$id": "2240", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "2241", "kind": "constant", "name": "ListAssistantsRequestAccept122", "namespace": "", "usage": "None", "valueType": { "$id": "2242", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2243", "kind": "constant", "name": "completeUploadContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2244", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2245", "kind": "constant", "name": "ListAssistantsRequestAccept123", "namespace": "", "usage": "None", "valueType": { "$id": "2246", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2247", "kind": "constant", "name": "ListAssistantsRequestAccept124", "namespace": "", "usage": "None", "valueType": { "$id": "2248", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2249", "kind": "constant", "name": "ListAssistantsRequestAccept125", "namespace": "", "usage": "None", "valueType": { "$id": "2250", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2251", "kind": "constant", "name": "listConversationItemsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2252", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2253", "kind": "constant", "name": "ListAssistantsResponseObject1", "namespace": "", "usage": "None", "valueType": { "$id": "2254", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "2255", "kind": "constant", "name": "createConversationItemsContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2256", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2257", "kind": "constant", "name": "createConversationItemsContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2258", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2259", "kind": "constant", "name": "deleteConversationItemContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2260", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2261", "kind": "constant", "name": "ConversationResourceObject", "namespace": "", "usage": "None", "valueType": { "$id": "2262", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "conversation", "decorators": [] }, { "$id": "2263", "kind": "constant", "name": "getConversationItemContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2264", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2265", "kind": "constant", "name": "createConversationContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2266", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2267", "kind": "constant", "name": "createConversationContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2268", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2269", "kind": "constant", "name": "deleteConversationContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2270", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2271", "kind": "constant", "name": "DeletedConversationResourceObject", "namespace": "", "usage": "None", "valueType": { "$id": "2272", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "conversation.deleted", "decorators": [] }, { "$id": "2273", "kind": "constant", "name": "getConversationContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2274", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2275", "kind": "constant", "name": "updateConversationContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2276", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2277", "kind": "constant", "name": "updateConversationContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2278", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2279", "kind": "constant", "name": "ListVideosContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2280", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2281", "kind": "constant", "name": "ListAssistantsResponseObject2", "namespace": "", "usage": "None", "valueType": { "$id": "2282", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "list", "decorators": [] }, { "$id": "2283", "kind": "constant", "name": "VideoResourceObject", "namespace": "", "usage": "None", "valueType": { "$id": "2284", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "video", "decorators": [] }, { "$id": "2285", "kind": "constant", "name": "CreateTranscriptionRequestContentType14", "namespace": "", "usage": "None", "valueType": { "$id": "2286", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "2287", "kind": "constant", "name": "createVideoContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2288", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2289", "kind": "constant", "name": "CreateTranscriptionRequestContentType15", "namespace": "", "usage": "None", "valueType": { "$id": "2290", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "2291", "kind": "constant", "name": "DeleteVideoContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2292", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2293", "kind": "constant", "name": "DeletedVideoResourceObject", "namespace": "", "usage": "None", "valueType": { "$id": "2294", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "video.deleted", "decorators": [] }, { "$id": "2295", "kind": "constant", "name": "GetVideoContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2296", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2297", "kind": "constant", "name": "RetrieveVideoContentResponseContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2298", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "video/mp4", "decorators": [] }, { "$id": "2299", "kind": "constant", "name": "RetrieveVideoContentResponseContentType1", "namespace": "", "usage": "None", "valueType": { "$id": "2300", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "image/webp", "decorators": [] }, { "$id": "2301", "kind": "constant", "name": "CreateTranscriptionRequestContentType16", "namespace": "", "usage": "None", "valueType": { "$id": "2302", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] }, { "$id": "2303", "kind": "constant", "name": "CreateVideoRemixContentType", "namespace": "", "usage": "None", "valueType": { "$id": "2304", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "application/json", "decorators": [] }, { "$id": "2305", "kind": "constant", "name": "CreateTranscriptionRequestContentType17", "namespace": "", "usage": "None", "valueType": { "$id": "2306", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "value": "multipart/form-data", "decorators": [] } ], "models": [ { "$id": "2307", "kind": "model", "name": "ListAssistantsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2308", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1457" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2309", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "2310", "kind": "array", "name": "ArrayAssistantObject", "valueType": { "$id": "2311", "kind": "model", "name": "AssistantObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantObject", "usage": "Output,Json", "doc": "Represents an `assistant` that can call the model and use tools.", "decorators": [], "properties": [ { "$id": "2312", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "2313", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2314", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `assistant`.", "type": { "$ref": "1459" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2315", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the assistant was created.", "type": { "$id": "2316", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2317", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "2318", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the assistant. The maximum length is 256 characters.", "type": { "$id": "2319", "kind": "nullable", "type": { "$id": "2320", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2321", "kind": "property", "name": "description", "serializedName": "description", "doc": "The description of the assistant. The maximum length is 512 characters.", "type": { "$id": "2322", "kind": "nullable", "type": { "$id": "2323", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "2324", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.", "type": { "$id": "2325", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "2326", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The system instructions that the assistant uses. The maximum length is 256,000 characters.", "type": { "$id": "2327", "kind": "nullable", "type": { "$id": "2328", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "2329", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.", "type": { "$id": "2330", "kind": "array", "name": "ArrayAssistantToolDefinition", "valueType": { "$id": "2331", "kind": "model", "name": "AssistantToolDefinition", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolDefinition", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "2332", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolDefinition.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "2332" } ], "discriminatedSubtypes": { "code_interpreter": { "$id": "2333", "kind": "model", "name": "AssistantToolsCode", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolsCode", "usage": "Input,Output,Json", "discriminatorValue": "code_interpreter", "decorators": [], "baseModel": { "$ref": "2331" }, "properties": [ { "$id": "2334", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool being defined: `code_interpreter`", "type": { "$id": "2335", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "2" }, "enumType": { "$id": "2336", "kind": "enum", "decorators": [], "name": "AssistantToolDefinitionType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "2337", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2338", "kind": "enumvalue", "decorators": [], "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "2337" }, "enumType": { "$ref": "2336" } }, { "$id": "2339", "kind": "enumvalue", "decorators": [], "name": "file_search", "value": "file_search", "valueType": { "$ref": "2337" }, "enumType": { "$ref": "2336" } }, { "$id": "2340", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "valueType": { "$ref": "2337" }, "enumType": { "$ref": "2336" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.AssistantToolDefinitionType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsCode.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "file_search": { "$id": "2341", "kind": "model", "name": "AssistantToolsFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch", "usage": "Input,Output,Json", "discriminatorValue": "file_search", "decorators": [], "baseModel": { "$ref": "2331" }, "properties": [ { "$id": "2342", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool being defined: `file_search`", "type": { "$id": "2343", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "2" }, "enumType": { "$ref": "2336" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2344", "kind": "property", "name": "file_search", "serializedName": "file_search", "doc": "Overrides for the file search tool.", "type": { "$id": "2345", "kind": "model", "name": "AssistantToolsFileSearchFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch.file_search.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2346", "kind": "property", "name": "max_num_results", "serializedName": "max_num_results", "doc": "The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.", "type": { "$id": "2347", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch.file_search.anonymous.max_num_results", "serializationOptions": { "json": { "name": "max_num_results" } }, "isHttpMetadata": false }, { "$id": "2348", "kind": "property", "name": "ranking_options", "serializedName": "ranking_options", "type": { "$id": "2349", "kind": "model", "name": "FileSearchRankingOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FileSearchRankingOptions", "usage": "Input,Output,Json", "doc": "The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.", "decorators": [], "properties": [ { "$id": "2350", "kind": "property", "name": "ranker", "serializedName": "ranker", "type": { "$ref": "6" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchRankingOptions.ranker", "serializationOptions": { "json": { "name": "ranker" } }, "isHttpMetadata": false }, { "$id": "2351", "kind": "property", "name": "score_threshold", "serializedName": "score_threshold", "doc": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "$id": "2352", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchRankingOptions.score_threshold", "serializationOptions": { "json": { "name": "score_threshold" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch.file_search.anonymous.ranking_options", "serializationOptions": { "json": { "name": "ranking_options" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearch.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "function": { "$id": "2353", "kind": "model", "name": "AssistantToolsFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolsFunction", "usage": "Input,Output,Json", "discriminatorValue": "function", "decorators": [], "baseModel": { "$ref": "2331" }, "properties": [ { "$id": "2354", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool being defined: `function`", "type": { "$id": "2355", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "2" }, "enumType": { "$ref": "2336" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFunction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2356", "kind": "property", "name": "function", "serializedName": "function", "type": { "$id": "2357", "kind": "model", "name": "FunctionObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionObject", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2358", "kind": "property", "name": "description", "serializedName": "description", "doc": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "$id": "2359", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionObject.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "2360", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "$id": "2361", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionObject.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2362", "kind": "property", "name": "parameters", "serializedName": "parameters", "doc": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list.", "type": { "$id": "2363", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionObject.parameters", "serializationOptions": { "json": { "name": "parameters" } }, "isHttpMetadata": false }, { "$id": "2364", "kind": "property", "name": "strict", "serializedName": "strict", "doc": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).", "type": { "$id": "2365", "kind": "nullable", "type": { "$id": "2366", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionObject.strict", "serializationOptions": { "json": { "name": "strict" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFunction.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "2367", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "2368", "kind": "nullable", "type": { "$id": "2369", "kind": "model", "name": "AssistantObjectToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2370", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "2371", "kind": "model", "name": "AssistantObjectToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources.code_interpreter.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2372", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$id": "2373", "kind": "array", "name": "Array", "valueType": { "$id": "2374", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "2375", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$id": "2376", "kind": "model", "name": "ToolResourcesFileSearchIdsOnly", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearchIdsOnly", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2377", "kind": "property", "name": "vector_store_ids", "serializedName": "vector_store_ids", "doc": "The [vector store](/docs/api-reference/vector-stores/object) attached to this assistant.\nThere can be a maximum of 1 vector store attached to the assistant.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearchIdsOnly.vector_store_ids", "serializationOptions": { "json": { "name": "vector_store_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "2378", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$id": "2379", "kind": "nullable", "type": { "$id": "2380", "kind": "dict", "keyType": { "$id": "2381", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "valueType": { "$id": "2382", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "2383", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.", "type": { "$id": "2384", "kind": "nullable", "type": { "$id": "2385", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "2386", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", "type": { "$id": "2387", "kind": "nullable", "type": { "$id": "2388", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "2389", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "2390", "kind": "nullable", "type": { "$id": "2391", "kind": "union", "name": "AssistantsApiResponseFormatOption", "variantTypes": [ { "$ref": "1461" }, { "$id": "2392", "kind": "model", "name": "ResponseFormatText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormatText", "usage": "Input,Output,Json", "doc": "Default response format. Used to generate text responses.", "discriminatorValue": "text", "decorators": [], "baseModel": { "$id": "2393", "kind": "model", "name": "ResponseFormat", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormat", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "2394", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "10" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormat.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "2394" } ], "discriminatedSubtypes": { "text": { "$ref": "2392" }, "json_object": { "$id": "2395", "kind": "model", "name": "ResponseFormatJsonObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonObject", "usage": "Input,Output,Json", "doc": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.", "discriminatorValue": "json_object", "decorators": [], "baseModel": { "$ref": "2393" }, "properties": [ { "$id": "2396", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of response format being defined. Always `json_object`.", "type": { "$id": "2397", "kind": "enumvalue", "name": "json_object", "value": "json_object", "valueType": { "$ref": "11" }, "enumType": { "$id": "2398", "kind": "enum", "decorators": [], "name": "ResponseFormatType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "2399", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2400", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "valueType": { "$ref": "2399" }, "enumType": { "$ref": "2398" } }, { "$id": "2401", "kind": "enumvalue", "decorators": [], "name": "json_object", "value": "json_object", "valueType": { "$ref": "2399" }, "enumType": { "$ref": "2398" } }, { "$id": "2402", "kind": "enumvalue", "decorators": [], "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "2399" }, "enumType": { "$ref": "2398" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ResponseFormat.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "json_schema": { "$id": "2403", "kind": "model", "name": "ResponseFormatJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema", "usage": "Input,Output,Json", "doc": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).", "discriminatorValue": "json_schema", "decorators": [], "baseModel": { "$ref": "2393" }, "properties": [ { "$id": "2404", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of response format being defined. Always `json_schema`.", "type": { "$id": "2405", "kind": "enumvalue", "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "11" }, "enumType": { "$ref": "2398" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2406", "kind": "property", "name": "json_schema", "serializedName": "json_schema", "doc": "Structured Outputs configuration options, including a JSON Schema.", "type": { "$id": "2407", "kind": "model", "name": "ResponseFormatJsonSchemaJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2408", "kind": "property", "name": "description", "serializedName": "description", "doc": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.", "type": { "$id": "2409", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema.anonymous.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "2410", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.", "type": { "$id": "2411", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2412", "kind": "property", "name": "schema", "serializedName": "schema", "type": { "$id": "2413", "kind": "model", "name": "ResponseFormatJsonSchemaSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchemaSchema", "usage": "Input,Output,Json", "doc": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "decorators": [], "additionalProperties": { "$id": "2414", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "properties": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema.anonymous.schema", "serializationOptions": { "json": { "name": "schema" } }, "isHttpMetadata": false }, { "$id": "2415", "kind": "property", "name": "strict", "serializedName": "strict", "doc": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).", "type": { "$id": "2416", "kind": "nullable", "type": { "$id": "2417", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema.anonymous.strict", "serializationOptions": { "json": { "name": "strict" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatJsonSchema.json_schema", "serializationOptions": { "json": { "name": "json_schema" } }, "isHttpMetadata": false } ] } } }, "properties": [ { "$id": "2418", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of response format being defined. Always `text`.", "type": { "$id": "2419", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "11" }, "enumType": { "$ref": "2398" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFormatText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, { "$ref": "2395" }, { "$ref": "2403" } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantObject.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "2420", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "2421", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "2422", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "2423", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "2424", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "2425", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListAssistantsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "2311" }, { "$ref": "2331" }, { "$ref": "2333" }, { "$ref": "2341" }, { "$ref": "2345" }, { "$ref": "2349" }, { "$ref": "2353" }, { "$ref": "2357" }, { "$ref": "2369" }, { "$ref": "2371" }, { "$ref": "2376" }, { "$ref": "2392" }, { "$ref": "2393" }, { "$ref": "2395" }, { "$ref": "2403" }, { "$ref": "2407" }, { "$ref": "2413" }, { "$id": "2426", "kind": "model", "name": "ErrorResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ErrorResponse", "usage": "Json,Exception", "decorators": [], "properties": [ { "$id": "2427", "kind": "property", "name": "error", "serializedName": "error", "type": { "$id": "2428", "kind": "model", "name": "Error", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Error", "usage": "Output,Json,Exception", "decorators": [], "properties": [ { "$id": "2429", "kind": "property", "name": "code", "serializedName": "code", "type": { "$id": "2430", "kind": "nullable", "type": { "$id": "2431", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "2432", "kind": "property", "name": "message", "serializedName": "message", "type": { "$id": "2433", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "2434", "kind": "property", "name": "param", "serializedName": "param", "type": { "$id": "2435", "kind": "nullable", "type": { "$id": "2436", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false }, { "$id": "2437", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "2438", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ErrorResponse.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, { "$ref": "2428" }, { "$id": "2439", "kind": "model", "name": "CreateAssistantRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2440", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.", "type": { "$ref": "15" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "2441", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the assistant. The maximum length is 256 characters.", "type": { "$id": "2442", "kind": "nullable", "type": { "$id": "2443", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2444", "kind": "property", "name": "description", "serializedName": "description", "doc": "The description of the assistant. The maximum length is 512 characters.", "type": { "$id": "2445", "kind": "nullable", "type": { "$id": "2446", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "2447", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The system instructions that the assistant uses. The maximum length is 256,000 characters.", "type": { "$id": "2448", "kind": "nullable", "type": { "$id": "2449", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "2450", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "type": { "$id": "2451", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "2452", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.", "type": { "$ref": "2330" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "2453", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "2454", "kind": "nullable", "type": { "$id": "2455", "kind": "model", "name": "CreateAssistantRequestToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2456", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "2457", "kind": "model", "name": "CreateAssistantRequestToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources.code_interpreter.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2458", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "2459", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$id": "2460", "kind": "model", "name": "ToolResourcesFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2461", "kind": "property", "name": "vector_store_ids", "serializedName": "vector_store_ids", "doc": "The [vector store](/docs/api-reference/vector-stores/object) attached to this assistant.\nThere can be a maximum of 1 vector store attached to the assistant.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_store_ids", "serializationOptions": { "json": { "name": "vector_store_ids" } }, "isHttpMetadata": false }, { "$id": "2462", "kind": "property", "name": "vector_stores", "serializedName": "vector_stores", "doc": "A helper to create a [vector store](/docs/api-reference/vector-stores/object) with\nfile_ids and attach it to this assistant. There can be a maximum of 1 vector store\nattached to the assistant.", "type": { "$id": "2463", "kind": "array", "name": "Array1", "valueType": { "$id": "2464", "kind": "model", "name": "ToolResourcesFileSearchVectorStore", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_store.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2465", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs to add to the vector store. There can be\na maximum of 10000 files in a vector store.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_store.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false }, { "$id": "2466", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "doc": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", "type": { "$id": "2467", "kind": "model", "name": "ChunkingStrategyRequestParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyRequestParam", "usage": "Input,Json", "doc": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", "decorators": [], "discriminatorProperty": { "$id": "2468", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of chunking strategy.", "type": { "$ref": "59" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyRequestParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "2468" } ], "discriminatedSubtypes": { "auto": { "$id": "2469", "kind": "model", "name": "AutoChunkingStrategyRequestParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AutoChunkingStrategyRequestParam", "usage": "Input,Json", "doc": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", "discriminatorValue": "auto", "decorators": [], "baseModel": { "$ref": "2467" }, "properties": [ { "$id": "2470", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `auto`.", "type": { "$id": "2471", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "60" }, "enumType": { "$id": "2472", "kind": "enum", "decorators": [], "name": "ChunkingStrategyRequestParamType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "2473", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2474", "kind": "enumvalue", "decorators": [], "name": "auto", "value": "auto", "valueType": { "$ref": "2473" }, "enumType": { "$ref": "2472" } }, { "$id": "2475", "kind": "enumvalue", "decorators": [], "name": "static", "value": "static", "valueType": { "$ref": "2473" }, "enumType": { "$ref": "2472" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyRequestParam.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AutoChunkingStrategyRequestParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "static": { "$id": "2476", "kind": "model", "name": "StaticChunkingStrategyRequestParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyRequestParam", "usage": "Input,Json", "doc": "Customize your own chunking strategy by setting chunk size and chunk overlap.", "discriminatorValue": "static", "decorators": [], "baseModel": { "$ref": "2467" }, "properties": [ { "$id": "2477", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `static`.", "type": { "$id": "2478", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "60" }, "enumType": { "$ref": "2472" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyRequestParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2479", "kind": "property", "name": "static", "serializedName": "static", "type": { "$id": "2480", "kind": "model", "name": "StaticChunkingStrategy", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategy", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2481", "kind": "property", "name": "max_chunk_size_tokens", "serializedName": "max_chunk_size_tokens", "doc": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`.", "type": { "$id": "2482", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategy.max_chunk_size_tokens", "serializationOptions": { "json": { "name": "max_chunk_size_tokens" } }, "isHttpMetadata": false }, { "$id": "2483", "kind": "property", "name": "chunk_overlap_tokens", "serializedName": "chunk_overlap_tokens", "doc": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.", "type": { "$id": "2484", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategy.chunk_overlap_tokens", "serializationOptions": { "json": { "name": "chunk_overlap_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyRequestParam.static", "serializationOptions": { "json": { "name": "static" } }, "isHttpMetadata": false } ] } } }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_store.anonymous.chunking_strategy", "serializationOptions": { "json": { "name": "chunking_strategy" } }, "isHttpMetadata": false }, { "$id": "2485", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_store.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolResourcesFileSearch.vector_stores", "serializationOptions": { "json": { "name": "vector_stores" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "2486", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "2487", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.", "type": { "$id": "2488", "kind": "nullable", "type": { "$id": "2489", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "2490", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", "type": { "$id": "2491", "kind": "nullable", "type": { "$id": "2492", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "2493", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "2494", "kind": "nullable", "type": { "$ref": "2391" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateAssistantRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, { "$ref": "2455" }, { "$ref": "2457" }, { "$ref": "2460" }, { "$ref": "2464" }, { "$ref": "2467" }, { "$ref": "2469" }, { "$ref": "2476" }, { "$ref": "2480" }, { "$id": "2495", "kind": "model", "name": "ModifyAssistantRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2496", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.", "type": { "$ref": "15" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "2497", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "type": { "$id": "2498", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "2499", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the assistant. The maximum length is 256 characters.", "type": { "$id": "2500", "kind": "nullable", "type": { "$id": "2501", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2502", "kind": "property", "name": "description", "serializedName": "description", "doc": "The description of the assistant. The maximum length is 512 characters.", "type": { "$id": "2503", "kind": "nullable", "type": { "$id": "2504", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "2505", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The system instructions that the assistant uses. The maximum length is 256,000 characters.", "type": { "$id": "2506", "kind": "nullable", "type": { "$id": "2507", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "2508", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.", "type": { "$ref": "2330" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "2509", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "2510", "kind": "nullable", "type": { "$id": "2511", "kind": "model", "name": "ModifyAssistantRequestToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2512", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "2513", "kind": "model", "name": "ModifyAssistantRequestToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources.code_interpreter.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2514", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "Overrides the list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "2515", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$ref": "2376" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "2516", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "2517", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.", "type": { "$id": "2518", "kind": "nullable", "type": { "$id": "2519", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "2520", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", "type": { "$id": "2521", "kind": "nullable", "type": { "$id": "2522", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "2523", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "2524", "kind": "nullable", "type": { "$ref": "2391" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyAssistantRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, { "$ref": "2511" }, { "$ref": "2513" }, { "$id": "2525", "kind": "model", "name": "DeleteAssistantResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteAssistantResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2526", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "2527", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteAssistantResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2528", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "2529", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteAssistantResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "2530", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1463" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteAssistantResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "2531", "kind": "model", "name": "CreateSpeechRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "2532", "kind": "property", "name": "model", "serializedName": "model", "doc": "One of the available [TTS models](/docs/models#tts): `tts-1`, `tts-1-hd` or `gpt-4o-mini-tts`.", "type": { "$ref": "63" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "2533", "kind": "property", "name": "input", "serializedName": "input", "doc": "The text to generate audio for. The maximum length is 4096 characters.", "type": { "$id": "2534", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "2535", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.", "type": { "$id": "2536", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "2537", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice to use when generating the audio. Supported voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and `verse`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech#voice-options).", "type": { "$ref": "68" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "2538", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.", "type": { "$ref": "81" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false }, { "$id": "2539", "kind": "property", "name": "speed", "serializedName": "speed", "doc": "The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default. Does not work with `gpt-4o-mini-tts`.", "type": { "$id": "2540", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateSpeechRequest.speed", "serializationOptions": { "json": { "name": "speed" } }, "isHttpMetadata": false } ] }, { "$id": "2541", "kind": "model", "name": "CreateTranscriptionRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "2542", "kind": "property", "name": "file", "serializedName": "file", "doc": "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.", "type": { "$id": "2543", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.file", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "file", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2544", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `whisper-1` (which is powered by our open source Whisper V2 model).", "type": { "$ref": "89" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.model", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "model", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2545", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format will improve accuracy and latency.", "type": { "$id": "2546", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.language", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "language", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2547", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should match the audio language.", "type": { "$id": "2548", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.prompt", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "prompt", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2549", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$ref": "94" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.response_format", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "response_format", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2550", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.", "type": { "$id": "2551", "kind": "float32", "name": "ZeroOrOneFloat", "crossLanguageDefinitionId": "OpenAI.ZeroOrOneFloat", "baseType": { "$id": "2552", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.temperature", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "temperature", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2553", "kind": "property", "name": "include[]", "serializedName": "include[]", "doc": "Additional information to include in the transcription response.\n`logprobs` will return the log probabilities of the tokens in the\nresponse to understand the model's confidence in the transcription.\n`logprobs` only works with response_format set to `json` and only with\nthe models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`.", "type": { "$id": "2554", "kind": "array", "name": "ArrayTranscriptionInclude", "valueType": { "$ref": "101" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.include[]", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "include[]", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2555", "kind": "property", "name": "timestamp_granularities[]", "serializedName": "timestamp_granularities[]", "doc": "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", "type": { "$id": "2556", "kind": "array", "name": "Array2", "valueType": { "$ref": "104" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.timestamp_granularities[]", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "timestamp_granularities[]", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2557", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)\nfor more information.\n\nNote: Streaming is not supported for the `whisper-1` model and will be ignored.", "type": { "$id": "2558", "kind": "nullable", "type": { "$id": "2559", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.stream", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "stream", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2560", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "doc": "Controls how the audio is cut into chunks. When set to `\"auto\"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block.", "type": { "$id": "2561", "kind": "nullable", "type": { "$id": "2562", "kind": "model", "name": "VadConfig", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VadConfig", "usage": "Input", "decorators": [], "properties": [ { "$id": "2563", "kind": "property", "name": "type", "doc": "Must be set to `server_vad` to enable manual chunking using server side VAD.", "type": { "$ref": "1465" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VadConfig.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2564", "kind": "property", "name": "prefix_padding_ms", "doc": "Amount of audio to include before the VAD detected speech (in\nmilliseconds).", "type": { "$id": "2565", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VadConfig.prefix_padding_ms", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2566", "kind": "property", "name": "silence_duration_ms", "doc": "Duration of silence to detect speech stop (in milliseconds).\nWith shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.", "type": { "$id": "2567", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VadConfig.silence_duration_ms", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2568", "kind": "property", "name": "threshold", "doc": "Sensitivity threshold (0.0 to 1.0) for voice activity detection. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.", "type": { "$id": "2569", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VadConfig.threshold", "serializationOptions": {}, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionRequest.chunking_strategy", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "chunking_strategy", "headers": [] } }, "isHttpMetadata": false } ] }, { "$ref": "2562" }, { "$id": "2570", "kind": "model", "name": "CreateTranscriptionResponseVerboseJson", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson", "usage": "Output,Json", "doc": "Represents a verbose json transcription response returned by model, based on the provided input.", "decorators": [], "properties": [ { "$id": "2571", "kind": "property", "name": "task", "serializedName": "task", "doc": "The task label.", "type": { "$ref": "1467" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.task", "serializationOptions": { "json": { "name": "task" } }, "isHttpMetadata": false }, { "$id": "2572", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the input audio.", "type": { "$id": "2573", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "2574", "kind": "property", "name": "duration", "serializedName": "duration", "doc": "The duration of the input audio.", "type": { "$id": "2575", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2576", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.duration", "serializationOptions": { "json": { "name": "duration" } }, "isHttpMetadata": false }, { "$id": "2577", "kind": "property", "name": "text", "serializedName": "text", "doc": "The transcribed text.", "type": { "$id": "2578", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "2579", "kind": "property", "name": "words", "serializedName": "words", "doc": "Extracted words and their corresponding timestamps.", "type": { "$id": "2580", "kind": "array", "name": "ArrayTranscriptionWord", "valueType": { "$id": "2581", "kind": "model", "name": "TranscriptionWord", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptionWord", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2582", "kind": "property", "name": "word", "serializedName": "word", "doc": "The text content of the word.", "type": { "$id": "2583", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionWord.word", "serializationOptions": { "json": { "name": "word" } }, "isHttpMetadata": false }, { "$id": "2584", "kind": "property", "name": "start", "serializedName": "start", "doc": "Start time of the word in seconds.", "type": { "$id": "2585", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2586", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionWord.start", "serializationOptions": { "json": { "name": "start" } }, "isHttpMetadata": false }, { "$id": "2587", "kind": "property", "name": "end", "serializedName": "end", "doc": "End time of the word in seconds.", "type": { "$id": "2588", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2589", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionWord.end", "serializationOptions": { "json": { "name": "end" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.words", "serializationOptions": { "json": { "name": "words" } }, "isHttpMetadata": false }, { "$id": "2590", "kind": "property", "name": "segments", "serializedName": "segments", "doc": "Segments of the transcribed text and their corresponding details.", "type": { "$id": "2591", "kind": "array", "name": "ArrayTranscriptionSegment", "valueType": { "$id": "2592", "kind": "model", "name": "TranscriptionSegment", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2593", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier of the segment.", "type": { "$id": "2594", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2595", "kind": "property", "name": "seek", "serializedName": "seek", "doc": "Seek offset of the segment.", "type": { "$id": "2596", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.seek", "serializationOptions": { "json": { "name": "seek" } }, "isHttpMetadata": false }, { "$id": "2597", "kind": "property", "name": "start", "serializedName": "start", "doc": "Start time of the segment in seconds.", "type": { "$id": "2598", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2599", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.start", "serializationOptions": { "json": { "name": "start" } }, "isHttpMetadata": false }, { "$id": "2600", "kind": "property", "name": "end", "serializedName": "end", "doc": "End time of the segment in seconds.", "type": { "$id": "2601", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2602", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.end", "serializationOptions": { "json": { "name": "end" } }, "isHttpMetadata": false }, { "$id": "2603", "kind": "property", "name": "text", "serializedName": "text", "doc": "Text content of the segment.", "type": { "$id": "2604", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "2605", "kind": "property", "name": "tokens", "serializedName": "tokens", "doc": "Array of token IDs for the text content.", "type": { "$id": "2606", "kind": "array", "name": "Array3", "valueType": { "$id": "2607", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.tokens", "serializationOptions": { "json": { "name": "tokens" } }, "isHttpMetadata": false }, { "$id": "2608", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Temperature parameter used for generating the segment.", "type": { "$id": "2609", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "2610", "kind": "property", "name": "avg_logprob", "serializedName": "avg_logprob", "doc": "Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.", "type": { "$id": "2611", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.avg_logprob", "serializationOptions": { "json": { "name": "avg_logprob" } }, "isHttpMetadata": false }, { "$id": "2612", "kind": "property", "name": "compression_ratio", "serializedName": "compression_ratio", "doc": "Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.", "type": { "$id": "2613", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.compression_ratio", "serializationOptions": { "json": { "name": "compression_ratio" } }, "isHttpMetadata": false }, { "$id": "2614", "kind": "property", "name": "no_speech_prob", "serializedName": "no_speech_prob", "doc": "Probability of no speech in the segment. If the value is higher than 1.0 and the `avg_logprob` is below -1, consider this segment silent.", "type": { "$id": "2615", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptionSegment.no_speech_prob", "serializationOptions": { "json": { "name": "no_speech_prob" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseVerboseJson.segments", "serializationOptions": { "json": { "name": "segments" } }, "isHttpMetadata": false } ] }, { "$ref": "2581" }, { "$ref": "2592" }, { "$id": "2616", "kind": "model", "name": "CreateTranscriptionResponseJson", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson", "usage": "Output,Json", "doc": "Represents a transcription response returned by model, based on the provided input.", "decorators": [], "properties": [ { "$id": "2617", "kind": "property", "name": "text", "serializedName": "text", "doc": "The transcribed text.", "type": { "$id": "2618", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "2619", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "The log probabilities of the tokens in the transcription. Only returned with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added to the `include` array.", "type": { "$id": "2620", "kind": "array", "name": "Array4", "valueType": { "$id": "2621", "kind": "model", "name": "CreateTranscriptionResponseJsonLogprob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.logprob.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2622", "kind": "property", "name": "token", "serializedName": "token", "doc": "The token in the transcription.", "type": { "$id": "2623", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.logprob.anonymous.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "2624", "kind": "property", "name": "logprob", "serializedName": "logprob", "doc": "The log probability of the token.", "type": { "$id": "2625", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.logprob.anonymous.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "2626", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "The bytes of the token.", "type": { "$id": "2627", "kind": "array", "name": "Array5", "valueType": { "$id": "2628", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.logprob.anonymous.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseJson.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false } ] }, { "$ref": "2621" }, { "$id": "2629", "kind": "model", "name": "CreateTranscriptionResponseStreamEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseStreamEvent", "usage": "Output", "decorators": [], "discriminatorProperty": { "$id": "2630", "kind": "property", "name": "type", "type": { "$ref": "108" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseStreamEvent.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "2630" } ], "discriminatedSubtypes": { "transcript.text.delta": { "$id": "2631", "kind": "model", "name": "TranscriptTextDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent", "usage": "Output", "doc": "Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.", "discriminatorValue": "transcript.text.delta", "decorators": [], "baseModel": { "$ref": "2629" }, "properties": [ { "$id": "2632", "kind": "property", "name": "type", "doc": "The type of the event. Always `transcript.text.delta`.", "type": { "$id": "2633", "kind": "enumvalue", "name": "transcript_text_delta", "value": "transcript.text.delta", "valueType": { "$ref": "109" }, "enumType": { "$id": "2634", "kind": "enum", "decorators": [], "name": "CreateTranscriptionResponseStreamEventType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "2635", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2636", "kind": "enumvalue", "decorators": [], "name": "transcript_text_delta", "value": "transcript.text.delta", "valueType": { "$ref": "2635" }, "enumType": { "$ref": "2634" } }, { "$id": "2637", "kind": "enumvalue", "decorators": [], "name": "transcript_text_done", "value": "transcript.text.done", "valueType": { "$ref": "2635" }, "enumType": { "$ref": "2634" } } ], "isFixed": false, "isFlags": false, "usage": "Output", "access": "public", "crossLanguageDefinitionId": "OpenAI.CreateTranscriptionResponseStreamEventType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2638", "kind": "property", "name": "delta", "doc": "The text delta that was additionally transcribed.", "type": { "$id": "2639", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.delta", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2640", "kind": "property", "name": "logprobs", "doc": "The log probabilities of the delta. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.", "type": { "$id": "2641", "kind": "array", "name": "Array6", "valueType": { "$id": "2642", "kind": "model", "name": "TranscriptTextDeltaEventLogprob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.logprob.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "2643", "kind": "property", "name": "token", "doc": "The token that was used to generate the log probability.", "type": { "$id": "2644", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.logprob.anonymous.token", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2645", "kind": "property", "name": "logprob", "doc": "The log probability of the token.", "type": { "$id": "2646", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.logprob.anonymous.logprob", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2647", "kind": "property", "name": "bytes", "doc": "The bytes that were used to generate the log probability.", "type": { "$ref": "2606" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.logprob.anonymous.bytes", "serializationOptions": {}, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDeltaEvent.logprobs", "serializationOptions": {}, "isHttpMetadata": false } ] }, "transcript.text.done": { "$id": "2648", "kind": "model", "name": "TranscriptTextDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent", "usage": "Output", "doc": "Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.", "discriminatorValue": "transcript.text.done", "decorators": [], "baseModel": { "$ref": "2629" }, "properties": [ { "$id": "2649", "kind": "property", "name": "type", "doc": "The type of the event. Always `transcript.text.done`.", "type": { "$id": "2650", "kind": "enumvalue", "name": "transcript_text_done", "value": "transcript.text.done", "valueType": { "$ref": "109" }, "enumType": { "$ref": "2634" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2651", "kind": "property", "name": "text", "doc": "The text that was transcribed.", "type": { "$id": "2652", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.text", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2653", "kind": "property", "name": "logprobs", "doc": "The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.", "type": { "$id": "2654", "kind": "array", "name": "Array7", "valueType": { "$id": "2655", "kind": "model", "name": "TranscriptTextDoneEventLogprob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.logprob.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "2656", "kind": "property", "name": "token", "doc": "The token that was used to generate the log probability.", "type": { "$id": "2657", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.logprob.anonymous.token", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2658", "kind": "property", "name": "logprob", "doc": "The log probability of the token.", "type": { "$id": "2659", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.logprob.anonymous.logprob", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "2660", "kind": "property", "name": "bytes", "doc": "The bytes that were used to generate the log probability.", "type": { "$ref": "2606" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.logprob.anonymous.bytes", "serializationOptions": {}, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TranscriptTextDoneEvent.logprobs", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, { "$ref": "2631" }, { "$ref": "2642" }, { "$ref": "2648" }, { "$ref": "2655" }, { "$id": "2661", "kind": "model", "name": "CreateTranslationRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "2662", "kind": "property", "name": "file", "serializedName": "file", "doc": "The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.", "type": { "$id": "2663", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.file", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "file", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2664", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.", "type": { "$ref": "112" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.model", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "model", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2665", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should be in English.", "type": { "$id": "2666", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.prompt", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "prompt", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2667", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.", "type": { "$ref": "115" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.response_format", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "response_format", "headers": [] } }, "isHttpMetadata": false }, { "$id": "2668", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.", "type": { "$id": "2669", "kind": "float32", "name": "ZeroOrOneFloat", "crossLanguageDefinitionId": "OpenAI.ZeroOrOneFloat", "baseType": { "$id": "2670", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationRequest.temperature", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "temperature", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "2671", "kind": "model", "name": "CreateTranslationResponseVerboseJson", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2672", "kind": "property", "name": "task", "serializedName": "task", "doc": "The task label.", "type": { "$ref": "1469" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson.task", "serializationOptions": { "json": { "name": "task" } }, "isHttpMetadata": false }, { "$id": "2673", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the output translation (always `english`).", "type": { "$id": "2674", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "2675", "kind": "property", "name": "duration", "serializedName": "duration", "doc": "The duration of the input audio.", "type": { "$id": "2676", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "2677", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson.duration", "serializationOptions": { "json": { "name": "duration" } }, "isHttpMetadata": false }, { "$id": "2678", "kind": "property", "name": "text", "serializedName": "text", "doc": "The translated text.", "type": { "$id": "2679", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "2680", "kind": "property", "name": "segments", "serializedName": "segments", "doc": "Segments of the translated text and their corresponding details.", "type": { "$ref": "2591" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseVerboseJson.segments", "serializationOptions": { "json": { "name": "segments" } }, "isHttpMetadata": false } ] }, { "$id": "2681", "kind": "model", "name": "CreateTranslationResponseJson", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseJson", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2682", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "2683", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateTranslationResponseJson.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, { "$id": "2684", "kind": "model", "name": "CreateBatchRequest", "namespace": "", "crossLanguageDefinitionId": "OpenAI.createBatch.Request.anonymous", "usage": "Spread,Json", "decorators": [], "properties": [ { "$id": "2685", "kind": "property", "name": "input_file_id", "serializedName": "input_file_id", "doc": "The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](/docs/api-reference/files/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](/docs/api-reference/batch/requestInput),\nand must be uploaded with the purpose `batch`.", "type": { "$id": "2686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "createBatch.Request.anonymous.input_file_id", "serializationOptions": { "json": { "name": "input_file_id" } }, "isHttpMetadata": false }, { "$id": "2687", "kind": "property", "name": "endpoint", "serializedName": "endpoint", "doc": "The endpoint to be used for all requests in the batch. Currently `/v1/chat/completions` and\n`/v1/embeddings` are supported.", "type": { "$ref": "122" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "createBatch.Request.anonymous.endpoint", "serializationOptions": { "json": { "name": "endpoint" } }, "isHttpMetadata": false }, { "$id": "2688", "kind": "property", "name": "completion_window", "serializedName": "completion_window", "doc": "The time frame within which the batch should be processed. Currently only `24h` is supported.", "type": { "$ref": "1471" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "createBatch.Request.anonymous.completion_window", "serializationOptions": { "json": { "name": "completion_window" } }, "isHttpMetadata": false }, { "$id": "2689", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "createBatch.Request.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "2690", "kind": "model", "name": "Batch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Batch", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2691", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "2692", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2693", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `batch`.", "type": { "$ref": "1473" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2694", "kind": "property", "name": "endpoint", "serializedName": "endpoint", "doc": "The OpenAI API endpoint used by the batch.", "type": { "$id": "2695", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.endpoint", "serializationOptions": { "json": { "name": "endpoint" } }, "isHttpMetadata": false }, { "$id": "2696", "kind": "property", "name": "errors", "serializedName": "errors", "type": { "$id": "2697", "kind": "model", "name": "BatchErrors", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Batch.errors.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2698", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `list`.", "type": { "$ref": "126" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2699", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "2700", "kind": "array", "name": "Array8", "valueType": { "$id": "2701", "kind": "model", "name": "BatchErrorsDatum", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Batch.errors.datum.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2702", "kind": "property", "name": "code", "serializedName": "code", "doc": "An error code identifying the error type.", "type": { "$id": "2703", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.datum.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "2704", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable message providing more details about the error.", "type": { "$id": "2705", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.datum.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "2706", "kind": "property", "name": "param", "serializedName": "param", "doc": "The name of the parameter that caused the error, if applicable.", "type": { "$id": "2707", "kind": "nullable", "type": { "$id": "2708", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.datum.anonymous.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false }, { "$id": "2709", "kind": "property", "name": "line", "serializedName": "line", "doc": "The line number of the input file where the error occurred, if applicable.", "type": { "$id": "2710", "kind": "nullable", "type": { "$id": "2711", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.datum.anonymous.line", "serializationOptions": { "json": { "name": "line" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors.anonymous.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.errors", "serializationOptions": { "json": { "name": "errors" } }, "isHttpMetadata": false }, { "$id": "2712", "kind": "property", "name": "input_file_id", "serializedName": "input_file_id", "doc": "The ID of the input file for the batch.", "type": { "$id": "2713", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.input_file_id", "serializationOptions": { "json": { "name": "input_file_id" } }, "isHttpMetadata": false }, { "$id": "2714", "kind": "property", "name": "completion_window", "serializedName": "completion_window", "doc": "The time frame within which the batch should be processed.", "type": { "$id": "2715", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.completion_window", "serializationOptions": { "json": { "name": "completion_window" } }, "isHttpMetadata": false }, { "$id": "2716", "kind": "property", "name": "status", "serializedName": "status", "doc": "The current status of the batch.", "type": { "$ref": "130" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "2717", "kind": "property", "name": "output_file_id", "serializedName": "output_file_id", "doc": "The ID of the file containing the outputs of successfully executed requests.", "type": { "$id": "2718", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.output_file_id", "serializationOptions": { "json": { "name": "output_file_id" } }, "isHttpMetadata": false }, { "$id": "2719", "kind": "property", "name": "error_file_id", "serializedName": "error_file_id", "doc": "The ID of the file containing the outputs of requests with errors.", "type": { "$id": "2720", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.error_file_id", "serializationOptions": { "json": { "name": "error_file_id" } }, "isHttpMetadata": false }, { "$id": "2721", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the batch was created.", "type": { "$id": "2722", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2723", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "2724", "kind": "property", "name": "in_progress_at", "serializedName": "in_progress_at", "doc": "The Unix timestamp (in seconds) for when the batch started processing.", "type": { "$id": "2725", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2726", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.in_progress_at", "serializationOptions": { "json": { "name": "in_progress_at" } }, "isHttpMetadata": false }, { "$id": "2727", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when the batch will expire.", "type": { "$id": "2728", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2729", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "2730", "kind": "property", "name": "finalizing_at", "serializedName": "finalizing_at", "doc": "The Unix timestamp (in seconds) for when the batch started finalizing.", "type": { "$id": "2731", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2732", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.finalizing_at", "serializationOptions": { "json": { "name": "finalizing_at" } }, "isHttpMetadata": false }, { "$id": "2733", "kind": "property", "name": "completed_at", "serializedName": "completed_at", "doc": "The Unix timestamp (in seconds) for when the batch was completed.", "type": { "$id": "2734", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2735", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.completed_at", "serializationOptions": { "json": { "name": "completed_at" } }, "isHttpMetadata": false }, { "$id": "2736", "kind": "property", "name": "failed_at", "serializedName": "failed_at", "doc": "The Unix timestamp (in seconds) for when the batch failed.", "type": { "$id": "2737", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2738", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.failed_at", "serializationOptions": { "json": { "name": "failed_at" } }, "isHttpMetadata": false }, { "$id": "2739", "kind": "property", "name": "expired_at", "serializedName": "expired_at", "doc": "The Unix timestamp (in seconds) for when the batch expired.", "type": { "$id": "2740", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2741", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.expired_at", "serializationOptions": { "json": { "name": "expired_at" } }, "isHttpMetadata": false }, { "$id": "2742", "kind": "property", "name": "cancelling_at", "serializedName": "cancelling_at", "doc": "The Unix timestamp (in seconds) for when the batch started cancelling.", "type": { "$id": "2743", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2744", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.cancelling_at", "serializationOptions": { "json": { "name": "cancelling_at" } }, "isHttpMetadata": false }, { "$id": "2745", "kind": "property", "name": "cancelled_at", "serializedName": "cancelled_at", "doc": "The Unix timestamp (in seconds) for when the batch was cancelled.", "type": { "$id": "2746", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2747", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.cancelled_at", "serializationOptions": { "json": { "name": "cancelled_at" } }, "isHttpMetadata": false }, { "$id": "2748", "kind": "property", "name": "request_counts", "serializedName": "request_counts", "doc": "The request counts for different statuses within the batch.", "type": { "$id": "2749", "kind": "model", "name": "BatchRequestCounts", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Batch.request_counts.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2750", "kind": "property", "name": "total", "serializedName": "total", "doc": "Total number of requests in the batch.", "type": { "$id": "2751", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.request_counts.anonymous.total", "serializationOptions": { "json": { "name": "total" } }, "isHttpMetadata": false }, { "$id": "2752", "kind": "property", "name": "completed", "serializedName": "completed", "doc": "Number of requests that have been completed successfully.", "type": { "$id": "2753", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.request_counts.anonymous.completed", "serializationOptions": { "json": { "name": "completed" } }, "isHttpMetadata": false }, { "$id": "2754", "kind": "property", "name": "failed", "serializedName": "failed", "doc": "Number of requests that have failed.", "type": { "$id": "2755", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.request_counts.anonymous.failed", "serializationOptions": { "json": { "name": "failed" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.request_counts", "serializationOptions": { "json": { "name": "request_counts" } }, "isHttpMetadata": false }, { "$id": "2756", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batch.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "2697" }, { "$ref": "2701" }, { "$ref": "2749" }, { "$id": "2757", "kind": "model", "name": "ListBatchesResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2758", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "2759", "kind": "array", "name": "ArrayBatch", "valueType": { "$ref": "2690" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "2760", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "2761", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "2762", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "2763", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "2764", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "2765", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false }, { "$id": "2766", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1475" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListBatchesResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "2767", "kind": "model", "name": "ChatCompletionList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionList", "usage": "Output,Json", "doc": "An object representing a list of Chat Completions.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2768", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object. It is always set to \"list\".", "type": { "$ref": "1477" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2769", "kind": "property", "name": "data", "serializedName": "data", "doc": "An array of chat completion objects.", "type": { "$id": "2770", "kind": "array", "name": "ArrayCreateChatCompletionResponse", "valueType": { "$id": "2771", "kind": "model", "name": "CreateChatCompletionResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse", "usage": "Output,Json", "doc": "Represents a chat completion response returned by model, based on the provided input.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2772", "kind": "property", "name": "id", "serializedName": "id", "doc": "A unique identifier for the chat completion.", "type": { "$id": "2773", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2774", "kind": "property", "name": "choices", "serializedName": "choices", "doc": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", "type": { "$id": "2775", "kind": "array", "name": "Array9", "valueType": { "$id": "2776", "kind": "model", "name": "CreateChatCompletionResponseChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2777", "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.", "type": { "$ref": "140" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.anonymous.finish_reason", "serializationOptions": { "json": { "name": "finish_reason" } }, "isHttpMetadata": false }, { "$id": "2778", "kind": "property", "name": "index", "serializedName": "index", "doc": "The index of the choice in the list of choices.", "type": { "$id": "2779", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.anonymous.index", "serializationOptions": { "json": { "name": "index" } }, "isHttpMetadata": false }, { "$id": "2780", "kind": "property", "name": "message", "serializedName": "message", "type": { "$id": "2781", "kind": "model", "name": "ChatCompletionResponseMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage", "usage": "Output,Json", "doc": "A chat completion message generated by the model.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2782", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the message.", "type": { "$id": "2783", "kind": "nullable", "type": { "$id": "2784", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "2785", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal message generated by the model.", "type": { "$id": "2786", "kind": "nullable", "type": { "$id": "2787", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false }, { "$id": "2788", "kind": "property", "name": "tool_calls", "serializedName": "tool_calls", "type": { "$id": "2789", "kind": "array", "name": "ChatCompletionMessageToolCalls", "valueType": { "$id": "2790", "kind": "model", "name": "ChatCompletionMessageToolCall", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2791", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the tool call.", "type": { "$id": "2792", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2793", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the tool. Currently, only `function` is supported.", "type": { "$id": "2794", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1355" }, "enumType": { "$id": "2795", "kind": "enum", "decorators": [], "name": "ChatToolCallKind", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "2796", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2797", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "enumType": { "$ref": "2795" }, "valueType": { "$ref": "2796" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChatToolCallKind", "apiVersions": [], "isUnionAsEnum": false, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2798", "kind": "property", "name": "function", "serializedName": "function", "doc": "The function that the model called.", "type": { "$id": "2799", "kind": "model", "name": "ChatCompletionMessageToolCallFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.function.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2800", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "2801", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2802", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.", "type": { "$id": "2803", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.function.anonymous.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCall.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCalls", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.tool_calls", "serializationOptions": { "json": { "name": "tool_calls" } }, "isHttpMetadata": false }, { "$id": "2804", "kind": "property", "name": "annotations", "serializedName": "annotations", "doc": "Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).", "type": { "$id": "2805", "kind": "array", "name": "Array10", "valueType": { "$id": "2806", "kind": "model", "name": "ChatCompletionResponseMessageAnnotation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2807", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the URL citation. Always `url_citation`.", "type": { "$ref": "1479" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2808", "kind": "property", "name": "url_citation", "serializedName": "url_citation", "doc": "A URL citation when using web search.", "type": { "$id": "2809", "kind": "model", "name": "ChatCompletionResponseMessageAnnotationUrlCitation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.url_citation.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2810", "kind": "property", "name": "end_index", "serializedName": "end_index", "doc": "The index of the last character of the URL citation in the message.", "type": { "$id": "2811", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.url_citation.anonymous.end_index", "serializationOptions": { "json": { "name": "end_index" } }, "isHttpMetadata": false }, { "$id": "2812", "kind": "property", "name": "start_index", "serializedName": "start_index", "doc": "The index of the first character of the URL citation in the message.", "type": { "$id": "2813", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.url_citation.anonymous.start_index", "serializationOptions": { "json": { "name": "start_index" } }, "isHttpMetadata": false }, { "$id": "2814", "kind": "property", "name": "url", "serializedName": "url", "doc": "The URL of the web resource.", "type": { "$id": "2815", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.url_citation.anonymous.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false }, { "$id": "2816", "kind": "property", "name": "title", "serializedName": "title", "doc": "The title of the web resource.", "type": { "$id": "2817", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.url_citation.anonymous.title", "serializationOptions": { "json": { "name": "title" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotation.anonymous.url_citation", "serializationOptions": { "json": { "name": "url_citation" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.annotations", "serializationOptions": { "json": { "name": "annotations" } }, "isHttpMetadata": false }, { "$id": "2818", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the author of this message.", "type": { "$id": "2819", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "154" }, "enumType": { "$id": "2820", "kind": "enum", "decorators": [], "doc": "The role of the author of a message", "name": "ChatCompletionRole", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "2821", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2822", "kind": "enumvalue", "decorators": [], "name": "system", "value": "system", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } }, { "$id": "2823", "kind": "enumvalue", "decorators": [], "name": "developer", "value": "developer", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } }, { "$id": "2824", "kind": "enumvalue", "decorators": [], "name": "user", "value": "user", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } }, { "$id": "2825", "kind": "enumvalue", "decorators": [], "name": "assistant", "value": "assistant", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } }, { "$id": "2826", "kind": "enumvalue", "decorators": [], "name": "tool", "value": "tool", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } }, { "$id": "2827", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "enumType": { "$ref": "2820" }, "valueType": { "$ref": "2821" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRole", "apiVersions": [], "isUnionAsEnum": false, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "2828", "kind": "property", "name": "function_call", "serializedName": "function_call", "doc": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "type": { "$id": "2829", "kind": "model", "name": "ChatCompletionResponseMessageFunctionCall", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.function_call.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2830", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "2831", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.function_call.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "2832", "kind": "property", "name": "arguments", "serializedName": "arguments", "type": { "$id": "2833", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.function_call.anonymous.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.function_call", "serializationOptions": { "json": { "name": "function_call" } }, "isHttpMetadata": false }, { "$id": "2834", "kind": "property", "name": "audio", "serializedName": "audio", "doc": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).", "type": { "$id": "2835", "kind": "nullable", "type": { "$id": "2836", "kind": "model", "name": "ChatCompletionResponseMessageAudio1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2837", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for this audio response.", "type": { "$id": "2838", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "2839", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.", "type": { "$id": "2840", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2841", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio.anonymous.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "2842", "kind": "property", "name": "data", "serializedName": "data", "doc": "Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.", "type": { "$id": "2843", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio.anonymous.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "2844", "kind": "property", "name": "transcript", "serializedName": "transcript", "doc": "Transcript of the audio generated by the model.", "type": { "$id": "2845", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio.anonymous.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionResponseMessage.audio", "serializationOptions": { "json": { "name": "audio" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "2846", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "Log probability information for the choice.", "type": { "$id": "2847", "kind": "nullable", "type": { "$id": "2848", "kind": "model", "name": "CreateChatCompletionResponseChoiceLogprobs1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.logprobs.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2849", "kind": "property", "name": "content", "serializedName": "content", "doc": "A list of message content tokens with log probability information.", "type": { "$id": "2850", "kind": "nullable", "type": { "$id": "2851", "kind": "array", "name": "ArrayChatCompletionTokenLogprob", "valueType": { "$id": "2852", "kind": "model", "name": "ChatCompletionTokenLogprob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2853", "kind": "property", "name": "token", "serializedName": "token", "doc": "The token.", "type": { "$id": "2854", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "2855", "kind": "property", "name": "logprob", "serializedName": "logprob", "doc": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.", "type": { "$id": "2856", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "2857", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", "type": { "$id": "2858", "kind": "nullable", "type": { "$ref": "2606" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "2859", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "doc": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", "type": { "$id": "2860", "kind": "array", "name": "Array11", "valueType": { "$id": "2861", "kind": "model", "name": "ChatCompletionTokenLogprobTopLogprob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.top_logprob.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2862", "kind": "property", "name": "token", "serializedName": "token", "doc": "The token.", "type": { "$id": "2863", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.top_logprob.anonymous.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "2864", "kind": "property", "name": "logprob", "serializedName": "logprob", "doc": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.", "type": { "$id": "2865", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.top_logprob.anonymous.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "2866", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", "type": { "$id": "2867", "kind": "nullable", "type": { "$ref": "2606" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.top_logprob.anonymous.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTokenLogprob.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.logprobs.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "2868", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "A list of message refusal tokens with log probability information.", "type": { "$id": "2869", "kind": "nullable", "type": { "$ref": "2851" }, "namespace": "OpenAI" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.logprobs.anonymous.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choice.anonymous.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.choices", "serializationOptions": { "json": { "name": "choices" } }, "isHttpMetadata": false }, { "$id": "2870", "kind": "property", "name": "created", "serializedName": "created", "doc": "The Unix timestamp (in seconds) of when the chat completion was created.", "type": { "$id": "2871", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "2872", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.created", "serializationOptions": { "json": { "name": "created" } }, "isHttpMetadata": false }, { "$id": "2873", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model used for the chat completion.", "type": { "$id": "2874", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "2875", "kind": "property", "name": "service_tier", "serializedName": "service_tier", "type": { "$ref": "147" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.service_tier", "serializationOptions": { "json": { "name": "service_tier" } }, "isHttpMetadata": false }, { "$id": "2876", "kind": "property", "name": "system_fingerprint", "serializedName": "system_fingerprint", "doc": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.", "type": { "$id": "2877", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.system_fingerprint", "serializationOptions": { "json": { "name": "system_fingerprint" } }, "isHttpMetadata": false }, { "$id": "2878", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `chat.completion`.", "type": { "$ref": "1481" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "2879", "kind": "property", "name": "usage", "serializedName": "usage", "type": { "$id": "2880", "kind": "model", "name": "CompletionUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompletionUsage", "usage": "Output,Json", "doc": "Usage statistics for the completion request.", "decorators": [], "properties": [ { "$id": "2881", "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", "doc": "Number of tokens in the generated completion.", "type": { "$id": "2882", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens", "serializationOptions": { "json": { "name": "completion_tokens" } }, "isHttpMetadata": false }, { "$id": "2883", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "Number of tokens in the prompt.", "type": { "$id": "2884", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "2885", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "Total number of tokens used in the request (prompt + completion).", "type": { "$id": "2886", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false }, { "$id": "2887", "kind": "property", "name": "completion_tokens_details", "serializedName": "completion_tokens_details", "doc": "Breakdown of tokens used in a completion.", "type": { "$id": "2888", "kind": "model", "name": "CompletionUsageCompletionTokensDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2889", "kind": "property", "name": "accepted_prediction_tokens", "serializedName": "accepted_prediction_tokens", "doc": "When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.", "type": { "$id": "2890", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details.anonymous.accepted_prediction_tokens", "serializationOptions": { "json": { "name": "accepted_prediction_tokens" } }, "isHttpMetadata": false }, { "$id": "2891", "kind": "property", "name": "audio_tokens", "serializedName": "audio_tokens", "doc": "Audio input tokens generated by the model.", "type": { "$id": "2892", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details.anonymous.audio_tokens", "serializationOptions": { "json": { "name": "audio_tokens" } }, "isHttpMetadata": false }, { "$id": "2893", "kind": "property", "name": "reasoning_tokens", "serializedName": "reasoning_tokens", "doc": "Tokens generated by the model for reasoning.", "type": { "$id": "2894", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details.anonymous.reasoning_tokens", "serializationOptions": { "json": { "name": "reasoning_tokens" } }, "isHttpMetadata": false }, { "$id": "2895", "kind": "property", "name": "rejected_prediction_tokens", "serializedName": "rejected_prediction_tokens", "doc": "When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.", "type": { "$id": "2896", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details.anonymous.rejected_prediction_tokens", "serializationOptions": { "json": { "name": "rejected_prediction_tokens" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.completion_tokens_details", "serializationOptions": { "json": { "name": "completion_tokens_details" } }, "isHttpMetadata": false }, { "$id": "2897", "kind": "property", "name": "prompt_tokens_details", "serializedName": "prompt_tokens_details", "doc": "Breakdown of tokens used in the prompt.", "type": { "$id": "2898", "kind": "model", "name": "CompletionUsagePromptTokensDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompletionUsage.prompt_tokens_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "2899", "kind": "property", "name": "audio_tokens", "serializedName": "audio_tokens", "doc": "Audio input tokens present in the prompt.", "type": { "$id": "2900", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.prompt_tokens_details.anonymous.audio_tokens", "serializationOptions": { "json": { "name": "audio_tokens" } }, "isHttpMetadata": false }, { "$id": "2901", "kind": "property", "name": "cached_tokens", "serializedName": "cached_tokens", "doc": "Cached tokens present in the prompt.", "type": { "$id": "2902", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.prompt_tokens_details.anonymous.cached_tokens", "serializationOptions": { "json": { "name": "cached_tokens" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompletionUsage.prompt_tokens_details", "serializationOptions": { "json": { "name": "prompt_tokens_details" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "2903", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The identifier of the first chat completion in the data array.", "type": { "$id": "2904", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "2905", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The identifier of the last chat completion in the data array.", "type": { "$id": "2906", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "2907", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates whether there are more Chat Completions available.", "type": { "$id": "2908", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "2771" }, { "$ref": "2776" }, { "$ref": "2781" }, { "$ref": "2790" }, { "$ref": "2799" }, { "$ref": "2806" }, { "$ref": "2809" }, { "$ref": "2829" }, { "$ref": "2836" }, { "$ref": "2848" }, { "$ref": "2852" }, { "$ref": "2861" }, { "$ref": "2880" }, { "$ref": "2888" }, { "$ref": "2898" }, { "$id": "2909", "kind": "model", "name": "CreateChatCompletionRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "2910", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "2911", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", "type": { "$id": "2912", "kind": "nullable", "type": { "$id": "2913", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "2914", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "doc": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.", "type": { "$id": "2915", "kind": "nullable", "type": { "$id": "2916", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false }, { "$id": "2917", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$id": "2918", "kind": "nullable", "type": { "$id": "2919", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "2920", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "2921", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false }, { "$id": "2922", "kind": "property", "name": "safety_identifier", "serializedName": "safety_identifier", "doc": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).", "type": { "$id": "2923", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.safety_identifier", "serializationOptions": { "json": { "name": "safety_identifier" } }, "isHttpMetadata": false }, { "$id": "2924", "kind": "property", "name": "service_tier", "serializedName": "service_tier", "type": { "$ref": "147" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.service_tier", "serializationOptions": { "json": { "name": "service_tier" } }, "isHttpMetadata": false }, { "$id": "2925", "kind": "property", "name": "messages", "serializedName": "messages", "doc": "A list of messages comprising the conversation so far. Depending on the\n[model](/docs/models) you use, different message types (modalities) are\nsupported, like [text](/docs/guides/text-generation),\n[images](/docs/guides/vision), and [audio](/docs/guides/audio).", "type": { "$id": "2926", "kind": "array", "name": "ArrayChatCompletionRequestMessage", "valueType": { "$id": "2927", "kind": "model", "name": "ChatCompletionRequestMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessage", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "2928", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the author of this message.", "type": { "$ref": "153" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "2928" }, { "$id": "2929", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message. Valid content part types vary per message role.", "type": { "$id": "2930", "kind": "nullable", "type": { "$id": "2931", "kind": "union", "name": "ChatCompletionRequestMessageContent", "variantTypes": [ { "$id": "2932", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "2933", "kind": "array", "name": "ArrayChatCompletionRequestMessageContentPart", "valueType": { "$id": "2934", "kind": "model", "name": "ChatCompletionRequestMessageContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPart", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "2935", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "161" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "2935" } ], "discriminatedSubtypes": { "text": { "$id": "2936", "kind": "model", "name": "ChatCompletionRequestMessageContentPartText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartText", "usage": "Input,Output,Json", "doc": "Learn about [text inputs](/docs/guides/text-generation).", "discriminatorValue": "text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2934" }, "properties": [ { "$id": "2937", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part.", "type": { "$id": "2938", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "162" }, "enumType": { "$id": "2939", "kind": "enum", "decorators": [], "name": "ChatCompletionRequestMessageContentPartType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "2940", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "2941", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "valueType": { "$ref": "2940" }, "enumType": { "$ref": "2939" } }, { "$id": "2942", "kind": "enumvalue", "decorators": [], "name": "file", "value": "file", "valueType": { "$ref": "2940" }, "enumType": { "$ref": "2939" } }, { "$id": "2943", "kind": "enumvalue", "decorators": [], "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "2940" }, "enumType": { "$ref": "2939" } }, { "$id": "2944", "kind": "enumvalue", "decorators": [], "name": "image_url", "value": "image_url", "valueType": { "$ref": "2940" }, "enumType": { "$ref": "2939" } }, { "$id": "2945", "kind": "enumvalue", "decorators": [], "name": "refusal", "value": "refusal", "valueType": { "$ref": "2940" }, "enumType": { "$ref": "2939" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2946", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text content.", "type": { "$id": "2947", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartText.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "image_url": { "$id": "2948", "kind": "model", "name": "ChatCompletionRequestMessageContentPartImage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage", "usage": "Input,Output,Json", "doc": "Learn about [image inputs](/docs/guides/vision).", "discriminatorValue": "image_url", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2934" }, "properties": [ { "$id": "2949", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part.", "type": { "$id": "2950", "kind": "enumvalue", "name": "image_url", "value": "image_url", "valueType": { "$ref": "162" }, "enumType": { "$ref": "2939" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2951", "kind": "property", "name": "image_url", "serializedName": "image_url", "type": { "$id": "2952", "kind": "model", "name": "ChatCompletionRequestMessageContentPartImageImageUrl", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.image_url.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2953", "kind": "property", "name": "url", "serializedName": "url", "doc": "Either a URL of the image or the base64 encoded image data.", "type": { "$id": "2954", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.image_url.anonymous.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false }, { "$id": "2955", "kind": "property", "name": "detail", "serializedName": "detail", "doc": "Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding).", "type": { "$ref": "168" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.image_url.anonymous.detail", "serializationOptions": { "json": { "name": "detail" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartImage.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false } ] }, "refusal": { "$id": "2956", "kind": "model", "name": "ChatCompletionRequestMessageContentPartRefusal", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartRefusal", "usage": "Input,Output,Json", "discriminatorValue": "refusal", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2934" }, "properties": [ { "$id": "2957", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part.", "type": { "$id": "2958", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "162" }, "enumType": { "$ref": "2939" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartRefusal.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2959", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal message generated by the model.", "type": { "$id": "2960", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartRefusal.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false } ] }, "file": { "$id": "2961", "kind": "model", "name": "ChatCompletionRequestMessageContentPartFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile", "usage": "Input,Output,Json", "doc": "Learn about [file inputs](/docs/guides/text) for text generation.", "discriminatorValue": "file", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2934" }, "properties": [ { "$id": "2962", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part. Always `file`.", "type": { "$id": "2963", "kind": "enumvalue", "name": "file", "value": "file", "valueType": { "$ref": "162" }, "enumType": { "$ref": "2939" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2964", "kind": "property", "name": "file", "serializedName": "file", "type": { "$id": "2965", "kind": "model", "name": "ChatCompletionRequestMessageContentPartFileFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.file.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2966", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file, used when passing the file to the model as a\nstring.", "type": { "$id": "2967", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.file.anonymous.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "2968", "kind": "property", "name": "file_data", "serializedName": "file_data", "doc": "The base64 encoded file data, used when passing the file to the model\nas a string.", "type": { "$id": "2969", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.file.anonymous.file_data", "serializationOptions": { "json": { "name": "file_data" } }, "isHttpMetadata": false }, { "$id": "2970", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of an uploaded file to use as input.", "type": { "$id": "2971", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.file.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartFile.file", "serializationOptions": { "json": { "name": "file" } }, "isHttpMetadata": false } ] }, "input_audio": { "$id": "2972", "kind": "model", "name": "ChatCompletionRequestMessageContentPartAudio", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio", "usage": "Input,Output,Json", "doc": "Learn about [audio inputs](/docs/guides/audio).", "discriminatorValue": "input_audio", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2934" }, "properties": [ { "$id": "2973", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part. Always `input_audio`.", "type": { "$id": "2974", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "162" }, "enumType": { "$ref": "2939" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "2975", "kind": "property", "name": "input_audio", "serializedName": "input_audio", "type": { "$id": "2976", "kind": "model", "name": "ChatCompletionRequestMessageContentPartAudioInputAudio", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.input_audio.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "2977", "kind": "property", "name": "data", "serializedName": "data", "doc": "Base64 encoded audio data.", "type": { "$id": "2978", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.input_audio.anonymous.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "2979", "kind": "property", "name": "format", "serializedName": "format", "doc": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".", "type": { "$ref": "173" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.input_audio.anonymous.format", "serializationOptions": { "json": { "name": "format" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessageContentPartAudio.input_audio", "serializationOptions": { "json": { "name": "input_audio" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "system": { "$id": "2980", "kind": "model", "name": "ChatCompletionRequestSystemMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestSystemMessage", "usage": "Input,Json", "doc": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.", "discriminatorValue": "system", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "2981", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the system message.", "type": { "$id": "2982", "kind": "union", "name": "ChatCompletionRequestSystemMessageContent", "variantTypes": [ { "$id": "2983", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "2984", "kind": "array", "name": "ArrayChatCompletionRequestSystemMessageContentPart", "valueType": { "$id": "2985", "kind": "union", "name": "ChatCompletionRequestSystemMessageContentPart", "variantTypes": [ { "$ref": "2936" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestSystemMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "2986", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `system`.", "type": { "$id": "2987", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestSystemMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "2988", "kind": "property", "name": "name", "serializedName": "name", "doc": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.", "type": { "$id": "2989", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestSystemMessage.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "developer": { "$id": "2990", "kind": "model", "name": "ChatCompletionRequestDeveloperMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestDeveloperMessage", "usage": "Input,Json", "doc": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.", "discriminatorValue": "developer", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "2991", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the developer message.", "type": { "$id": "2992", "kind": "union", "name": "ChatCompletionRequestDeveloperMessageContent", "variantTypes": [ { "$id": "2993", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "2994", "kind": "array", "name": "ArrayChatCompletionRequestMessageContentPartText", "valueType": { "$ref": "2936" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestDeveloperMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "2995", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `developer`.", "type": { "$id": "2996", "kind": "enumvalue", "name": "developer", "value": "developer", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestDeveloperMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "2997", "kind": "property", "name": "name", "serializedName": "name", "doc": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.", "type": { "$id": "2998", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestDeveloperMessage.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "user": { "$id": "2999", "kind": "model", "name": "ChatCompletionRequestUserMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestUserMessage", "usage": "Input,Json", "doc": "Messages sent by an end user, containing prompts or additional context\ninformation.", "discriminatorValue": "user", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "3000", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the user message.", "type": { "$id": "3001", "kind": "union", "name": "ChatCompletionRequestUserMessageContent", "variantTypes": [ { "$id": "3002", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "3003", "kind": "array", "name": "ArrayChatCompletionRequestUserMessageContentPart", "valueType": { "$id": "3004", "kind": "union", "name": "ChatCompletionRequestUserMessageContentPart", "variantTypes": [ { "$ref": "2936" }, { "$ref": "2948" }, { "$ref": "2972" }, { "$ref": "2961" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestUserMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3005", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `user`.", "type": { "$id": "3006", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestUserMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3007", "kind": "property", "name": "name", "serializedName": "name", "doc": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.", "type": { "$id": "3008", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestUserMessage.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "assistant": { "$id": "3009", "kind": "model", "name": "ChatCompletionRequestAssistantMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage", "usage": "Input,Json", "doc": "Messages sent by the model in response to user messages.", "discriminatorValue": "assistant", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "3010", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.", "type": { "$id": "3011", "kind": "nullable", "type": { "$id": "3012", "kind": "union", "name": "ChatCompletionRequestAssistantMessageContent", "variantTypes": [ { "$id": "3013", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "3014", "kind": "array", "name": "ArrayChatCompletionRequestAssistantMessageContentPart", "valueType": { "$id": "3015", "kind": "union", "name": "ChatCompletionRequestAssistantMessageContentPart", "variantTypes": [ { "$ref": "2936" }, { "$ref": "2956" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3016", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal message by the assistant.", "type": { "$id": "3017", "kind": "nullable", "type": { "$id": "3018", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false }, { "$id": "3019", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `assistant`.", "type": { "$id": "3020", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3021", "kind": "property", "name": "name", "serializedName": "name", "doc": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.", "type": { "$id": "3022", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3023", "kind": "property", "name": "audio", "serializedName": "audio", "doc": "Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).", "type": { "$id": "3024", "kind": "nullable", "type": { "$id": "3025", "kind": "model", "name": "ChatCompletionRequestAssistantMessageAudio1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.audio.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3026", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for a previous audio response from the model.", "type": { "$id": "3027", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.audio.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.audio", "serializationOptions": { "json": { "name": "audio" } }, "isHttpMetadata": false }, { "$id": "3028", "kind": "property", "name": "tool_calls", "serializedName": "tool_calls", "type": { "$ref": "2789" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.tool_calls", "serializationOptions": { "json": { "name": "tool_calls" } }, "isHttpMetadata": false }, { "$id": "3029", "kind": "property", "name": "function_call", "serializedName": "function_call", "doc": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "type": { "$id": "3030", "kind": "nullable", "type": { "$id": "3031", "kind": "model", "name": "ChatCompletionRequestAssistantMessageFunctionCall1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.function_call.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3032", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "3033", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.function_call.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3034", "kind": "property", "name": "arguments", "serializedName": "arguments", "type": { "$id": "3035", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.function_call.anonymous.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestAssistantMessage.function_call", "serializationOptions": { "json": { "name": "function_call" } }, "isHttpMetadata": false } ] }, "tool": { "$id": "3036", "kind": "model", "name": "ChatCompletionRequestToolMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestToolMessage", "usage": "Input,Json", "discriminatorValue": "tool", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "3037", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `tool`.", "type": { "$id": "3038", "kind": "enumvalue", "name": "tool", "value": "tool", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestToolMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3039", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the tool message.", "type": { "$id": "3040", "kind": "union", "name": "ChatCompletionRequestToolMessageContent", "variantTypes": [ { "$id": "3041", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "3042", "kind": "array", "name": "ArrayChatCompletionRequestToolMessageContentPart", "valueType": { "$id": "3043", "kind": "union", "name": "ChatCompletionRequestToolMessageContentPart", "variantTypes": [ { "$ref": "2936" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestToolMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3044", "kind": "property", "name": "tool_call_id", "serializedName": "tool_call_id", "doc": "Tool call that this message is responding to.", "type": { "$id": "3045", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestToolMessage.tool_call_id", "serializationOptions": { "json": { "name": "tool_call_id" } }, "isHttpMetadata": false } ] }, "function": { "$id": "3046", "kind": "model", "name": "ChatCompletionRequestFunctionMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestFunctionMessage", "usage": "Input,Json", "deprecation": "This field is marked as deprecated.", "discriminatorValue": "function", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "2927" }, "properties": [ { "$id": "3047", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the messages author, in this case `function`.", "type": { "$id": "3048", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestFunctionMessage.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3049", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the function message.", "type": { "$id": "3050", "kind": "nullable", "type": { "$id": "3051", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestFunctionMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3052", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "3053", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionRequestFunctionMessage.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.messages", "serializationOptions": { "json": { "name": "messages" } }, "isHttpMetadata": false }, { "$id": "3054", "kind": "property", "name": "model", "serializedName": "model", "doc": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.", "type": { "$ref": "177" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3055", "kind": "property", "name": "modalities", "serializedName": "modalities", "type": { "$id": "3056", "kind": "nullable", "type": { "$id": "3057", "kind": "array", "name": "ResponseModalities", "valueType": { "$ref": "234" }, "crossLanguageDefinitionId": "OpenAI.ResponseModalities", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "3058", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "type": { "$id": "3059", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "3060", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).", "type": { "$id": "3061", "kind": "nullable", "type": { "$id": "3062", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "3063", "kind": "property", "name": "frequency_penalty", "serializedName": "frequency_penalty", "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.", "type": { "$id": "3064", "kind": "nullable", "type": { "$id": "3065", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.frequency_penalty", "serializationOptions": { "json": { "name": "frequency_penalty" } }, "isHttpMetadata": false }, { "$id": "3066", "kind": "property", "name": "presence_penalty", "serializedName": "presence_penalty", "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.", "type": { "$id": "3067", "kind": "nullable", "type": { "$id": "3068", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.presence_penalty", "serializationOptions": { "json": { "name": "presence_penalty" } }, "isHttpMetadata": false }, { "$id": "3069", "kind": "property", "name": "web_search_options", "serializedName": "web_search_options", "doc": "This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](/docs/guides/tools-web-search?api-mode=chat).", "type": { "$id": "3070", "kind": "model", "name": "CreateChatCompletionRequestWebSearchOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3071", "kind": "property", "name": "user_location", "serializedName": "user_location", "doc": "Approximate location parameters for the search.", "type": { "$id": "3072", "kind": "nullable", "type": { "$id": "3073", "kind": "model", "name": "CreateChatCompletionRequestWebSearchOptionsUserLocation1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.user_location.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3074", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of location approximation. Always `approximate`.", "type": { "$ref": "1483" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.user_location.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3075", "kind": "property", "name": "approximate", "serializedName": "approximate", "type": { "$id": "3076", "kind": "model", "name": "WebSearchLocation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchLocation", "usage": "Input,Json", "doc": "Approximate location parameters for the search.", "decorators": [], "properties": [ { "$id": "3077", "kind": "property", "name": "country", "serializedName": "country", "doc": "The two-letter\n[ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user,\ne.g. `US`.", "type": { "$id": "3078", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchLocation.country", "serializationOptions": { "json": { "name": "country" } }, "isHttpMetadata": false }, { "$id": "3079", "kind": "property", "name": "region", "serializedName": "region", "doc": "Free text input for the region of the user, e.g. `California`.", "type": { "$id": "3080", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchLocation.region", "serializationOptions": { "json": { "name": "region" } }, "isHttpMetadata": false }, { "$id": "3081", "kind": "property", "name": "city", "serializedName": "city", "doc": "Free text input for the city of the user, e.g. `San Francisco`.", "type": { "$id": "3082", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchLocation.city", "serializationOptions": { "json": { "name": "city" } }, "isHttpMetadata": false }, { "$id": "3083", "kind": "property", "name": "timezone", "serializedName": "timezone", "doc": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones)\nof the user, e.g. `America/Los_Angeles`.", "type": { "$id": "3084", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchLocation.timezone", "serializationOptions": { "json": { "name": "timezone" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.user_location.anonymous.approximate", "serializationOptions": { "json": { "name": "approximate" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.anonymous.user_location", "serializationOptions": { "json": { "name": "user_location" } }, "isHttpMetadata": false }, { "$id": "3085", "kind": "property", "name": "search_context_size", "serializedName": "search_context_size", "type": { "$ref": "238" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options.anonymous.search_context_size", "serializationOptions": { "json": { "name": "search_context_size" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.web_search_options", "serializationOptions": { "json": { "name": "web_search_options" } }, "isHttpMetadata": false }, { "$id": "3086", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.", "type": { "$ref": "2393" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false }, { "$id": "3087", "kind": "property", "name": "audio", "serializedName": "audio", "doc": "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).", "type": { "$id": "3088", "kind": "nullable", "type": { "$id": "3089", "kind": "model", "name": "CreateChatCompletionRequestAudio1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.audio.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3090", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice the model uses to respond. Supported voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.", "type": { "$ref": "68" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.audio.anonymous.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "3091", "kind": "property", "name": "format", "serializedName": "format", "doc": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.", "type": { "$ref": "243" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.audio.anonymous.format", "serializationOptions": { "json": { "name": "format" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.audio", "serializationOptions": { "json": { "name": "audio" } }, "isHttpMetadata": false }, { "$id": "3092", "kind": "property", "name": "store", "serializedName": "store", "doc": "Whether or not to store the output of this chat completion request for\nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.", "type": { "$id": "3093", "kind": "nullable", "type": { "$id": "3094", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.store", "serializationOptions": { "json": { "name": "store" } }, "isHttpMetadata": false }, { "$id": "3095", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/chat/streaming)\nfor more information, along with the [streaming responses](/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events.", "type": { "$id": "3096", "kind": "nullable", "type": { "$id": "3097", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false }, { "$id": "3098", "kind": "property", "name": "stop", "serializedName": "stop", "type": { "$id": "3099", "kind": "nullable", "type": { "$id": "3100", "kind": "union", "name": "StopConfiguration", "variantTypes": [ { "$id": "3101", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2373" } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.stop", "serializationOptions": { "json": { "name": "stop" } }, "isHttpMetadata": false }, { "$id": "3102", "kind": "property", "name": "logit_bias", "serializedName": "logit_bias", "doc": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.", "type": { "$id": "3103", "kind": "nullable", "type": { "$id": "3104", "kind": "dict", "keyType": { "$id": "3105", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "valueType": { "$id": "3106", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.logit_bias", "serializationOptions": { "json": { "name": "logit_bias" } }, "isHttpMetadata": false }, { "$id": "3107", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.", "type": { "$id": "3108", "kind": "nullable", "type": { "$id": "3109", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false }, { "$id": "3110", "kind": "property", "name": "max_tokens", "serializedName": "max_tokens", "doc": "The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](/docs/guides/reasoning).", "type": { "$id": "3111", "kind": "nullable", "type": { "$id": "3112", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.max_tokens", "serializationOptions": { "json": { "name": "max_tokens" } }, "isHttpMetadata": false }, { "$id": "3113", "kind": "property", "name": "n", "serializedName": "n", "doc": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.", "type": { "$id": "3114", "kind": "nullable", "type": { "$id": "3115", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.n", "serializationOptions": { "json": { "name": "n" } }, "isHttpMetadata": false }, { "$id": "3116", "kind": "property", "name": "prediction", "serializedName": "prediction", "doc": "Configuration for a [Predicted Output](/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.", "type": { "$id": "3117", "kind": "nullable", "type": { "$id": "3118", "kind": "model", "name": "ChatOutputPrediction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatOutputPrediction", "usage": "Input,Json", "doc": "Base representation of predicted output from a model.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "3119", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "251" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatOutputPrediction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3119" } ], "discriminatedSubtypes": { "content": { "$id": "3120", "kind": "model", "name": "ChatOutputPredictionContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatOutputPredictionContent", "usage": "Input,Json", "doc": "Static predicted output content, such as the content of a text file that is\nbeing regenerated.", "discriminatorValue": "content", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "3118" }, "properties": [ { "$id": "3121", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the predicted content you want to provide. This type is\ncurrently always `content`.", "type": { "$id": "3122", "kind": "enumvalue", "name": "static_content", "value": "content", "valueType": { "$ref": "252" }, "enumType": { "$id": "3123", "kind": "enum", "decorators": [], "name": "ChatOutputPredictionType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "3124", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3125", "kind": "enumvalue", "decorators": [], "name": "static_content", "value": "content", "valueType": { "$ref": "3124" }, "enumType": { "$ref": "3123" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChatOutputPredictionType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatOutputPredictionContent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3126", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.", "type": { "$id": "3127", "kind": "union", "name": "ChatOutputPredictionContentContent", "variantTypes": [ { "$id": "3128", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2994" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatOutputPredictionContent.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] } } }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.prediction", "serializationOptions": { "json": { "name": "prediction" } }, "isHttpMetadata": false }, { "$id": "3129", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.", "type": { "$id": "3130", "kind": "nullable", "type": { "$id": "3131", "kind": "int64", "name": "int64", "crossLanguageDefinitionId": "TypeSpec.int64", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "3132", "kind": "property", "name": "stream_options", "serializedName": "stream_options", "type": { "$id": "3133", "kind": "nullable", "type": { "$id": "3134", "kind": "model", "name": "ChatCompletionStreamOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamOptions", "usage": "Input,Json", "doc": "Options for streaming response. Only set this when you set `stream: true`.", "decorators": [], "properties": [ { "$id": "3135", "kind": "property", "name": "include_usage", "serializedName": "include_usage", "doc": "If set, an additional chunk will be streamed before the `data: [DONE]`\nmessage. The `usage` field on this chunk shows the token usage statistics\nfor the entire request, and the `choices` field will always be an empty\narray.\n\nAll other chunks will also include a `usage` field, but with a null\nvalue. **NOTE:** If the stream is interrupted, you may not receive the\nfinal usage chunk which contains the total token usage for the request.", "type": { "$id": "3136", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamOptions.include_usage", "serializationOptions": { "json": { "name": "include_usage" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.stream_options", "serializationOptions": { "json": { "name": "stream_options" } }, "isHttpMetadata": false }, { "$id": "3137", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.", "type": { "$id": "3138", "kind": "array", "name": "ArrayChatCompletionTool", "valueType": { "$id": "3139", "kind": "model", "name": "ChatCompletionTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionTool", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3140", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the tool. Currently, only `function` is supported.", "type": { "$id": "3141", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1358" }, "enumType": { "$id": "3142", "kind": "enum", "decorators": [], "name": "ChatToolKind", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "3143", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3144", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "enumType": { "$ref": "3142" }, "valueType": { "$ref": "3143" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChatToolKind", "apiVersions": [], "isUnionAsEnum": false, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3145", "kind": "property", "name": "function", "serializedName": "function", "type": { "$ref": "2357" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionTool.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "3146", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$id": "3147", "kind": "union", "name": "ChatCompletionToolChoiceOption", "variantTypes": [ { "$ref": "254" }, { "$id": "3148", "kind": "model", "name": "ChatCompletionNamedToolChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionNamedToolChoice", "usage": "Input,Json", "doc": "Specifies a tool the model should use. Use to force the model to call a specific function.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3149", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the tool. Currently, only `function` is supported.", "type": { "$ref": "1485" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionNamedToolChoice.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3150", "kind": "property", "name": "function", "serializedName": "function", "type": { "$id": "3151", "kind": "model", "name": "ChatCompletionNamedToolChoiceFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionNamedToolChoice.function.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3152", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "3153", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionNamedToolChoice.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionNamedToolChoice.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "3154", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "type": { "$id": "3155", "kind": "boolean", "name": "ParallelToolCalls", "crossLanguageDefinitionId": "OpenAI.ParallelToolCalls", "baseType": { "$id": "3156", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "3157", "kind": "property", "name": "function_call", "serializedName": "function_call", "doc": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.", "type": { "$id": "3158", "kind": "union", "name": "CreateChatCompletionRequestFunctionCall", "variantTypes": [ { "$ref": "1487" }, { "$ref": "1489" }, { "$id": "3159", "kind": "model", "name": "ChatCompletionFunctionCallOption", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctionCallOption", "usage": "Input,Json", "doc": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3160", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "3161", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctionCallOption.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.function_call", "serializationOptions": { "json": { "name": "function_call" } }, "isHttpMetadata": false }, { "$id": "3162", "kind": "property", "name": "functions", "serializedName": "functions", "doc": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.", "type": { "$id": "3163", "kind": "array", "name": "ArrayChatCompletionFunctions", "valueType": { "$id": "3164", "kind": "model", "name": "ChatCompletionFunctions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctions", "usage": "Input,Json", "deprecation": "This field is marked as deprecated.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3165", "kind": "property", "name": "description", "serializedName": "description", "doc": "A description of what the function does, used by the model to choose when and how to call the function.", "type": { "$id": "3166", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctions.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "3167", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", "type": { "$id": "3168", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctions.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3169", "kind": "property", "name": "parameters", "serializedName": "parameters", "doc": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list.", "type": { "$id": "3170", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctions.parameters", "serializationOptions": { "json": { "name": "parameters" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionRequest.functions", "serializationOptions": { "json": { "name": "functions" } }, "isHttpMetadata": false } ] }, { "$ref": "2927" }, { "$ref": "2934" }, { "$ref": "2936" }, { "$ref": "2948" }, { "$ref": "2952" }, { "$ref": "2956" }, { "$ref": "2961" }, { "$ref": "2965" }, { "$ref": "2972" }, { "$ref": "2976" }, { "$ref": "2980" }, { "$ref": "2990" }, { "$ref": "2999" }, { "$ref": "3009" }, { "$ref": "3025" }, { "$ref": "3031" }, { "$ref": "3036" }, { "$ref": "3046" }, { "$ref": "3070" }, { "$ref": "3073" }, { "$ref": "3076" }, { "$ref": "3089" }, { "$ref": "3118" }, { "$ref": "3120" }, { "$ref": "3134" }, { "$ref": "3139" }, { "$ref": "3148" }, { "$ref": "3151" }, { "$ref": "3159" }, { "$ref": "3164" }, { "$id": "3171", "kind": "model", "name": "CreateChatCompletionStreamResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse", "access": "public", "usage": "Output", "doc": "Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input.\n[Learn more](/docs/guides/streaming-responses).", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3172", "kind": "property", "name": "id", "doc": "A unique identifier for the chat completion. Each chunk has the same ID.", "type": { "$id": "3173", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3174", "kind": "property", "name": "choices", "doc": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the\nlast chunk if you set `stream_options: {\"include_usage\": true}`.", "type": { "$id": "3175", "kind": "array", "name": "Array12", "valueType": { "$id": "3176", "kind": "model", "name": "CreateChatCompletionStreamResponseChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3177", "kind": "property", "name": "delta", "type": { "$id": "3178", "kind": "model", "name": "ChatCompletionStreamResponseDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta", "usage": "Output", "doc": "A chat completion delta generated by streamed model responses.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3179", "kind": "property", "name": "audio", "doc": "Response audio associated with the streaming chat delta payload.", "type": { "$id": "3180", "kind": "model", "name": "ChatCompletionMessageAudioChunk", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageAudioChunk", "usage": "Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3181", "kind": "property", "name": "id", "type": { "$id": "3182", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageAudioChunk.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3183", "kind": "property", "name": "transcript", "type": { "$id": "3184", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageAudioChunk.transcript", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3185", "kind": "property", "name": "data", "type": { "$id": "3186", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageAudioChunk.data", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3187", "kind": "property", "name": "expires_at", "type": { "$id": "3188", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3189", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageAudioChunk.expires_at", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.audio", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3190", "kind": "property", "name": "content", "doc": "The contents of the chunk message.", "type": { "$id": "3191", "kind": "nullable", "type": { "$id": "3192", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.content", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3193", "kind": "property", "name": "function_call", "doc": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "type": { "$id": "3194", "kind": "model", "name": "ChatCompletionStreamResponseDeltaFunctionCall", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.function_call.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3195", "kind": "property", "name": "name", "type": { "$id": "3196", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.function_call.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3197", "kind": "property", "name": "arguments", "type": { "$id": "3198", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.function_call.anonymous.arguments", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.function_call", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3199", "kind": "property", "name": "tool_calls", "type": { "$id": "3200", "kind": "array", "name": "ArrayChatCompletionMessageToolCallChunk", "valueType": { "$id": "3201", "kind": "model", "name": "ChatCompletionMessageToolCallChunk", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk", "usage": "Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3202", "kind": "property", "name": "index", "type": { "$id": "3203", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3204", "kind": "property", "name": "id", "doc": "The ID of the tool call.", "type": { "$id": "3205", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3206", "kind": "property", "name": "type", "doc": "The type of the tool. Currently, only `function` is supported.", "type": { "$ref": "259" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3207", "kind": "property", "name": "function", "type": { "$id": "3208", "kind": "model", "name": "ChatCompletionMessageToolCallChunkFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.function.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3209", "kind": "property", "name": "name", "doc": "The name of the function to call.", "type": { "$id": "3210", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.function.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3211", "kind": "property", "name": "arguments", "doc": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.", "type": { "$id": "3212", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.function.anonymous.arguments", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageToolCallChunk.function", "serializationOptions": {}, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.tool_calls", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3213", "kind": "property", "name": "role", "doc": "The role of the author of this message.", "type": { "$ref": "153" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.role", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3214", "kind": "property", "name": "refusal", "doc": "The refusal message generated by the model.", "type": { "$id": "3215", "kind": "nullable", "type": { "$id": "3216", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionStreamResponseDelta.refusal", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.anonymous.delta", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3217", "kind": "property", "name": "logprobs", "doc": "Log probability information for the choice.", "type": { "$id": "3218", "kind": "nullable", "type": { "$id": "3219", "kind": "model", "name": "CreateChatCompletionStreamResponseChoiceLogprobs1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.logprobs.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3220", "kind": "property", "name": "content", "doc": "A list of message content tokens with log probability information.", "type": { "$id": "3221", "kind": "nullable", "type": { "$ref": "2851" }, "namespace": "OpenAI" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.logprobs.anonymous.content", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3222", "kind": "property", "name": "refusal", "doc": "A list of message refusal tokens with log probability information.", "type": { "$id": "3223", "kind": "nullable", "type": { "$ref": "2851" }, "namespace": "OpenAI" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.logprobs.anonymous.refusal", "serializationOptions": {}, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.anonymous.logprobs", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3224", "kind": "property", "name": "finish_reason", "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.", "type": { "$id": "3225", "kind": "nullable", "type": { "$ref": "263" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.anonymous.finish_reason", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3226", "kind": "property", "name": "index", "doc": "The index of the choice in the list of choices.", "type": { "$id": "3227", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choice.anonymous.index", "serializationOptions": {}, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.choices", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3228", "kind": "property", "name": "created", "doc": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.", "type": { "$id": "3229", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3230", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.created", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3231", "kind": "property", "name": "model", "doc": "The model to generate the completion.", "type": { "$id": "3232", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.model", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3233", "kind": "property", "name": "service_tier", "type": { "$ref": "147" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.service_tier", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3234", "kind": "property", "name": "system_fingerprint", "doc": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.", "type": { "$id": "3235", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.system_fingerprint", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3236", "kind": "property", "name": "object", "doc": "The object type, which is always `chat.completion.chunk`.", "type": { "$ref": "1491" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3237", "kind": "property", "name": "usage", "doc": "An optional field that will only be present when you set\n`stream_options: {\"include_usage\": true}` in your request. When present, it\ncontains a null value **except for the last chunk** which contains the\ntoken usage statistics for the entire request.\n\n**NOTE:** If the stream is interrupted or cancelled, you may not\nreceive the final usage chunk which contains the total token usage for\nthe request.", "type": { "$id": "3238", "kind": "nullable", "type": { "$ref": "2880" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionStreamResponse.usage", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$ref": "3176" }, { "$ref": "3178" }, { "$ref": "3180" }, { "$ref": "3194" }, { "$ref": "3201" }, { "$ref": "3208" }, { "$ref": "3219" }, { "$id": "3239", "kind": "model", "name": "UpdateChatCompletionRequest", "namespace": "", "crossLanguageDefinitionId": "OpenAI.updateChatCompletion.Request.anonymous", "usage": "Spread,Json", "decorators": [], "properties": [ { "$id": "3240", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "updateChatCompletion.Request.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "3241", "kind": "model", "name": "ChatCompletionDeleted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionDeleted", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3242", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of object being deleted.", "type": { "$ref": "1493" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionDeleted.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3243", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the chat completion that was deleted.", "type": { "$id": "3244", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionDeleted.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3245", "kind": "property", "name": "deleted", "serializedName": "deleted", "doc": "Whether the chat completion was deleted.", "type": { "$id": "3246", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionDeleted.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "3247", "kind": "model", "name": "ChatCompletionMessageList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList", "usage": "Output,Json", "doc": "An object representing a list of chat completion messages.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3248", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object. It is always set to \"list\".", "type": { "$ref": "1495" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3249", "kind": "property", "name": "data", "serializedName": "data", "doc": "An array of chat completion message objects.", "type": { "$id": "3250", "kind": "array", "name": "Array13", "valueType": { "$id": "3251", "kind": "model", "name": "ChatCompletionMessageListDatum", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3252", "kind": "property", "name": "content", "serializedName": "content", "doc": "The contents of the message.", "type": { "$ref": "2783" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3253", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal message generated by the model.", "type": { "$ref": "2786" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false }, { "$id": "3254", "kind": "property", "name": "tool_calls", "serializedName": "tool_calls", "type": { "$ref": "2789" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.tool_calls", "serializationOptions": { "json": { "name": "tool_calls" } }, "isHttpMetadata": false }, { "$id": "3255", "kind": "property", "name": "annotations", "serializedName": "annotations", "doc": "Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).", "type": { "$ref": "2805" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.annotations", "serializationOptions": { "json": { "name": "annotations" } }, "isHttpMetadata": false }, { "$id": "3256", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the author of this message.", "type": { "$id": "3257", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3258", "kind": "property", "name": "function_call", "serializedName": "function_call", "doc": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "type": { "$ref": "2829" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.function_call", "serializationOptions": { "json": { "name": "function_call" } }, "isHttpMetadata": false }, { "$id": "3259", "kind": "property", "name": "audio", "serializedName": "audio", "doc": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).", "type": { "$ref": "2835" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.audio", "serializationOptions": { "json": { "name": "audio" } }, "isHttpMetadata": false }, { "$id": "3260", "kind": "property", "name": "content_parts", "serializedName": "content_parts", "type": { "$id": "3261", "kind": "nullable", "type": { "$ref": "2933" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.content_parts", "serializationOptions": { "json": { "name": "content_parts" } }, "isHttpMetadata": false }, { "$id": "3262", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier of the chat message.", "type": { "$id": "3263", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.datum.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3264", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The identifier of the first chat message in the data array.", "type": { "$id": "3265", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3266", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The identifier of the last chat message in the data array.", "type": { "$id": "3267", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3268", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates whether there are more chat messages available.", "type": { "$id": "3269", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3251" }, { "$id": "3270", "kind": "model", "name": "ContainerListResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerListResource", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3271", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of object returned, must be 'list'.", "type": { "$ref": "1497" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerListResource.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3272", "kind": "property", "name": "data", "serializedName": "data", "doc": "A list of containers.", "type": { "$id": "3273", "kind": "array", "name": "ArrayContainerResource", "valueType": { "$id": "3274", "kind": "model", "name": "ContainerResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerResource", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3275", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for the container.", "type": { "$id": "3276", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3277", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object.", "type": { "$id": "3278", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3279", "kind": "property", "name": "name", "serializedName": "name", "doc": "Name of the container.", "type": { "$id": "3280", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3281", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "Unix timestamp (in seconds) when the container was created.", "type": { "$id": "3282", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3283", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3284", "kind": "property", "name": "status", "serializedName": "status", "doc": "Status of the container (e.g., active, deleted).", "type": { "$id": "3285", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "3286", "kind": "property", "name": "expires_after", "serializedName": "expires_after", "doc": "The container will expire after this time period.\nThe anchor is the reference point for the expiration.\nThe minutes is the number of minutes after the anchor before the container expires.", "type": { "$id": "3287", "kind": "model", "name": "ContainerResourceExpiresAfter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerResource.expires_after.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3288", "kind": "property", "name": "anchor", "serializedName": "anchor", "doc": "The reference point for the expiration.", "type": { "$ref": "270" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.expires_after.anonymous.anchor", "serializationOptions": { "json": { "name": "anchor" } }, "isHttpMetadata": false }, { "$id": "3289", "kind": "property", "name": "minutes", "serializedName": "minutes", "doc": "The number of minutes after the anchor before the container expires.", "type": { "$id": "3290", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.expires_after.anonymous.minutes", "serializationOptions": { "json": { "name": "minutes" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerResource.expires_after", "serializationOptions": { "json": { "name": "expires_after" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerListResource.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3291", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The ID of the first container in the list.", "type": { "$id": "3292", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerListResource.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3293", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The ID of the last container in the list.", "type": { "$id": "3294", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerListResource.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3295", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Whether there are more containers available.", "type": { "$id": "3296", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerListResource.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3274" }, { "$ref": "3287" }, { "$id": "3297", "kind": "model", "name": "CreateContainerBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateContainerBody", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3298", "kind": "property", "name": "name", "serializedName": "name", "doc": "Name of the container to create.", "type": { "$id": "3299", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3300", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "IDs of files to copy to the container.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false }, { "$id": "3301", "kind": "property", "name": "expires_after", "serializedName": "expires_after", "doc": "Container expiration time in seconds relative to the 'anchor' time.", "type": { "$id": "3302", "kind": "model", "name": "CreateContainerBodyExpiresAfter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.expires_after.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3303", "kind": "property", "name": "anchor", "serializedName": "anchor", "doc": "Time anchor for the expiration time. Currently only 'last_active_at' is supported.", "type": { "$ref": "1499" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.expires_after.anonymous.anchor", "serializationOptions": { "json": { "name": "anchor" } }, "isHttpMetadata": false }, { "$id": "3304", "kind": "property", "name": "minutes", "serializedName": "minutes", "type": { "$id": "3305", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.expires_after.anonymous.minutes", "serializationOptions": { "json": { "name": "minutes" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerBody.expires_after", "serializationOptions": { "json": { "name": "expires_after" } }, "isHttpMetadata": false } ] }, { "$ref": "3302" }, { "$id": "3306", "kind": "model", "name": "DeleteContainerResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.deleteContainer.Response.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3307", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "3308", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainer.Response.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3309", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1501" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainer.Response.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3310", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$ref": "1503" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainer.Response.anonymous.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "3311", "kind": "model", "name": "CreateContainerFileBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateContainerFileBody", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "3312", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "Name of the file to create.", "type": { "$id": "3313", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerFileBody.file_id", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "file_id", "headers": [] } }, "isHttpMetadata": false }, { "$id": "3314", "kind": "property", "name": "file", "serializedName": "file", "doc": "The File object (not file name) to be uploaded.", "type": { "$id": "3315", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateContainerFileBody.file", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "file", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "3316", "kind": "model", "name": "ContainerFileResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerFileResource", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3317", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for the file.", "type": { "$id": "3318", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3319", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object (`container.file`).", "type": { "$id": "3320", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3321", "kind": "property", "name": "container_id", "serializedName": "container_id", "doc": "The container this file belongs to.", "type": { "$id": "3322", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.container_id", "serializationOptions": { "json": { "name": "container_id" } }, "isHttpMetadata": false }, { "$id": "3323", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "Unix timestamp (in seconds) when the file was created.", "type": { "$id": "3324", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3325", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3326", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "Size of the file in bytes.", "type": { "$id": "3327", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "3328", "kind": "property", "name": "path", "serializedName": "path", "doc": "Path of the file in the container.", "type": { "$id": "3329", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.path", "serializationOptions": { "json": { "name": "path" } }, "isHttpMetadata": false }, { "$id": "3330", "kind": "property", "name": "source", "serializedName": "source", "doc": "Source of the file (e.g., `user`, `assistant`).", "type": { "$id": "3331", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileResource.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false } ] }, { "$id": "3332", "kind": "model", "name": "ContainerFileListResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3333", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of object returned, must be 'list'.", "type": { "$ref": "1505" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3334", "kind": "property", "name": "data", "serializedName": "data", "doc": "A list of container files.", "type": { "$id": "3335", "kind": "array", "name": "ArrayContainerFileResource", "valueType": { "$ref": "3316" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3336", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The ID of the first file in the list.", "type": { "$id": "3337", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3338", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The ID of the last file in the list.", "type": { "$id": "3339", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3340", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Whether there are more files available.", "type": { "$id": "3341", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileListResource.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$id": "3342", "kind": "model", "name": "DeleteContainerFileResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.deleteContainerFile.Response.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3343", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "3344", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainerFile.Response.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3345", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1507" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainerFile.Response.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3346", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$ref": "1509" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteContainerFile.Response.anonymous.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "3347", "kind": "model", "name": "CreateEmbeddingRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3348", "kind": "property", "name": "input", "serializedName": "input", "doc": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.", "type": { "$id": "3349", "kind": "union", "name": "CreateEmbeddingRequestInput", "variantTypes": [ { "$id": "3350", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2373" }, { "$ref": "2606" }, { "$id": "3351", "kind": "array", "name": "ArrayArray", "valueType": { "$ref": "2606" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3352", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.", "type": { "$ref": "274" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3353", "kind": "property", "name": "encoding_format", "serializedName": "encoding_format", "doc": "The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).", "type": { "$ref": "279" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.encoding_format", "serializationOptions": { "json": { "name": "encoding_format" } }, "isHttpMetadata": false }, { "$id": "3354", "kind": "property", "name": "dimensions", "serializedName": "dimensions", "doc": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", "type": { "$id": "3355", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.dimensions", "serializationOptions": { "json": { "name": "dimensions" } }, "isHttpMetadata": false }, { "$id": "3356", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "3357", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingRequest.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false } ] }, { "$id": "3358", "kind": "model", "name": "CreateEmbeddingResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3359", "kind": "property", "name": "data", "serializedName": "data", "doc": "The list of embeddings generated by the model.", "type": { "$id": "3360", "kind": "array", "name": "ArrayEmbedding", "valueType": { "$id": "3361", "kind": "model", "name": "Embedding", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Embedding", "usage": "Output,Json", "doc": "Represents an embedding vector returned by embedding endpoint.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "3362", "kind": "property", "name": "index", "serializedName": "index", "doc": "The index of the embedding in the list of embeddings.", "type": { "$id": "3363", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embedding.index", "serializationOptions": { "json": { "name": "index" } }, "isHttpMetadata": false }, { "$id": "3364", "kind": "property", "name": "embedding", "serializedName": "embedding", "doc": "The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/docs/guides/embeddings).", "type": { "$id": "3365", "kind": "union", "name": "EmbeddingEmbedding", "variantTypes": [ { "$id": "3366", "kind": "array", "name": "Array14", "valueType": { "$id": "3367", "kind": "float", "name": "float", "crossLanguageDefinitionId": "TypeSpec.float", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, { "$id": "3368", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embedding.embedding", "serializationOptions": { "json": { "name": "embedding" } }, "isHttpMetadata": false }, { "$id": "3369", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"embedding\".", "type": { "$ref": "1511" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embedding.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3370", "kind": "property", "name": "model", "serializedName": "model", "doc": "The name of the model used to generate the embedding.", "type": { "$id": "3371", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3372", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"list\".", "type": { "$ref": "1513" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3373", "kind": "property", "name": "usage", "serializedName": "usage", "doc": "The usage information for the request.", "type": { "$id": "3374", "kind": "model", "name": "CreateEmbeddingResponseUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.usage.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3375", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "The number of tokens used by the prompt.", "type": { "$id": "3376", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.usage.anonymous.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "3377", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens used by the request.", "type": { "$id": "3378", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.usage.anonymous.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEmbeddingResponse.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false } ] }, { "$ref": "3361" }, { "$ref": "3374" }, { "$id": "3379", "kind": "model", "name": "ListFilesResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListFilesResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3380", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1515" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFilesResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3381", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "3382", "kind": "array", "name": "ArrayOpenAiFile", "valueType": { "$id": "3383", "kind": "model", "name": "OpenAIFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.OpenAIFile", "usage": "Output,Json", "doc": "The `File` object represents a document that has been uploaded to OpenAI.", "decorators": [], "properties": [ { "$id": "3384", "kind": "property", "name": "id", "serializedName": "id", "doc": "The file identifier, which can be referenced in the API endpoints.", "type": { "$id": "3385", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3386", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "The size of the file, in bytes.", "type": { "$id": "3387", "kind": "nullable", "type": { "$id": "3388", "kind": "int64", "name": "int64", "crossLanguageDefinitionId": "TypeSpec.int64", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "3389", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the file was created.", "type": { "$id": "3390", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3391", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3392", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when the file will expire.", "type": { "$id": "3393", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3394", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "3395", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file.", "type": { "$id": "3396", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "3397", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `file`.", "type": { "$ref": "1517" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3398", "kind": "property", "name": "purpose", "serializedName": "purpose", "doc": "The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`.", "type": { "$ref": "283" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.purpose", "serializationOptions": { "json": { "name": "purpose" } }, "isHttpMetadata": false }, { "$id": "3399", "kind": "property", "name": "status", "serializedName": "status", "doc": "Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.", "type": { "$ref": "294" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "3400", "kind": "property", "name": "status_details", "serializedName": "status_details", "doc": "Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`.", "type": { "$id": "3401", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OpenAIFile.status_details", "serializationOptions": { "json": { "name": "status_details" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFilesResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3402", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "3403", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFilesResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3404", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "3405", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFilesResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3406", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "3407", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFilesResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3383" }, { "$id": "3408", "kind": "model", "name": "CreateFileRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFileRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "3409", "kind": "property", "name": "file", "serializedName": "file", "doc": "The File object (not file name) to be uploaded.", "type": { "$id": "3410", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFileRequest.file", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "file", "headers": [] } }, "isHttpMetadata": false }, { "$id": "3411", "kind": "property", "name": "purpose", "serializedName": "purpose", "doc": "The intended purpose of the uploaded file. One of: - `assistants`: Used in the Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`: Flexible file type for any purpose - `evals`: Used for eval data sets", "type": { "$ref": "299" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFileRequest.purpose", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "purpose", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "3412", "kind": "model", "name": "DeleteFileResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteFileResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3413", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "3414", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFileResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3415", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1519" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFileResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3416", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "3417", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFileResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "3418", "kind": "model", "name": "ListFineTuningCheckpointPermissionResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3419", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "3420", "kind": "array", "name": "ArrayFineTuningCheckpointPermission", "valueType": { "$id": "3421", "kind": "model", "name": "FineTuningCheckpointPermission", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningCheckpointPermission", "usage": "Output,Json", "doc": "The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.", "decorators": [], "properties": [ { "$id": "3422", "kind": "property", "name": "id", "serializedName": "id", "doc": "The permission identifier, which can be referenced in the API endpoints.", "type": { "$id": "3423", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningCheckpointPermission.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3424", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the permission was created.", "type": { "$id": "3425", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3426", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningCheckpointPermission.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3427", "kind": "property", "name": "project_id", "serializedName": "project_id", "doc": "The project identifier that the permission is for.", "type": { "$id": "3428", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningCheckpointPermission.project_id", "serializationOptions": { "json": { "name": "project_id" } }, "isHttpMetadata": false }, { "$id": "3429", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"checkpoint.permission\".", "type": { "$ref": "1521" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningCheckpointPermission.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3430", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1523" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3431", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "3432", "kind": "nullable", "type": { "$id": "3433", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3434", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "3435", "kind": "nullable", "type": { "$id": "3436", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3437", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "3438", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningCheckpointPermissionResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3421" }, { "$id": "3439", "kind": "model", "name": "CreateFineTuningCheckpointPermissionRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningCheckpointPermissionRequest", "usage": "Spread,Json", "decorators": [], "properties": [ { "$id": "3440", "kind": "property", "name": "project_ids", "serializedName": "project_ids", "doc": "The project identifiers to grant access to.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningCheckpointPermissionRequest.project_ids", "serializationOptions": { "json": { "name": "project_ids" } }, "isHttpMetadata": false } ] }, { "$id": "3441", "kind": "model", "name": "DeleteFineTuningCheckpointPermissionResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteFineTuningCheckpointPermissionResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3442", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the fine-tuned model checkpoint permission that was deleted.", "type": { "$id": "3443", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFineTuningCheckpointPermissionResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3444", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"checkpoint.permission\".", "type": { "$ref": "1525" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFineTuningCheckpointPermissionResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3445", "kind": "property", "name": "deleted", "serializedName": "deleted", "doc": "Whether the fine-tuned model checkpoint permission was successfully deleted.", "type": { "$id": "3446", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteFineTuningCheckpointPermissionResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "3447", "kind": "model", "name": "CreateFineTuningJobRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3448", "kind": "property", "name": "model", "serializedName": "model", "doc": "The name of the model to fine-tune. You can select one of the\n[supported models](/docs/guides/fine-tuning#which-models-can-be-fine-tuned).", "type": { "$ref": "307" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3449", "kind": "property", "name": "training_file", "serializedName": "training_file", "doc": "The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/create) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.\n\nThe contents of the file should differ depending on if the model uses the [chat](/docs/api-reference/fine-tuning/chat-input), [completions](/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](/docs/api-reference/fine-tuning/preference-input) format.\n\nSee the [fine-tuning guide](/docs/guides/model-optimization) for more details.", "type": { "$id": "3450", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.training_file", "serializationOptions": { "json": { "name": "training_file" } }, "isHttpMetadata": false }, { "$id": "3451", "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", "doc": "The hyperparameters used for the fine-tuning job.\nThis value is now deprecated in favor of `method`, and should be passed in under the `method` parameter.", "type": { "$id": "3452", "kind": "model", "name": "CreateFineTuningJobRequestHyperparameters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.hyperparameters.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3453", "kind": "property", "name": "batch_size", "serializedName": "batch_size", "doc": "Number of examples in each batch. A larger batch size means that model parameters\nare updated less frequently, but with lower variance.", "type": { "$id": "3454", "kind": "union", "name": "CreateFineTuningJobRequestHyperparametersBatchSize", "variantTypes": [ { "$ref": "1527" }, { "$id": "3455", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.hyperparameters.anonymous.batch_size", "serializationOptions": { "json": { "name": "batch_size" } }, "isHttpMetadata": false }, { "$id": "3456", "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", "doc": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting.", "type": { "$id": "3457", "kind": "union", "name": "CreateFineTuningJobRequestHyperparametersLearningRateMultiplier", "variantTypes": [ { "$ref": "1529" }, { "$id": "3458", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.hyperparameters.anonymous.learning_rate_multiplier", "serializationOptions": { "json": { "name": "learning_rate_multiplier" } }, "isHttpMetadata": false }, { "$id": "3459", "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", "doc": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset.", "type": { "$id": "3460", "kind": "union", "name": "CreateFineTuningJobRequestHyperparametersNEpochs", "variantTypes": [ { "$ref": "1531" }, { "$id": "3461", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.hyperparameters.anonymous.n_epochs", "serializationOptions": { "json": { "name": "n_epochs" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.hyperparameters", "serializationOptions": { "json": { "name": "hyperparameters" } }, "isHttpMetadata": false }, { "$id": "3462", "kind": "property", "name": "suffix", "serializedName": "suffix", "doc": "A string of up to 64 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.", "type": { "$id": "3463", "kind": "nullable", "type": { "$id": "3464", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.suffix", "serializationOptions": { "json": { "name": "suffix" } }, "isHttpMetadata": false }, { "$id": "3465", "kind": "property", "name": "validation_file", "serializedName": "validation_file", "doc": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation\nmetrics periodically during fine-tuning. These metrics can be viewed in\nthe fine-tuning results file.\nThe same data should not be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/model-optimization) for more details.", "type": { "$id": "3466", "kind": "nullable", "type": { "$id": "3467", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.validation_file", "serializationOptions": { "json": { "name": "validation_file" } }, "isHttpMetadata": false }, { "$id": "3468", "kind": "property", "name": "integrations", "serializedName": "integrations", "doc": "A list of integrations to enable for your fine-tuning job.", "type": { "$id": "3469", "kind": "nullable", "type": { "$id": "3470", "kind": "array", "name": "ArrayCreateFineTuningJobRequestIntegration", "valueType": { "$id": "3471", "kind": "model", "name": "CreateFineTuningJobRequestIntegration", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestIntegration", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "3472", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "313" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestIntegration.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3472" } ], "discriminatedSubtypes": { "wandb": { "$id": "3473", "kind": "model", "name": "CreateFineTuningJobRequestWandbIntegration", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration", "usage": "Input,Json", "discriminatorValue": "wandb", "decorators": [], "baseModel": { "$ref": "3471" }, "properties": [ { "$id": "3474", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "3475", "kind": "enumvalue", "name": "wandb", "value": "wandb", "valueType": { "$ref": "314" }, "enumType": { "$id": "3476", "kind": "enum", "decorators": [], "name": "CreateFineTuningJobRequestIntegrationType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "3477", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3478", "kind": "enumvalue", "decorators": [], "name": "wandb", "value": "wandb", "valueType": { "$ref": "3477" }, "enumType": { "$ref": "3476" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestIntegration.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3479", "kind": "property", "name": "wandb", "serializedName": "wandb", "type": { "$id": "3480", "kind": "model", "name": "CreateFineTuningJobRequestWandbIntegrationWandb", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3481", "kind": "property", "name": "project", "serializedName": "project", "type": { "$id": "3482", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb.anonymous.project", "serializationOptions": { "json": { "name": "project" } }, "isHttpMetadata": false }, { "$id": "3483", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "3484", "kind": "nullable", "type": { "$id": "3485", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3486", "kind": "property", "name": "entity", "serializedName": "entity", "type": { "$id": "3487", "kind": "nullable", "type": { "$id": "3488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb.anonymous.entity", "serializationOptions": { "json": { "name": "entity" } }, "isHttpMetadata": false }, { "$id": "3489", "kind": "property", "name": "tags", "serializedName": "tags", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb.anonymous.tags", "serializationOptions": { "json": { "name": "tags" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequestWandbIntegration.wandb", "serializationOptions": { "json": { "name": "wandb" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.integrations", "serializationOptions": { "json": { "name": "integrations" } }, "isHttpMetadata": false }, { "$id": "3490", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\nIf a seed is not specified, one will be generated for you.", "type": { "$id": "3491", "kind": "nullable", "type": { "$id": "3492", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "3493", "kind": "property", "name": "method", "serializedName": "method", "type": { "$id": "3494", "kind": "model", "name": "FineTuneMethod", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneMethod", "usage": "Input,Output,Json", "doc": "The method used for fine-tuning.", "decorators": [], "properties": [ { "$id": "3495", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of method. Is either `supervised`, `dpo`, or `reinforcement`.", "type": { "$ref": "316" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneMethod.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3496", "kind": "property", "name": "supervised", "serializedName": "supervised", "type": { "$id": "3497", "kind": "model", "name": "FineTuneSupervisedMethod", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedMethod", "usage": "Input,Output,Json", "doc": "Configuration for the supervised fine-tuning method.", "decorators": [], "properties": [ { "$id": "3498", "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", "type": { "$id": "3499", "kind": "model", "name": "FineTuneSupervisedHyperparameters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedHyperparameters", "usage": "Input,Output,Json", "doc": "The hyperparameters used for the fine-tuning job.", "decorators": [], "properties": [ { "$id": "3500", "kind": "property", "name": "batch_size", "serializedName": "batch_size", "doc": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.", "type": { "$id": "3501", "kind": "union", "name": "FineTuneSupervisedHyperparametersBatchSize", "variantTypes": [ { "$ref": "1533" }, { "$id": "3502", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedHyperparameters.batch_size", "serializationOptions": { "json": { "name": "batch_size" } }, "isHttpMetadata": false }, { "$id": "3503", "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", "doc": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.", "type": { "$id": "3504", "kind": "union", "name": "FineTuneSupervisedHyperparametersLearningRateMultiplier", "variantTypes": [ { "$ref": "1535" }, { "$id": "3505", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedHyperparameters.learning_rate_multiplier", "serializationOptions": { "json": { "name": "learning_rate_multiplier" } }, "isHttpMetadata": false }, { "$id": "3506", "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", "type": { "$id": "3507", "kind": "union", "name": "FineTuneSupervisedHyperparametersNEpochs", "variantTypes": [ { "$ref": "1537" }, { "$id": "3508", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedHyperparameters.n_epochs", "serializationOptions": { "json": { "name": "n_epochs" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneSupervisedMethod.hyperparameters", "serializationOptions": { "json": { "name": "hyperparameters" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneMethod.supervised", "serializationOptions": { "json": { "name": "supervised" } }, "isHttpMetadata": false }, { "$id": "3509", "kind": "property", "name": "dpo", "serializedName": "dpo", "type": { "$id": "3510", "kind": "model", "name": "FineTuneDPOMethod", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneDPOMethod", "usage": "Input,Output,Json", "doc": "Configuration for the DPO fine-tuning method.", "decorators": [], "properties": [ { "$id": "3511", "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", "type": { "$id": "3512", "kind": "model", "name": "FineTuneDPOHyperparameters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneDPOHyperparameters", "usage": "Input,Output,Json", "doc": "The hyperparameters used for the DPO fine-tuning job.", "decorators": [], "properties": [ { "$id": "3513", "kind": "property", "name": "beta", "serializedName": "beta", "doc": "The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.", "type": { "$id": "3514", "kind": "union", "name": "FineTuneDPOHyperparametersBeta", "variantTypes": [ { "$ref": "1539" }, { "$id": "3515", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneDPOHyperparameters.beta", "serializationOptions": { "json": { "name": "beta" } }, "isHttpMetadata": false }, { "$id": "3516", "kind": "property", "name": "batch_size", "serializedName": "batch_size", "doc": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.", "type": { "$id": "3517", "kind": "union", "name": "FineTuneDPOHyperparametersBatchSize", "variantTypes": [ { "$ref": "1541" }, { "$id": "3518", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneDPOHyperparameters.batch_size", "serializationOptions": { "json": { "name": "batch_size" } }, "isHttpMetadata": false }, { "$id": "3519", "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", "doc": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.", "type": { "$id": "3520", "kind": "union", "name": "FineTuneDPOHyperparametersLearningRateMultiplier", "variantTypes": [ { "$ref": "1543" }, { "$id": "3521", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneDPOHyperparameters.learning_rate_multiplier", "serializationOptions": { "json": { "name": "learning_rate_multiplier" } }, "isHttpMetadata": false }, { "$id": "3522", "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", "type": { "$id": "3523", "kind": "union", "name": "FineTuneDPOHyperparametersNEpochs", "variantTypes": [ { "$ref": "1545" }, { "$id": "3524", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneDPOHyperparameters.n_epochs", "serializationOptions": { "json": { "name": "n_epochs" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneDPOMethod.hyperparameters", "serializationOptions": { "json": { "name": "hyperparameters" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneMethod.dpo", "serializationOptions": { "json": { "name": "dpo" } }, "isHttpMetadata": false }, { "$id": "3525", "kind": "property", "name": "reinforcement", "serializedName": "reinforcement", "type": { "$id": "3526", "kind": "model", "name": "FineTuneReinforcementMethod", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementMethod", "usage": "Input,Output,Json", "doc": "Configuration for the reinforcement fine-tuning method.", "decorators": [], "properties": [ { "$id": "3527", "kind": "property", "name": "grader", "serializedName": "grader", "doc": "The grader used for the fine-tuning job.", "type": { "$id": "3528", "kind": "union", "name": "FineTuneReinforcementMethodGrader", "variantTypes": [ { "$id": "3529", "kind": "model", "name": "GraderStringCheck", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderStringCheck", "usage": "Input,Output,Json", "doc": "A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.", "discriminatorValue": "string_check", "decorators": [], "baseModel": { "$id": "3530", "kind": "model", "name": "Grader", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Grader", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "3531", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "327" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Grader.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3531" } ], "discriminatedSubtypes": { "string_check": { "$ref": "3529" }, "text_similarity": { "$id": "3532", "kind": "model", "name": "GraderTextSimilarity", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity", "usage": "Input,Output,Json", "doc": "A TextSimilarityGrader object which grades text based on similarity metrics.", "discriminatorValue": "text_similarity", "decorators": [], "baseModel": { "$ref": "3530" }, "properties": [ { "$id": "3533", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of grader.", "type": { "$id": "3534", "kind": "enumvalue", "name": "text_similarity", "value": "text_similarity", "valueType": { "$ref": "328" }, "enumType": { "$id": "3535", "kind": "enum", "decorators": [], "name": "GraderType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "3536", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3537", "kind": "enumvalue", "decorators": [], "name": "string_check", "value": "string_check", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } }, { "$id": "3538", "kind": "enumvalue", "decorators": [], "name": "text_similarity", "value": "text_similarity", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } }, { "$id": "3539", "kind": "enumvalue", "decorators": [], "name": "score_model", "value": "score_model", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } }, { "$id": "3540", "kind": "enumvalue", "decorators": [], "name": "label_model", "value": "label_model", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } }, { "$id": "3541", "kind": "enumvalue", "decorators": [], "name": "python", "value": "python", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } }, { "$id": "3542", "kind": "enumvalue", "decorators": [], "name": "multi", "value": "multi", "valueType": { "$ref": "3536" }, "enumType": { "$ref": "3535" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.GraderType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3543", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3544", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3545", "kind": "property", "name": "input", "serializedName": "input", "doc": "The text being graded.", "type": { "$id": "3546", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3547", "kind": "property", "name": "reference", "serializedName": "reference", "doc": "The text being graded against.", "type": { "$id": "3548", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.reference", "serializationOptions": { "json": { "name": "reference" } }, "isHttpMetadata": false }, { "$id": "3549", "kind": "property", "name": "evaluation_metric", "serializedName": "evaluation_metric", "doc": "The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.", "type": { "$ref": "335" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderTextSimilarity.evaluation_metric", "serializationOptions": { "json": { "name": "evaluation_metric" } }, "isHttpMetadata": false } ] }, "python": { "$id": "3550", "kind": "model", "name": "GraderPython", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderPython", "usage": "Input,Output,Json", "doc": "A PythonGrader object that runs a python script on the input.", "discriminatorValue": "python", "decorators": [], "baseModel": { "$ref": "3530" }, "properties": [ { "$id": "3551", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `python`.", "type": { "$id": "3552", "kind": "enumvalue", "name": "python", "value": "python", "valueType": { "$ref": "328" }, "enumType": { "$ref": "3535" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderPython.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3553", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3554", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderPython.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3555", "kind": "property", "name": "source", "serializedName": "source", "doc": "The source code of the python script.", "type": { "$id": "3556", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderPython.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false }, { "$id": "3557", "kind": "property", "name": "image_tag", "serializedName": "image_tag", "doc": "The image tag to use for the python script.", "type": { "$id": "3558", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderPython.image_tag", "serializationOptions": { "json": { "name": "image_tag" } }, "isHttpMetadata": false } ] }, "score_model": { "$id": "3559", "kind": "model", "name": "GraderScoreModel", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderScoreModel", "usage": "Input,Output,Json", "doc": "A ScoreModelGrader object that uses a model to assign a score to the input.", "discriminatorValue": "score_model", "decorators": [], "baseModel": { "$ref": "3530" }, "properties": [ { "$id": "3560", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `score_model`.", "type": { "$id": "3561", "kind": "enumvalue", "name": "score_model", "value": "score_model", "valueType": { "$ref": "328" }, "enumType": { "$ref": "3535" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3562", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3563", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3564", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation.", "type": { "$id": "3565", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3566", "kind": "property", "name": "sampling_params", "serializedName": "sampling_params", "doc": "The sampling parameters for the model.", "type": { "$id": "3567", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.sampling_params", "serializationOptions": { "json": { "name": "sampling_params" } }, "isHttpMetadata": false }, { "$id": "3568", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input text. This may include template strings.", "type": { "$id": "3569", "kind": "array", "name": "ArrayEvalItem", "valueType": { "$id": "3570", "kind": "model", "name": "EvalItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalItem", "usage": "Input,Output,Json", "doc": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "decorators": [], "properties": [ { "$id": "3571", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.", "type": { "$ref": "347" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3572", "kind": "property", "name": "content", "serializedName": "content", "doc": "Text inputs to the model - can contain template strings.", "type": { "$id": "3573", "kind": "union", "name": "EvalItemContent1", "variantTypes": [ { "$id": "3574", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "3575", "kind": "model", "name": "EvalItemContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalItemContent", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "3576", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "353" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItemContent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3576" } ], "discriminatedSubtypes": { "input_text": { "$id": "3577", "kind": "model", "name": "EvalItemContentInputText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalItemContentInputText", "usage": "Input,Output,Json", "discriminatorValue": "input_text", "decorators": [], "baseModel": { "$ref": "3575" }, "properties": [ { "$id": "3578", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "3579", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "354" }, "enumType": { "$id": "3580", "kind": "enum", "decorators": [], "name": "EvalItemContentType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "3581", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3582", "kind": "enumvalue", "decorators": [], "name": "input_text", "value": "input_text", "valueType": { "$ref": "3581" }, "enumType": { "$ref": "3580" } }, { "$id": "3583", "kind": "enumvalue", "decorators": [], "name": "output_text", "value": "output_text", "valueType": { "$ref": "3581" }, "enumType": { "$ref": "3580" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.EvalItemContentType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItemContentInputText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3584", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "3585", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItemContentInputText.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "output_text": { "$id": "3586", "kind": "model", "name": "EvalItemContentOutputText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalItemContentOutputText", "usage": "Input,Output,Json", "discriminatorValue": "output_text", "decorators": [], "baseModel": { "$ref": "3575" }, "properties": [ { "$id": "3587", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "3588", "kind": "enumvalue", "name": "output_text", "value": "output_text", "valueType": { "$ref": "354" }, "enumType": { "$ref": "3580" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItemContentOutputText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3589", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "3590", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItemContentOutputText.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] } } } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "3591", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the message input. Always `message`.", "type": { "$ref": "357" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3592", "kind": "property", "name": "range", "serializedName": "range", "doc": "The range of the score. Defaults to `[0, 1]`.", "type": { "$ref": "2627" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderScoreModel.range", "serializationOptions": { "json": { "name": "range" } }, "isHttpMetadata": false } ] }, "multi": { "$id": "3593", "kind": "model", "name": "GraderMulti", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderMulti", "usage": "Input,Output,Json", "doc": "A MultiGrader object combines the output of multiple graders to produce a single score.", "discriminatorValue": "multi", "decorators": [], "baseModel": { "$ref": "3530" }, "properties": [ { "$id": "3594", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `multi`.", "type": { "$id": "3595", "kind": "enumvalue", "name": "multi", "value": "multi", "valueType": { "$ref": "328" }, "enumType": { "$ref": "3535" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderMulti.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3596", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3597", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderMulti.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3598", "kind": "property", "name": "graders", "serializedName": "graders", "type": { "$id": "3599", "kind": "union", "name": "GraderMultiGraders", "variantTypes": [ { "$ref": "3529" }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$id": "3600", "kind": "model", "name": "GraderLabelModel", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.GraderLabelModel", "usage": "Input,Output,Json", "doc": "A LabelModelGrader object which uses a model to assign labels to each item\nin the evaluation.", "discriminatorValue": "label_model", "decorators": [], "baseModel": { "$ref": "3530" }, "properties": [ { "$id": "3601", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `label_model`.", "type": { "$id": "3602", "kind": "enumvalue", "name": "label_model", "value": "label_model", "valueType": { "$ref": "328" }, "enumType": { "$ref": "3535" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3603", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3604", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3605", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation. Must support structured outputs.", "type": { "$id": "3606", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3607", "kind": "property", "name": "input", "serializedName": "input", "type": { "$ref": "3569" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3608", "kind": "property", "name": "labels", "serializedName": "labels", "doc": "The labels to assign to each item in the evaluation.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.labels", "serializationOptions": { "json": { "name": "labels" } }, "isHttpMetadata": false }, { "$id": "3609", "kind": "property", "name": "passing_labels", "serializedName": "passing_labels", "doc": "The labels that indicate a passing result. Must be a subset of labels.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderLabelModel.passing_labels", "serializationOptions": { "json": { "name": "passing_labels" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderMulti.graders", "serializationOptions": { "json": { "name": "graders" } }, "isHttpMetadata": false }, { "$id": "3610", "kind": "property", "name": "calculate_output", "serializedName": "calculate_output", "doc": "A formula to calculate the output based on grader results.", "type": { "$id": "3611", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderMulti.calculate_output", "serializationOptions": { "json": { "name": "calculate_output" } }, "isHttpMetadata": false } ] }, "label_model": { "$ref": "3600" } } }, "properties": [ { "$id": "3612", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `string_check`.", "type": { "$id": "3613", "kind": "enumvalue", "name": "string_check", "value": "string_check", "valueType": { "$ref": "328" }, "enumType": { "$ref": "3535" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3614", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3615", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3616", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input text. This may include template strings.", "type": { "$id": "3617", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3618", "kind": "property", "name": "reference", "serializedName": "reference", "doc": "The reference text. This may include template strings.", "type": { "$id": "3619", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.reference", "serializationOptions": { "json": { "name": "reference" } }, "isHttpMetadata": false }, { "$id": "3620", "kind": "property", "name": "operation", "serializedName": "operation", "doc": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.", "type": { "$ref": "321" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GraderStringCheck.operation", "serializationOptions": { "json": { "name": "operation" } }, "isHttpMetadata": false } ] }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$ref": "3593" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementMethod.grader", "serializationOptions": { "json": { "name": "grader" } }, "isHttpMetadata": false }, { "$id": "3621", "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", "type": { "$id": "3622", "kind": "model", "name": "FineTuneReinforcementHyperparameters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters", "usage": "Input,Output,Json", "doc": "The hyperparameters used for the reinforcement fine-tuning job.", "decorators": [], "properties": [ { "$id": "3623", "kind": "property", "name": "batch_size", "serializedName": "batch_size", "doc": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.", "type": { "$id": "3624", "kind": "union", "name": "FineTuneReinforcementHyperparametersBatchSize", "variantTypes": [ { "$ref": "1547" }, { "$id": "3625", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.batch_size", "serializationOptions": { "json": { "name": "batch_size" } }, "isHttpMetadata": false }, { "$id": "3626", "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", "doc": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.", "type": { "$id": "3627", "kind": "union", "name": "FineTuneReinforcementHyperparametersLearningRateMultiplier", "variantTypes": [ { "$ref": "1549" }, { "$id": "3628", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.learning_rate_multiplier", "serializationOptions": { "json": { "name": "learning_rate_multiplier" } }, "isHttpMetadata": false }, { "$id": "3629", "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", "type": { "$id": "3630", "kind": "union", "name": "FineTuneReinforcementHyperparametersNEpochs", "variantTypes": [ { "$ref": "1551" }, { "$id": "3631", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.n_epochs", "serializationOptions": { "json": { "name": "n_epochs" } }, "isHttpMetadata": false }, { "$id": "3632", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "doc": "Level of reasoning effort.", "type": { "$ref": "361" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "3633", "kind": "property", "name": "compute_multiplier", "serializedName": "compute_multiplier", "doc": "Multiplier on amount of compute used for exploring search space during training.", "type": { "$id": "3634", "kind": "union", "name": "FineTuneReinforcementHyperparametersComputeMultiplier", "variantTypes": [ { "$ref": "1553" }, { "$id": "3635", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.compute_multiplier", "serializationOptions": { "json": { "name": "compute_multiplier" } }, "isHttpMetadata": false }, { "$id": "3636", "kind": "property", "name": "eval_interval", "serializedName": "eval_interval", "doc": "The number of training steps between evaluation runs.", "type": { "$id": "3637", "kind": "union", "name": "FineTuneReinforcementHyperparametersEvalInterval", "variantTypes": [ { "$ref": "1555" }, { "$id": "3638", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.eval_interval", "serializationOptions": { "json": { "name": "eval_interval" } }, "isHttpMetadata": false }, { "$id": "3639", "kind": "property", "name": "eval_samples", "serializedName": "eval_samples", "doc": "Number of evaluation samples to generate per training step.", "type": { "$id": "3640", "kind": "union", "name": "FineTuneReinforcementHyperparametersEvalSamples", "variantTypes": [ { "$ref": "1557" }, { "$id": "3641", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementHyperparameters.eval_samples", "serializationOptions": { "json": { "name": "eval_samples" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneReinforcementMethod.hyperparameters", "serializationOptions": { "json": { "name": "hyperparameters" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneMethod.reinforcement", "serializationOptions": { "json": { "name": "reinforcement" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.method", "serializationOptions": { "json": { "name": "method" } }, "isHttpMetadata": false }, { "$id": "3642", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateFineTuningJobRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "3452" }, { "$ref": "3471" }, { "$ref": "3473" }, { "$ref": "3480" }, { "$ref": "3494" }, { "$ref": "3497" }, { "$ref": "3499" }, { "$ref": "3510" }, { "$ref": "3512" }, { "$ref": "3526" }, { "$ref": "3529" }, { "$ref": "3530" }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$ref": "3570" }, { "$ref": "3575" }, { "$ref": "3577" }, { "$ref": "3586" }, { "$ref": "3593" }, { "$ref": "3600" }, { "$ref": "3622" }, { "$id": "3643", "kind": "model", "name": "FineTuningJob", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJob", "usage": "Output,Json", "doc": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.", "decorators": [], "properties": [ { "$id": "3644", "kind": "property", "name": "user_provided_suffix", "serializedName": "user_provided_suffix", "doc": "The descriptive suffix applied to the job, as specified in the job creation request.", "type": { "$id": "3645", "kind": "nullable", "type": { "$id": "3646", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.user_provided_suffix", "serializationOptions": { "json": { "name": "user_provided_suffix" } }, "isHttpMetadata": false }, { "$id": "3647", "kind": "property", "name": "id", "serializedName": "id", "doc": "The object identifier, which can be referenced in the API endpoints.", "type": { "$id": "3648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3649", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", "type": { "$id": "3650", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3651", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3652", "kind": "property", "name": "error", "serializedName": "error", "doc": "For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.", "type": { "$id": "3653", "kind": "nullable", "type": { "$id": "3654", "kind": "model", "name": "FineTuningJobError1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJob.error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3655", "kind": "property", "name": "code", "serializedName": "code", "doc": "A machine-readable error code.", "type": { "$id": "3656", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "3657", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable error message.", "type": { "$id": "3658", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "3659", "kind": "property", "name": "param", "serializedName": "param", "doc": "The parameter that was invalid, usually `training_file` or `validation_file`. This field will be null if the failure was not parameter-specific.", "type": { "$id": "3660", "kind": "nullable", "type": { "$id": "3661", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.error.anonymous.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false }, { "$id": "3662", "kind": "property", "name": "fine_tuned_model", "serializedName": "fine_tuned_model", "doc": "The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.", "type": { "$id": "3663", "kind": "nullable", "type": { "$id": "3664", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.fine_tuned_model", "serializationOptions": { "json": { "name": "fine_tuned_model" } }, "isHttpMetadata": false }, { "$id": "3665", "kind": "property", "name": "finished_at", "serializedName": "finished_at", "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.", "type": { "$id": "3666", "kind": "nullable", "type": { "$id": "3667", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3668", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.finished_at", "serializationOptions": { "json": { "name": "finished_at" } }, "isHttpMetadata": false }, { "$id": "3669", "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", "doc": "The hyperparameters used for the fine-tuning job. This value will only be returned when running `supervised` jobs.", "type": { "$id": "3670", "kind": "model", "name": "FineTuningJobHyperparameters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJob.hyperparameters.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3671", "kind": "property", "name": "batch_size", "serializedName": "batch_size", "doc": "Number of examples in each batch. A larger batch size means that model parameters\nare updated less frequently, but with lower variance.", "type": { "$id": "3672", "kind": "nullable", "type": { "$id": "3673", "kind": "union", "name": "FineTuningJobHyperparametersBatchSize", "variantTypes": [ { "$ref": "1559" }, { "$id": "3674", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.hyperparameters.anonymous.batch_size", "serializationOptions": { "json": { "name": "batch_size" } }, "isHttpMetadata": false }, { "$id": "3675", "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", "doc": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting.", "type": { "$id": "3676", "kind": "union", "name": "FineTuningJobHyperparametersLearningRateMultiplier", "variantTypes": [ { "$ref": "1561" }, { "$id": "3677", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.hyperparameters.anonymous.learning_rate_multiplier", "serializationOptions": { "json": { "name": "learning_rate_multiplier" } }, "isHttpMetadata": false }, { "$id": "3678", "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", "doc": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset.", "type": { "$id": "3679", "kind": "union", "name": "FineTuningJobHyperparametersNEpochs", "variantTypes": [ { "$ref": "1563" }, { "$id": "3680", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.hyperparameters.anonymous.n_epochs", "serializationOptions": { "json": { "name": "n_epochs" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.hyperparameters", "serializationOptions": { "json": { "name": "hyperparameters" } }, "isHttpMetadata": false }, { "$id": "3681", "kind": "property", "name": "model", "serializedName": "model", "doc": "The base model that is being fine-tuned.", "type": { "$id": "3682", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3683", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"fine_tuning.job\".", "type": { "$ref": "1565" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3684", "kind": "property", "name": "organization_id", "serializedName": "organization_id", "doc": "The organization that owns the fine-tuning job.", "type": { "$id": "3685", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.organization_id", "serializationOptions": { "json": { "name": "organization_id" } }, "isHttpMetadata": false }, { "$id": "3686", "kind": "property", "name": "result_files", "serializedName": "result_files", "doc": "The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.result_files", "serializationOptions": { "json": { "name": "result_files" } }, "isHttpMetadata": false }, { "$id": "3687", "kind": "property", "name": "status", "serializedName": "status", "doc": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.", "type": { "$ref": "367" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "3688", "kind": "property", "name": "trained_tokens", "serializedName": "trained_tokens", "doc": "The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.", "type": { "$id": "3689", "kind": "nullable", "type": { "$id": "3690", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.trained_tokens", "serializationOptions": { "json": { "name": "trained_tokens" } }, "isHttpMetadata": false }, { "$id": "3691", "kind": "property", "name": "training_file", "serializedName": "training_file", "doc": "The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$id": "3692", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.training_file", "serializationOptions": { "json": { "name": "training_file" } }, "isHttpMetadata": false }, { "$id": "3693", "kind": "property", "name": "validation_file", "serializedName": "validation_file", "doc": "The file ID used for validation. You can retrieve the validation results with the [Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$id": "3694", "kind": "nullable", "type": { "$id": "3695", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.validation_file", "serializationOptions": { "json": { "name": "validation_file" } }, "isHttpMetadata": false }, { "$id": "3696", "kind": "property", "name": "integrations", "serializedName": "integrations", "doc": "A list of integrations to enable for this fine-tuning job.", "type": { "$id": "3697", "kind": "nullable", "type": { "$id": "3698", "kind": "array", "name": "ArrayFineTuningIntegration", "valueType": { "$id": "3699", "kind": "model", "name": "FineTuningIntegration", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningIntegration", "usage": "Output,Json", "decorators": [], "discriminatorProperty": { "$id": "3700", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "375" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegration.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3700" } ], "discriminatedSubtypes": { "wandb": { "$id": "3701", "kind": "model", "name": "FineTuningIntegrationWandb", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb", "usage": "Output,Json", "discriminatorValue": "wandb", "decorators": [], "baseModel": { "$ref": "3699" }, "properties": [ { "$id": "3702", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the integration being enabled for the fine-tuning job", "type": { "$id": "3703", "kind": "enumvalue", "name": "wandb", "value": "wandb", "valueType": { "$ref": "376" }, "enumType": { "$id": "3704", "kind": "enum", "decorators": [], "name": "FineTuningIntegrationType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "3705", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3706", "kind": "enumvalue", "decorators": [], "name": "wandb", "value": "wandb", "valueType": { "$ref": "3705" }, "enumType": { "$ref": "3704" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.FineTuningIntegration.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3707", "kind": "property", "name": "wandb", "serializedName": "wandb", "doc": "The settings for your integration with Weights and Biases. This payload specifies the project that\nmetrics will be sent to. Optionally, you can set an explicit display name for your run, add tags\nto your run, and set a default entity (team, username, etc) to be associated with your run.", "type": { "$id": "3708", "kind": "model", "name": "FineTuningIntegrationWandbWandb", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3709", "kind": "property", "name": "project", "serializedName": "project", "doc": "The name of the project that the new run will be created under.", "type": { "$id": "3710", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb.anonymous.project", "serializationOptions": { "json": { "name": "project" } }, "isHttpMetadata": false }, { "$id": "3711", "kind": "property", "name": "name", "serializedName": "name", "doc": "A display name to set for the run. If not set, we will use the Job ID as the name.", "type": { "$id": "3712", "kind": "nullable", "type": { "$id": "3713", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3714", "kind": "property", "name": "entity", "serializedName": "entity", "doc": "The entity to use for the run. This allows you to set the team or username of the WandB user that you would\nlike associated with the run. If not set, the default entity for the registered WandB API key is used.", "type": { "$id": "3715", "kind": "nullable", "type": { "$id": "3716", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb.anonymous.entity", "serializationOptions": { "json": { "name": "entity" } }, "isHttpMetadata": false }, { "$id": "3717", "kind": "property", "name": "tags", "serializedName": "tags", "doc": "A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some\ndefault tags are generated by OpenAI: \"openai/finetune\", \"openai/{base-model}\", \"openai/{ftjob-abcdef}\".", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb.anonymous.tags", "serializationOptions": { "json": { "name": "tags" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningIntegrationWandb.wandb", "serializationOptions": { "json": { "name": "wandb" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.integrations", "serializationOptions": { "json": { "name": "integrations" } }, "isHttpMetadata": false }, { "$id": "3718", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "The seed used for the fine-tuning job.", "type": { "$id": "3719", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "3720", "kind": "property", "name": "estimated_finish", "serializedName": "estimated_finish", "doc": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", "type": { "$id": "3721", "kind": "nullable", "type": { "$id": "3722", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3723", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.estimated_finish", "serializationOptions": { "json": { "name": "estimated_finish" } }, "isHttpMetadata": false }, { "$id": "3724", "kind": "property", "name": "method", "serializedName": "method", "type": { "$ref": "3494" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.method", "serializationOptions": { "json": { "name": "method" } }, "isHttpMetadata": false }, { "$id": "3725", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJob.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "3654" }, { "$ref": "3670" }, { "$ref": "3699" }, { "$ref": "3701" }, { "$ref": "3708" }, { "$id": "3726", "kind": "model", "name": "ListPaginatedFineTuningJobsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListPaginatedFineTuningJobsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3727", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "3728", "kind": "array", "name": "ArrayFineTuningJob", "valueType": { "$ref": "3643" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListPaginatedFineTuningJobsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3729", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "3730", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListPaginatedFineTuningJobsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false }, { "$id": "3731", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1567" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListPaginatedFineTuningJobsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "3732", "kind": "model", "name": "ListFineTuningJobCheckpointsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3733", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "3734", "kind": "array", "name": "ArrayFineTuningJobCheckpoint", "valueType": { "$id": "3735", "kind": "model", "name": "FineTuningJobCheckpoint", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint", "usage": "Output,Json", "doc": "The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready to use.", "decorators": [], "properties": [ { "$id": "3736", "kind": "property", "name": "id", "serializedName": "id", "doc": "The checkpoint identifier, which can be referenced in the API endpoints.", "type": { "$id": "3737", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3738", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the checkpoint was created.", "type": { "$id": "3739", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3740", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3741", "kind": "property", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The name of the fine-tuned checkpoint model that is created.", "type": { "$id": "3742", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.fine_tuned_model_checkpoint", "serializationOptions": { "json": { "name": "fine_tuned_model_checkpoint" } }, "isHttpMetadata": false }, { "$id": "3743", "kind": "property", "name": "step_number", "serializedName": "step_number", "doc": "The step number that the checkpoint was created at.", "type": { "$id": "3744", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.step_number", "serializationOptions": { "json": { "name": "step_number" } }, "isHttpMetadata": false }, { "$id": "3745", "kind": "property", "name": "metrics", "serializedName": "metrics", "doc": "Metrics at the step number during the fine-tuning job.", "type": { "$id": "3746", "kind": "model", "name": "FineTuningJobCheckpointMetrics", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3747", "kind": "property", "name": "step", "serializedName": "step", "type": { "$id": "3748", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.step", "serializationOptions": { "json": { "name": "step" } }, "isHttpMetadata": false }, { "$id": "3749", "kind": "property", "name": "train_loss", "serializedName": "train_loss", "type": { "$id": "3750", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.train_loss", "serializationOptions": { "json": { "name": "train_loss" } }, "isHttpMetadata": false }, { "$id": "3751", "kind": "property", "name": "train_mean_token_accuracy", "serializedName": "train_mean_token_accuracy", "type": { "$id": "3752", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.train_mean_token_accuracy", "serializationOptions": { "json": { "name": "train_mean_token_accuracy" } }, "isHttpMetadata": false }, { "$id": "3753", "kind": "property", "name": "valid_loss", "serializedName": "valid_loss", "type": { "$id": "3754", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.valid_loss", "serializationOptions": { "json": { "name": "valid_loss" } }, "isHttpMetadata": false }, { "$id": "3755", "kind": "property", "name": "valid_mean_token_accuracy", "serializedName": "valid_mean_token_accuracy", "type": { "$id": "3756", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.valid_mean_token_accuracy", "serializationOptions": { "json": { "name": "valid_mean_token_accuracy" } }, "isHttpMetadata": false }, { "$id": "3757", "kind": "property", "name": "full_valid_loss", "serializedName": "full_valid_loss", "type": { "$id": "3758", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.full_valid_loss", "serializationOptions": { "json": { "name": "full_valid_loss" } }, "isHttpMetadata": false }, { "$id": "3759", "kind": "property", "name": "full_valid_mean_token_accuracy", "serializedName": "full_valid_mean_token_accuracy", "type": { "$id": "3760", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics.anonymous.full_valid_mean_token_accuracy", "serializationOptions": { "json": { "name": "full_valid_mean_token_accuracy" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.metrics", "serializationOptions": { "json": { "name": "metrics" } }, "isHttpMetadata": false }, { "$id": "3761", "kind": "property", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The name of the fine-tuning job that this checkpoint was created from.", "type": { "$id": "3762", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.fine_tuning_job_id", "serializationOptions": { "json": { "name": "fine_tuning_job_id" } }, "isHttpMetadata": false }, { "$id": "3763", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"fine_tuning.job.checkpoint\".", "type": { "$ref": "1569" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobCheckpoint.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3764", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1571" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3765", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "3766", "kind": "nullable", "type": { "$id": "3767", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3768", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "3769", "kind": "nullable", "type": { "$id": "3770", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3771", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "3772", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobCheckpointsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3735" }, { "$ref": "3746" }, { "$id": "3773", "kind": "model", "name": "ListFineTuningJobEventsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobEventsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "3774", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "3775", "kind": "array", "name": "ArrayFineTuningJobEvent", "valueType": { "$id": "3776", "kind": "model", "name": "FineTuningJobEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent", "usage": "Output,Json", "doc": "Fine-tuning job event object", "decorators": [], "properties": [ { "$id": "3777", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"fine_tuning.job.event\".", "type": { "$ref": "1573" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3778", "kind": "property", "name": "id", "serializedName": "id", "doc": "The object identifier.", "type": { "$id": "3779", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3780", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", "type": { "$id": "3781", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3782", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3783", "kind": "property", "name": "level", "serializedName": "level", "doc": "The log level of the event.", "type": { "$ref": "378" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.level", "serializationOptions": { "json": { "name": "level" } }, "isHttpMetadata": false }, { "$id": "3784", "kind": "property", "name": "message", "serializedName": "message", "doc": "The message of the event.", "type": { "$id": "3785", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "3786", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of event.", "type": { "$ref": "383" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3787", "kind": "property", "name": "data", "serializedName": "data", "doc": "The data associated with the event.", "type": { "$id": "3788", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobEvent.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobEventsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3789", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1575" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobEventsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3790", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "3791", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListFineTuningJobEventsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3776" }, { "$id": "3792", "kind": "model", "name": "RunGraderRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunGraderRequest", "usage": "Json", "decorators": [], "properties": [ { "$id": "3793", "kind": "property", "name": "grader", "serializedName": "grader", "doc": "The grader used for the fine-tuning job.", "type": { "$id": "3794", "kind": "union", "name": "RunGraderRequestGrader", "variantTypes": [ { "$ref": "3529" }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$ref": "3593" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderRequest.grader", "serializationOptions": { "json": { "name": "grader" } }, "isHttpMetadata": false }, { "$id": "3795", "kind": "property", "name": "item", "serializedName": "item", "doc": "The dataset item provided to the grader. This will be used to populate\nthe `item` namespace. See [the guide](/docs/guides/graders) for more details.", "type": { "$id": "3796", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderRequest.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false }, { "$id": "3797", "kind": "property", "name": "model_sample", "serializedName": "model_sample", "doc": "The model sample to be evaluated. This value will be used to populate\nthe `sample` namespace. See [the guide](/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a\nvalid JSON string.", "type": { "$id": "3798", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderRequest.model_sample", "serializationOptions": { "json": { "name": "model_sample" } }, "isHttpMetadata": false } ] }, { "$id": "3799", "kind": "model", "name": "RunGraderResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunGraderResponse", "usage": "Output", "decorators": [], "properties": [ { "$id": "3800", "kind": "property", "name": "reward", "type": { "$id": "3801", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.reward", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3802", "kind": "property", "name": "metadata", "type": { "$id": "3803", "kind": "model", "name": "RunGraderResponseMetadata", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3804", "kind": "property", "name": "name", "type": { "$id": "3805", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3806", "kind": "property", "name": "type", "type": { "$id": "3807", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3808", "kind": "property", "name": "errors", "type": { "$id": "3809", "kind": "model", "name": "RunGraderResponseMetadataErrors", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "3810", "kind": "property", "name": "formula_parse_error", "type": { "$id": "3811", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.formula_parse_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3812", "kind": "property", "name": "sample_parse_error", "type": { "$id": "3813", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.sample_parse_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3814", "kind": "property", "name": "truncated_observation_error", "type": { "$id": "3815", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.truncated_observation_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3816", "kind": "property", "name": "unresponsive_reward_error", "type": { "$id": "3817", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.unresponsive_reward_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3818", "kind": "property", "name": "invalid_variable_error", "type": { "$id": "3819", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.invalid_variable_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3820", "kind": "property", "name": "other_error", "type": { "$id": "3821", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.other_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3822", "kind": "property", "name": "python_grader_server_error", "type": { "$id": "3823", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.python_grader_server_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3824", "kind": "property", "name": "python_grader_server_error_type", "type": { "$id": "3825", "kind": "nullable", "type": { "$id": "3826", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.python_grader_server_error_type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3827", "kind": "property", "name": "python_grader_runtime_error", "type": { "$id": "3828", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.python_grader_runtime_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3829", "kind": "property", "name": "python_grader_runtime_error_details", "type": { "$id": "3830", "kind": "nullable", "type": { "$id": "3831", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.python_grader_runtime_error_details", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3832", "kind": "property", "name": "model_grader_server_error", "type": { "$id": "3833", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.model_grader_server_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3834", "kind": "property", "name": "model_grader_refusal_error", "type": { "$id": "3835", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.model_grader_refusal_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3836", "kind": "property", "name": "model_grader_parse_error", "type": { "$id": "3837", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.model_grader_parse_error", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3838", "kind": "property", "name": "model_grader_server_error_details", "type": { "$id": "3839", "kind": "nullable", "type": { "$id": "3840", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.errors.anonymous.model_grader_server_error_details", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.errors", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3841", "kind": "property", "name": "execution_time", "type": { "$id": "3842", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.execution_time", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3843", "kind": "property", "name": "scores", "type": { "$id": "3844", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.scores", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3845", "kind": "property", "name": "token_usage", "type": { "$id": "3846", "kind": "nullable", "type": { "$id": "3847", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.token_usage", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3848", "kind": "property", "name": "sampled_model_name", "type": { "$id": "3849", "kind": "nullable", "type": { "$id": "3850", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata.anonymous.sampled_model_name", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.metadata", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3851", "kind": "property", "name": "sub_rewards", "type": { "$id": "3852", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.sub_rewards", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "3853", "kind": "property", "name": "model_grader_token_usage_per_model", "type": { "$id": "3854", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunGraderResponse.model_grader_token_usage_per_model", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$ref": "3803" }, { "$ref": "3809" }, { "$id": "3855", "kind": "model", "name": "ValidateGraderRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ValidateGraderRequest", "usage": "Json", "decorators": [], "properties": [ { "$id": "3856", "kind": "property", "name": "grader", "serializedName": "grader", "doc": "The grader used for the fine-tuning job.", "type": { "$id": "3857", "kind": "union", "name": "ValidateGraderRequestGrader", "variantTypes": [ { "$ref": "3529" }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$ref": "3593" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ValidateGraderRequest.grader", "serializationOptions": { "json": { "name": "grader" } }, "isHttpMetadata": false } ] }, { "$id": "3858", "kind": "model", "name": "ValidateGraderResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ValidateGraderResponse", "usage": "Output", "decorators": [], "properties": [ { "$id": "3859", "kind": "property", "name": "grader", "doc": "The grader used for the fine-tuning job.", "type": { "$id": "3860", "kind": "union", "name": "ValidateGraderResponseGrader", "variantTypes": [ { "$ref": "3529" }, { "$ref": "3532" }, { "$ref": "3550" }, { "$ref": "3559" }, { "$ref": "3593" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ValidateGraderResponse.grader", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "3861", "kind": "model", "name": "EvalList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalList", "usage": "Output,Json", "doc": "An object representing a list of evals.", "decorators": [], "properties": [ { "$id": "3862", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object. It is always set to \"list\".", "type": { "$ref": "1577" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3863", "kind": "property", "name": "data", "serializedName": "data", "doc": "An array of eval objects.", "type": { "$id": "3864", "kind": "array", "name": "ArrayEval", "valueType": { "$id": "3865", "kind": "model", "name": "Eval", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Eval", "usage": "Output,Json", "doc": "An Eval object with a data source config and testing criteria.\nAn Eval represents a task to be done for your LLM integration.\nLike:\n- Improve the quality of my chatbot\n- See how well my chatbot handles customer support\n- Check if o4-mini is better at my usecase than gpt-4o", "decorators": [], "properties": [ { "$id": "3866", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type.", "type": { "$ref": "1579" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "3867", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for the evaluation.", "type": { "$id": "3868", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "3869", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the evaluation.", "type": { "$id": "3870", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3871", "kind": "property", "name": "data_source_config", "serializedName": "data_source_config", "doc": "Configuration of data sources used in runs of the evaluation.", "type": { "$id": "3872", "kind": "model", "name": "EvalDataSourceConfigResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigResource", "usage": "Output,Json", "decorators": [], "discriminatorProperty": { "$id": "3873", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "387" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3873" } ], "discriminatedSubtypes": { "custom": { "$id": "3874", "kind": "model", "name": "EvalCustomDataSourceConfigResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigResource", "usage": "Output,Json", "doc": "A CustomDataSourceConfig which specifies the schema of your `item` and optionally `sample` namespaces.\nThe response schema defines the shape of the data that will be:\n- Used to define your testing criteria and\n- What data is required when creating a run", "discriminatorValue": "custom", "decorators": [], "baseModel": { "$ref": "3872" }, "properties": [ { "$id": "3875", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `custom`.", "type": { "$id": "3876", "kind": "enumvalue", "name": "custom", "value": "custom", "valueType": { "$ref": "388" }, "enumType": { "$id": "3877", "kind": "enum", "decorators": [], "name": "EvalDataSourceConfigType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "3878", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "3879", "kind": "enumvalue", "decorators": [], "name": "custom", "value": "custom", "valueType": { "$ref": "3878" }, "enumType": { "$ref": "3877" } }, { "$id": "3880", "kind": "enumvalue", "decorators": [], "name": "logs", "value": "logs", "valueType": { "$ref": "3878" }, "enumType": { "$ref": "3877" } }, { "$id": "3881", "kind": "enumvalue", "decorators": [], "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "3878" }, "enumType": { "$ref": "3877" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3882", "kind": "property", "name": "schema", "serializedName": "schema", "doc": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "type": { "$id": "3883", "kind": "dict", "keyType": { "$id": "3884", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "valueType": { "$id": "3885", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigResource.schema", "serializationOptions": { "json": { "name": "schema" } }, "isHttpMetadata": false } ] }, "stored_completions": { "$id": "3886", "kind": "model", "name": "EvalStoredCompletionsDataSourceConfigResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigResource", "usage": "Output,Json", "deprecation": "This field is marked as deprecated.", "doc": "Deprecated in favor of LogsDataSourceConfig.", "discriminatorValue": "stored_completions", "decorators": [], "baseModel": { "$ref": "3872" }, "properties": [ { "$id": "3887", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `stored_completions`.", "type": { "$id": "3888", "kind": "enumvalue", "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "388" }, "enumType": { "$ref": "3877" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3889", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigResource.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "3890", "kind": "property", "name": "schema", "serializedName": "schema", "doc": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "type": { "$ref": "3883" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigResource.schema", "serializationOptions": { "json": { "name": "schema" } }, "isHttpMetadata": false } ] }, "logs": { "$id": "3891", "kind": "model", "name": "EvalLogsDataSourceConfigResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigResource", "usage": "Output,Json", "doc": "A LogsDataSourceConfig which specifies the metadata property of your logs query.\nThis is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.\nThe schema returned by this data source config is used to defined what variables are available in your evals.\n`item` and `sample` are both defined when using this data source config.", "discriminatorValue": "logs", "decorators": [], "baseModel": { "$ref": "3872" }, "properties": [ { "$id": "3892", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `logs`.", "type": { "$id": "3893", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "388" }, "enumType": { "$ref": "3877" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3894", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigResource.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "3895", "kind": "property", "name": "schema", "serializedName": "schema", "doc": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/).", "type": { "$ref": "3883" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigResource.schema", "serializationOptions": { "json": { "name": "schema" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.data_source_config", "serializationOptions": { "json": { "name": "data_source_config" } }, "isHttpMetadata": false }, { "$id": "3896", "kind": "property", "name": "testing_criteria", "serializedName": "testing_criteria", "doc": "A list of testing criteria.", "type": { "$id": "3897", "kind": "nullable", "type": { "$id": "3898", "kind": "array", "name": "ArrayEvalGraderResource", "valueType": { "$id": "3899", "kind": "model", "name": "EvalGraderResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderResource", "usage": "Output,Json", "decorators": [], "discriminatorProperty": { "$id": "3900", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "327" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3900" } ], "discriminatedSubtypes": { "label_model": { "$id": "3901", "kind": "model", "name": "EvalGraderLabelModelResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource", "usage": "Output,Json", "discriminatorValue": "label_model", "decorators": [], "baseModel": { "$ref": "3899" }, "properties": [ { "$id": "3902", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `label_model`.", "type": { "$ref": "3602" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3903", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3904", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3905", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation. Must support structured outputs.", "type": { "$id": "3906", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3907", "kind": "property", "name": "input", "serializedName": "input", "type": { "$ref": "3569" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3908", "kind": "property", "name": "labels", "serializedName": "labels", "doc": "The labels to assign to each item in the evaluation.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.labels", "serializationOptions": { "json": { "name": "labels" } }, "isHttpMetadata": false }, { "$id": "3909", "kind": "property", "name": "passing_labels", "serializedName": "passing_labels", "doc": "The labels that indicate a passing result. Must be a subset of labels.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelResource.passing_labels", "serializationOptions": { "json": { "name": "passing_labels" } }, "isHttpMetadata": false } ] }, "text_similarity": { "$id": "3910", "kind": "model", "name": "EvalGraderTextSimilarityResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource", "usage": "Output,Json", "discriminatorValue": "text_similarity", "decorators": [], "baseModel": { "$ref": "3899" }, "properties": [ { "$id": "3911", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of grader.", "type": { "$ref": "3534" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3912", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3913", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3914", "kind": "property", "name": "input", "serializedName": "input", "doc": "The text being graded.", "type": { "$id": "3915", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3916", "kind": "property", "name": "reference", "serializedName": "reference", "doc": "The text being graded against.", "type": { "$id": "3917", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.reference", "serializationOptions": { "json": { "name": "reference" } }, "isHttpMetadata": false }, { "$id": "3918", "kind": "property", "name": "evaluation_metric", "serializedName": "evaluation_metric", "doc": "The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.", "type": { "$ref": "335" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.evaluation_metric", "serializationOptions": { "json": { "name": "evaluation_metric" } }, "isHttpMetadata": false }, { "$id": "3919", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "3920", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityResource.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] }, "python": { "$id": "3921", "kind": "model", "name": "EvalGraderPythonResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource", "usage": "Output,Json", "discriminatorValue": "python", "decorators": [], "baseModel": { "$ref": "3899" }, "properties": [ { "$id": "3922", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `python`.", "type": { "$ref": "3552" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3923", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3924", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3925", "kind": "property", "name": "source", "serializedName": "source", "doc": "The source code of the python script.", "type": { "$id": "3926", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false }, { "$id": "3927", "kind": "property", "name": "image_tag", "serializedName": "image_tag", "doc": "The image tag to use for the python script.", "type": { "$id": "3928", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource.image_tag", "serializationOptions": { "json": { "name": "image_tag" } }, "isHttpMetadata": false }, { "$id": "3929", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "3930", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonResource.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] }, "score_model": { "$id": "3931", "kind": "model", "name": "EvalGraderScoreModelResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource", "usage": "Output,Json", "discriminatorValue": "score_model", "decorators": [], "baseModel": { "$ref": "3899" }, "properties": [ { "$id": "3932", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `score_model`.", "type": { "$ref": "3561" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3933", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3934", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3935", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation.", "type": { "$id": "3936", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3937", "kind": "property", "name": "sampling_params", "serializedName": "sampling_params", "doc": "The sampling parameters for the model.", "type": { "$id": "3938", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.sampling_params", "serializationOptions": { "json": { "name": "sampling_params" } }, "isHttpMetadata": false }, { "$id": "3939", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input text. This may include template strings.", "type": { "$ref": "3569" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3940", "kind": "property", "name": "range", "serializedName": "range", "doc": "The range of the score. Defaults to `[0, 1]`.", "type": { "$ref": "2627" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.range", "serializationOptions": { "json": { "name": "range" } }, "isHttpMetadata": false }, { "$id": "3941", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "3942", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelResource.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.testing_criteria", "serializationOptions": { "json": { "name": "testing_criteria" } }, "isHttpMetadata": false }, { "$id": "3943", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the eval was created.", "type": { "$id": "3944", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "3945", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "3946", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Eval.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "3947", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The identifier of the first eval in the data array.", "type": { "$id": "3948", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "3949", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The identifier of the last eval in the data array.", "type": { "$id": "3950", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "3951", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates whether there are more evals available.", "type": { "$id": "3952", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "3865" }, { "$ref": "3872" }, { "$ref": "3874" }, { "$ref": "3886" }, { "$ref": "3891" }, { "$ref": "3899" }, { "$ref": "3901" }, { "$ref": "3910" }, { "$ref": "3921" }, { "$ref": "3931" }, { "$id": "3953", "kind": "model", "name": "CreateEvalRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateEvalRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3954", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the evaluation.", "type": { "$id": "3955", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3956", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "3957", "kind": "property", "name": "data_source_config", "serializedName": "data_source_config", "doc": "The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.", "type": { "$id": "3958", "kind": "model", "name": "EvalDataSourceConfigParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigParams", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "3959", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "387" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalDataSourceConfigParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3959" } ], "discriminatedSubtypes": { "custom": { "$id": "3960", "kind": "model", "name": "EvalCustomDataSourceConfigParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigParams", "usage": "Input,Json", "doc": "A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs.\nThis schema is used to define the shape of the data that will be:\n- Used to define your testing criteria and\n- What data is required when creating a run", "discriminatorValue": "custom", "decorators": [], "baseModel": { "$ref": "3958" }, "properties": [ { "$id": "3961", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `custom`.", "type": { "$ref": "3876" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3962", "kind": "property", "name": "item_schema", "serializedName": "item_schema", "doc": "The json schema for each row in the data source.", "type": { "$ref": "3883" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigParams.item_schema", "serializationOptions": { "json": { "name": "item_schema" } }, "isHttpMetadata": false }, { "$id": "3963", "kind": "property", "name": "include_sample_schema", "serializedName": "include_sample_schema", "doc": "Whether the eval should expect you to populate the sample namespace (ie, by generating responses off of your data source)", "type": { "$id": "3964", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCustomDataSourceConfigParams.include_sample_schema", "serializationOptions": { "json": { "name": "include_sample_schema" } }, "isHttpMetadata": false } ] }, "logs": { "$id": "3965", "kind": "model", "name": "EvalLogsDataSourceConfigParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigParams", "usage": "Input,Json", "doc": "A data source config which specifies the metadata property of your logs query.\nThis is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.", "discriminatorValue": "logs", "decorators": [], "baseModel": { "$ref": "3958" }, "properties": [ { "$id": "3966", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `logs`.", "type": { "$ref": "3893" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3967", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalLogsDataSourceConfigParams.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "stored_completions": { "$id": "3968", "kind": "model", "name": "EvalStoredCompletionsDataSourceConfigParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigParams", "usage": "Input,Json", "deprecation": "This field is marked as deprecated.", "doc": "Deprecated in favor of LogsDataSourceConfig.", "discriminatorValue": "stored_completions", "decorators": [], "baseModel": { "$ref": "3958" }, "properties": [ { "$id": "3969", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `stored_completions`.", "type": { "$ref": "3888" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3970", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Metadata filters for the stored completions data source.", "type": { "$ref": "3883" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalStoredCompletionsDataSourceConfigParams.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRequest.data_source_config", "serializationOptions": { "json": { "name": "data_source_config" } }, "isHttpMetadata": false }, { "$id": "3971", "kind": "property", "name": "testing_criteria", "serializedName": "testing_criteria", "doc": "A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`).", "type": { "$id": "3972", "kind": "array", "name": "ArrayEvalGraderParams", "valueType": { "$id": "3973", "kind": "model", "name": "EvalGraderParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderParams", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "3974", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "327" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "3974" } ], "discriminatedSubtypes": { "label_model": { "$id": "3975", "kind": "model", "name": "EvalGraderLabelModelParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams", "usage": "Input,Json", "doc": "A LabelModelGrader object which uses a model to assign labels to each item\nin the evaluation.", "discriminatorValue": "label_model", "decorators": [], "baseModel": { "$ref": "3973" }, "properties": [ { "$id": "3976", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `label_model`.", "type": { "$ref": "3602" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3977", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3978", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3979", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation. Must support structured outputs.", "type": { "$id": "3980", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "3981", "kind": "property", "name": "input", "serializedName": "input", "doc": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.", "type": { "$id": "3982", "kind": "array", "name": "ArrayCreateEvalItem", "valueType": { "$id": "3983", "kind": "union", "name": "CreateEvalItem", "variantTypes": [ { "$id": "3984", "kind": "model", "name": "EvalGraderLabelModelParamsInput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.input.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "3985", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message (e.g. \"system\", \"assistant\", \"user\").", "type": { "$id": "3986", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.input.anonymous.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "3987", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message.", "type": { "$id": "3988", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.input.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, { "$ref": "3570" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3989", "kind": "property", "name": "labels", "serializedName": "labels", "doc": "The labels to classify to each item in the evaluation.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.labels", "serializationOptions": { "json": { "name": "labels" } }, "isHttpMetadata": false }, { "$id": "3990", "kind": "property", "name": "passing_labels", "serializedName": "passing_labels", "doc": "The labels that indicate a passing result. Must be a subset of labels.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderLabelModelParams.passing_labels", "serializationOptions": { "json": { "name": "passing_labels" } }, "isHttpMetadata": false } ] }, "string_check": { "$id": "3991", "kind": "model", "name": "EvalGraderStringCheckParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams", "usage": "Input,Json", "discriminatorValue": "string_check", "decorators": [], "baseModel": { "$ref": "3973" }, "properties": [ { "$id": "3992", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `string_check`.", "type": { "$ref": "3613" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "3993", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "3994", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "3995", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input text. This may include template strings.", "type": { "$id": "3996", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "3997", "kind": "property", "name": "reference", "serializedName": "reference", "doc": "The reference text. This may include template strings.", "type": { "$id": "3998", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams.reference", "serializationOptions": { "json": { "name": "reference" } }, "isHttpMetadata": false }, { "$id": "3999", "kind": "property", "name": "operation", "serializedName": "operation", "doc": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.", "type": { "$ref": "321" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderStringCheckParams.operation", "serializationOptions": { "json": { "name": "operation" } }, "isHttpMetadata": false } ] }, "text_similarity": { "$id": "4000", "kind": "model", "name": "EvalGraderTextSimilarityParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams", "usage": "Input,Json", "discriminatorValue": "text_similarity", "decorators": [], "baseModel": { "$ref": "3973" }, "properties": [ { "$id": "4001", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of grader.", "type": { "$ref": "3534" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4002", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "4003", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4004", "kind": "property", "name": "input", "serializedName": "input", "doc": "The text being graded.", "type": { "$id": "4005", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "4006", "kind": "property", "name": "reference", "serializedName": "reference", "doc": "The text being graded against.", "type": { "$id": "4007", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.reference", "serializationOptions": { "json": { "name": "reference" } }, "isHttpMetadata": false }, { "$id": "4008", "kind": "property", "name": "evaluation_metric", "serializedName": "evaluation_metric", "doc": "The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.", "type": { "$ref": "335" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.evaluation_metric", "serializationOptions": { "json": { "name": "evaluation_metric" } }, "isHttpMetadata": false }, { "$id": "4009", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "4010", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderTextSimilarityParams.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] }, "python": { "$id": "4011", "kind": "model", "name": "EvalGraderPythonParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams", "usage": "Input,Json", "discriminatorValue": "python", "decorators": [], "baseModel": { "$ref": "3973" }, "properties": [ { "$id": "4012", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `python`.", "type": { "$ref": "3552" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4013", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "4014", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4015", "kind": "property", "name": "source", "serializedName": "source", "doc": "The source code of the python script.", "type": { "$id": "4016", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false }, { "$id": "4017", "kind": "property", "name": "image_tag", "serializedName": "image_tag", "doc": "The image tag to use for the python script.", "type": { "$id": "4018", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams.image_tag", "serializationOptions": { "json": { "name": "image_tag" } }, "isHttpMetadata": false }, { "$id": "4019", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "4020", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderPythonParams.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] }, "score_model": { "$id": "4021", "kind": "model", "name": "EvalGraderScoreModelParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams", "usage": "Input,Json", "discriminatorValue": "score_model", "decorators": [], "baseModel": { "$ref": "3973" }, "properties": [ { "$id": "4022", "kind": "property", "name": "type", "serializedName": "type", "doc": "The object type, which is always `score_model`.", "type": { "$ref": "3561" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4023", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the grader.", "type": { "$id": "4024", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4025", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for the evaluation.", "type": { "$id": "4026", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4027", "kind": "property", "name": "sampling_params", "serializedName": "sampling_params", "doc": "The sampling parameters for the model.", "type": { "$id": "4028", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.sampling_params", "serializationOptions": { "json": { "name": "sampling_params" } }, "isHttpMetadata": false }, { "$id": "4029", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input text. This may include template strings.", "type": { "$ref": "3569" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "4030", "kind": "property", "name": "range", "serializedName": "range", "doc": "The range of the score. Defaults to `[0, 1]`.", "type": { "$ref": "2627" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.range", "serializationOptions": { "json": { "name": "range" } }, "isHttpMetadata": false }, { "$id": "4031", "kind": "property", "name": "pass_threshold", "serializedName": "pass_threshold", "doc": "The threshold for the score.", "type": { "$id": "4032", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalGraderScoreModelParams.pass_threshold", "serializationOptions": { "json": { "name": "pass_threshold" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRequest.testing_criteria", "serializationOptions": { "json": { "name": "testing_criteria" } }, "isHttpMetadata": false } ] }, { "$ref": "3958" }, { "$ref": "3960" }, { "$ref": "3965" }, { "$ref": "3968" }, { "$ref": "3973" }, { "$ref": "3975" }, { "$ref": "3984" }, { "$ref": "3991" }, { "$ref": "4000" }, { "$ref": "4011" }, { "$ref": "4021" }, { "$id": "4033", "kind": "model", "name": "UpdateEvalRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.updateEval.Request.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4034", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "4035", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.updateEval.Request.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4036", "kind": "property", "name": "metadata", "serializedName": "metadata", "type": { "$id": "4037", "kind": "model", "name": "MetadataPropertyForRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MetadataPropertyForRequest", "usage": "Input,Json", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "decorators": [], "properties": [ { "$id": "4038", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MetadataPropertyForRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.updateEval.Request.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "4037" }, { "$id": "4039", "kind": "model", "name": "DeleteEvalResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.deleteEval.Response.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4040", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1581" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEval.Response.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4041", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "4042", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEval.Response.anonymous.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "4043", "kind": "property", "name": "eval_id", "serializedName": "eval_id", "type": { "$id": "4044", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEval.Response.anonymous.eval_id", "serializationOptions": { "json": { "name": "eval_id" } }, "isHttpMetadata": false } ] }, { "$id": "4045", "kind": "model", "name": "EvalRunList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunList", "usage": "Output,Json", "doc": "An object representing a list of runs for an evaluation.", "decorators": [], "properties": [ { "$id": "4046", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object. It is always set to \"list\".", "type": { "$ref": "1583" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4047", "kind": "property", "name": "data", "serializedName": "data", "doc": "An array of eval run objects.", "type": { "$id": "4048", "kind": "array", "name": "ArrayEvalRun", "valueType": { "$id": "4049", "kind": "model", "name": "EvalRun", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRun", "usage": "Output,Json", "doc": "A schema representing an evaluation run.", "decorators": [], "properties": [ { "$id": "4050", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of the object. Always \"eval.run\".", "type": { "$ref": "1585" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4051", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for the evaluation run.", "type": { "$id": "4052", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "4053", "kind": "property", "name": "eval_id", "serializedName": "eval_id", "doc": "The identifier of the associated evaluation.", "type": { "$id": "4054", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.eval_id", "serializationOptions": { "json": { "name": "eval_id" } }, "isHttpMetadata": false }, { "$id": "4055", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the evaluation run.", "type": { "$id": "4056", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "4057", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model that is evaluated, if applicable.", "type": { "$id": "4058", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4059", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the evaluation run.", "type": { "$id": "4060", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4061", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "Unix timestamp (in seconds) when the evaluation run was created.", "type": { "$id": "4062", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "4063", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "4064", "kind": "property", "name": "report_url", "serializedName": "report_url", "doc": "The URL to the rendered evaluation run report on the UI dashboard.", "type": { "$id": "4065", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.report_url", "serializationOptions": { "json": { "name": "report_url" } }, "isHttpMetadata": false }, { "$id": "4066", "kind": "property", "name": "result_counts", "serializedName": "result_counts", "doc": "Counters summarizing the outcomes of the evaluation run.", "type": { "$id": "4067", "kind": "model", "name": "EvalRunResultCounts", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4068", "kind": "property", "name": "total", "serializedName": "total", "doc": "Total number of executed output items.", "type": { "$id": "4069", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts.anonymous.total", "serializationOptions": { "json": { "name": "total" } }, "isHttpMetadata": false }, { "$id": "4070", "kind": "property", "name": "errored", "serializedName": "errored", "doc": "Number of output items that resulted in an error.", "type": { "$id": "4071", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts.anonymous.errored", "serializationOptions": { "json": { "name": "errored" } }, "isHttpMetadata": false }, { "$id": "4072", "kind": "property", "name": "failed", "serializedName": "failed", "doc": "Number of output items that failed to pass the evaluation.", "type": { "$id": "4073", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts.anonymous.failed", "serializationOptions": { "json": { "name": "failed" } }, "isHttpMetadata": false }, { "$id": "4074", "kind": "property", "name": "passed", "serializedName": "passed", "doc": "Number of output items that passed the evaluation.", "type": { "$id": "4075", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts.anonymous.passed", "serializationOptions": { "json": { "name": "passed" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.result_counts", "serializationOptions": { "json": { "name": "result_counts" } }, "isHttpMetadata": false }, { "$id": "4076", "kind": "property", "name": "per_model_usage", "serializedName": "per_model_usage", "doc": "Usage statistics for each model during the evaluation run.", "type": { "$id": "4077", "kind": "array", "name": "Array15", "valueType": { "$id": "4078", "kind": "model", "name": "EvalRunPerModelUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4079", "kind": "property", "name": "model_name", "serializedName": "model_name", "doc": "The name of the model.", "type": { "$id": "4080", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.model_name", "serializationOptions": { "json": { "name": "model_name" } }, "isHttpMetadata": false }, { "$id": "4081", "kind": "property", "name": "invocation_count", "serializedName": "invocation_count", "doc": "The number of invocations.", "type": { "$id": "4082", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.invocation_count", "serializationOptions": { "json": { "name": "invocation_count" } }, "isHttpMetadata": false }, { "$id": "4083", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "The number of prompt tokens used.", "type": { "$id": "4084", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "4085", "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", "doc": "The number of completion tokens generated.", "type": { "$id": "4086", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.completion_tokens", "serializationOptions": { "json": { "name": "completion_tokens" } }, "isHttpMetadata": false }, { "$id": "4087", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens used.", "type": { "$id": "4088", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false }, { "$id": "4089", "kind": "property", "name": "cached_tokens", "serializedName": "cached_tokens", "doc": "The number of tokens retrieved from cache.", "type": { "$id": "4090", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage.anonymous.cached_tokens", "serializationOptions": { "json": { "name": "cached_tokens" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_model_usage", "serializationOptions": { "json": { "name": "per_model_usage" } }, "isHttpMetadata": false }, { "$id": "4091", "kind": "property", "name": "per_testing_criteria_results", "serializedName": "per_testing_criteria_results", "doc": "Results per testing criteria applied during the evaluation run.", "type": { "$id": "4092", "kind": "array", "name": "Array16", "valueType": { "$id": "4093", "kind": "model", "name": "EvalRunPerTestingCriteriaResult", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRun.per_testing_criteria_result.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4094", "kind": "property", "name": "testing_criteria", "serializedName": "testing_criteria", "doc": "A description of the testing criteria.", "type": { "$id": "4095", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_testing_criteria_result.anonymous.testing_criteria", "serializationOptions": { "json": { "name": "testing_criteria" } }, "isHttpMetadata": false }, { "$id": "4096", "kind": "property", "name": "passed", "serializedName": "passed", "doc": "Number of tests passed for this criteria.", "type": { "$id": "4097", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_testing_criteria_result.anonymous.passed", "serializationOptions": { "json": { "name": "passed" } }, "isHttpMetadata": false }, { "$id": "4098", "kind": "property", "name": "failed", "serializedName": "failed", "doc": "Number of tests failed for this criteria.", "type": { "$id": "4099", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_testing_criteria_result.anonymous.failed", "serializationOptions": { "json": { "name": "failed" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.per_testing_criteria_results", "serializationOptions": { "json": { "name": "per_testing_criteria_results" } }, "isHttpMetadata": false }, { "$id": "4100", "kind": "property", "name": "data_source", "serializedName": "data_source", "doc": "Information about the run's data source.", "type": { "$id": "4101", "kind": "model", "name": "EvalRunDataSourceResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceResource", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4102", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "392" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.data_source", "serializationOptions": { "json": { "name": "data_source" } }, "isHttpMetadata": false }, { "$id": "4103", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "4104", "kind": "property", "name": "error", "serializedName": "error", "type": { "$id": "4105", "kind": "model", "name": "EvalApiError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalApiError", "usage": "Output,Json", "doc": "An object representing an error response from the Eval API.", "decorators": [], "properties": [ { "$id": "4106", "kind": "property", "name": "code", "serializedName": "code", "doc": "The error code.", "type": { "$id": "4107", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalApiError.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "4108", "kind": "property", "name": "message", "serializedName": "message", "doc": "The error message.", "type": { "$id": "4109", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalApiError.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRun.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "4110", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The identifier of the first eval run in the data array.", "type": { "$id": "4111", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "4112", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The identifier of the last eval run in the data array.", "type": { "$id": "4113", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "4114", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates whether there are more evals available.", "type": { "$id": "4115", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "4049" }, { "$ref": "4067" }, { "$ref": "4078" }, { "$ref": "4093" }, { "$ref": "4101" }, { "$ref": "4105" }, { "$id": "4116", "kind": "model", "name": "CreateEvalRunRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateEvalRunRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4117", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the run.", "type": { "$id": "4118", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRunRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4119", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRunRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "4120", "kind": "property", "name": "data_source", "serializedName": "data_source", "doc": "Details about the run's data source.", "type": { "$id": "4121", "kind": "model", "name": "EvalRunDataSourceParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceParams", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "4122", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "392" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4122" } ], "discriminatedSubtypes": { "jsonl": { "$id": "4123", "kind": "model", "name": "EvalJsonlRunDataSourceParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalJsonlRunDataSourceParams", "usage": "Input,Json", "doc": "A JsonlRunDataSource object with that specifies a JSONL file that matches the eval", "discriminatorValue": "jsonl", "decorators": [], "baseModel": { "$ref": "4121" }, "properties": [ { "$id": "4124", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of data source. Always `jsonl`.", "type": { "$id": "4125", "kind": "enumvalue", "name": "jsonl", "value": "jsonl", "valueType": { "$ref": "393" }, "enumType": { "$id": "4126", "kind": "enum", "decorators": [], "name": "EvalRunDataSourceType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4127", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4128", "kind": "enumvalue", "decorators": [], "name": "jsonl", "value": "jsonl", "valueType": { "$ref": "4127" }, "enumType": { "$ref": "4126" } }, { "$id": "4129", "kind": "enumvalue", "decorators": [], "name": "completions", "value": "completions", "valueType": { "$ref": "4127" }, "enumType": { "$ref": "4126" } }, { "$id": "4130", "kind": "enumvalue", "decorators": [], "name": "responses", "value": "responses", "valueType": { "$ref": "4127" }, "enumType": { "$ref": "4126" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.EvalRunDataSourceType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalJsonlRunDataSourceParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4131", "kind": "property", "name": "source", "serializedName": "source", "doc": "Determines what populates the `item` namespace in the data source.", "type": { "$id": "4132", "kind": "union", "name": "EvalJsonlRunDataSourceParamsSource", "variantTypes": [ { "$id": "4133", "kind": "model", "name": "EvalRunFileContentDataContentSource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource", "usage": "Input,Json", "discriminatorValue": "file_content", "decorators": [], "baseModel": { "$id": "4134", "kind": "model", "name": "EvalRunDataContentSource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunDataContentSource", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "4135", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "397" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunDataContentSource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4135" } ], "discriminatedSubtypes": { "file_content": { "$ref": "4133" }, "file_id": { "$id": "4136", "kind": "model", "name": "EvalRunFileIdDataContentSource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunFileIdDataContentSource", "usage": "Input,Json", "discriminatorValue": "file_id", "decorators": [], "baseModel": { "$ref": "4134" }, "properties": [ { "$id": "4137", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of jsonl source. Always `file_id`.", "type": { "$id": "4138", "kind": "enumvalue", "name": "file_id", "value": "file_id", "valueType": { "$ref": "398" }, "enumType": { "$id": "4139", "kind": "enum", "decorators": [], "name": "EvalRunDataContentSourceType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4140", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4141", "kind": "enumvalue", "decorators": [], "name": "file_id", "value": "file_id", "valueType": { "$ref": "4140" }, "enumType": { "$ref": "4139" } }, { "$id": "4142", "kind": "enumvalue", "decorators": [], "name": "file_content", "value": "file_content", "valueType": { "$ref": "4140" }, "enumType": { "$ref": "4139" } }, { "$id": "4143", "kind": "enumvalue", "decorators": [], "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "4140" }, "enumType": { "$ref": "4139" } }, { "$id": "4144", "kind": "enumvalue", "decorators": [], "name": "responses", "value": "responses", "valueType": { "$ref": "4140" }, "enumType": { "$ref": "4139" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.EvalRunDataContentSourceType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileIdDataContentSource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4145", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier of the file.", "type": { "$id": "4146", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileIdDataContentSource.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ] }, "stored_completions": { "$id": "4147", "kind": "model", "name": "EvalRunStoredCompletionsDataContentSource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource", "usage": "Input,Json", "doc": "A StoredCompletionsRunDataSource configuration describing a set of filters", "discriminatorValue": "stored_completions", "decorators": [], "baseModel": { "$ref": "4134" }, "properties": [ { "$id": "4148", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of source. Always `stored_completions`.", "type": { "$id": "4149", "kind": "enumvalue", "name": "stored_completions", "value": "stored_completions", "valueType": { "$ref": "398" }, "enumType": { "$ref": "4139" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4150", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "4151", "kind": "property", "name": "model", "serializedName": "model", "doc": "An optional model to filter by (e.g., 'gpt-4o').", "type": { "$id": "4152", "kind": "nullable", "type": { "$id": "4153", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4154", "kind": "property", "name": "created_after", "serializedName": "created_after", "doc": "An optional Unix timestamp to filter items created after this time.", "type": { "$id": "4155", "kind": "nullable", "type": { "$id": "4156", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.created_after", "serializationOptions": { "json": { "name": "created_after" } }, "isHttpMetadata": false }, { "$id": "4157", "kind": "property", "name": "created_before", "serializedName": "created_before", "doc": "An optional Unix timestamp to filter items created before this time.", "type": { "$id": "4158", "kind": "nullable", "type": { "$id": "4159", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.created_before", "serializationOptions": { "json": { "name": "created_before" } }, "isHttpMetadata": false }, { "$id": "4160", "kind": "property", "name": "limit", "serializedName": "limit", "doc": "An optional maximum number of items to return.", "type": { "$id": "4161", "kind": "nullable", "type": { "$id": "4162", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunStoredCompletionsDataContentSource.limit", "serializationOptions": { "json": { "name": "limit" } }, "isHttpMetadata": false } ] }, "responses": { "$id": "4163", "kind": "model", "name": "EvalRunResponsesDataContentSource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource", "usage": "Input,Json", "doc": "A EvalResponsesSource object describing a run data source configuration.", "discriminatorValue": "responses", "decorators": [], "baseModel": { "$ref": "4134" }, "properties": [ { "$id": "4164", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of run data source. Always `responses`.", "type": { "$id": "4165", "kind": "enumvalue", "name": "responses", "value": "responses", "valueType": { "$ref": "398" }, "enumType": { "$ref": "4139" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4166", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "4167", "kind": "property", "name": "model", "serializedName": "model", "doc": "The name of the model to find responses for. This is a query parameter used to select responses.", "type": { "$id": "4168", "kind": "nullable", "type": { "$id": "4169", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4170", "kind": "property", "name": "instructions_search", "serializedName": "instructions_search", "doc": "Optional string to search the 'instructions' field. This is a query parameter used to select responses.", "type": { "$id": "4171", "kind": "nullable", "type": { "$id": "4172", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.instructions_search", "serializationOptions": { "json": { "name": "instructions_search" } }, "isHttpMetadata": false }, { "$id": "4173", "kind": "property", "name": "created_after", "serializedName": "created_after", "doc": "Only include items created after this timestamp (inclusive). This is a query parameter used to select responses.", "type": { "$id": "4174", "kind": "nullable", "type": { "$id": "4175", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.created_after", "serializationOptions": { "json": { "name": "created_after" } }, "isHttpMetadata": false }, { "$id": "4176", "kind": "property", "name": "created_before", "serializedName": "created_before", "doc": "Only include items created before this timestamp (inclusive). This is a query parameter used to select responses.", "type": { "$id": "4177", "kind": "nullable", "type": { "$id": "4178", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.created_before", "serializationOptions": { "json": { "name": "created_before" } }, "isHttpMetadata": false }, { "$id": "4179", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "doc": "Optional reasoning effort parameter. This is a query parameter used to select responses.", "type": { "$id": "4180", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "4181", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Sampling temperature. This is a query parameter used to select responses.", "type": { "$id": "4182", "kind": "nullable", "type": { "$id": "4183", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "4184", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "Nucleus sampling parameter. This is a query parameter used to select responses.", "type": { "$id": "4185", "kind": "nullable", "type": { "$id": "4186", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "4187", "kind": "property", "name": "users", "serializedName": "users", "doc": "List of user identifiers. This is a query parameter used to select responses.", "type": { "$id": "4188", "kind": "nullable", "type": { "$ref": "2373" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.users", "serializationOptions": { "json": { "name": "users" } }, "isHttpMetadata": false }, { "$id": "4189", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "List of tool names. This is a query parameter used to select responses.", "type": { "$id": "4190", "kind": "nullable", "type": { "$ref": "2373" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunResponsesDataContentSource.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false } ] } } }, "properties": [ { "$id": "4191", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of jsonl source. Always `file_content`.", "type": { "$id": "4192", "kind": "enumvalue", "name": "file_content", "value": "file_content", "valueType": { "$ref": "398" }, "enumType": { "$ref": "4139" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4193", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the jsonl file.", "type": { "$id": "4194", "kind": "array", "name": "Array17", "valueType": { "$id": "4195", "kind": "model", "name": "EvalRunFileContentDataContentSourceContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource.content.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4196", "kind": "property", "name": "item", "serializedName": "item", "type": { "$ref": "3883" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource.content.anonymous.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false }, { "$id": "4197", "kind": "property", "name": "sample", "serializedName": "sample", "type": { "$ref": "3883" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource.content.anonymous.sample", "serializationOptions": { "json": { "name": "sample" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunFileContentDataContentSource.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, { "$ref": "4136" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalJsonlRunDataSourceParams.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false } ] }, "completions": { "$id": "4198", "kind": "model", "name": "EvalCompletionsRunDataSourceParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams", "usage": "Input,Json", "doc": "A CompletionsRunDataSource object describing a model sampling configuration.", "discriminatorValue": "completions", "decorators": [], "baseModel": { "$ref": "4121" }, "properties": [ { "$id": "4199", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of run data source. Always `completions`.", "type": { "$id": "4200", "kind": "enumvalue", "name": "completions", "value": "completions", "valueType": { "$ref": "393" }, "enumType": { "$ref": "4126" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4201", "kind": "property", "name": "input_messages", "serializedName": "input_messages", "doc": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace.", "type": { "$id": "4202", "kind": "union", "name": "EvalCompletionsRunDataSourceParamsInputMessages", "variantTypes": [ { "$id": "4203", "kind": "model", "name": "EvalCompletionsRunDataSourceParamsInputMessages1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4204", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of input messages. Always `template`.", "type": { "$ref": "1587" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4205", "kind": "property", "name": "template", "serializedName": "template", "doc": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.", "type": { "$id": "4206", "kind": "array", "name": "Array18", "valueType": { "$id": "4207", "kind": "union", "name": "EvalCompletionsRunDataSourceParamsInputMessagesTemplate", "variantTypes": [ { "$id": "4208", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, { "$ref": "3570" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous.template", "serializationOptions": { "json": { "name": "template" } }, "isHttpMetadata": false } ] }, { "$id": "4209", "kind": "model", "name": "EvalCompletionsRunDataSourceParamsInputMessages2", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4210", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of input messages. Always `item_reference`.", "type": { "$ref": "1589" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4211", "kind": "property", "name": "item_reference", "serializedName": "item_reference", "doc": "A reference to a variable in the `item` namespace. Ie, \"item.input_trajectory\"", "type": { "$id": "4212", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages.anonymous.item_reference", "serializationOptions": { "json": { "name": "item_reference" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.input_messages", "serializationOptions": { "json": { "name": "input_messages" } }, "isHttpMetadata": false }, { "$id": "4213", "kind": "property", "name": "sampling_params", "serializedName": "sampling_params", "type": { "$id": "4214", "kind": "model", "name": "EvalCompletionsRunDataSourceParamsSamplingParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4215", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "A higher temperature increases randomness in the outputs.", "type": { "$id": "4216", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "4217", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of tokens in the generated output.", "type": { "$id": "4218", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "4219", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens.", "type": { "$id": "4220", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "4221", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "A seed value to initialize the randomness, during sampling.", "type": { "$id": "4222", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "4223", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.", "type": { "$id": "4224", "kind": "model", "name": "ResponseTextFormatConfiguration", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfiguration", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4225", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "403" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfiguration.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4225" } ], "discriminatedSubtypes": { "text": { "$id": "4226", "kind": "model", "name": "ResponseTextFormatConfigurationText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationText", "usage": "Input,Output,Json", "discriminatorValue": "text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4224" }, "properties": [ { "$id": "4227", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4228", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "404" }, "enumType": { "$id": "4229", "kind": "enum", "decorators": [], "doc": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.", "name": "ResponseTextFormatConfigurationType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4230", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4231", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "valueType": { "$ref": "4230" }, "enumType": { "$ref": "4229" } }, { "$id": "4232", "kind": "enumvalue", "decorators": [], "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "4230" }, "enumType": { "$ref": "4229" } }, { "$id": "4233", "kind": "enumvalue", "decorators": [], "name": "json_object", "value": "json_object", "valueType": { "$ref": "4230" }, "enumType": { "$ref": "4229" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "json_object": { "$id": "4234", "kind": "model", "name": "ResponseTextFormatConfigurationJsonObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonObject", "usage": "Input,Output,Json", "discriminatorValue": "json_object", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4224" }, "properties": [ { "$id": "4235", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4236", "kind": "enumvalue", "name": "json_object", "value": "json_object", "valueType": { "$ref": "404" }, "enumType": { "$ref": "4229" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "json_schema": { "$id": "4237", "kind": "model", "name": "ResponseTextFormatConfigurationJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema", "usage": "Input,Output,Json", "doc": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).", "discriminatorValue": "json_schema", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4224" }, "properties": [ { "$id": "4238", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of response format being defined. Always `json_schema`.", "type": { "$id": "4239", "kind": "enumvalue", "name": "json_schema", "value": "json_schema", "valueType": { "$ref": "404" }, "enumType": { "$ref": "4229" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4240", "kind": "property", "name": "description", "serializedName": "description", "doc": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.", "type": { "$id": "4241", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "4242", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.", "type": { "$id": "4243", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4244", "kind": "property", "name": "schema", "serializedName": "schema", "type": { "$ref": "2413" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema.schema", "serializationOptions": { "json": { "name": "schema" } }, "isHttpMetadata": false }, { "$id": "4245", "kind": "property", "name": "strict", "serializedName": "strict", "doc": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).", "type": { "$id": "4246", "kind": "nullable", "type": { "$id": "4247", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextFormatConfigurationJsonSchema.strict", "serializationOptions": { "json": { "name": "strict" } }, "isHttpMetadata": false } ] } } }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false }, { "$id": "4248", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.", "type": { "$ref": "3138" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params.anonymous.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.sampling_params", "serializationOptions": { "json": { "name": "sampling_params" } }, "isHttpMetadata": false }, { "$id": "4249", "kind": "property", "name": "model", "serializedName": "model", "doc": "The name of the model to use for generating completions (e.g. \"o3-mini\").", "type": { "$id": "4250", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4251", "kind": "property", "name": "source", "serializedName": "source", "doc": "Determines what populates the `item` namespace in this run's data source.", "type": { "$id": "4252", "kind": "union", "name": "EvalCompletionsRunDataSourceParamsSource", "variantTypes": [ { "$ref": "4133" }, { "$ref": "4136" }, { "$ref": "4147" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalCompletionsRunDataSourceParams.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false } ] }, "responses": { "$id": "4253", "kind": "model", "name": "EvalResponsesRunDataSourceParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams", "usage": "Input,Json", "doc": "A ResponsesRunDataSource object describing a model sampling configuration.", "discriminatorValue": "responses", "decorators": [], "baseModel": { "$ref": "4121" }, "properties": [ { "$id": "4254", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of run data source. Always `responses`.", "type": { "$id": "4255", "kind": "enumvalue", "name": "responses", "value": "responses", "valueType": { "$ref": "393" }, "enumType": { "$ref": "4126" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4256", "kind": "property", "name": "input_messages", "serializedName": "input_messages", "doc": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace.", "type": { "$id": "4257", "kind": "union", "name": "EvalResponsesRunDataSourceParamsInputMessages", "variantTypes": [ { "$id": "4258", "kind": "model", "name": "EvalResponsesRunDataSourceParamsInputMessages1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4259", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of input messages. Always `template`.", "type": { "$ref": "1591" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4260", "kind": "property", "name": "template", "serializedName": "template", "doc": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.", "type": { "$id": "4261", "kind": "array", "name": "Array19", "valueType": { "$id": "4262", "kind": "union", "name": "EvalResponsesRunDataSourceParamsInputMessagesTemplate", "variantTypes": [ { "$id": "4263", "kind": "model", "name": "EvalResponsesRunDataSourceParamsInputMessagesTemplate1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.template.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4264", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message (e.g. \"system\", \"assistant\", \"user\").", "type": { "$id": "4265", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.template.anonymous.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4266", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message.", "type": { "$id": "4267", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.template.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, { "$ref": "3570" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous.template", "serializationOptions": { "json": { "name": "template" } }, "isHttpMetadata": false } ] }, { "$id": "4268", "kind": "model", "name": "EvalResponsesRunDataSourceParamsInputMessages2", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4269", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of input messages. Always `item_reference`.", "type": { "$ref": "1593" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4270", "kind": "property", "name": "item_reference", "serializedName": "item_reference", "doc": "A reference to a variable in the `item` namespace. Ie, \"item.name\"", "type": { "$id": "4271", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages.anonymous.item_reference", "serializationOptions": { "json": { "name": "item_reference" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.input_messages", "serializationOptions": { "json": { "name": "input_messages" } }, "isHttpMetadata": false }, { "$id": "4272", "kind": "property", "name": "sampling_params", "serializedName": "sampling_params", "type": { "$id": "4273", "kind": "model", "name": "EvalResponsesRunDataSourceParamsSamplingParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4274", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "A higher temperature increases randomness in the outputs.", "type": { "$id": "4275", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "4276", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of tokens in the generated output.", "type": { "$id": "4277", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "4278", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens.", "type": { "$id": "4279", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "4280", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "A seed value to initialize the randomness, during sampling.", "type": { "$id": "4281", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "4282", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code. Learn more about\n [function calling](/docs/guides/function-calling).", "type": { "$id": "4283", "kind": "array", "name": "ArrayTool", "valueType": { "$id": "4284", "kind": "model", "name": "Tool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Tool", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4285", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "408" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Tool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4285" } ], "discriminatedSubtypes": { "function": { "$id": "4286", "kind": "model", "name": "FunctionTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionTool", "usage": "Input,Output,Json", "doc": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "discriminatorValue": "function", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4287", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the function tool. Always `function`.", "type": { "$id": "4288", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "409" }, "enumType": { "$id": "4289", "kind": "enum", "decorators": [], "doc": "A tool that can be used to generate a response.", "name": "ToolType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4290", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4291", "kind": "enumvalue", "decorators": [], "name": "file_search", "value": "file_search", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4292", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4293", "kind": "enumvalue", "decorators": [], "name": "computer_use_preview", "value": "computer_use_preview", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4294", "kind": "enumvalue", "decorators": [], "name": "web_search", "value": "web_search", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4295", "kind": "enumvalue", "decorators": [], "name": "web_search_preview", "value": "web_search_preview", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4296", "kind": "enumvalue", "decorators": [], "name": "mcp", "value": "mcp", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4297", "kind": "enumvalue", "decorators": [], "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4298", "kind": "enumvalue", "decorators": [], "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } }, { "$id": "4299", "kind": "enumvalue", "decorators": [], "name": "local_shell", "value": "local_shell", "valueType": { "$ref": "4290" }, "enumType": { "$ref": "4289" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ToolType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4300", "kind": "property", "name": "FunctionName", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "4301", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionTool.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4302", "kind": "property", "name": "FunctionDescription", "serializedName": "description", "doc": "A description of the function. Used by the model to determine whether or not to call the function.", "type": { "$id": "4303", "kind": "nullable", "type": { "$id": "4304", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionTool.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "4305", "kind": "property", "name": "FunctionParameters", "serializedName": "parameters", "doc": "A JSON schema object describing the parameters of the function.", "type": { "$id": "4306", "kind": "nullable", "type": { "$id": "4307", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionTool.parameters", "serializationOptions": { "json": { "name": "parameters" } }, "isHttpMetadata": false }, { "$id": "4308", "kind": "property", "name": "StrictModeEnabled", "serializedName": "strict", "doc": "Whether to enforce strict parameter validation. Default `true`.", "type": { "$id": "4309", "kind": "nullable", "type": { "$id": "4310", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionTool.strict", "serializationOptions": { "json": { "name": "strict" } }, "isHttpMetadata": false } ] }, "file_search": { "$id": "4311", "kind": "model", "name": "FileSearchTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FileSearchTool", "usage": "Input,Output,Json", "doc": "A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).", "discriminatorValue": "file_search", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4312", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the file search tool. Always `file_search`.", "type": { "$id": "4313", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4314", "kind": "property", "name": "vector_store_ids", "serializedName": "vector_store_ids", "doc": "The IDs of the vector stores to search.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchTool.vector_store_ids", "serializationOptions": { "json": { "name": "vector_store_ids" } }, "isHttpMetadata": false }, { "$id": "4315", "kind": "property", "name": "MaxResultCount", "serializedName": "max_num_results", "doc": "The maximum number of results to return. This number should be between 1 and 50 inclusive.", "type": { "$id": "4316", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchTool.max_num_results", "serializationOptions": { "json": { "name": "max_num_results" } }, "isHttpMetadata": false }, { "$id": "4317", "kind": "property", "name": "ranking_options", "serializedName": "ranking_options", "doc": "Ranking options for search.", "type": { "$id": "4318", "kind": "model", "name": "RankingOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RankingOptions", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4319", "kind": "property", "name": "ranker", "serializedName": "ranker", "doc": "The ranker to use for the file search.", "type": { "$ref": "419" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RankingOptions.ranker", "serializationOptions": { "json": { "name": "ranker" } }, "isHttpMetadata": false }, { "$id": "4320", "kind": "property", "name": "score_threshold", "serializedName": "score_threshold", "doc": "The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.", "type": { "$id": "4321", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RankingOptions.score_threshold", "serializationOptions": { "json": { "name": "score_threshold" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchTool.ranking_options", "serializationOptions": { "json": { "name": "ranking_options" } }, "isHttpMetadata": false }, { "$id": "4322", "kind": "property", "name": "filters", "serializedName": "filters", "doc": "A filter to apply.", "type": { "$id": "4323", "kind": "nullable", "type": { "$id": "4324", "kind": "union", "name": "Filters", "variantTypes": [ { "$id": "4325", "kind": "model", "name": "ComparisonFilter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilter", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4326", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "423" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilter.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4326" }, { "$id": "4327", "kind": "property", "name": "key", "serializedName": "key", "type": { "$id": "4328", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilter.key", "serializationOptions": { "json": { "name": "key" } }, "isHttpMetadata": false }, { "$id": "4329", "kind": "property", "name": "value", "serializedName": "value", "type": { "$id": "4330", "kind": "union", "name": "ComparisonFilterValue", "variantTypes": [ { "$id": "4331", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "4332", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, { "$id": "4333", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilter.value", "serializationOptions": { "json": { "name": "value" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "eq": { "$id": "4334", "kind": "model", "name": "ComparisonFilterEquals", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterEquals", "usage": "Input,Output,Json", "discriminatorValue": "eq", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4335", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4336", "kind": "enumvalue", "name": "eq", "value": "eq", "valueType": { "$ref": "424" }, "enumType": { "$id": "4337", "kind": "enum", "decorators": [], "name": "ComparisonFilterType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "4338", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4339", "kind": "enumvalue", "decorators": [], "name": "eq", "value": "eq", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } }, { "$id": "4340", "kind": "enumvalue", "decorators": [], "name": "ne", "value": "ne", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } }, { "$id": "4341", "kind": "enumvalue", "decorators": [], "name": "gt", "value": "gt", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } }, { "$id": "4342", "kind": "enumvalue", "decorators": [], "name": "gte", "value": "gte", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } }, { "$id": "4343", "kind": "enumvalue", "decorators": [], "name": "lt", "value": "lt", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } }, { "$id": "4344", "kind": "enumvalue", "decorators": [], "name": "lte", "value": "lte", "valueType": { "$ref": "4338" }, "enumType": { "$ref": "4337" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ComparisonFilter.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterEquals.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "ne": { "$id": "4345", "kind": "model", "name": "ComparisonFilterNotEquals", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterNotEquals", "usage": "Input,Output,Json", "discriminatorValue": "ne", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4346", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4347", "kind": "enumvalue", "name": "ne", "value": "ne", "valueType": { "$ref": "424" }, "enumType": { "$ref": "4337" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterNotEquals.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "gt": { "$id": "4348", "kind": "model", "name": "ComparisonFilterGreaterThan", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterGreaterThan", "usage": "Input,Output,Json", "discriminatorValue": "gt", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4349", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4350", "kind": "enumvalue", "name": "gt", "value": "gt", "valueType": { "$ref": "424" }, "enumType": { "$ref": "4337" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterGreaterThan.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "gte": { "$id": "4351", "kind": "model", "name": "ComparisonFilterGreaterThanOrEquals", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterGreaterThanOrEquals", "usage": "Input,Output,Json", "discriminatorValue": "gte", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4352", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4353", "kind": "enumvalue", "name": "gte", "value": "gte", "valueType": { "$ref": "424" }, "enumType": { "$ref": "4337" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterGreaterThanOrEquals.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "lt": { "$id": "4354", "kind": "model", "name": "ComparisonFilterLessThan", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterLessThan", "usage": "Input,Output,Json", "discriminatorValue": "lt", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4355", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4356", "kind": "enumvalue", "name": "lt", "value": "lt", "valueType": { "$ref": "424" }, "enumType": { "$ref": "4337" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterLessThan.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "lte": { "$id": "4357", "kind": "model", "name": "ComparisonFilterLessThanOrEquals", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComparisonFilterLessThanOrEquals", "usage": "Input,Output,Json", "discriminatorValue": "lte", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4325" }, "properties": [ { "$id": "4358", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4359", "kind": "enumvalue", "name": "lte", "value": "lte", "valueType": { "$ref": "424" }, "enumType": { "$ref": "4337" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComparisonFilterLessThanOrEquals.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] } } }, { "$id": "4360", "kind": "model", "name": "CompoundFilter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompoundFilter", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4361", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "431" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompoundFilter.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4361" }, { "$id": "4362", "kind": "property", "name": "filters", "serializedName": "filters", "type": { "$id": "4363", "kind": "array", "name": "Array20", "valueType": { "$id": "4364", "kind": "union", "name": "CompoundFilterFilter", "variantTypes": [ { "$ref": "4325" }, { "$ref": "4360" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompoundFilter.filters", "serializationOptions": { "json": { "name": "filters" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "and": { "$id": "4365", "kind": "model", "name": "CompoundFilterAnd", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompoundFilterAnd", "usage": "Input,Output,Json", "discriminatorValue": "and", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4360" }, "properties": [ { "$id": "4366", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4367", "kind": "enumvalue", "name": "and", "value": "and", "valueType": { "$ref": "432" }, "enumType": { "$id": "4368", "kind": "enum", "decorators": [], "name": "CompoundFilterType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "4369", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4370", "kind": "enumvalue", "decorators": [], "name": "and", "value": "and", "valueType": { "$ref": "4369" }, "enumType": { "$ref": "4368" } }, { "$id": "4371", "kind": "enumvalue", "decorators": [], "name": "or", "value": "or", "valueType": { "$ref": "4369" }, "enumType": { "$ref": "4368" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.CompoundFilter.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompoundFilterAnd.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "or": { "$id": "4372", "kind": "model", "name": "CompoundFilterOr", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompoundFilterOr", "usage": "Input,Output,Json", "discriminatorValue": "or", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4360" }, "properties": [ { "$id": "4373", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4374", "kind": "enumvalue", "name": "or", "value": "or", "valueType": { "$ref": "432" }, "enumType": { "$ref": "4368" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompoundFilterOr.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] } } } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchTool.filters", "serializationOptions": { "json": { "name": "filters" } }, "isHttpMetadata": false } ] }, "computer_use_preview": { "$id": "4375", "kind": "model", "name": "ComputerUsePreviewTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool", "usage": "Input,Output,Json", "doc": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", "discriminatorValue": "computer_use_preview", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4376", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the computer use tool. Always `computer_use_preview`.", "type": { "$id": "4377", "kind": "enumvalue", "name": "computer_use_preview", "value": "computer_use_preview", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4378", "kind": "property", "name": "environment", "serializedName": "environment", "doc": "The type of computer environment to control.", "type": { "$ref": "435" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool.environment", "serializationOptions": { "json": { "name": "environment" } }, "isHttpMetadata": false }, { "$id": "4379", "kind": "property", "name": "display_width", "serializedName": "display_width", "doc": "The width of the computer display.", "type": { "$id": "4380", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool.display_width", "serializationOptions": { "json": { "name": "display_width" } }, "isHttpMetadata": false }, { "$id": "4381", "kind": "property", "name": "display_height", "serializedName": "display_height", "doc": "The height of the computer display.", "type": { "$id": "4382", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerUsePreviewTool.display_height", "serializationOptions": { "json": { "name": "display_height" } }, "isHttpMetadata": false } ] }, "web_search_preview": { "$id": "4383", "kind": "model", "name": "WebSearchPreviewTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchPreviewTool", "usage": "Input,Output,Json", "doc": "This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).", "discriminatorValue": "web_search_preview", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4384", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", "type": { "$id": "4385", "kind": "enumvalue", "name": "web_search_preview", "value": "web_search_preview", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchPreviewTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4386", "kind": "property", "name": "user_location", "serializedName": "user_location", "doc": "The user's location.", "type": { "$id": "4387", "kind": "nullable", "type": { "$id": "4388", "kind": "model", "name": "Location", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Location", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4389", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "442" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Location.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4389" } ], "discriminatedSubtypes": { "approximate": { "$id": "4390", "kind": "model", "name": "ApproximateLocation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ApproximateLocation", "usage": "Input,Output,Json", "discriminatorValue": "approximate", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4388" }, "properties": [ { "$id": "4391", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4392", "kind": "enumvalue", "name": "approximate", "value": "approximate", "valueType": { "$ref": "443" }, "enumType": { "$id": "4393", "kind": "enum", "decorators": [], "name": "LocationType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4394", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4395", "kind": "enumvalue", "decorators": [], "name": "approximate", "value": "approximate", "valueType": { "$ref": "4394" }, "enumType": { "$ref": "4393" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.LocationType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ApproximateLocation.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4396", "kind": "property", "name": "country", "serializedName": "country", "type": { "$id": "4397", "kind": "nullable", "type": { "$id": "4398", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ApproximateLocation.country", "serializationOptions": { "json": { "name": "country" } }, "isHttpMetadata": false }, { "$id": "4399", "kind": "property", "name": "region", "serializedName": "region", "type": { "$id": "4400", "kind": "nullable", "type": { "$id": "4401", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ApproximateLocation.region", "serializationOptions": { "json": { "name": "region" } }, "isHttpMetadata": false }, { "$id": "4402", "kind": "property", "name": "city", "serializedName": "city", "type": { "$id": "4403", "kind": "nullable", "type": { "$id": "4404", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ApproximateLocation.city", "serializationOptions": { "json": { "name": "city" } }, "isHttpMetadata": false }, { "$id": "4405", "kind": "property", "name": "timezone", "serializedName": "timezone", "type": { "$id": "4406", "kind": "nullable", "type": { "$id": "4407", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ApproximateLocation.timezone", "serializationOptions": { "json": { "name": "timezone" } }, "isHttpMetadata": false } ] } } }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchPreviewTool.user_location", "serializationOptions": { "json": { "name": "user_location" } }, "isHttpMetadata": false }, { "$id": "4408", "kind": "property", "name": "search_context_size", "serializedName": "search_context_size", "doc": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.", "type": { "$ref": "445" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchPreviewTool.search_context_size", "serializationOptions": { "json": { "name": "search_context_size" } }, "isHttpMetadata": false } ] }, "web_search": { "$id": "4409", "kind": "model", "name": "WebSearchTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchTool", "usage": "Input,Output,Json", "doc": "This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).", "discriminatorValue": "web_search", "decorators": [], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4410", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", "type": { "$id": "4411", "kind": "enumvalue", "name": "web_search", "value": "web_search", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4412", "kind": "property", "name": "filters", "serializedName": "filters", "type": { "$id": "4413", "kind": "nullable", "type": { "$id": "4414", "kind": "model", "name": "WebSearchToolFilters", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchToolFilters", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4415", "kind": "property", "name": "allowed_domains", "serializedName": "allowed_domains", "type": { "$id": "4416", "kind": "nullable", "type": { "$ref": "2373" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchToolFilters.allowed_domains", "serializationOptions": { "json": { "name": "allowed_domains" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchTool.filters", "serializationOptions": { "json": { "name": "filters" } }, "isHttpMetadata": false }, { "$id": "4417", "kind": "property", "name": "user_location", "serializedName": "user_location", "type": { "$id": "4418", "kind": "nullable", "type": { "$ref": "4388" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchTool.user_location", "serializationOptions": { "json": { "name": "user_location" } }, "isHttpMetadata": false }, { "$id": "4419", "kind": "property", "name": "search_context_size", "serializedName": "search_context_size", "doc": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.", "type": { "$ref": "445" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchTool.search_context_size", "serializationOptions": { "json": { "name": "search_context_size" } }, "isHttpMetadata": false } ] }, "code_interpreter": { "$id": "4420", "kind": "model", "name": "CodeInterpreterTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterTool", "usage": "Input,Output,Json", "doc": "A tool that runs Python code to help generate a response to a prompt.", "discriminatorValue": "code_interpreter", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4421", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the code interpreter tool. Always `code_interpreter`.", "type": { "$id": "4422", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4423", "kind": "property", "name": "container", "serializedName": "container", "doc": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code.", "type": { "$id": "4424", "kind": "union", "name": "CodeInterpreterToolContainer", "variantTypes": [ { "$id": "4425", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "4426", "kind": "model", "name": "CodeInterpreterToolAuto", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolAuto", "usage": "Input,Output,Json", "doc": "Configuration for a code interpreter container. Optionally specify the IDs\nof the files to run the code on.", "discriminatorValue": "auto", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$id": "4427", "kind": "model", "name": "CodeInterpreterContainerConfiguration", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterContainerConfiguration", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4428", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output.", "type": { "$ref": "450" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterContainerConfiguration.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4428" } ], "discriminatedSubtypes": { "auto": { "$ref": "4426" } } }, "properties": [ { "$id": "4429", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `auto`.", "type": { "$id": "4430", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "451" }, "enumType": { "$id": "4431", "kind": "enum", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "name": "CodeInterpreterContainerConfigurationType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4432", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4433", "kind": "enumvalue", "decorators": [], "name": "auto", "value": "auto", "valueType": { "$ref": "4432" }, "enumType": { "$ref": "4431" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterContainerConfigurationType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolAuto.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4434", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "An optional list of uploaded files to make available to your code.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolAuto.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterTool.container", "serializationOptions": { "json": { "name": "container" } }, "isHttpMetadata": false } ] }, "image_generation": { "$id": "4435", "kind": "model", "name": "ImageGenTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImageGenTool", "usage": "Input,Output,Json", "doc": "A tool that generates images using a model like `gpt-image-1`.", "discriminatorValue": "image_generation", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4436", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the image generation tool. Always `image_generation`.", "type": { "$id": "4437", "kind": "enumvalue", "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4438", "kind": "property", "name": "model", "serializedName": "model", "doc": "The image generation model to use. Default: `gpt-image-1`.", "type": { "$ref": "453" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4439", "kind": "property", "name": "quality", "serializedName": "quality", "doc": "The quality of the generated image. One of `low`, `medium`, `high`,\nor `auto`. Default: `auto`.", "type": { "$ref": "457" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.quality", "serializationOptions": { "json": { "name": "quality" } }, "isHttpMetadata": false }, { "$id": "4440", "kind": "property", "name": "size", "serializedName": "size", "doc": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n`1536x1024`, or `auto`. Default: `auto`.", "type": { "$ref": "463" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.size", "serializationOptions": { "json": { "name": "size" } }, "isHttpMetadata": false }, { "$id": "4441", "kind": "property", "name": "output_format", "serializedName": "output_format", "doc": "The output format of the generated image. One of `png`, `webp`, or\n`jpeg`. Default: `png`.", "type": { "$ref": "469" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.output_format", "serializationOptions": { "json": { "name": "output_format" } }, "isHttpMetadata": false }, { "$id": "4442", "kind": "property", "name": "output_compression", "serializedName": "output_compression", "doc": "Compression level for the output image. Default: 100.", "type": { "$id": "4443", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.output_compression", "serializationOptions": { "json": { "name": "output_compression" } }, "isHttpMetadata": false }, { "$id": "4444", "kind": "property", "name": "moderation", "serializedName": "moderation", "doc": "Moderation level for the generated image. Default: `auto`.", "type": { "$ref": "474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.moderation", "serializationOptions": { "json": { "name": "moderation" } }, "isHttpMetadata": false }, { "$id": "4445", "kind": "property", "name": "background", "serializedName": "background", "doc": "Background type for the generated image. One of `transparent`,\n`opaque`, or `auto`. Default: `auto`.", "type": { "$ref": "478" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.background", "serializationOptions": { "json": { "name": "background" } }, "isHttpMetadata": false }, { "$id": "4446", "kind": "property", "name": "input_fidelity", "serializedName": "input_fidelity", "doc": "Control how much effort the model will exert to match the style and features,\nespecially facial features, of input images. This parameter is only supported\nfor `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.", "type": { "$ref": "483" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_fidelity", "serializationOptions": { "json": { "name": "input_fidelity" } }, "isHttpMetadata": false }, { "$id": "4447", "kind": "property", "name": "input_image_mask", "serializedName": "input_image_mask", "doc": "Optional mask for inpainting. Contains `image_url`\n(string, optional) and `file_id` (string, optional).", "type": { "$id": "4448", "kind": "model", "name": "ImageGenToolInputImageMask", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_image_mask.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "4449", "kind": "property", "name": "image_url", "serializedName": "image_url", "doc": "Base64-encoded mask image.", "type": { "$id": "4450", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_image_mask.anonymous.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false }, { "$id": "4451", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "File ID for the mask image.", "type": { "$id": "4452", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_image_mask.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.input_image_mask", "serializationOptions": { "json": { "name": "input_image_mask" } }, "isHttpMetadata": false }, { "$id": "4453", "kind": "property", "name": "partial_images", "serializedName": "partial_images", "doc": "Number of partial images to generate in streaming mode, from 0 (default value) to 3.", "type": { "$id": "4454", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenTool.partial_images", "serializationOptions": { "json": { "name": "partial_images" } }, "isHttpMetadata": false } ] }, "local_shell": { "$id": "4455", "kind": "model", "name": "LocalShellTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellTool", "usage": "Input,Output,Json", "doc": "A tool that allows the model to execute shell commands in a local environment.", "discriminatorValue": "local_shell", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4456", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the local shell tool. Always `local_shell`.", "type": { "$id": "4457", "kind": "enumvalue", "name": "local_shell", "value": "local_shell", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "mcp": { "$id": "4458", "kind": "model", "name": "MCPTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPTool", "usage": "Input,Output,Json", "doc": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).", "discriminatorValue": "mcp", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4284" }, "properties": [ { "$id": "4459", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the MCP tool. Always `mcp`.", "type": { "$id": "4460", "kind": "enumvalue", "name": "mcp", "value": "mcp", "valueType": { "$ref": "409" }, "enumType": { "$ref": "4289" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4461", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "A label for this MCP server, used to identify it in tool calls.", "type": { "$id": "4462", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "4463", "kind": "property", "name": "ServerUri", "serializedName": "server_url", "doc": "The URL for the MCP server. One of `server_url` or `connector_id` must be\n provided.", "type": { "$id": "4464", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.server_url", "serializationOptions": { "json": { "name": "server_url" } }, "isHttpMetadata": false }, { "$id": "4465", "kind": "property", "name": "connector_id", "serializedName": "connector_id", "doc": "Identifier for service connectors, like those available in ChatGPT. One of\n `server_url` or `connector_id` must be provided. Learn more about service\n connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).\n\n Currently supported `connector_id` values are:\n\n - Dropbox: `connector_dropbox`\n - Gmail: `connector_gmail`\n - Google Calendar: `connector_googlecalendar`\n - Google Drive: `connector_googledrive`\n - Microsoft Teams: `connector_microsoftteams`\n - Outlook Calendar: `connector_outlookcalendar`\n - Outlook Email: `connector_outlookemail`\n - SharePoint: `connector_sharepoint`", "type": { "$ref": "487" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.connector_id", "serializationOptions": { "json": { "name": "connector_id" } }, "isHttpMetadata": false }, { "$id": "4466", "kind": "property", "name": "AuthorizationToken", "serializedName": "authorization", "doc": "An OAuth access token that can be used with a remote MCP server, either\n with a custom MCP server URL or a service connector. Your application\n must handle the OAuth authorization flow and provide the token here.", "type": { "$id": "4467", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.authorization", "serializationOptions": { "json": { "name": "authorization" } }, "isHttpMetadata": false }, { "$id": "4468", "kind": "property", "name": "server_description", "serializedName": "server_description", "doc": "Optional description of the MCP server, used to provide more context.", "type": { "$id": "4469", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.server_description", "serializationOptions": { "json": { "name": "server_description" } }, "isHttpMetadata": false }, { "$id": "4470", "kind": "property", "name": "headers", "serializedName": "headers", "doc": "Optional HTTP headers to send to the MCP server. Use for authentication\n or other purposes.", "type": { "$id": "4471", "kind": "nullable", "type": { "$ref": "2380" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.headers", "serializationOptions": { "json": { "name": "headers" } }, "isHttpMetadata": false }, { "$id": "4472", "kind": "property", "name": "allowed_tools", "serializedName": "allowed_tools", "doc": "List of allowed tool names or a filter object.", "type": { "$id": "4473", "kind": "nullable", "type": { "$id": "4474", "kind": "model", "name": "MCPToolFilter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPToolFilter", "usage": "Input,Output,Json", "doc": "A filter object to specify which tools are allowed.", "summary": "MCP tool filter", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4475", "kind": "property", "name": "tool_names", "serializedName": "tool_names", "summary": "MCP allowed tools", "doc": "List of allowed tool names.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPToolFilter.tool_names", "serializationOptions": { "json": { "name": "tool_names" } }, "isHttpMetadata": false }, { "$id": "4476", "kind": "property", "name": "IsReadOnly", "serializedName": "read_only", "doc": "Indicates whether or not a tool modifies data or is read-only. If an\n MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\n it will match this filter.", "type": { "$id": "4477", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPToolFilter.read_only", "serializationOptions": { "json": { "name": "read_only" } }, "isHttpMetadata": false } ] }, "namespace": "" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.allowed_tools", "serializationOptions": { "json": { "name": "allowed_tools" } }, "isHttpMetadata": false }, { "$id": "4478", "kind": "property", "name": "require_approval", "serializedName": "require_approval", "doc": "Specify which of the MCP server's tools require approval.", "type": { "$id": "4479", "kind": "nullable", "type": { "$id": "4480", "kind": "union", "name": "MCPToolRequireApproval", "variantTypes": [ { "$id": "4481", "kind": "model", "name": "MCPToolRequireApproval1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPTool.require_approval.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "4482", "kind": "property", "name": "always", "serializedName": "always", "type": { "$ref": "4474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.require_approval.anonymous.always", "serializationOptions": { "json": { "name": "always" } }, "isHttpMetadata": false }, { "$id": "4483", "kind": "property", "name": "never", "serializedName": "never", "type": { "$ref": "4474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.require_approval.anonymous.never", "serializationOptions": { "json": { "name": "never" } }, "isHttpMetadata": false } ] }, { "$ref": "1595" }, { "$ref": "1597" } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPTool.require_approval", "serializationOptions": { "json": { "name": "require_approval" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "4484", "kind": "property", "name": "text", "serializedName": "text", "doc": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)", "type": { "$id": "4485", "kind": "model", "name": "EvalResponsesRunDataSourceParamsSamplingParamsText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.text.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "4486", "kind": "property", "name": "format", "serializedName": "format", "type": { "$ref": "4224" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.text.anonymous.format", "serializationOptions": { "json": { "name": "format" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.sampling_params", "serializationOptions": { "json": { "name": "sampling_params" } }, "isHttpMetadata": false }, { "$id": "4487", "kind": "property", "name": "model", "serializedName": "model", "doc": "The name of the model to use for generating completions (e.g. \"o3-mini\").", "type": { "$id": "4488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4489", "kind": "property", "name": "source", "serializedName": "source", "doc": "Determines what populates the `item` namespace in this run's data source.", "type": { "$id": "4490", "kind": "union", "name": "EvalResponsesRunDataSourceParamsSource", "variantTypes": [ { "$ref": "4133" }, { "$ref": "4136" }, { "$ref": "4163" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalResponsesRunDataSourceParams.source", "serializationOptions": { "json": { "name": "source" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateEvalRunRequest.data_source", "serializationOptions": { "json": { "name": "data_source" } }, "isHttpMetadata": false } ] }, { "$ref": "4121" }, { "$ref": "4123" }, { "$ref": "4133" }, { "$ref": "4195" }, { "$ref": "4134" }, { "$ref": "4136" }, { "$ref": "4147" }, { "$ref": "4163" }, { "$ref": "4198" }, { "$ref": "4203" }, { "$ref": "4209" }, { "$ref": "4214" }, { "$ref": "4224" }, { "$ref": "4226" }, { "$ref": "4234" }, { "$ref": "4237" }, { "$ref": "4253" }, { "$ref": "4258" }, { "$ref": "4263" }, { "$ref": "4268" }, { "$ref": "4273" }, { "$ref": "4284" }, { "$ref": "4286" }, { "$ref": "4311" }, { "$ref": "4318" }, { "$ref": "4325" }, { "$ref": "4334" }, { "$ref": "4345" }, { "$ref": "4348" }, { "$ref": "4351" }, { "$ref": "4354" }, { "$ref": "4357" }, { "$ref": "4360" }, { "$ref": "4365" }, { "$ref": "4372" }, { "$ref": "4375" }, { "$ref": "4383" }, { "$ref": "4388" }, { "$ref": "4390" }, { "$ref": "4409" }, { "$ref": "4414" }, { "$ref": "4420" }, { "$ref": "4426" }, { "$ref": "4427" }, { "$ref": "4435" }, { "$ref": "4448" }, { "$ref": "4455" }, { "$ref": "4458" }, { "$ref": "4474" }, { "$ref": "4481" }, { "$ref": "4485" }, { "$id": "4491", "kind": "model", "name": "DeleteEvalRunResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.deleteEvalRun.Response.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4492", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1599" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEvalRun.Response.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4493", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "4494", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEvalRun.Response.anonymous.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "4495", "kind": "property", "name": "eval_run_id", "serializedName": "eval_run_id", "type": { "$id": "4496", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteEvalRun.Response.anonymous.eval_run_id", "serializationOptions": { "json": { "name": "eval_run_id" } }, "isHttpMetadata": false } ] }, { "$id": "4497", "kind": "model", "name": "EvalRunOutputItemList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList", "usage": "Output,Json", "doc": "An object representing a list of output items for an evaluation run.", "decorators": [], "properties": [ { "$id": "4498", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of this object. It is always set to \"list\".", "type": { "$ref": "1601" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4499", "kind": "property", "name": "data", "serializedName": "data", "doc": "An array of eval run output item objects.", "type": { "$id": "4500", "kind": "array", "name": "ArrayEvalRunOutputItem", "valueType": { "$id": "4501", "kind": "model", "name": "EvalRunOutputItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem", "usage": "Output,Json", "doc": "A schema representing an evaluation run output item.", "decorators": [], "properties": [ { "$id": "4502", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of the object. Always \"eval.run.output_item\".", "type": { "$ref": "1603" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "4503", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for the evaluation run output item.", "type": { "$id": "4504", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "4505", "kind": "property", "name": "run_id", "serializedName": "run_id", "doc": "The identifier of the evaluation run associated with this output item.", "type": { "$id": "4506", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.run_id", "serializationOptions": { "json": { "name": "run_id" } }, "isHttpMetadata": false }, { "$id": "4507", "kind": "property", "name": "eval_id", "serializedName": "eval_id", "doc": "The identifier of the evaluation group.", "type": { "$id": "4508", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.eval_id", "serializationOptions": { "json": { "name": "eval_id" } }, "isHttpMetadata": false }, { "$id": "4509", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "Unix timestamp (in seconds) when the evaluation run was created.", "type": { "$id": "4510", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "4511", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "4512", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the evaluation run.", "type": { "$id": "4513", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "4514", "kind": "property", "name": "datasource_item_id", "serializedName": "datasource_item_id", "doc": "The identifier for the data source item.", "type": { "$id": "4515", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.datasource_item_id", "serializationOptions": { "json": { "name": "datasource_item_id" } }, "isHttpMetadata": false }, { "$id": "4516", "kind": "property", "name": "datasource_item", "serializedName": "datasource_item", "doc": "Details of the input data source item.", "type": { "$ref": "3883" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.datasource_item", "serializationOptions": { "json": { "name": "datasource_item" } }, "isHttpMetadata": false }, { "$id": "4517", "kind": "property", "name": "results", "serializedName": "results", "doc": "A list of results from the evaluation run.", "type": { "$id": "4518", "kind": "array", "name": "ArrayRecord", "valueType": { "$ref": "3883" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.results", "serializationOptions": { "json": { "name": "results" } }, "isHttpMetadata": false }, { "$id": "4519", "kind": "property", "name": "sample", "serializedName": "sample", "doc": "A sample containing the input and output of the evaluation run.", "type": { "$id": "4520", "kind": "model", "name": "EvalRunOutputItemSample", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4521", "kind": "property", "name": "input", "serializedName": "input", "doc": "An array of input messages.", "type": { "$id": "4522", "kind": "array", "name": "Array21", "valueType": { "$id": "4523", "kind": "model", "name": "EvalRunOutputItemSampleInput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.input.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4524", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message sender (e.g., system, user, developer).", "type": { "$id": "4525", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.input.anonymous.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4526", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message.", "type": { "$id": "4527", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.input.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "4528", "kind": "property", "name": "output", "serializedName": "output", "doc": "An array of output messages.", "type": { "$id": "4529", "kind": "array", "name": "Array22", "valueType": { "$id": "4530", "kind": "model", "name": "EvalRunOutputItemSampleOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.output.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4531", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message (e.g. \"system\", \"assistant\", \"user\").", "type": { "$id": "4532", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.output.anonymous.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4533", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message.", "type": { "$id": "4534", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.output.anonymous.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false }, { "$id": "4535", "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", "doc": "The reason why the sample generation was finished.", "type": { "$id": "4536", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.finish_reason", "serializationOptions": { "json": { "name": "finish_reason" } }, "isHttpMetadata": false }, { "$id": "4537", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model used for generating the sample.", "type": { "$id": "4538", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4539", "kind": "property", "name": "usage", "serializedName": "usage", "doc": "Token usage details for the sample.", "type": { "$id": "4540", "kind": "model", "name": "EvalRunOutputItemSampleUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.usage.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "4541", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens used.", "type": { "$id": "4542", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.usage.anonymous.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false }, { "$id": "4543", "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", "doc": "The number of completion tokens generated.", "type": { "$id": "4544", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.usage.anonymous.completion_tokens", "serializationOptions": { "json": { "name": "completion_tokens" } }, "isHttpMetadata": false }, { "$id": "4545", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "The number of prompt tokens used.", "type": { "$id": "4546", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.usage.anonymous.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "4547", "kind": "property", "name": "cached_tokens", "serializedName": "cached_tokens", "doc": "The number of tokens retrieved from cache.", "type": { "$id": "4548", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.usage.anonymous.cached_tokens", "serializationOptions": { "json": { "name": "cached_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false }, { "$id": "4549", "kind": "property", "name": "error", "serializedName": "error", "type": { "$ref": "4105" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false }, { "$id": "4550", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "The sampling temperature used.", "type": { "$id": "4551", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "4552", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of tokens allowed for completion.", "type": { "$id": "4553", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "4554", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "The top_p value used for sampling.", "type": { "$id": "4555", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "4556", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "The seed used for generating the sample.", "type": { "$id": "4557", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample.anonymous.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItem.sample", "serializationOptions": { "json": { "name": "sample" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "4558", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The identifier of the first eval run output item in the data array.", "type": { "$id": "4559", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "4560", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The identifier of the last eval run output item in the data array.", "type": { "$id": "4561", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "4562", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates whether there are more eval run output items available.", "type": { "$id": "4563", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.EvalRunOutputItemList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "4501" }, { "$ref": "4520" }, { "$ref": "4523" }, { "$ref": "4530" }, { "$ref": "4540" }, { "$id": "4564", "kind": "model", "name": "CreateResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateResponse", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4565", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "4566", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", "type": { "$ref": "2912" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "4567", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "doc": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.", "type": { "$ref": "2915" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false }, { "$id": "4568", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$ref": "2918" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "4569", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "4570", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false }, { "$id": "4571", "kind": "property", "name": "safety_identifier", "serializedName": "safety_identifier", "doc": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).", "type": { "$id": "4572", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.safety_identifier", "serializationOptions": { "json": { "name": "safety_identifier" } }, "isHttpMetadata": false }, { "$id": "4573", "kind": "property", "name": "service_tier", "serializedName": "service_tier", "type": { "$ref": "497" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.service_tier", "serializationOptions": { "json": { "name": "service_tier" } }, "isHttpMetadata": false }, { "$id": "4574", "kind": "property", "name": "previous_response_id", "serializedName": "previous_response_id", "doc": "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](/docs/guides/conversation-state).", "type": { "$id": "4575", "kind": "nullable", "type": { "$id": "4576", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.previous_response_id", "serializationOptions": { "json": { "name": "previous_response_id" } }, "isHttpMetadata": false }, { "$id": "4577", "kind": "property", "name": "model", "serializedName": "model", "doc": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.", "type": { "$id": "4578", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "4579", "kind": "property", "name": "reasoning", "serializedName": "reasoning", "type": { "$id": "4580", "kind": "nullable", "type": { "$id": "4581", "kind": "model", "name": "Reasoning", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Reasoning", "usage": "Input,Output,Json", "doc": "**o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4582", "kind": "property", "name": "effort", "serializedName": "effort", "type": { "$id": "4583", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Reasoning.effort", "serializationOptions": { "json": { "name": "effort" } }, "isHttpMetadata": false }, { "$id": "4584", "kind": "property", "name": "summary", "serializedName": "summary", "doc": "A summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.", "type": { "$id": "4585", "kind": "nullable", "type": { "$ref": "503" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Reasoning.summary", "serializationOptions": { "json": { "name": "summary" } }, "isHttpMetadata": false }, { "$id": "4586", "kind": "property", "name": "generate_summary", "serializedName": "generate_summary", "doc": "**Deprecated:** use `summary` instead.\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.", "type": { "$id": "4587", "kind": "nullable", "type": { "$ref": "508" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Reasoning.generate_summary", "serializationOptions": { "json": { "name": "generate_summary" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.reasoning", "serializationOptions": { "json": { "name": "reasoning" } }, "isHttpMetadata": false }, { "$id": "4588", "kind": "property", "name": "background", "serializedName": "background", "doc": "Whether to run the model response in the background.\n[Learn more](/docs/guides/background).", "type": { "$id": "4589", "kind": "nullable", "type": { "$id": "4590", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.background", "serializationOptions": { "json": { "name": "background" } }, "isHttpMetadata": false }, { "$id": "4591", "kind": "property", "name": "max_output_tokens", "serializedName": "max_output_tokens", "doc": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).", "type": { "$id": "4592", "kind": "nullable", "type": { "$id": "4593", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.max_output_tokens", "serializationOptions": { "json": { "name": "max_output_tokens" } }, "isHttpMetadata": false }, { "$id": "4594", "kind": "property", "name": "max_tool_calls", "serializedName": "max_tool_calls", "doc": "The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.", "type": { "$id": "4595", "kind": "nullable", "type": { "$id": "4596", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.max_tool_calls", "serializationOptions": { "json": { "name": "max_tool_calls" } }, "isHttpMetadata": false }, { "$id": "4597", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "Inserts a system (or developer) message as the first item in the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.", "type": { "$id": "4598", "kind": "nullable", "type": { "$id": "4599", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "4600", "kind": "property", "name": "text", "serializedName": "text", "doc": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)", "type": { "$id": "4601", "kind": "model", "name": "CreateResponseText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateResponse.text.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "4602", "kind": "property", "name": "format", "serializedName": "format", "type": { "$ref": "4224" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.text.anonymous.format", "serializationOptions": { "json": { "name": "format" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "4603", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code. Learn more about\n [function calling](/docs/guides/function-calling).", "type": { "$ref": "4283" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "4604", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "doc": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.", "type": { "$id": "4605", "kind": "union", "name": "CreateResponseToolChoice", "variantTypes": [ { "$ref": "513" }, { "$id": "4606", "kind": "model", "name": "ToolChoiceObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObject", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4607", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "518" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4607" } ], "discriminatedSubtypes": { "file_search": { "$id": "4608", "kind": "model", "name": "ToolChoiceObjectFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectFileSearch", "usage": "Input,Output,Json", "discriminatorValue": "file_search", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4609", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4610", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "519" }, "enumType": { "$id": "4611", "kind": "enum", "decorators": [], "doc": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).", "name": "ToolChoiceObjectType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4612", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4613", "kind": "enumvalue", "decorators": [], "name": "file_search", "value": "file_search", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4614", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4615", "kind": "enumvalue", "decorators": [], "name": "computer", "value": "computer_use_preview", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4616", "kind": "enumvalue", "decorators": [], "name": "web_search", "value": "web_search_preview", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4617", "kind": "enumvalue", "decorators": [], "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4618", "kind": "enumvalue", "decorators": [], "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } }, { "$id": "4619", "kind": "enumvalue", "decorators": [], "name": "mcp", "value": "mcp", "valueType": { "$ref": "4612" }, "enumType": { "$ref": "4611" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectFileSearch.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "computer_use_preview": { "$id": "4620", "kind": "model", "name": "ToolChoiceObjectComputer", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectComputer", "usage": "Input,Output,Json", "discriminatorValue": "computer_use_preview", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4621", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4622", "kind": "enumvalue", "name": "computer", "value": "computer_use_preview", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectComputer.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "web_search_preview": { "$id": "4623", "kind": "model", "name": "ToolChoiceObjectWebSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectWebSearch", "usage": "Input,Output,Json", "discriminatorValue": "web_search_preview", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4624", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4625", "kind": "enumvalue", "name": "web_search", "value": "web_search_preview", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectWebSearch.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "image_generation": { "$id": "4626", "kind": "model", "name": "ToolChoiceObjectImageGen", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectImageGen", "usage": "Input,Output,Json", "discriminatorValue": "image_generation", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4627", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4628", "kind": "enumvalue", "name": "image_generation", "value": "image_generation", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectImageGen.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "code_interpreter": { "$id": "4629", "kind": "model", "name": "ToolChoiceObjectCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectCodeInterpreter", "usage": "Input,Output,Json", "discriminatorValue": "code_interpreter", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4630", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4631", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectCodeInterpreter.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "mcp": { "$id": "4632", "kind": "model", "name": "ToolChoiceObjectMCP", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectMCP", "usage": "Input,Output,Json", "discriminatorValue": "mcp", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4633", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4634", "kind": "enumvalue", "name": "mcp", "value": "mcp", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectMCP.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "function": { "$id": "4635", "kind": "model", "name": "ToolChoiceObjectFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectFunction", "usage": "Input,Output,Json", "doc": "Use this option to force the model to call a specific function.", "discriminatorValue": "function", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4606" }, "properties": [ { "$id": "4636", "kind": "property", "name": "type", "serializedName": "type", "doc": "For function calling, the type is always `function`.", "type": { "$id": "4637", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "519" }, "enumType": { "$ref": "4611" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectFunction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4638", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "4639", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ToolChoiceObjectFunction.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] } } } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "4640", "kind": "property", "name": "truncation", "serializedName": "truncation", "doc": "The truncation strategy to use for the model response.\n- `auto`: If the context of this response and previous ones exceeds\n the model's context window size, the model will truncate the\n response to fit the context window by dropping input items in the\n middle of the conversation.\n- `disabled` (default): If a model response will exceed the context window\n size for a model, the request will fail with a 400 error.", "type": { "$id": "4641", "kind": "nullable", "type": { "$ref": "527" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.truncation", "serializationOptions": { "json": { "name": "truncation" } }, "isHttpMetadata": false }, { "$id": "4642", "kind": "property", "name": "input", "serializedName": "input", "doc": "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Image inputs](/docs/guides/images)\n- [File inputs](/docs/guides/pdf-files)\n- [Conversation state](/docs/guides/conversation-state)\n- [Function calling](/docs/guides/function-calling)", "type": { "$id": "4643", "kind": "union", "name": "CreateResponseInput", "variantTypes": [ { "$id": "4644", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "4645", "kind": "array", "name": "Array23", "valueType": { "$id": "4646", "kind": "union", "name": "CreateResponseInput1", "variantTypes": [ { "$id": "4647", "kind": "model", "name": "ImplicitUserMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImplicitUserMessage", "usage": "Input,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4648", "kind": "property", "name": "content", "serializedName": "content", "type": { "$id": "4649", "kind": "union", "name": "ImplicitUserMessageContent", "variantTypes": [ { "$id": "4650", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "4651", "kind": "array", "name": "ArrayItemContent", "valueType": { "$id": "4652", "kind": "model", "name": "ItemContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContent", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4653", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "531" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4653" } ], "discriminatedSubtypes": { "input_audio": { "$id": "4654", "kind": "model", "name": "ItemContentInputAudio", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentInputAudio", "usage": "Input,Output,Json", "doc": "An audio input to the model.", "discriminatorValue": "input_audio", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4655", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the input item. Always `input_audio`.", "type": { "$id": "4656", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "532" }, "enumType": { "$id": "4657", "kind": "enum", "decorators": [], "doc": "Multi-modal input and output contents.", "name": "ItemContentType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4658", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4659", "kind": "enumvalue", "decorators": [], "name": "input_text", "value": "input_text", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4660", "kind": "enumvalue", "decorators": [], "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4661", "kind": "enumvalue", "decorators": [], "name": "input_image", "value": "input_image", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4662", "kind": "enumvalue", "decorators": [], "name": "input_file", "value": "input_file", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4663", "kind": "enumvalue", "decorators": [], "name": "output_text", "value": "output_text", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4664", "kind": "enumvalue", "decorators": [], "name": "output_audio", "value": "output_audio", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } }, { "$id": "4665", "kind": "enumvalue", "decorators": [], "name": "refusal", "value": "refusal", "valueType": { "$ref": "4658" }, "enumType": { "$ref": "4657" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ItemContentType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputAudio.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4666", "kind": "property", "name": "data", "serializedName": "data", "doc": "Base64-encoded audio data.", "type": { "$id": "4667", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputAudio.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "4668", "kind": "property", "name": "format", "serializedName": "format", "doc": "The format of the audio data. Currently supported formats are `mp3` and\n`wav`.", "type": { "$ref": "540" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputAudio.format", "serializationOptions": { "json": { "name": "format" } }, "isHttpMetadata": false } ] }, "output_audio": { "$id": "4669", "kind": "model", "name": "ItemContentOutputAudio", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentOutputAudio", "usage": "Input,Output,Json", "doc": "An audio output from the model.", "discriminatorValue": "output_audio", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4670", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output audio. Always `output_audio`.", "type": { "$id": "4671", "kind": "enumvalue", "name": "output_audio", "value": "output_audio", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputAudio.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4672", "kind": "property", "name": "data", "serializedName": "data", "doc": "Base64-encoded audio data from the model.", "type": { "$id": "4673", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputAudio.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "4674", "kind": "property", "name": "transcript", "serializedName": "transcript", "doc": "The transcript of the audio data from the model.", "type": { "$id": "4675", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputAudio.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false } ] }, "refusal": { "$id": "4676", "kind": "model", "name": "ItemContentRefusal", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentRefusal", "usage": "Input,Output,Json", "doc": "A refusal from the model.", "discriminatorValue": "refusal", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4677", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the refusal. Always `refusal`.", "type": { "$id": "4678", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentRefusal.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4679", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal explanationfrom the model.", "type": { "$id": "4680", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentRefusal.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false } ] }, "input_text": { "$id": "4681", "kind": "model", "name": "ItemContentInputText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentInputText", "usage": "Input,Output,Json", "doc": "A text input to the model.", "discriminatorValue": "input_text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4682", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the input item. Always `input_text`.", "type": { "$id": "4683", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4684", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text input to the model.", "type": { "$id": "4685", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputText.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "input_image": { "$id": "4686", "kind": "model", "name": "ItemContentInputImage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage", "usage": "Input,Output,Json", "doc": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "discriminatorValue": "input_image", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4687", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the input item. Always `input_image`.", "type": { "$id": "4688", "kind": "enumvalue", "name": "input_image", "value": "input_image", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4689", "kind": "property", "name": "image_url", "serializedName": "image_url", "doc": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", "type": { "$id": "4690", "kind": "nullable", "type": { "$id": "4691", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false }, { "$id": "4692", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to be sent to the model.", "type": { "$id": "4693", "kind": "nullable", "type": { "$id": "4694", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4695", "kind": "property", "name": "detail", "serializedName": "detail", "doc": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.", "type": { "$ref": "544" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputImage.detail", "serializationOptions": { "json": { "name": "detail" } }, "isHttpMetadata": false } ] }, "input_file": { "$id": "4696", "kind": "model", "name": "ItemContentInputFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentInputFile", "usage": "Input,Output,Json", "doc": "A file input to the model.", "discriminatorValue": "input_file", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4697", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the input item. Always `input_file`.", "type": { "$id": "4698", "kind": "enumvalue", "name": "input_file", "value": "input_file", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputFile.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4699", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to be sent to the model.", "type": { "$id": "4700", "kind": "nullable", "type": { "$id": "4701", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputFile.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4702", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file to be sent to the model.", "type": { "$id": "4703", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputFile.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "4704", "kind": "property", "name": "file_data", "serializedName": "file_data", "doc": "The content of the file to be sent to the model.", "type": { "$id": "4705", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentInputFile.file_data", "serializationOptions": { "json": { "name": "file_data" } }, "isHttpMetadata": false } ] }, "output_text": { "$id": "4706", "kind": "model", "name": "ItemContentOutputText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemContentOutputText", "usage": "Input,Output,Json", "doc": "A text output from the model.", "discriminatorValue": "output_text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4652" }, "properties": [ { "$id": "4707", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output text. Always `output_text`.", "type": { "$id": "4708", "kind": "enumvalue", "name": "output_text", "value": "output_text", "valueType": { "$ref": "532" }, "enumType": { "$ref": "4657" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputText.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4709", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text output from the model.", "type": { "$id": "4710", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputText.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "4711", "kind": "property", "name": "annotations", "serializedName": "annotations", "doc": "The annotations of the text output.", "type": { "$id": "4712", "kind": "array", "name": "ArrayAnnotation", "valueType": { "$id": "4713", "kind": "model", "name": "Annotation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Annotation", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4714", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "549" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Annotation.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4714" } ], "discriminatedSubtypes": { "file_citation": { "$id": "4715", "kind": "model", "name": "AnnotationFileCitation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AnnotationFileCitation", "usage": "Input,Output,Json", "doc": "A citation to a file.", "discriminatorValue": "file_citation", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4713" }, "properties": [ { "$id": "4716", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the file citation. Always `file_citation`.", "type": { "$id": "4717", "kind": "enumvalue", "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "550" }, "enumType": { "$id": "4718", "kind": "enum", "decorators": [], "name": "AnnotationType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4719", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4720", "kind": "enumvalue", "decorators": [], "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "4719" }, "enumType": { "$ref": "4718" } }, { "$id": "4721", "kind": "enumvalue", "decorators": [], "name": "url_citation", "value": "url_citation", "valueType": { "$ref": "4719" }, "enumType": { "$ref": "4718" } }, { "$id": "4722", "kind": "enumvalue", "decorators": [], "name": "file_path", "value": "file_path", "valueType": { "$ref": "4719" }, "enumType": { "$ref": "4718" } }, { "$id": "4723", "kind": "enumvalue", "decorators": [], "name": "container_file_citation", "value": "container_file_citation", "valueType": { "$ref": "4719" }, "enumType": { "$ref": "4718" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.AnnotationType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFileCitation.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4724", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file.", "type": { "$id": "4725", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFileCitation.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4726", "kind": "property", "name": "index", "serializedName": "index", "doc": "The index of the file in the list of files.", "type": { "$id": "4727", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFileCitation.index", "serializationOptions": { "json": { "name": "index" } }, "isHttpMetadata": false }, { "$id": "4728", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The filename of the file cited.", "type": { "$id": "4729", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFileCitation.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false } ] }, "url_citation": { "$id": "4730", "kind": "model", "name": "AnnotationUrlCitation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation", "usage": "Input,Output,Json", "doc": "A citation for a web resource used to generate a model response.", "discriminatorValue": "url_citation", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4713" }, "properties": [ { "$id": "4731", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the URL citation. Always `url_citation`.", "type": { "$id": "4732", "kind": "enumvalue", "name": "url_citation", "value": "url_citation", "valueType": { "$ref": "550" }, "enumType": { "$ref": "4718" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4733", "kind": "property", "name": "url", "serializedName": "url", "doc": "The URL of the web resource.", "type": { "$id": "4734", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false }, { "$id": "4735", "kind": "property", "name": "start_index", "serializedName": "start_index", "doc": "The index of the first character of the URL citation in the message.", "type": { "$id": "4736", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation.start_index", "serializationOptions": { "json": { "name": "start_index" } }, "isHttpMetadata": false }, { "$id": "4737", "kind": "property", "name": "end_index", "serializedName": "end_index", "doc": "The index of the last character of the URL citation in the message.", "type": { "$id": "4738", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation.end_index", "serializationOptions": { "json": { "name": "end_index" } }, "isHttpMetadata": false }, { "$id": "4739", "kind": "property", "name": "title", "serializedName": "title", "doc": "The title of the web resource.", "type": { "$id": "4740", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationUrlCitation.title", "serializationOptions": { "json": { "name": "title" } }, "isHttpMetadata": false } ] }, "container_file_citation": { "$id": "4741", "kind": "model", "name": "ContainerFileCitationBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody", "usage": "Input,Output,Json", "doc": "A citation for a container file used to generate a model response.", "discriminatorValue": "container_file_citation", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4713" }, "properties": [ { "$id": "4742", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the container file citation. Always `container_file_citation`.", "type": { "$id": "4743", "kind": "enumvalue", "name": "container_file_citation", "value": "container_file_citation", "valueType": { "$ref": "550" }, "enumType": { "$ref": "4718" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4744", "kind": "property", "name": "container_id", "serializedName": "container_id", "doc": "The ID of the container file.", "type": { "$id": "4745", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.container_id", "serializationOptions": { "json": { "name": "container_id" } }, "isHttpMetadata": false }, { "$id": "4746", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file.", "type": { "$id": "4747", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4748", "kind": "property", "name": "start_index", "serializedName": "start_index", "doc": "The index of the first character of the container file citation in the message.", "type": { "$id": "4749", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.start_index", "serializationOptions": { "json": { "name": "start_index" } }, "isHttpMetadata": false }, { "$id": "4750", "kind": "property", "name": "end_index", "serializedName": "end_index", "doc": "The index of the last character of the container file citation in the message.", "type": { "$id": "4751", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.end_index", "serializationOptions": { "json": { "name": "end_index" } }, "isHttpMetadata": false }, { "$id": "4752", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The filename of the container file cited.", "type": { "$id": "4753", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCitationBody.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false } ] }, "file_path": { "$id": "4754", "kind": "model", "name": "AnnotationFilePath", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AnnotationFilePath", "usage": "Input,Output,Json", "doc": "A path to a file.", "discriminatorValue": "file_path", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4713" }, "properties": [ { "$id": "4755", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the file path. Always `file_path`.", "type": { "$id": "4756", "kind": "enumvalue", "name": "file_path", "value": "file_path", "valueType": { "$ref": "550" }, "enumType": { "$ref": "4718" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFilePath.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4757", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file.", "type": { "$id": "4758", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFilePath.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4759", "kind": "property", "name": "index", "serializedName": "index", "doc": "The index of the file in the list of files.", "type": { "$id": "4760", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AnnotationFilePath.index", "serializationOptions": { "json": { "name": "index" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputText.annotations", "serializationOptions": { "json": { "name": "annotations" } }, "isHttpMetadata": false }, { "$id": "4761", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "type": { "$id": "4762", "kind": "array", "name": "ArrayLogProb", "valueType": { "$id": "4763", "kind": "model", "name": "LogProb", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LogProb", "usage": "Input,Output,Json", "doc": "The log probability of a token.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4764", "kind": "property", "name": "token", "serializedName": "token", "type": { "$id": "4765", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProb.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "4766", "kind": "property", "name": "logprob", "serializedName": "logprob", "type": { "$id": "4767", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProb.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "4768", "kind": "property", "name": "bytes", "serializedName": "bytes", "type": { "$ref": "2606" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProb.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "4769", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "type": { "$id": "4770", "kind": "array", "name": "ArrayTopLogProb", "valueType": { "$id": "4771", "kind": "model", "name": "TopLogProb", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TopLogProb", "usage": "Input,Output,Json", "doc": "The top log probability of a token.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4772", "kind": "property", "name": "token", "serializedName": "token", "type": { "$id": "4773", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TopLogProb.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "4774", "kind": "property", "name": "logprob", "serializedName": "logprob", "type": { "$id": "4775", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TopLogProb.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "4776", "kind": "property", "name": "bytes", "serializedName": "bytes", "type": { "$ref": "2606" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TopLogProb.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProb.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemContentOutputText.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImplicitUserMessage.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, { "$id": "4777", "kind": "model", "name": "ItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemParam", "usage": "Input,Json", "doc": "Content item used to generate a response.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4778", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "555" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4778" } ], "discriminatedSubtypes": { "message": { "$id": "4779", "kind": "model", "name": "ResponsesMessageItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemParam", "usage": "Input,Json", "doc": "A response message item, representing a role and content, as provided as client request parameters.", "discriminatorValue": "message", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4780", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role associated with the message.", "type": { "$ref": "574" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemParam.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4781", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the responses item, which is always 'message'.", "type": { "$id": "4782", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$ref": "556" }, "enumType": { "$id": "4783", "kind": "enum", "decorators": [], "name": "ItemType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4784", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4785", "kind": "enumvalue", "decorators": [], "name": "message", "value": "message", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4786", "kind": "enumvalue", "decorators": [], "name": "file_search_call", "value": "file_search_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4787", "kind": "enumvalue", "decorators": [], "name": "function_call", "value": "function_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4788", "kind": "enumvalue", "decorators": [], "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4789", "kind": "enumvalue", "decorators": [], "name": "computer_call", "value": "computer_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4790", "kind": "enumvalue", "decorators": [], "name": "computer_call_output", "value": "computer_call_output", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4791", "kind": "enumvalue", "decorators": [], "name": "web_search_call", "value": "web_search_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4792", "kind": "enumvalue", "decorators": [], "name": "reasoning", "value": "reasoning", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4793", "kind": "enumvalue", "decorators": [], "name": "item_reference", "value": "item_reference", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4794", "kind": "enumvalue", "decorators": [], "name": "image_generation_call", "value": "image_generation_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4795", "kind": "enumvalue", "decorators": [], "name": "code_interpreter_call", "value": "code_interpreter_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4796", "kind": "enumvalue", "decorators": [], "name": "local_shell_call", "value": "local_shell_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4797", "kind": "enumvalue", "decorators": [], "name": "local_shell_call_output", "value": "local_shell_call_output", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4798", "kind": "enumvalue", "decorators": [], "name": "mcp_list_tools", "value": "mcp_list_tools", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4799", "kind": "enumvalue", "decorators": [], "name": "mcp_approval_request", "value": "mcp_approval_request", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4800", "kind": "enumvalue", "decorators": [], "name": "mcp_approval_response", "value": "mcp_approval_response", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } }, { "$id": "4801", "kind": "enumvalue", "decorators": [], "name": "mcp_call", "value": "mcp_call", "valueType": { "$ref": "4784" }, "enumType": { "$ref": "4783" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ItemType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$ref": "4780" } ], "discriminatedSubtypes": { "user": { "$id": "4802", "kind": "model", "name": "ResponsesUserMessageItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemParam", "usage": "Input,Json", "doc": "A message parameter item with the `user` role.", "discriminatorValue": "user", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4779" }, "properties": [ { "$id": "4803", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `user`.", "type": { "$id": "4804", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "575" }, "enumType": { "$id": "4805", "kind": "enum", "decorators": [], "doc": "The collection of valid roles for responses message items.", "name": "ResponsesMessageRole", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4806", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4807", "kind": "enumvalue", "decorators": [], "name": "system", "value": "system", "valueType": { "$ref": "4806" }, "enumType": { "$ref": "4805" } }, { "$id": "4808", "kind": "enumvalue", "decorators": [], "name": "developer", "value": "developer", "valueType": { "$ref": "4806" }, "enumType": { "$ref": "4805" } }, { "$id": "4809", "kind": "enumvalue", "decorators": [], "name": "user", "value": "user", "valueType": { "$ref": "4806" }, "enumType": { "$ref": "4805" } }, { "$id": "4810", "kind": "enumvalue", "decorators": [], "name": "assistant", "value": "assistant", "valueType": { "$ref": "4806" }, "enumType": { "$ref": "4805" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ResponsesMessageRole", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemParam.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4811", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemParam.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "system": { "$id": "4812", "kind": "model", "name": "ResponsesSystemMessageItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemParam", "usage": "Input,Json", "doc": "A message parameter item with the `system` role.", "discriminatorValue": "system", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4779" }, "properties": [ { "$id": "4813", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `system`.", "type": { "$id": "4814", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "575" }, "enumType": { "$ref": "4805" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemParam.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4815", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemParam.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "developer": { "$id": "4816", "kind": "model", "name": "ResponsesDeveloperMessageItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemParam", "usage": "Input,Json", "doc": "A message parameter item with the `developer` role.", "discriminatorValue": "developer", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4779" }, "properties": [ { "$id": "4817", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `developer`.", "type": { "$id": "4818", "kind": "enumvalue", "name": "developer", "value": "developer", "valueType": { "$ref": "575" }, "enumType": { "$ref": "4805" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemParam.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4819", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemParam.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "assistant": { "$id": "4820", "kind": "model", "name": "ResponsesAssistantMessageItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemParam", "usage": "Input,Json", "doc": "A message parameter item with the `assistant` role.", "discriminatorValue": "assistant", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4779" }, "properties": [ { "$id": "4821", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `assistant`.", "type": { "$id": "4822", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "575" }, "enumType": { "$ref": "4805" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemParam.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "4823", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemParam.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] } } }, "function_call_output": { "$id": "4824", "kind": "model", "name": "FunctionToolCallOutputItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemParam", "usage": "Input,Json", "doc": "The output of a function tool call.\n", "discriminatorValue": "function_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4825", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4826", "kind": "enumvalue", "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4827", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the function tool call generated by the model.", "type": { "$id": "4828", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemParam.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "4829", "kind": "property", "name": "output", "serializedName": "output", "doc": "A JSON string of the output of the function tool call.", "type": { "$id": "4830", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemParam.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "file_search_call": { "$id": "4831", "kind": "model", "name": "FileSearchToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemParam", "usage": "Input,Json", "doc": "The results of a file search tool call. See the\n[file search guide](/docs/guides/tools-file-search) for more information.\n", "discriminatorValue": "file_search_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4832", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4833", "kind": "enumvalue", "name": "file_search_call", "value": "file_search_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4834", "kind": "property", "name": "queries", "serializedName": "queries", "doc": "The queries used to search for files.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemParam.queries", "serializationOptions": { "json": { "name": "queries" } }, "isHttpMetadata": false }, { "$id": "4835", "kind": "property", "name": "results", "serializedName": "results", "doc": "The results of the file search tool call.", "type": { "$id": "4836", "kind": "nullable", "type": { "$id": "4837", "kind": "array", "name": "Array24", "valueType": { "$id": "4838", "kind": "model", "name": "FileSearchToolCallItemResourceResult", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "4839", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The unique ID of the file.", "type": { "$id": "4840", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "4841", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text that was retrieved from the file.", "type": { "$id": "4842", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "4843", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file.", "type": { "$id": "4844", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "4845", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$ref": "3883" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false }, { "$id": "4846", "kind": "property", "name": "score", "serializedName": "score", "doc": "The relevance score of the file - a value between 0 and 1.", "type": { "$id": "4847", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.result.anonymous.score", "serializationOptions": { "json": { "name": "score" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemParam.results", "serializationOptions": { "json": { "name": "results" } }, "isHttpMetadata": false } ] }, "computer_call": { "$id": "4848", "kind": "model", "name": "ComputerToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemParam", "usage": "Input,Json", "doc": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.\n", "discriminatorValue": "computer_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4849", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4850", "kind": "enumvalue", "name": "computer_call", "value": "computer_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4851", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "An identifier used when responding to the tool call with output.", "type": { "$id": "4852", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemParam.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "4853", "kind": "property", "name": "action", "serializedName": "action", "type": { "$id": "4854", "kind": "model", "name": "ComputerAction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerAction", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4855", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "580" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerAction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4855" } ], "discriminatedSubtypes": { "click": { "$id": "4856", "kind": "model", "name": "ComputerActionClick", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionClick", "usage": "Input,Output,Json", "doc": "A click action.", "discriminatorValue": "click", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4857", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a click action, this property is\nalways set to `click`.", "type": { "$id": "4858", "kind": "enumvalue", "name": "click", "value": "click", "valueType": { "$ref": "581" }, "enumType": { "$id": "4859", "kind": "enum", "decorators": [], "name": "ComputerActionType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4860", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4861", "kind": "enumvalue", "decorators": [], "name": "screenshot", "value": "screenshot", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4862", "kind": "enumvalue", "decorators": [], "name": "click", "value": "click", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4863", "kind": "enumvalue", "decorators": [], "name": "double_click", "value": "double_click", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4864", "kind": "enumvalue", "decorators": [], "name": "scroll", "value": "scroll", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4865", "kind": "enumvalue", "decorators": [], "name": "type", "value": "type", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4866", "kind": "enumvalue", "decorators": [], "name": "wait", "value": "wait", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4867", "kind": "enumvalue", "decorators": [], "name": "keypress", "value": "keypress", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4868", "kind": "enumvalue", "decorators": [], "name": "drag", "value": "drag", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } }, { "$id": "4869", "kind": "enumvalue", "decorators": [], "name": "move", "value": "move", "valueType": { "$ref": "4860" }, "enumType": { "$ref": "4859" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ComputerActionType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionClick.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4870", "kind": "property", "name": "button", "serializedName": "button", "doc": "Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`.", "type": { "$ref": "591" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionClick.button", "serializationOptions": { "json": { "name": "button" } }, "isHttpMetadata": false }, { "$id": "4871", "kind": "property", "name": "x", "serializedName": "x", "doc": "The x-coordinate where the click occurred.", "type": { "$id": "4872", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionClick.x", "serializationOptions": { "json": { "name": "x" } }, "isHttpMetadata": false }, { "$id": "4873", "kind": "property", "name": "y", "serializedName": "y", "doc": "The y-coordinate where the click occurred.", "type": { "$id": "4874", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionClick.y", "serializationOptions": { "json": { "name": "y" } }, "isHttpMetadata": false } ] }, "double_click": { "$id": "4875", "kind": "model", "name": "ComputerActionDoubleClick", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionDoubleClick", "usage": "Input,Output,Json", "doc": "A double click action.", "discriminatorValue": "double_click", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4876", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a double click action, this property is\nalways set to `double_click`.", "type": { "$id": "4877", "kind": "enumvalue", "name": "double_click", "value": "double_click", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionDoubleClick.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4878", "kind": "property", "name": "x", "serializedName": "x", "doc": "The x-coordinate where the double click occurred.", "type": { "$id": "4879", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionDoubleClick.x", "serializationOptions": { "json": { "name": "x" } }, "isHttpMetadata": false }, { "$id": "4880", "kind": "property", "name": "y", "serializedName": "y", "doc": "The y-coordinate where the double click occurred.", "type": { "$id": "4881", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionDoubleClick.y", "serializationOptions": { "json": { "name": "y" } }, "isHttpMetadata": false } ] }, "drag": { "$id": "4882", "kind": "model", "name": "ComputerActionDrag", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionDrag", "usage": "Input,Output,Json", "doc": "A drag action.", "discriminatorValue": "drag", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4883", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a drag action, this property is\nalways set to `drag`.", "type": { "$id": "4884", "kind": "enumvalue", "name": "drag", "value": "drag", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionDrag.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4885", "kind": "property", "name": "path", "serializedName": "path", "doc": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array\nof objects, eg\n```\n[\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n]\n```", "type": { "$id": "4886", "kind": "array", "name": "ArrayCoordinate", "valueType": { "$id": "4887", "kind": "model", "name": "Coordinate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Coordinate", "usage": "Input,Output,Json", "doc": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4888", "kind": "property", "name": "x", "serializedName": "x", "doc": "The x-coordinate.", "type": { "$id": "4889", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Coordinate.x", "serializationOptions": { "json": { "name": "x" } }, "isHttpMetadata": false }, { "$id": "4890", "kind": "property", "name": "y", "serializedName": "y", "doc": "The y-coordinate.", "type": { "$id": "4891", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Coordinate.y", "serializationOptions": { "json": { "name": "y" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionDrag.path", "serializationOptions": { "json": { "name": "path" } }, "isHttpMetadata": false } ] }, "move": { "$id": "4892", "kind": "model", "name": "ComputerActionMove", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionMove", "usage": "Input,Output,Json", "doc": "A mouse move action.", "discriminatorValue": "move", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4893", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a move action, this property is\nalways set to `move`.", "type": { "$id": "4894", "kind": "enumvalue", "name": "move", "value": "move", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionMove.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4895", "kind": "property", "name": "x", "serializedName": "x", "doc": "The x-coordinate to move to.", "type": { "$id": "4896", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionMove.x", "serializationOptions": { "json": { "name": "x" } }, "isHttpMetadata": false }, { "$id": "4897", "kind": "property", "name": "y", "serializedName": "y", "doc": "The y-coordinate to move to.", "type": { "$id": "4898", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionMove.y", "serializationOptions": { "json": { "name": "y" } }, "isHttpMetadata": false } ] }, "screenshot": { "$id": "4899", "kind": "model", "name": "ComputerActionScreenshot", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionScreenshot", "usage": "Input,Output,Json", "doc": "A screenshot action.", "discriminatorValue": "screenshot", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4900", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a screenshot action, this property is\nalways set to `screenshot`.", "type": { "$id": "4901", "kind": "enumvalue", "name": "screenshot", "value": "screenshot", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScreenshot.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "scroll": { "$id": "4902", "kind": "model", "name": "ComputerActionScroll", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll", "usage": "Input,Output,Json", "doc": "A scroll action.", "discriminatorValue": "scroll", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4903", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a scroll action, this property is\nalways set to `scroll`.", "type": { "$id": "4904", "kind": "enumvalue", "name": "scroll", "value": "scroll", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4905", "kind": "property", "name": "x", "serializedName": "x", "doc": "The x-coordinate where the scroll occurred.", "type": { "$id": "4906", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll.x", "serializationOptions": { "json": { "name": "x" } }, "isHttpMetadata": false }, { "$id": "4907", "kind": "property", "name": "y", "serializedName": "y", "doc": "The y-coordinate where the scroll occurred.", "type": { "$id": "4908", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll.y", "serializationOptions": { "json": { "name": "y" } }, "isHttpMetadata": false }, { "$id": "4909", "kind": "property", "name": "scroll_x", "serializedName": "scroll_x", "doc": "The horizontal scroll distance.", "type": { "$id": "4910", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll.scroll_x", "serializationOptions": { "json": { "name": "scroll_x" } }, "isHttpMetadata": false }, { "$id": "4911", "kind": "property", "name": "scroll_y", "serializedName": "scroll_y", "doc": "The vertical scroll distance.", "type": { "$id": "4912", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionScroll.scroll_y", "serializationOptions": { "json": { "name": "scroll_y" } }, "isHttpMetadata": false } ] }, "type": { "$id": "4913", "kind": "model", "name": "ComputerActionTypeKeys", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionTypeKeys", "usage": "Input,Output,Json", "doc": "An action to type in text.", "discriminatorValue": "type", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4914", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a type action, this property is\nalways set to `type`.", "type": { "$id": "4915", "kind": "enumvalue", "name": "type", "value": "type", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionTypeKeys.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4916", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text to type.", "type": { "$id": "4917", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionTypeKeys.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "wait": { "$id": "4918", "kind": "model", "name": "ComputerActionWait", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionWait", "usage": "Input,Output,Json", "doc": "A wait action.", "discriminatorValue": "wait", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4919", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a wait action, this property is\nalways set to `wait`.", "type": { "$id": "4920", "kind": "enumvalue", "name": "wait", "value": "wait", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionWait.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "keypress": { "$id": "4921", "kind": "model", "name": "ComputerActionKeyPress", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerActionKeyPress", "usage": "Input,Output,Json", "doc": "A collection of keypresses the model would like to perform.", "discriminatorValue": "keypress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4854" }, "properties": [ { "$id": "4922", "kind": "property", "name": "type", "serializedName": "type", "doc": "Specifies the event type. For a keypress action, this property is\nalways set to `keypress`.", "type": { "$id": "4923", "kind": "enumvalue", "name": "keypress", "value": "keypress", "valueType": { "$ref": "581" }, "enumType": { "$ref": "4859" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionKeyPress.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4924", "kind": "property", "name": "keys", "serializedName": "keys", "doc": "The combination of keys the model is requesting to be pressed. This is an\narray of strings, each representing a key.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerActionKeyPress.keys", "serializationOptions": { "json": { "name": "keys" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemParam.action", "serializationOptions": { "json": { "name": "action" } }, "isHttpMetadata": false }, { "$id": "4925", "kind": "property", "name": "pending_safety_checks", "serializedName": "pending_safety_checks", "doc": "The pending safety checks for the computer call.", "type": { "$id": "4926", "kind": "array", "name": "ArrayComputerToolCallSafetyCheck", "valueType": { "$id": "4927", "kind": "model", "name": "ComputerToolCallSafetyCheck", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallSafetyCheck", "usage": "Input,Output,Json", "doc": "A pending safety check for the computer call.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "4928", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the pending safety check.", "type": { "$id": "4929", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallSafetyCheck.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "4930", "kind": "property", "name": "code", "serializedName": "code", "doc": "The type of the pending safety check.", "type": { "$id": "4931", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallSafetyCheck.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "4932", "kind": "property", "name": "message", "serializedName": "message", "doc": "Details about the pending safety check.", "type": { "$id": "4933", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallSafetyCheck.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemParam.pending_safety_checks", "serializationOptions": { "json": { "name": "pending_safety_checks" } }, "isHttpMetadata": false } ] }, "computer_call_output": { "$id": "4934", "kind": "model", "name": "ComputerToolCallOutputItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemParam", "usage": "Input,Json", "doc": "The output of a computer tool call.\n", "discriminatorValue": "computer_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4935", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4936", "kind": "enumvalue", "name": "computer_call_output", "value": "computer_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4937", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The ID of the computer tool call that produced the output.", "type": { "$id": "4938", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemParam.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "4939", "kind": "property", "name": "acknowledged_safety_checks", "serializedName": "acknowledged_safety_checks", "doc": "The safety checks reported by the API that have been acknowledged by the\ndeveloper.", "type": { "$ref": "4926" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemParam.acknowledged_safety_checks", "serializationOptions": { "json": { "name": "acknowledged_safety_checks" } }, "isHttpMetadata": false }, { "$id": "4940", "kind": "property", "name": "output", "serializedName": "output", "type": { "$id": "4941", "kind": "model", "name": "ComputerToolCallOutputItemOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutput", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4942", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "598" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutput.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4942" } ], "discriminatedSubtypes": { "computer_screenshot": { "$id": "4943", "kind": "model", "name": "ComputerToolCallOutputItemOutputComputerScreenshot", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot", "usage": "Input,Output,Json", "discriminatorValue": "computer_screenshot", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4941" }, "properties": [ { "$id": "4944", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4945", "kind": "enumvalue", "name": "screenshot", "value": "computer_screenshot", "valueType": { "$ref": "599" }, "enumType": { "$id": "4946", "kind": "enum", "decorators": [], "doc": "A computer screenshot image used with the computer use tool.", "name": "ComputerToolCallOutputItemOutputType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4947", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4948", "kind": "enumvalue", "decorators": [], "name": "screenshot", "value": "computer_screenshot", "valueType": { "$ref": "4947" }, "enumType": { "$ref": "4946" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4949", "kind": "property", "name": "image_url", "serializedName": "image_url", "type": { "$id": "4950", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false }, { "$id": "4951", "kind": "property", "name": "file_id", "serializedName": "file_id", "type": { "$id": "4952", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemParam.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "web_search_call": { "$id": "4953", "kind": "model", "name": "WebSearchToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemParam", "usage": "Input,Json", "doc": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.\n", "discriminatorValue": "web_search_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4954", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4955", "kind": "enumvalue", "name": "web_search_call", "value": "web_search_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "function_call": { "$id": "4956", "kind": "model", "name": "FunctionToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemParam", "usage": "Input,Json", "doc": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.\n", "discriminatorValue": "function_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4957", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4958", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4959", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the function tool call generated by the model.", "type": { "$id": "4960", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemParam.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "4961", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to run.", "type": { "$id": "4962", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemParam.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "4963", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "A JSON string of the arguments to pass to the function.", "type": { "$id": "4964", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemParam.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "reasoning": { "$id": "4965", "kind": "model", "name": "ReasoningItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ReasoningItemParam", "usage": "Input,Json", "doc": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).\n", "discriminatorValue": "reasoning", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4966", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4967", "kind": "enumvalue", "name": "reasoning", "value": "reasoning", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4968", "kind": "property", "name": "encrypted_content", "serializedName": "encrypted_content", "doc": "The encrypted content of the reasoning item - populated when a response is\ngenerated with `reasoning.encrypted_content` in the `include` parameter.", "type": { "$id": "4969", "kind": "nullable", "type": { "$id": "4970", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemParam.encrypted_content", "serializationOptions": { "json": { "name": "encrypted_content" } }, "isHttpMetadata": false }, { "$id": "4971", "kind": "property", "name": "summary", "serializedName": "summary", "doc": "Reasoning text contents.", "type": { "$id": "4972", "kind": "array", "name": "ArrayReasoningItemSummaryPart", "valueType": { "$id": "4973", "kind": "model", "name": "ReasoningItemSummaryPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryPart", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "4974", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "601" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "4974" } ], "discriminatedSubtypes": { "summary_text": { "$id": "4975", "kind": "model", "name": "ReasoningItemSummaryTextPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryTextPart", "usage": "Input,Output,Json", "discriminatorValue": "summary_text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4973" }, "properties": [ { "$id": "4976", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4977", "kind": "enumvalue", "name": "summary_text", "value": "summary_text", "valueType": { "$ref": "602" }, "enumType": { "$id": "4978", "kind": "enum", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "name": "ReasoningItemSummaryPartType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "4979", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "4980", "kind": "enumvalue", "decorators": [], "name": "summary_text", "value": "summary_text", "valueType": { "$ref": "4979" }, "enumType": { "$ref": "4978" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryPartType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryTextPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4981", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "4982", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemSummaryTextPart.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemParam.summary", "serializationOptions": { "json": { "name": "summary" } }, "isHttpMetadata": false } ] }, "item_reference": { "$id": "4983", "kind": "model", "name": "ItemReferenceItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemReferenceItemParam", "usage": "Input,Json", "doc": "An internal identifier for an item to reference.", "discriminatorValue": "item_reference", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4984", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4985", "kind": "enumvalue", "name": "item_reference", "value": "item_reference", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemReferenceItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4986", "kind": "property", "name": "id", "serializedName": "id", "doc": "The service-originated ID of the previously generated response item being referenced.", "type": { "$id": "4987", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemReferenceItemParam.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ] }, "image_generation_call": { "$id": "4988", "kind": "model", "name": "ImageGenToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemParam", "usage": "Input,Json", "doc": "An image generation request made by the model.\n", "discriminatorValue": "image_generation_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4989", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4990", "kind": "enumvalue", "name": "image_generation_call", "value": "image_generation_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4991", "kind": "property", "name": "result", "serializedName": "result", "doc": "The generated image encoded in base64.", "type": { "$id": "4992", "kind": "nullable", "type": { "$id": "4993", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemParam.result", "serializationOptions": { "json": { "name": "result" } }, "isHttpMetadata": false } ] }, "code_interpreter_call": { "$id": "4994", "kind": "model", "name": "CodeInterpreterToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemParam", "usage": "Input,Json", "doc": "A tool call to run code.\n", "discriminatorValue": "code_interpreter_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "4995", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "4996", "kind": "enumvalue", "name": "code_interpreter_call", "value": "code_interpreter_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "4997", "kind": "property", "name": "container_id", "serializedName": "container_id", "doc": "The ID of the container used to run the code.", "type": { "$id": "4998", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemParam.container_id", "serializationOptions": { "json": { "name": "container_id" } }, "isHttpMetadata": false }, { "$id": "4999", "kind": "property", "name": "code", "serializedName": "code", "doc": "The code to run.", "type": { "$id": "5000", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemParam.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "5001", "kind": "property", "name": "outputs", "serializedName": "outputs", "doc": "The outputs of the code interpreter tool call.", "type": { "$id": "5002", "kind": "array", "name": "ArrayCodeInterpreterToolOutput", "valueType": { "$id": "5003", "kind": "model", "name": "CodeInterpreterToolOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolOutput", "usage": "Input,Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "5004", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output.", "type": { "$ref": "604" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolOutput.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "5004" } ], "discriminatedSubtypes": { "logs": { "$id": "5005", "kind": "model", "name": "CodeInterpreterToolLogsOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolLogsOutput", "usage": "Input,Output,Json", "discriminatorValue": "logs", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5003" }, "properties": [ { "$id": "5006", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output. Always 'logs'.", "type": { "$id": "5007", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "605" }, "enumType": { "$id": "5008", "kind": "enum", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "name": "CodeInterpreterToolOutputType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "5009", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "5010", "kind": "enumvalue", "decorators": [], "name": "logs", "value": "logs", "valueType": { "$ref": "5009" }, "enumType": { "$ref": "5008" } }, { "$id": "5011", "kind": "enumvalue", "decorators": [], "name": "image", "value": "image", "valueType": { "$ref": "5009" }, "enumType": { "$ref": "5008" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolOutputType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolLogsOutput.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5012", "kind": "property", "name": "logs", "serializedName": "logs", "doc": "The logs output from the code interpreter.", "type": { "$id": "5013", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolLogsOutput.logs", "serializationOptions": { "json": { "name": "logs" } }, "isHttpMetadata": false } ] }, "image": { "$id": "5014", "kind": "model", "name": "CodeInterpreterToolImageOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolImageOutput", "usage": "Input,Output,Json", "discriminatorValue": "image", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5003" }, "properties": [ { "$id": "5015", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the output. Always 'image'.", "type": { "$id": "5016", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "605" }, "enumType": { "$ref": "5008" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolImageOutput.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5017", "kind": "property", "name": "ImageUri", "serializedName": "url", "doc": "The URL of the image output from the code interpreter.", "type": { "$id": "5018", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolImageOutput.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemParam.outputs", "serializationOptions": { "json": { "name": "outputs" } }, "isHttpMetadata": false } ] }, "local_shell_call": { "$id": "5019", "kind": "model", "name": "LocalShellToolCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemParam", "usage": "Input,Json", "doc": "A tool call to run a command on the local shell.\n", "discriminatorValue": "local_shell_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5020", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5021", "kind": "enumvalue", "name": "local_shell_call", "value": "local_shell_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5022", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the local shell tool call generated by the model.", "type": { "$id": "5023", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemParam.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5024", "kind": "property", "name": "action", "serializedName": "action", "type": { "$id": "5025", "kind": "model", "name": "LocalShellExecAction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction", "usage": "Input,Output,Json", "doc": "Execute a shell command on the server.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5026", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the local shell action. Always `exec`.", "type": { "$ref": "1605" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5027", "kind": "property", "name": "command", "serializedName": "command", "doc": "The command to run.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.command", "serializationOptions": { "json": { "name": "command" } }, "isHttpMetadata": false }, { "$id": "5028", "kind": "property", "name": "timeout_ms", "serializedName": "timeout_ms", "doc": "Optional timeout in milliseconds for the command.", "type": { "$id": "5029", "kind": "nullable", "type": { "$id": "5030", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.timeout_ms", "serializationOptions": { "json": { "name": "timeout_ms" } }, "isHttpMetadata": false }, { "$id": "5031", "kind": "property", "name": "working_directory", "serializedName": "working_directory", "doc": "Optional working directory to run the command in.", "type": { "$id": "5032", "kind": "nullable", "type": { "$id": "5033", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.working_directory", "serializationOptions": { "json": { "name": "working_directory" } }, "isHttpMetadata": false }, { "$id": "5034", "kind": "property", "name": "env", "serializedName": "env", "doc": "Environment variables to set for the command.", "type": { "$ref": "2380" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.env", "serializationOptions": { "json": { "name": "env" } }, "isHttpMetadata": false }, { "$id": "5035", "kind": "property", "name": "user", "serializedName": "user", "doc": "Optional user to run the command as.", "type": { "$id": "5036", "kind": "nullable", "type": { "$id": "5037", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellExecAction.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemParam.action", "serializationOptions": { "json": { "name": "action" } }, "isHttpMetadata": false } ] }, "local_shell_call_output": { "$id": "5038", "kind": "model", "name": "LocalShellToolCallOutputItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemParam", "usage": "Input,Json", "doc": "The output of a local shell tool call.\n", "discriminatorValue": "local_shell_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5039", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5040", "kind": "enumvalue", "name": "local_shell_call_output", "value": "local_shell_call_output", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5041", "kind": "property", "name": "output", "serializedName": "output", "doc": "A JSON string of the output of the local shell tool call.", "type": { "$id": "5042", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemParam.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "mcp_list_tools": { "$id": "5043", "kind": "model", "name": "MCPListToolsItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemParam", "usage": "Input,Json", "doc": "A list of tools available on an MCP server.\n", "discriminatorValue": "mcp_list_tools", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5044", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5045", "kind": "enumvalue", "name": "mcp_list_tools", "value": "mcp_list_tools", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5046", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server.", "type": { "$id": "5047", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemParam.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5048", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "The tools available on the server.", "type": { "$id": "5049", "kind": "array", "name": "ArrayMcpListToolsTool", "valueType": { "$id": "5050", "kind": "model", "name": "MCPListToolsTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPListToolsTool", "usage": "Input,Output,Json", "doc": "A tool available on an MCP server.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5051", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the tool.", "type": { "$id": "5052", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsTool.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5053", "kind": "property", "name": "description", "serializedName": "description", "doc": "The description of the tool.", "type": { "$id": "5054", "kind": "nullable", "type": { "$id": "5055", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsTool.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "5056", "kind": "property", "name": "input_schema", "serializedName": "input_schema", "doc": "The JSON schema describing the tool's input.", "type": { "$id": "5057", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsTool.input_schema", "serializationOptions": { "json": { "name": "input_schema" } }, "isHttpMetadata": false }, { "$id": "5058", "kind": "property", "name": "annotations", "serializedName": "annotations", "doc": "Additional annotations about the tool.", "type": { "$id": "5059", "kind": "nullable", "type": { "$id": "5060", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsTool.annotations", "serializationOptions": { "json": { "name": "annotations" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemParam.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "5061", "kind": "property", "name": "error", "serializedName": "error", "doc": "Error message if the server could not list tools.", "type": { "$id": "5062", "kind": "nullable", "type": { "$id": "5063", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemParam.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "mcp_approval_request": { "$id": "5064", "kind": "model", "name": "MCPApprovalRequestItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemParam", "usage": "Input,Json", "doc": "A request for human approval of a tool invocation.\n", "discriminatorValue": "mcp_approval_request", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5065", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5066", "kind": "enumvalue", "name": "mcp_approval_request", "value": "mcp_approval_request", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5067", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server making the request.", "type": { "$id": "5068", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemParam.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5069", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the tool to run.", "type": { "$id": "5070", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemParam.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5071", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "A JSON string of arguments for the tool.", "type": { "$id": "5072", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemParam.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "mcp_approval_response": { "$id": "5073", "kind": "model", "name": "MCPApprovalResponseItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemParam", "usage": "Input,Json", "doc": "A response to an MCP approval request.\n", "discriminatorValue": "mcp_approval_response", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5074", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5075", "kind": "enumvalue", "name": "mcp_approval_response", "value": "mcp_approval_response", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5076", "kind": "property", "name": "approval_request_id", "serializedName": "approval_request_id", "doc": "The ID of the approval request being answered.", "type": { "$id": "5077", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemParam.approval_request_id", "serializationOptions": { "json": { "name": "approval_request_id" } }, "isHttpMetadata": false }, { "$id": "5078", "kind": "property", "name": "approve", "serializedName": "approve", "doc": "Whether the request was approved.", "type": { "$id": "5079", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemParam.approve", "serializationOptions": { "json": { "name": "approve" } }, "isHttpMetadata": false }, { "$id": "5080", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "Optional reason for the decision.", "type": { "$id": "5081", "kind": "nullable", "type": { "$id": "5082", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemParam.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false } ] }, "mcp_call": { "$id": "5083", "kind": "model", "name": "MCPCallItemParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam", "usage": "Input,Json", "doc": "An invocation of a tool on an MCP server.\n", "discriminatorValue": "mcp_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "4777" }, "properties": [ { "$id": "5084", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5085", "kind": "enumvalue", "name": "mcp_call", "value": "mcp_call", "valueType": { "$ref": "556" }, "enumType": { "$ref": "4783" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5086", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server running the tool.", "type": { "$id": "5087", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5088", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the tool that was run.", "type": { "$id": "5089", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5090", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "A JSON string of the arguments passed to the tool.", "type": { "$id": "5091", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false }, { "$id": "5092", "kind": "property", "name": "output", "serializedName": "output", "doc": "The output from the tool call.", "type": { "$id": "5093", "kind": "nullable", "type": { "$id": "5094", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false }, { "$id": "5095", "kind": "property", "name": "error", "serializedName": "error", "doc": "The error from the tool call, if any.", "type": { "$id": "5096", "kind": "nullable", "type": { "$id": "5097", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemParam.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] } } } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "5098", "kind": "property", "name": "include", "serializedName": "include", "doc": "Specify additional output data to include in the model response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning\n tokens in reasoning item outputs. This enables reasoning items to be used in\n multi-turn conversations when using the Responses API statelessly (like\n when the `store` parameter is set to `false`, or when an organization is\n enrolled in the zero data retention program).\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution\n in code interpreter tool call items.", "type": { "$id": "5099", "kind": "nullable", "type": { "$id": "5100", "kind": "array", "name": "ArrayIncludable", "valueType": { "$ref": "608" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.include", "serializationOptions": { "json": { "name": "include" } }, "isHttpMetadata": false }, { "$id": "5101", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "doc": "Whether to allow the model to run tool calls in parallel.", "type": { "$id": "5102", "kind": "nullable", "type": { "$id": "5103", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "5104", "kind": "property", "name": "store", "serializedName": "store", "doc": "Whether to store the generated model response for later retrieval via\nAPI.", "type": { "$id": "5105", "kind": "nullable", "type": { "$id": "5106", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.store", "serializationOptions": { "json": { "name": "store" } }, "isHttpMetadata": false }, { "$id": "5107", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.", "type": { "$id": "5108", "kind": "nullable", "type": { "$id": "5109", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false }, { "$id": "5110", "kind": "property", "name": "conversation", "serializedName": "conversation", "doc": "The conversation that this response belongs to.\nItems from this conversation are prepended to input_items for this response request.\nInput items and output items from this response are automatically added to this conversation after this response completes.", "type": { "$id": "5111", "kind": "model", "name": "ConversationParam-2", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ConversationParam-2", "usage": "Input,Output,Json", "doc": "The conversation that this response belongs to.", "summary": "Conversation object", "decorators": [], "properties": [ { "$id": "5112", "kind": "property", "name": "id", "serializedName": "id", "doc": "The unique ID of the conversation.", "type": { "$id": "5113", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationParam-2.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateResponse.conversation", "serializationOptions": { "json": { "name": "conversation" } }, "isHttpMetadata": false } ] }, { "$ref": "4581" }, { "$ref": "4601" }, { "$ref": "4606" }, { "$ref": "4608" }, { "$ref": "4620" }, { "$ref": "4623" }, { "$ref": "4626" }, { "$ref": "4629" }, { "$ref": "4632" }, { "$ref": "4635" }, { "$ref": "4647" }, { "$ref": "4652" }, { "$ref": "4654" }, { "$ref": "4669" }, { "$ref": "4676" }, { "$ref": "4681" }, { "$ref": "4686" }, { "$ref": "4696" }, { "$ref": "4706" }, { "$ref": "4713" }, { "$ref": "4715" }, { "$ref": "4730" }, { "$ref": "4741" }, { "$ref": "4754" }, { "$ref": "4763" }, { "$ref": "4771" }, { "$ref": "4777" }, { "$ref": "4779" }, { "$ref": "4802" }, { "$ref": "4812" }, { "$ref": "4816" }, { "$ref": "4820" }, { "$ref": "4824" }, { "$ref": "4831" }, { "$ref": "4838" }, { "$ref": "4848" }, { "$ref": "4854" }, { "$ref": "4856" }, { "$ref": "4875" }, { "$ref": "4882" }, { "$ref": "4887" }, { "$ref": "4892" }, { "$ref": "4899" }, { "$ref": "4902" }, { "$ref": "4913" }, { "$ref": "4918" }, { "$ref": "4921" }, { "$ref": "4927" }, { "$ref": "4934" }, { "$ref": "4941" }, { "$ref": "4943" }, { "$ref": "4953" }, { "$ref": "4956" }, { "$ref": "4965" }, { "$ref": "4973" }, { "$ref": "4975" }, { "$ref": "4983" }, { "$ref": "4988" }, { "$ref": "4994" }, { "$ref": "5003" }, { "$ref": "5005" }, { "$ref": "5014" }, { "$ref": "5019" }, { "$ref": "5025" }, { "$ref": "5038" }, { "$ref": "5043" }, { "$ref": "5050" }, { "$ref": "5064" }, { "$ref": "5073" }, { "$ref": "5083" }, { "$ref": "5111" }, { "$id": "5114", "kind": "model", "name": "Response", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Response", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5115", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "5116", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", "type": { "$id": "5117", "kind": "nullable", "type": { "$id": "5118", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "5119", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "doc": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.", "type": { "$id": "5120", "kind": "nullable", "type": { "$id": "5121", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false }, { "$id": "5122", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$id": "5123", "kind": "nullable", "type": { "$id": "5124", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "5125", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "5126", "kind": "nullable", "type": { "$id": "5127", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false }, { "$id": "5128", "kind": "property", "name": "safety_identifier", "serializedName": "safety_identifier", "doc": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).", "type": { "$id": "5129", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.safety_identifier", "serializationOptions": { "json": { "name": "safety_identifier" } }, "isHttpMetadata": false }, { "$id": "5130", "kind": "property", "name": "service_tier", "serializedName": "service_tier", "type": { "$ref": "497" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.service_tier", "serializationOptions": { "json": { "name": "service_tier" } }, "isHttpMetadata": false }, { "$id": "5131", "kind": "property", "name": "previous_response_id", "serializedName": "previous_response_id", "doc": "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](/docs/guides/conversation-state).", "type": { "$ref": "4575" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.previous_response_id", "serializationOptions": { "json": { "name": "previous_response_id" } }, "isHttpMetadata": false }, { "$id": "5132", "kind": "property", "name": "model", "serializedName": "model", "doc": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.", "type": { "$id": "5133", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "5134", "kind": "property", "name": "reasoning", "serializedName": "reasoning", "type": { "$ref": "4580" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.reasoning", "serializationOptions": { "json": { "name": "reasoning" } }, "isHttpMetadata": false }, { "$id": "5135", "kind": "property", "name": "background", "serializedName": "background", "doc": "Whether to run the model response in the background.\n[Learn more](/docs/guides/background).", "type": { "$ref": "4589" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.background", "serializationOptions": { "json": { "name": "background" } }, "isHttpMetadata": false }, { "$id": "5136", "kind": "property", "name": "max_output_tokens", "serializedName": "max_output_tokens", "doc": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).", "type": { "$ref": "4592" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.max_output_tokens", "serializationOptions": { "json": { "name": "max_output_tokens" } }, "isHttpMetadata": false }, { "$id": "5137", "kind": "property", "name": "max_tool_calls", "serializedName": "max_tool_calls", "doc": "The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.", "type": { "$ref": "4595" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.max_tool_calls", "serializationOptions": { "json": { "name": "max_tool_calls" } }, "isHttpMetadata": false }, { "$id": "5138", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "Inserts a system (or developer) message as the first item in the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.", "type": { "$ref": "4598" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "5139", "kind": "property", "name": "text", "serializedName": "text", "doc": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)", "type": { "$ref": "4601" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "5140", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code. Learn more about\n [function calling](/docs/guides/function-calling).", "type": { "$ref": "4283" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "5141", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "doc": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.", "type": { "$ref": "4605" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "5142", "kind": "property", "name": "truncation", "serializedName": "truncation", "doc": "The truncation strategy to use for the model response.\n- `auto`: If the context of this response and previous ones exceeds\n the model's context window size, the model will truncate the\n response to fit the context window by dropping input items in the\n middle of the conversation.\n- `disabled` (default): If a model response will exceed the context window\n size for a model, the request will fail with a 400 error.", "type": { "$ref": "4641" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.truncation", "serializationOptions": { "json": { "name": "truncation" } }, "isHttpMetadata": false }, { "$id": "5143", "kind": "property", "name": "id", "serializedName": "id", "doc": "Unique identifier for this Response.", "type": { "$id": "5144", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "5145", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type of this resource - always set to `response`.", "type": { "$ref": "1607" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "5146", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the response generation. One of `completed`, `failed`,\n`in_progress`, `cancelled`, `queued`, or `incomplete`.", "type": { "$ref": "615" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5147", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "Unix timestamp (in seconds) of when this Response was created.", "type": { "$id": "5148", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "5149", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "5150", "kind": "property", "name": "error", "serializedName": "error", "type": { "$id": "5151", "kind": "nullable", "type": { "$id": "5152", "kind": "model", "name": "ResponseError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseError", "usage": "Output,Json,Exception", "doc": "An error object returned when the model fails to generate a Response.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5153", "kind": "property", "name": "code", "serializedName": "code", "type": { "$ref": "623" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseError.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "5154", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable description of the error.", "type": { "$id": "5155", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseError.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false }, { "$id": "5156", "kind": "property", "name": "incomplete_details", "serializedName": "incomplete_details", "doc": "Details about why the response is incomplete.", "type": { "$id": "5157", "kind": "nullable", "type": { "$id": "5158", "kind": "model", "name": "ResponseIncompleteDetails1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Response.incomplete_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "5159", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "The reason why the response is incomplete.", "type": { "$ref": "643" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.incomplete_details.anonymous.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.incomplete_details", "serializationOptions": { "json": { "name": "incomplete_details" } }, "isHttpMetadata": false }, { "$id": "5160", "kind": "property", "name": "output", "serializedName": "output", "doc": "An array of content items generated by the model.\n\n- The length and order of items in the `output` array is dependent\n on the model's response.\n- Rather than accessing the first item in the `output` array and\n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs.", "type": { "$id": "5161", "kind": "array", "name": "ArrayItemResource", "valueType": { "$id": "5162", "kind": "model", "name": "ItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ItemResource", "usage": "Input,Output,Json", "doc": "Content item used to generate a response.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "5163", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "555" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "5163" }, { "$id": "5164", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "5165", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ItemResource.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "message": { "$id": "5166", "kind": "model", "name": "ResponsesMessageItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemResource", "usage": "Input,Output,Json", "doc": "A response message resource item, representing a role and content, as provided on service responses.", "discriminatorValue": "message", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "5167", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role associated with the message.", "type": { "$ref": "574" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemResource.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5168", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the responses item, which is always 'message'.", "type": { "$ref": "4782" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5169", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "647" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesMessageItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$ref": "5167" } ], "discriminatedSubtypes": { "user": { "$id": "5170", "kind": "model", "name": "ResponsesUserMessageItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemResource", "usage": "Input,Output,Json", "doc": "A message resource item with the `user` role.", "discriminatorValue": "user", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5166" }, "properties": [ { "$id": "5171", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `user`.", "type": { "$ref": "4804" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemResource.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "5172", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesUserMessageItemResource.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "system": { "$id": "5173", "kind": "model", "name": "ResponsesSystemMessageItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemResource", "usage": "Input,Output,Json", "doc": "A message resource item with the `system` role.", "discriminatorValue": "system", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5166" }, "properties": [ { "$id": "5174", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `system`.", "type": { "$ref": "4814" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemResource.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "5175", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesSystemMessageItemResource.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "developer": { "$id": "5176", "kind": "model", "name": "ResponsesDeveloperMessageItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemResource", "usage": "Input,Output,Json", "doc": "A message resource item with the `developer` role.", "discriminatorValue": "developer", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5166" }, "properties": [ { "$id": "5177", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `developer`.", "type": { "$ref": "4818" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemResource.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "5178", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesDeveloperMessageItemResource.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "assistant": { "$id": "5179", "kind": "model", "name": "ResponsesAssistantMessageItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemResource", "usage": "Input,Output,Json", "doc": "A message resource item with the `assistant` role.", "discriminatorValue": "assistant", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5166" }, "properties": [ { "$id": "5180", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the message, which is always `assistant`.", "type": { "$ref": "4822" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemResource.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "5181", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content associated with the message.", "type": { "$ref": "4651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponsesAssistantMessageItemResource.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] } } }, "computer_call_output": { "$id": "5182", "kind": "model", "name": "ComputerToolCallOutputItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource", "usage": "Input,Output,Json", "doc": "The output of a computer tool call.\n", "discriminatorValue": "computer_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5183", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4936" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5184", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "652" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5185", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The ID of the computer tool call that produced the output.", "type": { "$id": "5186", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5187", "kind": "property", "name": "acknowledged_safety_checks", "serializedName": "acknowledged_safety_checks", "doc": "The safety checks reported by the API that have been acknowledged by the\ndeveloper.", "type": { "$ref": "4926" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.acknowledged_safety_checks", "serializationOptions": { "json": { "name": "acknowledged_safety_checks" } }, "isHttpMetadata": false }, { "$id": "5188", "kind": "property", "name": "output", "serializedName": "output", "type": { "$ref": "4941" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallOutputItemResource.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "function_call": { "$id": "5189", "kind": "model", "name": "FunctionToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource", "usage": "Input,Output,Json", "doc": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.\n", "discriminatorValue": "function_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5190", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4958" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5191", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "657" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5192", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the function tool call generated by the model.", "type": { "$id": "5193", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5194", "kind": "property", "name": "FunctionName", "serializedName": "name", "doc": "The name of the function to run.", "type": { "$id": "5195", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5196", "kind": "property", "name": "FunctionArguments", "serializedName": "arguments", "doc": "A JSON string of the arguments to pass to the function.", "type": { "$id": "5197", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallItemResource.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "function_call_output": { "$id": "5198", "kind": "model", "name": "FunctionToolCallOutputItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource", "usage": "Input,Output,Json", "doc": "The output of a function tool call.\n", "discriminatorValue": "function_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5199", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4826" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5200", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "662" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5201", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the function tool call generated by the model.", "type": { "$id": "5202", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5203", "kind": "property", "name": "FunctionOutput", "serializedName": "output", "doc": "A JSON string of the output of the function tool call.", "type": { "$id": "5204", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FunctionToolCallOutputItemResource.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "mcp_approval_response": { "$id": "5205", "kind": "model", "name": "MCPApprovalResponseItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemResource", "usage": "Input,Output,Json", "doc": "A response to an MCP approval request.\n", "discriminatorValue": "mcp_approval_response", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5206", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5075" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5207", "kind": "property", "name": "approval_request_id", "serializedName": "approval_request_id", "doc": "The ID of the approval request being answered.", "type": { "$id": "5208", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemResource.approval_request_id", "serializationOptions": { "json": { "name": "approval_request_id" } }, "isHttpMetadata": false }, { "$id": "5209", "kind": "property", "name": "Approved", "serializedName": "approve", "doc": "Whether the request was approved.", "type": { "$id": "5210", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemResource.approve", "serializationOptions": { "json": { "name": "approve" } }, "isHttpMetadata": false }, { "$id": "5211", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "Optional reason for the decision.", "type": { "$ref": "5081" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalResponseItemResource.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false } ] }, "file_search_call": { "$id": "5212", "kind": "model", "name": "FileSearchToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource", "usage": "Input,Output,Json", "doc": "The results of a file search tool call. See the\n[file search guide](/docs/guides/tools-file-search) for more information.\n", "discriminatorValue": "file_search_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5213", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4833" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5214", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the file search tool call. One of `in_progress`, \n`searching`, `incomplete` or `failed`,", "type": { "$ref": "667" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5215", "kind": "property", "name": "queries", "serializedName": "queries", "doc": "The queries used to search for files.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.queries", "serializationOptions": { "json": { "name": "queries" } }, "isHttpMetadata": false }, { "$id": "5216", "kind": "property", "name": "results", "serializedName": "results", "doc": "The results of the file search tool call.", "type": { "$ref": "4836" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FileSearchToolCallItemResource.results", "serializationOptions": { "json": { "name": "results" } }, "isHttpMetadata": false } ] }, "computer_call": { "$id": "5217", "kind": "model", "name": "ComputerToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource", "usage": "Input,Output,Json", "doc": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.\n", "discriminatorValue": "computer_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5218", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4850" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5219", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "674" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5220", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "An identifier used when responding to the tool call with output.", "type": { "$id": "5221", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5222", "kind": "property", "name": "action", "serializedName": "action", "type": { "$ref": "4854" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.action", "serializationOptions": { "json": { "name": "action" } }, "isHttpMetadata": false }, { "$id": "5223", "kind": "property", "name": "pending_safety_checks", "serializedName": "pending_safety_checks", "doc": "The pending safety checks for the computer call.", "type": { "$ref": "4926" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ComputerToolCallItemResource.pending_safety_checks", "serializationOptions": { "json": { "name": "pending_safety_checks" } }, "isHttpMetadata": false } ] }, "web_search_call": { "$id": "5224", "kind": "model", "name": "WebSearchToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemResource", "usage": "Input,Output,Json", "doc": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.\n", "discriminatorValue": "web_search_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5225", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4955" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5226", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the web search tool call.", "type": { "$ref": "679" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.WebSearchToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false } ] }, "reasoning": { "$id": "5227", "kind": "model", "name": "ReasoningItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource", "usage": "Input,Output,Json", "doc": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).\n", "discriminatorValue": "reasoning", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5228", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4967" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5229", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.", "type": { "$ref": "685" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5230", "kind": "property", "name": "encrypted_content", "serializedName": "encrypted_content", "doc": "The encrypted content of the reasoning item - populated when a response is\ngenerated with `reasoning.encrypted_content` in the `include` parameter.", "type": { "$ref": "4969" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource.encrypted_content", "serializationOptions": { "json": { "name": "encrypted_content" } }, "isHttpMetadata": false }, { "$id": "5231", "kind": "property", "name": "SummaryParts", "serializedName": "summary", "doc": "Reasoning text contents.", "type": { "$ref": "4972" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ReasoningItemResource.summary", "serializationOptions": { "json": { "name": "summary" } }, "isHttpMetadata": false } ] }, "image_generation_call": { "$id": "5232", "kind": "model", "name": "ImageGenToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemResource", "usage": "Input,Output,Json", "doc": "An image generation request made by the model.\n", "discriminatorValue": "image_generation_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5233", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4990" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5234", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "690" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5235", "kind": "property", "name": "ImageResultBytes", "serializedName": "result", "doc": "The generated image encoded in base64.", "type": { "$ref": "4992" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImageGenToolCallItemResource.result", "serializationOptions": { "json": { "name": "result" } }, "isHttpMetadata": false } ] }, "code_interpreter_call": { "$id": "5236", "kind": "model", "name": "CodeInterpreterToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource", "usage": "Input,Output,Json", "doc": "A tool call to run code.\n", "discriminatorValue": "code_interpreter_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5237", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4996" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5238", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "696" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5239", "kind": "property", "name": "container_id", "serializedName": "container_id", "doc": "The ID of the container used to run the code.", "type": { "$id": "5240", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.container_id", "serializationOptions": { "json": { "name": "container_id" } }, "isHttpMetadata": false }, { "$id": "5241", "kind": "property", "name": "code", "serializedName": "code", "doc": "The code to run.", "type": { "$id": "5242", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "5243", "kind": "property", "name": "outputs", "serializedName": "outputs", "doc": "The outputs of the code interpreter tool call.", "type": { "$ref": "5002" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CodeInterpreterToolCallItemResource.outputs", "serializationOptions": { "json": { "name": "outputs" } }, "isHttpMetadata": false } ] }, "local_shell_call": { "$id": "5244", "kind": "model", "name": "LocalShellToolCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource", "usage": "Input,Output,Json", "doc": "A tool call to run a command on the local shell.\n", "discriminatorValue": "local_shell_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5245", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5021" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5246", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "701" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5247", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The unique ID of the local shell tool call generated by the model.", "type": { "$id": "5248", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "5249", "kind": "property", "name": "action", "serializedName": "action", "type": { "$ref": "5025" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallItemResource.action", "serializationOptions": { "json": { "name": "action" } }, "isHttpMetadata": false } ] }, "local_shell_call_output": { "$id": "5250", "kind": "model", "name": "LocalShellToolCallOutputItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemResource", "usage": "Input,Output,Json", "doc": "The output of a local shell tool call.\n", "discriminatorValue": "local_shell_call_output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5251", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5040" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5252", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "706" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemResource.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "5253", "kind": "property", "name": "output", "serializedName": "output", "doc": "A JSON string of the output of the local shell tool call.", "type": { "$id": "5254", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LocalShellToolCallOutputItemResource.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "mcp_list_tools": { "$id": "5255", "kind": "model", "name": "MCPListToolsItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemResource", "usage": "Input,Output,Json", "doc": "A list of tools available on an MCP server.\n", "discriminatorValue": "mcp_list_tools", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5256", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5045" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5257", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server.", "type": { "$id": "5258", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemResource.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5259", "kind": "property", "name": "ToolDefinitions", "serializedName": "tools", "doc": "The tools available on the server.", "type": { "$ref": "5049" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemResource.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "5260", "kind": "property", "name": "error", "serializedName": "error", "doc": "Error message if the server could not list tools.", "type": { "$id": "5261", "kind": "nullable", "type": { "$id": "5262", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "namespace": "" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPListToolsItemResource.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "mcp_approval_request": { "$id": "5263", "kind": "model", "name": "MCPApprovalRequestItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemResource", "usage": "Input,Output,Json", "doc": "A request for human approval of a tool invocation.\n", "discriminatorValue": "mcp_approval_request", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5264", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5066" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5265", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server making the request.", "type": { "$id": "5266", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemResource.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5267", "kind": "property", "name": "ToolName", "serializedName": "name", "doc": "The name of the tool to run.", "type": { "$id": "5268", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5269", "kind": "property", "name": "ToolArguments", "serializedName": "arguments", "doc": "A JSON string of arguments for the tool.", "type": { "$id": "5270", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPApprovalRequestItemResource.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "mcp_call": { "$id": "5271", "kind": "model", "name": "MCPCallItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource", "usage": "Input,Output,Json", "doc": "An invocation of a tool on an MCP server.\n", "discriminatorValue": "mcp_call", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5272", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "5085" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5273", "kind": "property", "name": "server_label", "serializedName": "server_label", "doc": "The label of the MCP server running the tool.", "type": { "$id": "5274", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.server_label", "serializationOptions": { "json": { "name": "server_label" } }, "isHttpMetadata": false }, { "$id": "5275", "kind": "property", "name": "ToolName", "serializedName": "name", "doc": "The name of the tool that was run.", "type": { "$id": "5276", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "5277", "kind": "property", "name": "ToolArguments", "serializedName": "arguments", "doc": "A JSON string of the arguments passed to the tool.", "type": { "$id": "5278", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false }, { "$id": "5279", "kind": "property", "name": "ToolOutput", "serializedName": "output", "doc": "The output from the tool call.", "type": { "$ref": "5093" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false }, { "$id": "5280", "kind": "property", "name": "error", "serializedName": "error", "doc": "The error from the tool call, if any.", "type": { "$id": "5281", "kind": "nullable", "type": { "$id": "5282", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "namespace": "" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MCPCallItemResource.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "item_reference": { "$id": "5283", "kind": "model", "name": "DotNetItemReferenceItemResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetItemReferenceItemResource", "access": "public", "usage": "Input,Output,Json", "discriminatorValue": "item_reference", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5162" }, "properties": [ { "$id": "5284", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "4985" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetItemReferenceItemResource.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false }, { "$id": "5285", "kind": "property", "name": "output_text", "serializedName": "output_text", "doc": "SDK-only convenience property that contains the aggregated text output\nfrom all `output_text` items in the `output` array, if any are present.\nSupported in the Python and JavaScript SDKs.", "type": { "$id": "5286", "kind": "nullable", "type": { "$id": "5287", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.output_text", "serializationOptions": { "json": { "name": "output_text" } }, "isHttpMetadata": false }, { "$id": "5288", "kind": "property", "name": "usage", "serializedName": "usage", "type": { "$id": "5289", "kind": "model", "name": "ResponseUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseUsage", "usage": "Output,Json", "doc": "Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5290", "kind": "property", "name": "input_tokens", "serializedName": "input_tokens", "doc": "The number of input tokens.", "type": { "$id": "5291", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.input_tokens", "serializationOptions": { "json": { "name": "input_tokens" } }, "isHttpMetadata": false }, { "$id": "5292", "kind": "property", "name": "input_tokens_details", "serializedName": "input_tokens_details", "doc": "A detailed breakdown of the input tokens.", "type": { "$id": "5293", "kind": "model", "name": "ResponseUsageInputTokensDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseUsage.input_tokens_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "5294", "kind": "property", "name": "cached_tokens", "serializedName": "cached_tokens", "doc": "The number of tokens that were retrieved from the cache.\n[More on prompt caching](/docs/guides/prompt-caching).", "type": { "$id": "5295", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.input_tokens_details.anonymous.cached_tokens", "serializationOptions": { "json": { "name": "cached_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.input_tokens_details", "serializationOptions": { "json": { "name": "input_tokens_details" } }, "isHttpMetadata": false }, { "$id": "5296", "kind": "property", "name": "output_tokens", "serializedName": "output_tokens", "doc": "The number of output tokens.", "type": { "$id": "5297", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.output_tokens", "serializationOptions": { "json": { "name": "output_tokens" } }, "isHttpMetadata": false }, { "$id": "5298", "kind": "property", "name": "output_tokens_details", "serializedName": "output_tokens_details", "doc": "A detailed breakdown of the output tokens.", "type": { "$id": "5299", "kind": "model", "name": "ResponseUsageOutputTokensDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseUsage.output_tokens_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "5300", "kind": "property", "name": "reasoning_tokens", "serializedName": "reasoning_tokens", "doc": "The number of reasoning tokens.", "type": { "$id": "5301", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.output_tokens_details.anonymous.reasoning_tokens", "serializationOptions": { "json": { "name": "reasoning_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.output_tokens_details", "serializationOptions": { "json": { "name": "output_tokens_details" } }, "isHttpMetadata": false }, { "$id": "5302", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens used.", "type": { "$id": "5303", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseUsage.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false }, { "$id": "5304", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "doc": "Whether to allow the model to run tool calls in parallel.", "type": { "$id": "5305", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "5306", "kind": "property", "name": "conversation", "serializedName": "conversation", "doc": "The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation.", "type": { "$id": "5307", "kind": "nullable", "type": { "$ref": "5111" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Response.conversation", "serializationOptions": { "json": { "name": "conversation" } }, "isHttpMetadata": false } ] }, { "$ref": "5152" }, { "$ref": "5158" }, { "$ref": "5162" }, { "$ref": "5166" }, { "$ref": "5170" }, { "$ref": "5173" }, { "$ref": "5176" }, { "$ref": "5179" }, { "$ref": "5182" }, { "$ref": "5189" }, { "$ref": "5198" }, { "$ref": "5205" }, { "$ref": "5212" }, { "$ref": "5217" }, { "$ref": "5224" }, { "$ref": "5227" }, { "$ref": "5232" }, { "$ref": "5236" }, { "$ref": "5244" }, { "$ref": "5250" }, { "$ref": "5255" }, { "$ref": "5263" }, { "$ref": "5271" }, { "$ref": "5283" }, { "$ref": "5289" }, { "$ref": "5293" }, { "$ref": "5299" }, { "$id": "5308", "kind": "model", "name": "ResponseStreamEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseStreamEvent", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "5309", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "711" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseStreamEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "5309" }, { "$id": "5310", "kind": "property", "name": "sequence_number", "serializedName": "sequence_number", "doc": "The sequence number for this event.", "type": { "$id": "5311", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseStreamEvent.sequence_number", "serializationOptions": { "json": { "name": "sequence_number" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "response.completed": { "$id": "5312", "kind": "model", "name": "ResponseCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCompletedEvent", "usage": "Output,Json", "doc": "Emitted when the model response is complete.", "discriminatorValue": "response.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5313", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.completed`.", "type": { "$id": "5314", "kind": "enumvalue", "name": "response_completed", "value": "response.completed", "valueType": { "$ref": "712" }, "enumType": { "$id": "5315", "kind": "enum", "decorators": [], "name": "ResponseStreamEventType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "5316", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "5317", "kind": "enumvalue", "decorators": [], "name": "response_audio_delta", "value": "response.audio.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5318", "kind": "enumvalue", "decorators": [], "name": "response_audio_done", "value": "response.audio.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5319", "kind": "enumvalue", "decorators": [], "name": "response_audio_transcript_delta", "value": "response.audio_transcript.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5320", "kind": "enumvalue", "decorators": [], "name": "response_audio_transcript_done", "value": "response.audio_transcript.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5321", "kind": "enumvalue", "decorators": [], "name": "response_code_interpreter_call_code_delta", "value": "response.code_interpreter_call_code.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5322", "kind": "enumvalue", "decorators": [], "name": "response_code_interpreter_call_code_done", "value": "response.code_interpreter_call_code.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5323", "kind": "enumvalue", "decorators": [], "name": "response_code_interpreter_call_completed", "value": "response.code_interpreter_call.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5324", "kind": "enumvalue", "decorators": [], "name": "response_code_interpreter_call_in_progress", "value": "response.code_interpreter_call.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5325", "kind": "enumvalue", "decorators": [], "name": "response_code_interpreter_call_interpreting", "value": "response.code_interpreter_call.interpreting", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5326", "kind": "enumvalue", "decorators": [], "name": "response_completed", "value": "response.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5327", "kind": "enumvalue", "decorators": [], "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5328", "kind": "enumvalue", "decorators": [], "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5329", "kind": "enumvalue", "decorators": [], "name": "response_created", "value": "response.created", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5330", "kind": "enumvalue", "decorators": [], "name": "error", "value": "error", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5331", "kind": "enumvalue", "decorators": [], "name": "response_file_search_call_completed", "value": "response.file_search_call.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5332", "kind": "enumvalue", "decorators": [], "name": "response_file_search_call_in_progress", "value": "response.file_search_call.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5333", "kind": "enumvalue", "decorators": [], "name": "response_file_search_call_searching", "value": "response.file_search_call.searching", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5334", "kind": "enumvalue", "decorators": [], "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5335", "kind": "enumvalue", "decorators": [], "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5336", "kind": "enumvalue", "decorators": [], "name": "response_in_progress", "value": "response.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5337", "kind": "enumvalue", "decorators": [], "name": "response_failed", "value": "response.failed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5338", "kind": "enumvalue", "decorators": [], "name": "response_incomplete", "value": "response.incomplete", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5339", "kind": "enumvalue", "decorators": [], "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5340", "kind": "enumvalue", "decorators": [], "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5341", "kind": "enumvalue", "decorators": [], "name": "response_refusal_delta", "value": "response.refusal.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5342", "kind": "enumvalue", "decorators": [], "name": "response_refusal_done", "value": "response.refusal.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5343", "kind": "enumvalue", "decorators": [], "name": "response_output_text_annotation_added", "value": "response.output_text.annotation.added", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5344", "kind": "enumvalue", "decorators": [], "name": "response_output_text_delta", "value": "response.output_text.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5345", "kind": "enumvalue", "decorators": [], "name": "response_output_text_done", "value": "response.output_text.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5346", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_part_added", "value": "response.reasoning_summary_part.added", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5347", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_part_done", "value": "response.reasoning_summary_part.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5348", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_text_delta", "value": "response.reasoning_summary_text.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5349", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_text_done", "value": "response.reasoning_summary_text.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5350", "kind": "enumvalue", "decorators": [], "name": "response_web_search_call_completed", "value": "response.web_search_call.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5351", "kind": "enumvalue", "decorators": [], "name": "response_web_search_call_in_progress", "value": "response.web_search_call.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5352", "kind": "enumvalue", "decorators": [], "name": "response_web_search_call_searching", "value": "response.web_search_call.searching", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5353", "kind": "enumvalue", "decorators": [], "name": "response_image_generation_call_completed", "value": "response.image_generation_call.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5354", "kind": "enumvalue", "decorators": [], "name": "response_image_generation_call_generating", "value": "response.image_generation_call.generating", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5355", "kind": "enumvalue", "decorators": [], "name": "response_image_generation_call_in_progress", "value": "response.image_generation_call.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5356", "kind": "enumvalue", "decorators": [], "name": "response_image_generation_call_partial_image", "value": "response.image_generation_call.partial_image", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5357", "kind": "enumvalue", "decorators": [], "name": "response_mcp_call_arguments_delta", "value": "response.mcp_call_arguments.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5358", "kind": "enumvalue", "decorators": [], "name": "response_mcp_call_arguments_done", "value": "response.mcp_call_arguments.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5359", "kind": "enumvalue", "decorators": [], "name": "response_mcp_call_completed", "value": "response.mcp_call.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5360", "kind": "enumvalue", "decorators": [], "name": "response_mcp_call_failed", "value": "response.mcp_call.failed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5361", "kind": "enumvalue", "decorators": [], "name": "response_mcp_call_in_progress", "value": "response.mcp_call.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5362", "kind": "enumvalue", "decorators": [], "name": "response_mcp_list_tools_completed", "value": "response.mcp_list_tools.completed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5363", "kind": "enumvalue", "decorators": [], "name": "response_mcp_list_tools_failed", "value": "response.mcp_list_tools.failed", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5364", "kind": "enumvalue", "decorators": [], "name": "response_mcp_list_tools_in_progress", "value": "response.mcp_list_tools.in_progress", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5365", "kind": "enumvalue", "decorators": [], "name": "response_queued", "value": "response.queued", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5366", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_delta", "value": "response.reasoning.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5367", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_done", "value": "response.reasoning.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5368", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_delta", "value": "response.reasoning_summary.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5369", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_summary_done", "value": "response.reasoning_summary.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5370", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_text_delta", "value": "response.reasoning_text.delta", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } }, { "$id": "5371", "kind": "enumvalue", "decorators": [], "name": "response_reasoning_text_done", "value": "response.reasoning_text.done", "valueType": { "$ref": "5316" }, "enumType": { "$ref": "5315" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ResponseStreamEventType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5372", "kind": "property", "name": "response", "serializedName": "response", "doc": "Properties of the completed response.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCompletedEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.content_part.added": { "$id": "5373", "kind": "model", "name": "ResponseContentPartAddedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent", "usage": "Output,Json", "doc": "Emitted when a new content part is added.", "discriminatorValue": "response.content_part.added", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5374", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.content_part.added`.", "type": { "$id": "5375", "kind": "enumvalue", "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5376", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the content part was added to.", "type": { "$id": "5377", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5378", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the content part was added to.", "type": { "$id": "5379", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5380", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that was added.", "type": { "$id": "5381", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5382", "kind": "property", "name": "part", "serializedName": "part", "doc": "The content part that was added.", "type": { "$ref": "4652" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartAddedEvent.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.content_part.done": { "$id": "5383", "kind": "model", "name": "ResponseContentPartDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent", "usage": "Output,Json", "doc": "Emitted when a content part is done.", "discriminatorValue": "response.content_part.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5384", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.content_part.done`.", "type": { "$id": "5385", "kind": "enumvalue", "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5386", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the content part was added to.", "type": { "$id": "5387", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5388", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the content part was added to.", "type": { "$id": "5389", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5390", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that is done.", "type": { "$id": "5391", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5392", "kind": "property", "name": "part", "serializedName": "part", "doc": "The content part that is done.", "type": { "$ref": "4652" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseContentPartDoneEvent.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.created": { "$id": "5393", "kind": "model", "name": "ResponseCreatedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCreatedEvent", "usage": "Output,Json", "doc": "An event that is emitted when a response is created.", "discriminatorValue": "response.created", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5394", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.created`.", "type": { "$id": "5395", "kind": "enumvalue", "name": "response_created", "value": "response.created", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCreatedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5396", "kind": "property", "name": "response", "serializedName": "response", "doc": "The response that was created.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCreatedEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "error": { "$id": "5397", "kind": "model", "name": "ResponseErrorEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseErrorEvent", "usage": "Output,Json", "doc": "Emitted when an error occurs.", "discriminatorValue": "error", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5398", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `error`.", "type": { "$id": "5399", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseErrorEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5400", "kind": "property", "name": "code", "serializedName": "code", "doc": "The error code.", "type": { "$id": "5401", "kind": "nullable", "type": { "$id": "5402", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseErrorEvent.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "5403", "kind": "property", "name": "message", "serializedName": "message", "doc": "The error message.", "type": { "$id": "5404", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseErrorEvent.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "5405", "kind": "property", "name": "param", "serializedName": "param", "doc": "The error parameter.", "type": { "$id": "5406", "kind": "nullable", "type": { "$id": "5407", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseErrorEvent.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false } ] }, "response.file_search_call.completed": { "$id": "5408", "kind": "model", "name": "ResponseFileSearchCallCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallCompletedEvent", "usage": "Output,Json", "doc": "Emitted when a file search call is completed (results found).", "discriminatorValue": "response.file_search_call.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5409", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.file_search_call.completed`.", "type": { "$id": "5410", "kind": "enumvalue", "name": "response_file_search_call_completed", "value": "response.file_search_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5411", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the file search call is initiated.", "type": { "$id": "5412", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5413", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the file search call is initiated.", "type": { "$id": "5414", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.file_search_call.in_progress": { "$id": "5415", "kind": "model", "name": "ResponseFileSearchCallInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallInProgressEvent", "usage": "Output,Json", "doc": "Emitted when a file search call is initiated.", "discriminatorValue": "response.file_search_call.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5416", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.file_search_call.in_progress`.", "type": { "$id": "5417", "kind": "enumvalue", "name": "response_file_search_call_in_progress", "value": "response.file_search_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5418", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the file search call is initiated.", "type": { "$id": "5419", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5420", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the file search call is initiated.", "type": { "$id": "5421", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.file_search_call.searching": { "$id": "5422", "kind": "model", "name": "ResponseFileSearchCallSearchingEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallSearchingEvent", "usage": "Output,Json", "doc": "Emitted when a file search is currently searching.", "discriminatorValue": "response.file_search_call.searching", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5423", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.file_search_call.searching`.", "type": { "$id": "5424", "kind": "enumvalue", "name": "response_file_search_call_searching", "value": "response.file_search_call.searching", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallSearchingEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5425", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the file search call is searching.", "type": { "$id": "5426", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallSearchingEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5427", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the file search call is initiated.", "type": { "$id": "5428", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFileSearchCallSearchingEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.function_call_arguments.delta": { "$id": "5429", "kind": "model", "name": "ResponseFunctionCallArgumentsDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is a partial function-call arguments delta.", "discriminatorValue": "response.function_call_arguments.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5430", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.function_call_arguments.delta`.", "type": { "$id": "5431", "kind": "enumvalue", "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5432", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the function-call arguments delta is added to.", "type": { "$id": "5433", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5434", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the function-call arguments delta is added to.", "type": { "$id": "5435", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5436", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The function-call arguments delta that is added.", "type": { "$id": "5437", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.function_call_arguments.done": { "$id": "5438", "kind": "model", "name": "ResponseFunctionCallArgumentsDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDoneEvent", "usage": "Output,Json", "doc": "Emitted when function-call arguments are finalized.", "discriminatorValue": "response.function_call_arguments.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5439", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "5440", "kind": "enumvalue", "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5441", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "5442", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5443", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item.", "type": { "$id": "5444", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5445", "kind": "property", "name": "FunctionArguments", "serializedName": "arguments", "doc": "The function-call arguments.", "type": { "$id": "5446", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFunctionCallArgumentsDoneEvent.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "response.in_progress": { "$id": "5447", "kind": "model", "name": "ResponseInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseInProgressEvent", "usage": "Output,Json", "doc": "Emitted when the response is in progress.", "discriminatorValue": "response.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5448", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.in_progress`.", "type": { "$id": "5449", "kind": "enumvalue", "name": "response_in_progress", "value": "response.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5450", "kind": "property", "name": "response", "serializedName": "response", "doc": "The response that is in progress.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseInProgressEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.failed": { "$id": "5451", "kind": "model", "name": "ResponseFailedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseFailedEvent", "usage": "Output,Json", "doc": "An event that is emitted when a response fails.", "discriminatorValue": "response.failed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5452", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.failed`.", "type": { "$id": "5453", "kind": "enumvalue", "name": "response_failed", "value": "response.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFailedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5454", "kind": "property", "name": "response", "serializedName": "response", "doc": "The response that failed.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseFailedEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.incomplete": { "$id": "5455", "kind": "model", "name": "ResponseIncompleteEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseIncompleteEvent", "usage": "Output,Json", "doc": "An event that is emitted when a response finishes as incomplete.", "discriminatorValue": "response.incomplete", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5456", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.incomplete`.", "type": { "$id": "5457", "kind": "enumvalue", "name": "response_incomplete", "value": "response.incomplete", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseIncompleteEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5458", "kind": "property", "name": "response", "serializedName": "response", "doc": "The response that was incomplete.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseIncompleteEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.output_item.added": { "$id": "5459", "kind": "model", "name": "ResponseOutputItemAddedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemAddedEvent", "usage": "Output,Json", "doc": "Emitted when a new output item is added.", "discriminatorValue": "response.output_item.added", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5460", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.output_item.added`.", "type": { "$id": "5461", "kind": "enumvalue", "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemAddedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5462", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that was added.", "type": { "$id": "5463", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemAddedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5464", "kind": "property", "name": "item", "serializedName": "item", "doc": "The output item that was added.", "type": { "$ref": "5162" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemAddedEvent.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "response.output_item.done": { "$id": "5465", "kind": "model", "name": "ResponseOutputItemDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemDoneEvent", "usage": "Output,Json", "doc": "Emitted when an output item is marked done.", "discriminatorValue": "response.output_item.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5466", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.output_item.done`.", "type": { "$id": "5467", "kind": "enumvalue", "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5468", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that was marked done.", "type": { "$id": "5469", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5470", "kind": "property", "name": "item", "serializedName": "item", "doc": "The output item that was marked done.", "type": { "$ref": "5162" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputItemDoneEvent.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "response.refusal.delta": { "$id": "5471", "kind": "model", "name": "ResponseRefusalDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is a partial refusal text.", "discriminatorValue": "response.refusal.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5472", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.refusal.delta`.", "type": { "$id": "5473", "kind": "enumvalue", "name": "response_refusal_delta", "value": "response.refusal.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5474", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the refusal text is added to.", "type": { "$id": "5475", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5476", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the refusal text is added to.", "type": { "$id": "5477", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5478", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that the refusal text is added to.", "type": { "$id": "5479", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5480", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The refusal text that is added.", "type": { "$id": "5481", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.refusal.done": { "$id": "5482", "kind": "model", "name": "ResponseRefusalDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent", "usage": "Output,Json", "doc": "Emitted when refusal text is finalized.", "discriminatorValue": "response.refusal.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5483", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.refusal.done`.", "type": { "$id": "5484", "kind": "enumvalue", "name": "response_refusal_done", "value": "response.refusal.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5485", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the refusal text is finalized.", "type": { "$id": "5486", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5487", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the refusal text is finalized.", "type": { "$id": "5488", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5489", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that the refusal text is finalized.", "type": { "$id": "5490", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5491", "kind": "property", "name": "refusal", "serializedName": "refusal", "doc": "The refusal text that is finalized.", "type": { "$id": "5492", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseRefusalDoneEvent.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false } ] }, "response.output_text.delta": { "$id": "5493", "kind": "model", "name": "ResponseTextDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is an additional text delta.", "discriminatorValue": "response.output_text.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5494", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.output_text.delta`.", "type": { "$id": "5495", "kind": "enumvalue", "name": "response_output_text_delta", "value": "response.output_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5496", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the text delta was added to.", "type": { "$id": "5497", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5498", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the text delta was added to.", "type": { "$id": "5499", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5500", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that the text delta was added to.", "type": { "$id": "5501", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5502", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The text delta that was added.", "type": { "$id": "5503", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.output_text.done": { "$id": "5504", "kind": "model", "name": "ResponseTextDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent", "usage": "Output,Json", "doc": "Emitted when text content is finalized.", "discriminatorValue": "response.output_text.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5505", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.output_text.done`.", "type": { "$id": "5506", "kind": "enumvalue", "name": "response_output_text_done", "value": "response.output_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5507", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the output item that the text content is finalized.", "type": { "$id": "5508", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5509", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the text content is finalized.", "type": { "$id": "5510", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5511", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that the text content is finalized.", "type": { "$id": "5512", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5513", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text content that is finalized.", "type": { "$id": "5514", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseTextDoneEvent.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary_part.added": { "$id": "5515", "kind": "model", "name": "ResponseReasoningSummaryPartAddedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent", "usage": "Output,Json", "doc": "Emitted when a new reasoning summary part is added.", "discriminatorValue": "response.reasoning_summary_part.added", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5516", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_summary_part.added`.", "type": { "$id": "5517", "kind": "enumvalue", "name": "response_reasoning_summary_part_added", "value": "response.reasoning_summary_part.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5518", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this summary part is associated with.", "type": { "$id": "5519", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5520", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this summary part is associated with.", "type": { "$id": "5521", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5522", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the reasoning summary.", "type": { "$id": "5523", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5524", "kind": "property", "name": "part", "serializedName": "part", "doc": "The summary part that was added.", "type": { "$ref": "4973" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartAddedEvent.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary_part.done": { "$id": "5525", "kind": "model", "name": "ResponseReasoningSummaryPartDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent", "usage": "Output,Json", "doc": "Emitted when a reasoning summary part is completed.", "discriminatorValue": "response.reasoning_summary_part.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5526", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_summary_part.done`.", "type": { "$id": "5527", "kind": "enumvalue", "name": "response_reasoning_summary_part_done", "value": "response.reasoning_summary_part.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5528", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this summary part is associated with.", "type": { "$id": "5529", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5530", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this summary part is associated with.", "type": { "$id": "5531", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5532", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the reasoning summary.", "type": { "$id": "5533", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5534", "kind": "property", "name": "part", "serializedName": "part", "doc": "The completed summary part.", "type": { "$ref": "4973" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryPartDoneEvent.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary_text.delta": { "$id": "5535", "kind": "model", "name": "ResponseReasoningSummaryTextDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent", "usage": "Output,Json", "doc": "Emitted when a delta is added to a reasoning summary text.", "discriminatorValue": "response.reasoning_summary_text.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5536", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_summary_text.delta`.", "type": { "$id": "5537", "kind": "enumvalue", "name": "response_reasoning_summary_text_delta", "value": "response.reasoning_summary_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5538", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this summary text delta is associated with.", "type": { "$id": "5539", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5540", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this summary text delta is associated with.", "type": { "$id": "5541", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5542", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the reasoning summary.", "type": { "$id": "5543", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5544", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The text delta that was added to the summary.", "type": { "$id": "5545", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary_text.done": { "$id": "5546", "kind": "model", "name": "ResponseReasoningSummaryTextDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent", "usage": "Output,Json", "doc": "Emitted when a reasoning summary text is completed.", "discriminatorValue": "response.reasoning_summary_text.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5547", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_summary_text.done`.", "type": { "$id": "5548", "kind": "enumvalue", "name": "response_reasoning_summary_text_done", "value": "response.reasoning_summary_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5549", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this summary text is associated with.", "type": { "$id": "5550", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5551", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this summary text is associated with.", "type": { "$id": "5552", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5553", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the reasoning summary.", "type": { "$id": "5554", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5555", "kind": "property", "name": "text", "serializedName": "text", "doc": "The full text of the completed reasoning summary.", "type": { "$id": "5556", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryTextDoneEvent.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.reasoning_text.delta": { "$id": "5557", "kind": "model", "name": "ResponseReasoningTextDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent", "usage": "Output,Json", "doc": "Emitted when a delta is added to a reasoning text.", "discriminatorValue": "response.reasoning_text.delta", "decorators": [], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5558", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_text.delta`.", "type": { "$id": "5559", "kind": "enumvalue", "name": "response_reasoning_text_delta", "value": "response.reasoning_text.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5560", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this reasoning text delta is associated with.", "type": { "$id": "5561", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5562", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this reasoning text delta is associated with.", "type": { "$id": "5563", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5564", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the reasoning content part this delta is associated with.", "type": { "$id": "5565", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5566", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The text delta that was added to the reasoning content.", "type": { "$id": "5567", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.reasoning_text.done": { "$id": "5568", "kind": "model", "name": "ResponseReasoningTextDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent", "usage": "Output,Json", "doc": "Emitted when a reasoning text is completed.", "discriminatorValue": "response.reasoning_text.done", "decorators": [], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5569", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.reasoning_text.done`.", "type": { "$id": "5570", "kind": "enumvalue", "name": "response_reasoning_text_done", "value": "response.reasoning_text.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5571", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item this reasoning text is associated with.", "type": { "$id": "5572", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5573", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item this reasoning text is associated with.", "type": { "$id": "5574", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5575", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the reasoning content part.", "type": { "$id": "5576", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5577", "kind": "property", "name": "text", "serializedName": "text", "doc": "The full text of the completed reasoning content.", "type": { "$id": "5578", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningTextDoneEvent.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.web_search_call.completed": { "$id": "5579", "kind": "model", "name": "ResponseWebSearchCallCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallCompletedEvent", "usage": "Output,Json", "doc": "Emitted when a web search call is completed.", "discriminatorValue": "response.web_search_call.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5580", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.web_search_call.completed`.", "type": { "$id": "5581", "kind": "enumvalue", "name": "response_web_search_call_completed", "value": "response.web_search_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5582", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the web search call is associated with.", "type": { "$id": "5583", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5584", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "Unique ID for the output item associated with the web search call.", "type": { "$id": "5585", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.web_search_call.in_progress": { "$id": "5586", "kind": "model", "name": "ResponseWebSearchCallInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallInProgressEvent", "usage": "Output,Json", "doc": "Emitted when a web search call is initiated.", "discriminatorValue": "response.web_search_call.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5587", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.web_search_call.in_progress`.", "type": { "$id": "5588", "kind": "enumvalue", "name": "response_web_search_call_in_progress", "value": "response.web_search_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5589", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the web search call is associated with.", "type": { "$id": "5590", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5591", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "Unique ID for the output item associated with the web search call.", "type": { "$id": "5592", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.web_search_call.searching": { "$id": "5593", "kind": "model", "name": "ResponseWebSearchCallSearchingEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallSearchingEvent", "usage": "Output,Json", "doc": "Emitted when a web search call is executing.", "discriminatorValue": "response.web_search_call.searching", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5594", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.web_search_call.searching`.", "type": { "$id": "5595", "kind": "enumvalue", "name": "response_web_search_call_searching", "value": "response.web_search_call.searching", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallSearchingEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5596", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the web search call is associated with.", "type": { "$id": "5597", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallSearchingEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5598", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "Unique ID for the output item associated with the web search call.", "type": { "$id": "5599", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseWebSearchCallSearchingEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.image_generation_call.completed": { "$id": "5600", "kind": "model", "name": "ResponseImageGenCallCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallCompletedEvent", "usage": "Output,Json", "doc": "Emitted when an image generation tool call has completed and the final image is available.", "discriminatorValue": "response.image_generation_call.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5601", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.image_generation_call.completed'.", "type": { "$id": "5602", "kind": "enumvalue", "name": "response_image_generation_call_completed", "value": "response.image_generation_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5603", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5604", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5605", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the image generation item being processed.", "type": { "$id": "5606", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.image_generation_call.generating": { "$id": "5607", "kind": "model", "name": "ResponseImageGenCallGeneratingEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallGeneratingEvent", "usage": "Output,Json", "doc": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "discriminatorValue": "response.image_generation_call.generating", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5608", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.image_generation_call.generating'.", "type": { "$id": "5609", "kind": "enumvalue", "name": "response_image_generation_call_generating", "value": "response.image_generation_call.generating", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallGeneratingEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5610", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5611", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallGeneratingEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5612", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the image generation item being processed.", "type": { "$id": "5613", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallGeneratingEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.image_generation_call.in_progress": { "$id": "5614", "kind": "model", "name": "ResponseImageGenCallInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallInProgressEvent", "usage": "Output,Json", "doc": "Emitted when an image generation tool call is in progress.", "discriminatorValue": "response.image_generation_call.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5615", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.image_generation_call.in_progress'.", "type": { "$id": "5616", "kind": "enumvalue", "name": "response_image_generation_call_in_progress", "value": "response.image_generation_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5617", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5618", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5619", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the image generation item being processed.", "type": { "$id": "5620", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.image_generation_call.partial_image": { "$id": "5621", "kind": "model", "name": "ResponseImageGenCallPartialImageEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent", "usage": "Output,Json", "doc": "Emitted when a partial image is available during image generation streaming.", "discriminatorValue": "response.image_generation_call.partial_image", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5622", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.image_generation_call.partial_image'.", "type": { "$id": "5623", "kind": "enumvalue", "name": "response_image_generation_call_partial_image", "value": "response.image_generation_call.partial_image", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5624", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5625", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5626", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the image generation item being processed.", "type": { "$id": "5627", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5628", "kind": "property", "name": "partial_image_index", "serializedName": "partial_image_index", "doc": "0-based index for the partial image (backend is 1-based, but this is 0-based for the user).", "type": { "$id": "5629", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent.partial_image_index", "serializationOptions": { "json": { "name": "partial_image_index" } }, "isHttpMetadata": false }, { "$id": "5630", "kind": "property", "name": "PartialImageBytes", "serializedName": "partial_image_b64", "doc": "Base64-encoded partial image data, suitable for rendering as an image.", "type": { "$id": "5631", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseImageGenCallPartialImageEvent.partial_image_b64", "serializationOptions": { "json": { "name": "partial_image_b64" } }, "isHttpMetadata": false } ] }, "response.mcp_call_arguments.delta": { "$id": "5632", "kind": "model", "name": "ResponseMCPCallArgumentsDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "discriminatorValue": "response.mcp_call_arguments.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5633", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_call.arguments_delta'.", "type": { "$id": "5634", "kind": "enumvalue", "name": "response_mcp_call_arguments_delta", "value": "response.mcp_call_arguments.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5635", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5636", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5637", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the MCP tool call item being processed.", "type": { "$id": "5638", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5639", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The partial update to the arguments for the MCP tool call.", "type": { "$id": "5640", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.mcp_call_arguments.done": { "$id": "5641", "kind": "model", "name": "ResponseMCPCallArgumentsDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDoneEvent", "usage": "Output,Json", "doc": "Emitted when the arguments for an MCP tool call are finalized.", "discriminatorValue": "response.mcp_call_arguments.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5642", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_call.arguments_done'.", "type": { "$id": "5643", "kind": "enumvalue", "name": "response_mcp_call_arguments_done", "value": "response.mcp_call_arguments.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5644", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5645", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5646", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the MCP tool call item being processed.", "type": { "$id": "5647", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5648", "kind": "property", "name": "ToolArguments", "serializedName": "arguments", "doc": "A JSON string containing the finalized arguments for the MCP tool call.", "type": { "$id": "5649", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallArgumentsDoneEvent.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "response.mcp_call.completed": { "$id": "5650", "kind": "model", "name": "ResponseMCPCallCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallCompletedEvent", "usage": "Output,Json", "doc": "Emitted when an MCP tool call has completed successfully.", "discriminatorValue": "response.mcp_call.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5651", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_call.completed'.", "type": { "$id": "5652", "kind": "enumvalue", "name": "response_mcp_call_completed", "value": "response.mcp_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5653", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the MCP tool call item that completed.", "type": { "$id": "5654", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5655", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that completed.", "type": { "$id": "5656", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false } ] }, "response.mcp_call.failed": { "$id": "5657", "kind": "model", "name": "ResponseMCPCallFailedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallFailedEvent", "usage": "Output,Json", "doc": "Emitted when an MCP tool call has failed.", "discriminatorValue": "response.mcp_call.failed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5658", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_call.failed'.", "type": { "$id": "5659", "kind": "enumvalue", "name": "response_mcp_call_failed", "value": "response.mcp_call.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallFailedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5660", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the MCP tool call item that failed.", "type": { "$id": "5661", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallFailedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5662", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that failed.", "type": { "$id": "5663", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallFailedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false } ] }, "response.mcp_call.in_progress": { "$id": "5664", "kind": "model", "name": "ResponseMCPCallInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallInProgressEvent", "usage": "Output,Json", "doc": "Emitted when an MCP tool call is in progress.", "discriminatorValue": "response.mcp_call.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5665", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_call.in_progress'.", "type": { "$id": "5666", "kind": "enumvalue", "name": "response_mcp_call_in_progress", "value": "response.mcp_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5667", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5668", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5669", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the MCP tool call item being processed.", "type": { "$id": "5670", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPCallInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.mcp_list_tools.completed": { "$id": "5671", "kind": "model", "name": "ResponseMCPListToolsCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsCompletedEvent", "usage": "Output,Json", "doc": "Emitted when the list of available MCP tools has been successfully retrieved.", "discriminatorValue": "response.mcp_list_tools.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5672", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_list_tools.completed'.", "type": { "$id": "5673", "kind": "enumvalue", "name": "response_mcp_list_tools_completed", "value": "response.mcp_list_tools.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5674", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the MCP tool call item that produced this output.", "type": { "$id": "5675", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5676", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that was processed.", "type": { "$id": "5677", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false } ] }, "response.mcp_list_tools.failed": { "$id": "5678", "kind": "model", "name": "ResponseMCPListToolsFailedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsFailedEvent", "usage": "Output,Json", "doc": "Emitted when the attempt to list available MCP tools has failed.", "discriminatorValue": "response.mcp_list_tools.failed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5679", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_list_tools.failed'.", "type": { "$id": "5680", "kind": "enumvalue", "name": "response_mcp_list_tools_failed", "value": "response.mcp_list_tools.failed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsFailedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5681", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the MCP tool call item that failed.", "type": { "$id": "5682", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsFailedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5683", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that failed.", "type": { "$id": "5684", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsFailedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false } ] }, "response.mcp_list_tools.in_progress": { "$id": "5685", "kind": "model", "name": "ResponseMCPListToolsInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsInProgressEvent", "usage": "Output,Json", "doc": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "discriminatorValue": "response.mcp_list_tools.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5686", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.mcp_list_tools.in_progress'.", "type": { "$id": "5687", "kind": "enumvalue", "name": "response_mcp_list_tools_in_progress", "value": "response.mcp_list_tools.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5688", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the MCP tool call item that is being processed.", "type": { "$id": "5689", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5690", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that is being processed.", "type": { "$id": "5691", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseMCPListToolsInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false } ] }, "response.output_text.annotation.added": { "$id": "5692", "kind": "model", "name": "ResponseOutputTextAnnotationAddedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent", "usage": "Output,Json", "doc": "Emitted when an annotation is added to output text content.", "discriminatorValue": "response.output_text.annotation.added", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5693", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.output_text_annotation.added'.", "type": { "$id": "5694", "kind": "enumvalue", "name": "response_output_text_annotation_added", "value": "response.output_text.annotation.added", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5695", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the item to which the annotation is being added.", "type": { "$id": "5696", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5697", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5698", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5699", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part within the output item.", "type": { "$id": "5700", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5701", "kind": "property", "name": "annotation_index", "serializedName": "annotation_index", "doc": "The index of the annotation within the content part.", "type": { "$id": "5702", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.annotation_index", "serializationOptions": { "json": { "name": "annotation_index" } }, "isHttpMetadata": false }, { "$id": "5703", "kind": "property", "name": "annotation", "serializedName": "annotation", "doc": "The annotation object being added. (See annotation schema for details.)", "type": { "$id": "5704", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseOutputTextAnnotationAddedEvent.annotation", "serializationOptions": { "json": { "name": "annotation" } }, "isHttpMetadata": false } ] }, "response.queued": { "$id": "5705", "kind": "model", "name": "ResponseQueuedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseQueuedEvent", "usage": "Output,Json", "doc": "Emitted when a response is queued and waiting to be processed.", "discriminatorValue": "response.queued", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5706", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.queued'.", "type": { "$id": "5707", "kind": "enumvalue", "name": "response_queued", "value": "response.queued", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseQueuedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5708", "kind": "property", "name": "response", "serializedName": "response", "doc": "The full response object that is queued.", "type": { "$ref": "5114" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseQueuedEvent.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.reasoning.delta": { "$id": "5709", "kind": "model", "name": "ResponseReasoningDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is a delta (partial update) to the reasoning content.", "discriminatorValue": "response.reasoning.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5710", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.reasoning.delta'.", "type": { "$id": "5711", "kind": "enumvalue", "name": "response_reasoning_delta", "value": "response.reasoning.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5712", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the item for which reasoning is being updated.", "type": { "$id": "5713", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5714", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5715", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5716", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the reasoning content part within the output item.", "type": { "$id": "5717", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5718", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The partial update to the reasoning content.", "type": { "$id": "5719", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.reasoning.done": { "$id": "5720", "kind": "model", "name": "ResponseReasoningDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent", "usage": "Output,Json", "doc": "Emitted when the reasoning content is finalized for an item.", "discriminatorValue": "response.reasoning.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5721", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.reasoning.done'.", "type": { "$id": "5722", "kind": "enumvalue", "name": "response_reasoning_done", "value": "response.reasoning.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5723", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the item for which reasoning is finalized.", "type": { "$id": "5724", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5725", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5726", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5727", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the reasoning content part within the output item.", "type": { "$id": "5728", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "5729", "kind": "property", "name": "text", "serializedName": "text", "doc": "The finalized reasoning text.", "type": { "$id": "5730", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningDoneEvent.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary.delta": { "$id": "5731", "kind": "model", "name": "ResponseReasoningSummaryDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent", "usage": "Output,Json", "doc": "Emitted when there is a delta (partial update) to the reasoning summary content.", "discriminatorValue": "response.reasoning_summary.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5732", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.reasoning_summary.delta'.", "type": { "$id": "5733", "kind": "enumvalue", "name": "response_reasoning_summary_delta", "value": "response.reasoning_summary.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5734", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the item for which the reasoning summary is being updated.", "type": { "$id": "5735", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5736", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5737", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5738", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the output item.", "type": { "$id": "5739", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5740", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The partial update to the reasoning summary content.", "type": { "$id": "5741", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.reasoning_summary.done": { "$id": "5742", "kind": "model", "name": "ResponseReasoningSummaryDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent", "usage": "Output,Json", "doc": "Emitted when the reasoning summary content is finalized for an item.", "discriminatorValue": "response.reasoning_summary.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5743", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always 'response.reasoning_summary.done'.", "type": { "$id": "5744", "kind": "enumvalue", "name": "response_reasoning_summary_done", "value": "response.reasoning_summary.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5745", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the item for which the reasoning summary is finalized.", "type": { "$id": "5746", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5747", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response's output array.", "type": { "$id": "5748", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5749", "kind": "property", "name": "summary_index", "serializedName": "summary_index", "doc": "The index of the summary part within the output item.", "type": { "$id": "5750", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent.summary_index", "serializationOptions": { "json": { "name": "summary_index" } }, "isHttpMetadata": false }, { "$id": "5751", "kind": "property", "name": "text", "serializedName": "text", "doc": "The finalized reasoning summary text.", "type": { "$id": "5752", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseReasoningSummaryDoneEvent.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.code_interpreter_call_code.delta": { "$id": "5753", "kind": "model", "name": "ResponseCodeInterpreterCallCodeDeltaEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", "usage": "Output,Json", "doc": "Emitted when a partial code snippet is added by the code interpreter.", "discriminatorValue": "response.code_interpreter_call_code.delta", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5754", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.code_interpreter_call_code.delta`.", "type": { "$id": "5755", "kind": "enumvalue", "name": "response_code_interpreter_call_code_delta", "value": "response.code_interpreter_call_code.delta", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5756", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the code interpreter call is in progress.", "type": { "$id": "5757", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5758", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the code interpreter tool call item.", "type": { "$id": "5759", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5760", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The partial code snippet added by the code interpreter.", "type": { "$id": "5761", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.code_interpreter_call_code.done": { "$id": "5762", "kind": "model", "name": "ResponseCodeInterpreterCallCodeDoneEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", "usage": "Output,Json", "doc": "Emitted when code snippet output is finalized by the code interpreter.", "discriminatorValue": "response.code_interpreter_call_code.done", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5763", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.code_interpreter_call_code.done`.", "type": { "$id": "5764", "kind": "enumvalue", "name": "response_code_interpreter_call_code_done", "value": "response.code_interpreter_call_code.done", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDoneEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5765", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the code interpreter call is in progress.", "type": { "$id": "5766", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDoneEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5767", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the code interpreter tool call item.", "type": { "$id": "5768", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDoneEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "5769", "kind": "property", "name": "code", "serializedName": "code", "doc": "The final code snippet output by the code interpreter.", "type": { "$id": "5770", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCodeDoneEvent.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false } ] }, "response.code_interpreter_call.completed": { "$id": "5771", "kind": "model", "name": "ResponseCodeInterpreterCallCompletedEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCompletedEvent", "usage": "Output,Json", "doc": "Emitted when the code interpreter call is completed.", "discriminatorValue": "response.code_interpreter_call.completed", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5772", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.code_interpreter_call.completed`.", "type": { "$id": "5773", "kind": "enumvalue", "name": "response_code_interpreter_call_completed", "value": "response.code_interpreter_call.completed", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCompletedEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5774", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the code interpreter call is in progress.", "type": { "$id": "5775", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCompletedEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5776", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the code interpreter tool call item.", "type": { "$id": "5777", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallCompletedEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.code_interpreter_call.in_progress": { "$id": "5778", "kind": "model", "name": "ResponseCodeInterpreterCallInProgressEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInProgressEvent", "usage": "Output,Json", "doc": "Emitted when a code interpreter call is in progress.", "discriminatorValue": "response.code_interpreter_call.in_progress", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5779", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.code_interpreter_call.in_progress`.", "type": { "$id": "5780", "kind": "enumvalue", "name": "response_code_interpreter_call_in_progress", "value": "response.code_interpreter_call.in_progress", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInProgressEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5781", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the code interpreter call is in progress.", "type": { "$id": "5782", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInProgressEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5783", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the code interpreter tool call item.", "type": { "$id": "5784", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInProgressEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.code_interpreter_call.interpreting": { "$id": "5785", "kind": "model", "name": "ResponseCodeInterpreterCallInterpretingEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInterpretingEvent", "usage": "Output,Json", "doc": "Emitted when the code interpreter is actively interpreting the code snippet.", "discriminatorValue": "response.code_interpreter_call.interpreting", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "5308" }, "properties": [ { "$id": "5786", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the event. Always `response.code_interpreter_call.interpreting`.", "type": { "$id": "5787", "kind": "enumvalue", "name": "response_code_interpreter_call_interpreting", "value": "response.code_interpreter_call.interpreting", "valueType": { "$ref": "712" }, "enumType": { "$ref": "5315" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInterpretingEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5788", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item that the code interpreter call is in progress.", "type": { "$id": "5789", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInterpretingEvent.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "5790", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The unique identifier of the code interpreter tool call item.", "type": { "$id": "5791", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseCodeInterpreterCallInterpretingEvent.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] } } }, { "$ref": "5312" }, { "$ref": "5373" }, { "$ref": "5383" }, { "$ref": "5393" }, { "$ref": "5397" }, { "$ref": "5408" }, { "$ref": "5415" }, { "$ref": "5422" }, { "$ref": "5429" }, { "$ref": "5438" }, { "$ref": "5447" }, { "$ref": "5451" }, { "$ref": "5455" }, { "$ref": "5459" }, { "$ref": "5465" }, { "$ref": "5471" }, { "$ref": "5482" }, { "$ref": "5493" }, { "$ref": "5504" }, { "$ref": "5515" }, { "$ref": "5525" }, { "$ref": "5535" }, { "$ref": "5546" }, { "$ref": "5557" }, { "$ref": "5568" }, { "$ref": "5579" }, { "$ref": "5586" }, { "$ref": "5593" }, { "$ref": "5600" }, { "$ref": "5607" }, { "$ref": "5614" }, { "$ref": "5621" }, { "$ref": "5632" }, { "$ref": "5641" }, { "$ref": "5650" }, { "$ref": "5657" }, { "$ref": "5664" }, { "$ref": "5671" }, { "$ref": "5678" }, { "$ref": "5685" }, { "$ref": "5692" }, { "$ref": "5705" }, { "$ref": "5709" }, { "$ref": "5720" }, { "$ref": "5731" }, { "$ref": "5742" }, { "$ref": "5753" }, { "$ref": "5762" }, { "$ref": "5771" }, { "$ref": "5778" }, { "$ref": "5785" }, { "$id": "5792", "kind": "model", "name": "ResponseErrorResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseErrorResponse", "usage": "Json,Exception", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5793", "kind": "property", "name": "error", "serializedName": "error", "type": { "$ref": "5152" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseErrorResponse.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, { "$id": "5794", "kind": "model", "name": "DeleteResponseResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteResponseResponse", "usage": "Output,Json", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5795", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "5796", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteResponseResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "5797", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1609" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteResponseResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "5798", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "5799", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteResponseResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false } ] }, { "$id": "5800", "kind": "model", "name": "ResponseItemList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ResponseItemList", "usage": "Output,Json", "doc": "A list of Response items.", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "5801", "kind": "property", "name": "object", "serializedName": "object", "doc": "The type of object returned, must be `list`.", "type": { "$ref": "1611" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseItemList.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "5802", "kind": "property", "name": "data", "serializedName": "data", "doc": "A list of items used to generate this response.", "type": { "$ref": "5161" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseItemList.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "5803", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Whether there are more items available.", "type": { "$id": "5804", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseItemList.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false }, { "$id": "5805", "kind": "property", "name": "first_id", "serializedName": "first_id", "doc": "The ID of the first item in the list.", "type": { "$id": "5806", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseItemList.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "5807", "kind": "property", "name": "last_id", "serializedName": "last_id", "doc": "The ID of the last item in the list.", "type": { "$id": "5808", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ResponseItemList.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false } ] }, { "$id": "5809", "kind": "model", "name": "CreateImageRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateImageRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "5810", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "A text description of the desired image(s). The maximum length is 32000 characters for `gpt-image-1`, 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.", "type": { "$id": "5811", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false }, { "$id": "5812", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or `gpt-image-1`. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.", "type": { "$id": "5813", "kind": "nullable", "type": { "$ref": "768" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "5814", "kind": "property", "name": "n", "serializedName": "n", "doc": "The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.", "type": { "$id": "5815", "kind": "nullable", "type": { "$id": "5816", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.n", "serializationOptions": { "json": { "name": "n" } }, "isHttpMetadata": false }, { "$id": "5817", "kind": "property", "name": "quality", "serializedName": "quality", "doc": "The quality of the image that will be generated.\n\n- `auto` (default value) will automatically select the best quality for the given model.\n- `high`, `medium` and `low` are supported for `gpt-image-1`.\n- `hd` and `standard` are supported for `dall-e-3`.\n- `standard` is the only option for `dall-e-2`.", "type": { "$id": "5818", "kind": "nullable", "type": { "$ref": "773" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.quality", "serializationOptions": { "json": { "name": "quality" } }, "isHttpMetadata": false }, { "$id": "5819", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "The format in which generated images with `dall-e-2` and `dall-e-3` are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images.", "type": { "$id": "5820", "kind": "nullable", "type": { "$ref": "781" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false }, { "$id": "5821", "kind": "property", "name": "output_format", "serializedName": "output_format", "doc": "The format in which the generated images are returned. This parameter is only supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.", "type": { "$id": "5822", "kind": "nullable", "type": { "$ref": "785" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.output_format", "serializationOptions": { "json": { "name": "output_format" } }, "isHttpMetadata": false }, { "$id": "5823", "kind": "property", "name": "output_compression", "serializedName": "output_compression", "doc": "The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and defaults to 100.", "type": { "$id": "5824", "kind": "nullable", "type": { "$id": "5825", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.output_compression", "serializationOptions": { "json": { "name": "output_compression" } }, "isHttpMetadata": false }, { "$id": "5826", "kind": "property", "name": "size", "serializedName": "size", "doc": "The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.", "type": { "$id": "5827", "kind": "nullable", "type": { "$ref": "790" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.size", "serializationOptions": { "json": { "name": "size" } }, "isHttpMetadata": false }, { "$id": "5828", "kind": "property", "name": "moderation", "serializedName": "moderation", "doc": "Control the content-moderation level for images generated by `gpt-image-1`. Must be either `low` for less restrictive filtering or `auto` (default value).", "type": { "$id": "5829", "kind": "nullable", "type": { "$ref": "800" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.moderation", "serializationOptions": { "json": { "name": "moderation" } }, "isHttpMetadata": false }, { "$id": "5830", "kind": "property", "name": "background", "serializedName": "background", "doc": "Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for `gpt-image-1`. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.", "type": { "$id": "5831", "kind": "nullable", "type": { "$ref": "804" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.background", "serializationOptions": { "json": { "name": "background" } }, "isHttpMetadata": false }, { "$id": "5832", "kind": "property", "name": "style", "serializedName": "style", "doc": "The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.", "type": { "$id": "5833", "kind": "nullable", "type": { "$ref": "809" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.style", "serializationOptions": { "json": { "name": "style" } }, "isHttpMetadata": false }, { "$id": "5834", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "5835", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageRequest.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false } ] }, { "$id": "5836", "kind": "model", "name": "ImagesResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImagesResponse", "usage": "Output,Json", "doc": "The response from the image generation endpoint.", "decorators": [], "properties": [ { "$id": "5837", "kind": "property", "name": "created", "serializedName": "created", "doc": "The Unix timestamp (in seconds) of when the image was created.", "type": { "$id": "5838", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "5839", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.created", "serializationOptions": { "json": { "name": "created" } }, "isHttpMetadata": false }, { "$id": "5840", "kind": "property", "name": "data", "serializedName": "data", "doc": "The list of generated images.", "type": { "$id": "5841", "kind": "array", "name": "ArrayImage", "valueType": { "$id": "5842", "kind": "model", "name": "Image", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Image", "usage": "Output,Json", "doc": "Represents the content or the URL of an image generated by the OpenAI API.", "decorators": [], "properties": [ { "$id": "5843", "kind": "property", "name": "b64_json", "serializedName": "b64_json", "doc": "The base64-encoded JSON of the generated image. Default value for `gpt-image-1`, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`.", "type": { "$id": "5844", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Image.b64_json", "serializationOptions": { "json": { "name": "b64_json" } }, "isHttpMetadata": false }, { "$id": "5845", "kind": "property", "name": "url", "serializedName": "url", "doc": "When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for `gpt-image-1`.", "type": { "$id": "5846", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Image.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false }, { "$id": "5847", "kind": "property", "name": "revised_prompt", "serializedName": "revised_prompt", "doc": "For `dall-e-3` only, the revised prompt that was used to generate the image.", "type": { "$id": "5848", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Image.revised_prompt", "serializationOptions": { "json": { "name": "revised_prompt" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "5849", "kind": "property", "name": "usage", "serializedName": "usage", "doc": "For `gpt-image-1` only, the token usage information for the image generation.", "type": { "$id": "5850", "kind": "model", "name": "ImagesResponseUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "5851", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens (images and text) used for the image generation.", "type": { "$id": "5852", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.anonymous.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false }, { "$id": "5853", "kind": "property", "name": "input_tokens", "serializedName": "input_tokens", "doc": "The number of tokens (images and text) in the input prompt.", "type": { "$id": "5854", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.anonymous.input_tokens", "serializationOptions": { "json": { "name": "input_tokens" } }, "isHttpMetadata": false }, { "$id": "5855", "kind": "property", "name": "output_tokens", "serializedName": "output_tokens", "doc": "The number of image tokens in the output image.", "type": { "$id": "5856", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.anonymous.output_tokens", "serializationOptions": { "json": { "name": "output_tokens" } }, "isHttpMetadata": false }, { "$id": "5857", "kind": "property", "name": "input_tokens_details", "serializedName": "input_tokens_details", "doc": "The input tokens detailed information for the image generation.", "type": { "$id": "5858", "kind": "model", "name": "ImagesResponseUsageInputTokensDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.input_tokens_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "5859", "kind": "property", "name": "text_tokens", "serializedName": "text_tokens", "doc": "The number of text tokens in the input prompt.", "type": { "$id": "5860", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.input_tokens_details.anonymous.text_tokens", "serializationOptions": { "json": { "name": "text_tokens" } }, "isHttpMetadata": false }, { "$id": "5861", "kind": "property", "name": "image_tokens", "serializedName": "image_tokens", "doc": "The number of image tokens in the input prompt.", "type": { "$id": "5862", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.input_tokens_details.anonymous.image_tokens", "serializationOptions": { "json": { "name": "image_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage.anonymous.input_tokens_details", "serializationOptions": { "json": { "name": "input_tokens_details" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ImagesResponse.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false } ] }, { "$ref": "5842" }, { "$ref": "5850" }, { "$ref": "5858" }, { "$id": "5863", "kind": "model", "name": "CreateImageEditRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "5864", "kind": "property", "name": "image", "serializedName": "image", "doc": "The image(s) to edit. Must be a supported image file or an array of images.\n\nFor `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less\nthan 50MB. You can provide up to 16 images.\n\nFor `dall-e-2`, you can only provide one image, and it should be a square\n`png` file less than 4MB.", "type": { "$id": "5865", "kind": "union", "name": "CreateImageEditRequestImage", "variantTypes": [ { "$id": "5866", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, { "$id": "5867", "kind": "array", "name": "Array25", "valueType": { "$id": "5868", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.image", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/octet-stream", "application/json" ], "name": "image", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5869", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for `gpt-image-1`.", "type": { "$id": "5870", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.prompt", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "prompt", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5871", "kind": "property", "name": "mask", "serializedName": "mask", "doc": "An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.", "type": { "$id": "5872", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.mask", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "mask", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5873", "kind": "property", "name": "background", "serializedName": "background", "doc": "Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for `gpt-image-1`. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.", "type": { "$id": "5874", "kind": "nullable", "type": { "$ref": "813" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.background", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "background", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5875", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are supported. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.", "type": { "$id": "5876", "kind": "nullable", "type": { "$ref": "818" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.model", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "model", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5877", "kind": "property", "name": "n", "serializedName": "n", "doc": "The number of images to generate. Must be between 1 and 10.", "type": { "$id": "5878", "kind": "nullable", "type": { "$id": "5879", "kind": "int32", "name": "OneToTenInt", "crossLanguageDefinitionId": "OpenAI.OneToTenInt", "baseType": { "$id": "5880", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.n", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "n", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5881", "kind": "property", "name": "size", "serializedName": "size", "doc": "The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.", "type": { "$id": "5882", "kind": "nullable", "type": { "$ref": "822" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.size", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "size", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5883", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for `dall-e-2`, as `gpt-image-1` will always return base64-encoded images.", "type": { "$id": "5884", "kind": "nullable", "type": { "$ref": "830" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.response_format", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "response_format", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5885", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "5886", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.user", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "user", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5887", "kind": "property", "name": "quality", "serializedName": "quality", "doc": "The quality of the image that will be generated. `high`, `medium` and `low` are only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality. Defaults to `auto`.", "type": { "$id": "5888", "kind": "nullable", "type": { "$ref": "834" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageEditRequest.quality", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "quality", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "5889", "kind": "model", "name": "CreateImageVariationRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "5890", "kind": "property", "name": "image", "serializedName": "image", "doc": "The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.", "type": { "$id": "5891", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.image", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "image", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5892", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for image generation. Only `dall-e-2` is supported at this time.", "type": { "$id": "5893", "kind": "nullable", "type": { "$ref": "841" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.model", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "model", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5894", "kind": "property", "name": "n", "serializedName": "n", "doc": "The number of images to generate. Must be between 1 and 10.", "type": { "$id": "5895", "kind": "nullable", "type": { "$id": "5896", "kind": "int32", "name": "OneToTenInt", "crossLanguageDefinitionId": "OpenAI.OneToTenInt", "baseType": { "$id": "5897", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.n", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "n", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5898", "kind": "property", "name": "response_format", "serializedName": "response_format", "doc": "The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.", "type": { "$id": "5899", "kind": "nullable", "type": { "$ref": "844" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.response_format", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "response_format", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5900", "kind": "property", "name": "size", "serializedName": "size", "doc": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", "type": { "$id": "5901", "kind": "nullable", "type": { "$ref": "848" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.size", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "size", "headers": [] } }, "isHttpMetadata": false }, { "$id": "5902", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "5903", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateImageVariationRequest.user", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "user", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "5904", "kind": "model", "name": "CreateMessageRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "5905", "kind": "property", "name": "role", "serializedName": "role", "doc": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.", "type": { "$ref": "853" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "5906", "kind": "property", "name": "content", "serializedName": "content", "type": { "$id": "5907", "kind": "array", "name": "ArrayMessageContent", "valueType": { "$id": "5908", "kind": "model", "name": "MessageContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContent", "access": "public", "usage": "Input,Output,Json", "doc": "Represents a single piece of content in an Assistants API message.", "decorators": [], "discriminatorProperty": { "$id": "5909", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "857" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "5909" } ], "discriminatedSubtypes": { "image_file": { "$id": "5910", "kind": "model", "name": "MessageContentImageFileObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject", "access": "public", "usage": "Input,Output,Json", "doc": "References an image [File](/docs/api-reference/files) in the content of a message.", "discriminatorValue": "image_file", "decorators": [], "baseModel": { "$ref": "5908" }, "properties": [ { "$id": "5911", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `image_file`.", "type": { "$id": "5912", "kind": "enumvalue", "name": "image_file", "value": "image_file", "valueType": { "$ref": "858" }, "enumType": { "$id": "5913", "kind": "enum", "decorators": [], "name": "MessageContentType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "5914", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "5915", "kind": "enumvalue", "decorators": [], "doc": "The content is a text message.", "name": "text", "value": "text", "valueType": { "$ref": "5914" }, "enumType": { "$ref": "5913" } }, { "$id": "5916", "kind": "enumvalue", "decorators": [], "doc": "The content is an image file.", "name": "image_file", "value": "image_file", "valueType": { "$ref": "5914" }, "enumType": { "$ref": "5913" } }, { "$id": "5917", "kind": "enumvalue", "decorators": [], "doc": "The content is an image URL.", "name": "image_url", "value": "image_url", "valueType": { "$ref": "5914" }, "enumType": { "$ref": "5913" } }, { "$id": "5918", "kind": "enumvalue", "decorators": [], "doc": "The content is a refusal message.", "name": "refusal", "value": "refusal", "valueType": { "$ref": "5914" }, "enumType": { "$ref": "5913" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.MessageContentType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "doc": "The content is an image file.", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5919", "kind": "property", "name": "image_file", "serializedName": "image_file", "type": { "$id": "5920", "kind": "model", "name": "MessageContentImageFileObjectImageFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.image_file.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5921", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content.", "type": { "$id": "5922", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.image_file.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "5923", "kind": "property", "name": "detail", "serializedName": "detail", "doc": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "$ref": "863" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.image_file.anonymous.detail", "serializationOptions": { "json": { "name": "detail" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageFileObject.image_file", "serializationOptions": { "json": { "name": "image_file" } }, "isHttpMetadata": false } ] }, "text": { "$id": "5924", "kind": "model", "name": "MessageContentTextObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject", "access": "public", "usage": "Input,Output,Json", "doc": "The text content that is part of a message.", "discriminatorValue": "text", "decorators": [], "baseModel": { "$ref": "5908" }, "properties": [ { "$id": "5925", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `text`.", "type": { "$id": "5926", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "858" }, "enumType": { "$ref": "5913" }, "doc": "The content is a text message.", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5927", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "5928", "kind": "union", "name": "MessageContentTextObjectText", "variantTypes": [ { "$id": "5929", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$id": "5930", "kind": "model", "name": "MessageContentTextObjectText1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject.text.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5931", "kind": "property", "name": "value", "serializedName": "value", "type": { "$id": "5932", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject.text.anonymous.value", "serializationOptions": { "json": { "name": "value" } }, "isHttpMetadata": false }, { "$id": "5933", "kind": "property", "name": "annotations", "serializedName": "annotations", "type": { "$id": "5934", "kind": "array", "name": "ArrayMessageContentTextObjectAnnotation", "valueType": { "$id": "5935", "kind": "model", "name": "MessageContentTextObjectAnnotation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextObjectAnnotation", "access": "public", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "5936", "kind": "property", "name": "type", "serializedName": "type", "doc": "The discriminated type identifier for the content item.", "type": { "$ref": "868" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextObjectAnnotation.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "5936" } ], "discriminatedSubtypes": { "file_citation": { "$id": "5937", "kind": "model", "name": "MessageContentTextAnnotationsFileCitationObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject", "access": "public", "usage": "Input,Output,Json", "doc": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.", "discriminatorValue": "file_citation", "decorators": [], "baseModel": { "$ref": "5935" }, "properties": [ { "$id": "5938", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `file_citation`.", "type": { "$id": "5939", "kind": "enumvalue", "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "869" }, "enumType": { "$id": "5940", "kind": "enum", "decorators": [], "name": "MessageContentTextAnnotationType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "5941", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "5942", "kind": "enumvalue", "decorators": [], "name": "file_citation", "value": "file_citation", "valueType": { "$ref": "5941" }, "enumType": { "$ref": "5940" } }, { "$id": "5943", "kind": "enumvalue", "decorators": [], "name": "file_path", "value": "file_path", "valueType": { "$ref": "5941" }, "enumType": { "$ref": "5940" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5944", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text in the message content that needs to be replaced.", "type": { "$id": "5945", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "5946", "kind": "property", "name": "file_citation", "serializedName": "file_citation", "type": { "$id": "5947", "kind": "model", "name": "MessageContentTextAnnotationsFileCitationObjectFileCitation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.file_citation.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5948", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the specific File the citation is from.", "type": { "$id": "5949", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.file_citation.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.file_citation", "serializationOptions": { "json": { "name": "file_citation" } }, "isHttpMetadata": false }, { "$id": "5950", "kind": "property", "name": "start_index", "serializedName": "start_index", "type": { "$id": "5951", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.start_index", "serializationOptions": { "json": { "name": "start_index" } }, "isHttpMetadata": false }, { "$id": "5952", "kind": "property", "name": "end_index", "serializedName": "end_index", "type": { "$id": "5953", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFileCitationObject.end_index", "serializationOptions": { "json": { "name": "end_index" } }, "isHttpMetadata": false } ] }, "file_path": { "$id": "5954", "kind": "model", "name": "MessageContentTextAnnotationsFilePathObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject", "access": "public", "usage": "Input,Output,Json", "doc": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "discriminatorValue": "file_path", "decorators": [], "baseModel": { "$ref": "5935" }, "properties": [ { "$id": "5955", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `file_path`.", "type": { "$id": "5956", "kind": "enumvalue", "name": "file_path", "value": "file_path", "valueType": { "$ref": "869" }, "enumType": { "$ref": "5940" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5957", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text in the message content that needs to be replaced.", "type": { "$id": "5958", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false }, { "$id": "5959", "kind": "property", "name": "file_path", "serializedName": "file_path", "type": { "$id": "5960", "kind": "model", "name": "MessageContentTextAnnotationsFilePathObjectFilePath", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.file_path.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5961", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file that was generated.", "type": { "$id": "5962", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.file_path.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.file_path", "serializationOptions": { "json": { "name": "file_path" } }, "isHttpMetadata": false }, { "$id": "5963", "kind": "property", "name": "start_index", "serializedName": "start_index", "type": { "$id": "5964", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.start_index", "serializationOptions": { "json": { "name": "start_index" } }, "isHttpMetadata": false }, { "$id": "5965", "kind": "property", "name": "end_index", "serializedName": "end_index", "type": { "$id": "5966", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextAnnotationsFilePathObject.end_index", "serializationOptions": { "json": { "name": "end_index" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject.text.anonymous.annotations", "serializationOptions": { "json": { "name": "annotations" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentTextObject.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "refusal": { "$id": "5967", "kind": "model", "name": "MessageContentRefusalObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentRefusalObject", "access": "public", "usage": "Input,Output,Json", "doc": "The refusal content generated by the assistant.", "discriminatorValue": "refusal", "decorators": [], "baseModel": { "$ref": "5908" }, "properties": [ { "$id": "5968", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `refusal`.", "type": { "$id": "5969", "kind": "enumvalue", "name": "refusal", "value": "refusal", "valueType": { "$ref": "858" }, "enumType": { "$ref": "5913" }, "doc": "The content is a refusal message.", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentRefusalObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5970", "kind": "property", "name": "refusal", "serializedName": "refusal", "type": { "$id": "5971", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentRefusalObject.refusal", "serializationOptions": { "json": { "name": "refusal" } }, "isHttpMetadata": false } ] }, "image_url": { "$id": "5972", "kind": "model", "name": "MessageContentImageUrlObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject", "access": "public", "usage": "Input,Output,Json", "doc": "References an image URL in the content of a message.", "discriminatorValue": "image_url", "decorators": [], "baseModel": { "$ref": "5908" }, "properties": [ { "$id": "5973", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content part.", "type": { "$id": "5974", "kind": "enumvalue", "name": "image_url", "value": "image_url", "valueType": { "$ref": "858" }, "enumType": { "$ref": "5913" }, "doc": "The content is an image URL.", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "5975", "kind": "property", "name": "image_url", "serializedName": "image_url", "type": { "$id": "5976", "kind": "model", "name": "MessageContentImageUrlObjectImageUrl", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.image_url.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5977", "kind": "property", "name": "url", "serializedName": "url", "doc": "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "$id": "5978", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.image_url.anonymous.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false }, { "$id": "5979", "kind": "property", "name": "detail", "serializedName": "detail", "doc": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`", "type": { "$ref": "872" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.image_url.anonymous.detail", "serializationOptions": { "json": { "name": "detail" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageContentImageUrlObject.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "5980", "kind": "property", "name": "attachments", "serializedName": "attachments", "doc": "A list of files attached to the message, and the tools they should be added to.", "type": { "$id": "5981", "kind": "nullable", "type": { "$id": "5982", "kind": "array", "name": "Array26", "valueType": { "$id": "5983", "kind": "model", "name": "CreateMessageRequestAttachment", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.attachment.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "5984", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to attach to the message.", "type": { "$id": "5985", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.attachment.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "5986", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "The tools to add this file to.", "type": { "$id": "5987", "kind": "array", "name": "Array27", "valueType": { "$id": "5988", "kind": "union", "name": "CreateMessageRequestAttachmentTool", "variantTypes": [ { "$ref": "2333" }, { "$id": "5989", "kind": "model", "name": "AssistantToolsFileSearchTypeOnly", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearchTypeOnly", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "5990", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool being defined: `file_search`", "type": { "$ref": "1613" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantToolsFileSearchTypeOnly.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.attachment.anonymous.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.attachments", "serializationOptions": { "json": { "name": "attachments" } }, "isHttpMetadata": false }, { "$id": "5991", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateMessageRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "5908" }, { "$ref": "5910" }, { "$ref": "5920" }, { "$ref": "5924" }, { "$ref": "5930" }, { "$ref": "5935" }, { "$ref": "5937" }, { "$ref": "5947" }, { "$ref": "5954" }, { "$ref": "5960" }, { "$ref": "5967" }, { "$ref": "5972" }, { "$ref": "5976" }, { "$ref": "5983" }, { "$ref": "5989" }, { "$id": "5992", "kind": "model", "name": "MessageObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageObject", "usage": "Output,Json", "doc": "Represents a message within a [thread](/docs/api-reference/threads).", "decorators": [], "properties": [ { "$id": "5993", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "5994", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "5995", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `thread.message`.", "type": { "$ref": "1615" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "5996", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the message was created.", "type": { "$id": "5997", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "5998", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "5999", "kind": "property", "name": "thread_id", "serializedName": "thread_id", "doc": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", "type": { "$id": "6000", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.thread_id", "serializationOptions": { "json": { "name": "thread_id" } }, "isHttpMetadata": false }, { "$id": "6001", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", "type": { "$ref": "877" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6002", "kind": "property", "name": "incomplete_details", "serializedName": "incomplete_details", "doc": "On an incomplete message, details about why the message is incomplete.", "type": { "$id": "6003", "kind": "nullable", "type": { "$id": "6004", "kind": "model", "name": "MessageObjectIncompleteDetails1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageObject.incomplete_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6005", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "The reason the message is incomplete.", "type": { "$ref": "882" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.incomplete_details.anonymous.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.incomplete_details", "serializationOptions": { "json": { "name": "incomplete_details" } }, "isHttpMetadata": false }, { "$id": "6006", "kind": "property", "name": "completed_at", "serializedName": "completed_at", "doc": "The Unix timestamp (in seconds) for when the message was completed.", "type": { "$id": "6007", "kind": "nullable", "type": { "$id": "6008", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6009", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.completed_at", "serializationOptions": { "json": { "name": "completed_at" } }, "isHttpMetadata": false }, { "$id": "6010", "kind": "property", "name": "incomplete_at", "serializedName": "incomplete_at", "doc": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", "type": { "$id": "6011", "kind": "nullable", "type": { "$id": "6012", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6013", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.incomplete_at", "serializationOptions": { "json": { "name": "incomplete_at" } }, "isHttpMetadata": false }, { "$id": "6014", "kind": "property", "name": "role", "serializedName": "role", "doc": "The entity that produced the message. One of `user` or `assistant`.", "type": { "$ref": "889" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "6015", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the message in array of text and/or images.", "type": { "$ref": "5907" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "6016", "kind": "property", "name": "assistant_id", "serializedName": "assistant_id", "doc": "If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.", "type": { "$id": "6017", "kind": "nullable", "type": { "$id": "6018", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.assistant_id", "serializationOptions": { "json": { "name": "assistant_id" } }, "isHttpMetadata": false }, { "$id": "6019", "kind": "property", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints.", "type": { "$id": "6020", "kind": "nullable", "type": { "$id": "6021", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.run_id", "serializationOptions": { "json": { "name": "run_id" } }, "isHttpMetadata": false }, { "$id": "6022", "kind": "property", "name": "attachments", "serializedName": "attachments", "doc": "A list of files attached to the message, and the tools they were added to.", "type": { "$id": "6023", "kind": "nullable", "type": { "$id": "6024", "kind": "array", "name": "Array28", "valueType": { "$id": "6025", "kind": "model", "name": "MessageObjectAttachment", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageObject.attachment.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6026", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to attach to the message.", "type": { "$id": "6027", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.attachment.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "6028", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "The tools to add this file to.", "type": { "$id": "6029", "kind": "array", "name": "Array29", "valueType": { "$id": "6030", "kind": "union", "name": "MessageObjectAttachmentTool", "variantTypes": [ { "$ref": "2333" }, { "$ref": "5989" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.attachment.anonymous.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.attachments", "serializationOptions": { "json": { "name": "attachments" } }, "isHttpMetadata": false }, { "$id": "6031", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "6004" }, { "$ref": "6025" }, { "$id": "6032", "kind": "model", "name": "ListMessagesResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6033", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1617" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6034", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6035", "kind": "array", "name": "ArrayMessageObject", "valueType": { "$ref": "5992" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6036", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "6037", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "6038", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "6039", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "6040", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "6041", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListMessagesResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$id": "6042", "kind": "model", "name": "ModifyMessageRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyMessageRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6043", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyMessageRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "6044", "kind": "model", "name": "DeleteMessageResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteMessageResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6045", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "6046", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteMessageResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6047", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "6048", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteMessageResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "6049", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1619" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteMessageResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "6050", "kind": "model", "name": "CreateModerationRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6051", "kind": "property", "name": "input", "serializedName": "input", "doc": "Input (or inputs) to classify. Can be a single string, an array of strings, or\nan array of multi-modal input objects similar to other models.", "type": { "$id": "6052", "kind": "union", "name": "CreateModerationRequestInput", "variantTypes": [ { "$id": "6053", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2373" }, { "$id": "6054", "kind": "array", "name": "Array30", "valueType": { "$id": "6055", "kind": "union", "name": "CreateModerationRequestInput1", "variantTypes": [ { "$id": "6056", "kind": "model", "name": "CreateModerationRequestInput2", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6057", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `image_url`.", "type": { "$ref": "1621" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6058", "kind": "property", "name": "image_url", "serializedName": "image_url", "doc": "Contains either an image URL or a data URL for a base64 encoded image.", "type": { "$id": "6059", "kind": "model", "name": "CreateModerationRequestInputImageUrl", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.image_url.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6060", "kind": "property", "name": "url", "serializedName": "url", "doc": "Either a URL of the image or the base64 encoded image data.", "type": { "$id": "6061", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.image_url.anonymous.url", "serializationOptions": { "json": { "name": "url" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous.image_url", "serializationOptions": { "json": { "name": "image_url" } }, "isHttpMetadata": false } ] }, { "$id": "6062", "kind": "model", "name": "CreateModerationRequestInput3", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6063", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `text`.", "type": { "$ref": "1623" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6064", "kind": "property", "name": "text", "serializedName": "text", "doc": "A string of text to classify.", "type": { "$id": "6065", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "6066", "kind": "property", "name": "model", "serializedName": "model", "doc": "The content moderation model you would like to use. Learn more in\n[the moderation guide](/docs/guides/moderation), and learn about\navailable models [here](/docs/models#moderation).", "type": { "$ref": "893" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false } ] }, { "$ref": "6056" }, { "$ref": "6059" }, { "$ref": "6062" }, { "$id": "6067", "kind": "model", "name": "CreateModerationResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationResponse", "usage": "Output,Json", "doc": "Represents if a given text input is potentially harmful.", "decorators": [], "properties": [ { "$id": "6068", "kind": "property", "name": "id", "serializedName": "id", "doc": "The unique identifier for the moderation request.", "type": { "$id": "6069", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6070", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model used to generate the moderation results.", "type": { "$id": "6071", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponse.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6072", "kind": "property", "name": "results", "serializedName": "results", "doc": "A list of moderation objects.", "type": { "$id": "6073", "kind": "array", "name": "ArrayCreateModerationResponseResult", "valueType": { "$id": "6074", "kind": "model", "name": "CreateModerationResponseResult", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6075", "kind": "property", "name": "flagged", "serializedName": "flagged", "doc": "Whether any of the below categories are flagged.", "type": { "$id": "6076", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.flagged", "serializationOptions": { "json": { "name": "flagged" } }, "isHttpMetadata": false }, { "$id": "6077", "kind": "property", "name": "categories", "serializedName": "categories", "doc": "A list of the categories, and whether they are flagged or not.", "type": { "$id": "6078", "kind": "model", "name": "CreateModerationResponseResultCategories", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6079", "kind": "property", "name": "hate", "serializedName": "hate", "doc": "Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment.", "type": { "$id": "6080", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.hate", "serializationOptions": { "json": { "name": "hate" } }, "isHttpMetadata": false }, { "$id": "6081", "kind": "property", "name": "hate/threatening", "serializedName": "hate/threatening", "doc": "Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste.", "type": { "$id": "6082", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.hate/threatening", "serializationOptions": { "json": { "name": "hate/threatening" } }, "isHttpMetadata": false }, { "$id": "6083", "kind": "property", "name": "harassment", "serializedName": "harassment", "doc": "Content that expresses, incites, or promotes harassing language towards any target.", "type": { "$id": "6084", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.harassment", "serializationOptions": { "json": { "name": "harassment" } }, "isHttpMetadata": false }, { "$id": "6085", "kind": "property", "name": "harassment/threatening", "serializedName": "harassment/threatening", "doc": "Harassment content that also includes violence or serious harm towards any target.", "type": { "$id": "6086", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.harassment/threatening", "serializationOptions": { "json": { "name": "harassment/threatening" } }, "isHttpMetadata": false }, { "$id": "6087", "kind": "property", "name": "illicit", "serializedName": "illicit", "doc": "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. For example, \"how to shoplift\" would fit this category.", "type": { "$id": "6088", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.illicit", "serializationOptions": { "json": { "name": "illicit" } }, "isHttpMetadata": false }, { "$id": "6089", "kind": "property", "name": "illicit/violent", "serializedName": "illicit/violent", "doc": "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence, or that gives advice or instruction on the procurement of any weapon.", "type": { "$id": "6090", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.illicit/violent", "serializationOptions": { "json": { "name": "illicit/violent" } }, "isHttpMetadata": false }, { "$id": "6091", "kind": "property", "name": "self-harm", "serializedName": "self-harm", "doc": "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.", "type": { "$id": "6092", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.self-harm", "serializationOptions": { "json": { "name": "self-harm" } }, "isHttpMetadata": false }, { "$id": "6093", "kind": "property", "name": "self-harm/intent", "serializedName": "self-harm/intent", "doc": "Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.", "type": { "$id": "6094", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.self-harm/intent", "serializationOptions": { "json": { "name": "self-harm/intent" } }, "isHttpMetadata": false }, { "$id": "6095", "kind": "property", "name": "self-harm/instructions", "serializedName": "self-harm/instructions", "doc": "Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.", "type": { "$id": "6096", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.self-harm/instructions", "serializationOptions": { "json": { "name": "self-harm/instructions" } }, "isHttpMetadata": false }, { "$id": "6097", "kind": "property", "name": "sexual", "serializedName": "sexual", "doc": "Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).", "type": { "$id": "6098", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.sexual", "serializationOptions": { "json": { "name": "sexual" } }, "isHttpMetadata": false }, { "$id": "6099", "kind": "property", "name": "sexual/minors", "serializedName": "sexual/minors", "doc": "Sexual content that includes an individual who is under 18 years old.", "type": { "$id": "6100", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.sexual/minors", "serializationOptions": { "json": { "name": "sexual/minors" } }, "isHttpMetadata": false }, { "$id": "6101", "kind": "property", "name": "violence", "serializedName": "violence", "doc": "Content that depicts death, violence, or physical injury.", "type": { "$id": "6102", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.violence", "serializationOptions": { "json": { "name": "violence" } }, "isHttpMetadata": false }, { "$id": "6103", "kind": "property", "name": "violence/graphic", "serializedName": "violence/graphic", "doc": "Content that depicts death, violence, or physical injury in graphic detail.", "type": { "$id": "6104", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories.anonymous.violence/graphic", "serializationOptions": { "json": { "name": "violence/graphic" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.categories", "serializationOptions": { "json": { "name": "categories" } }, "isHttpMetadata": false }, { "$id": "6105", "kind": "property", "name": "category_scores", "serializedName": "category_scores", "doc": "A list of the categories along with their scores as predicted by model.", "type": { "$id": "6106", "kind": "model", "name": "CreateModerationResponseResultCategoryScores", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6107", "kind": "property", "name": "hate", "serializedName": "hate", "doc": "The score for the category 'hate'.", "type": { "$id": "6108", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.hate", "serializationOptions": { "json": { "name": "hate" } }, "isHttpMetadata": false }, { "$id": "6109", "kind": "property", "name": "hate/threatening", "serializedName": "hate/threatening", "doc": "The score for the category 'hate/threatening'.", "type": { "$id": "6110", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.hate/threatening", "serializationOptions": { "json": { "name": "hate/threatening" } }, "isHttpMetadata": false }, { "$id": "6111", "kind": "property", "name": "harassment", "serializedName": "harassment", "doc": "The score for the category 'harassment'.", "type": { "$id": "6112", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.harassment", "serializationOptions": { "json": { "name": "harassment" } }, "isHttpMetadata": false }, { "$id": "6113", "kind": "property", "name": "harassment/threatening", "serializedName": "harassment/threatening", "doc": "The score for the category 'harassment/threatening'.", "type": { "$id": "6114", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.harassment/threatening", "serializationOptions": { "json": { "name": "harassment/threatening" } }, "isHttpMetadata": false }, { "$id": "6115", "kind": "property", "name": "illicit", "serializedName": "illicit", "doc": "The score for the category 'illicit'.", "type": { "$id": "6116", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.illicit", "serializationOptions": { "json": { "name": "illicit" } }, "isHttpMetadata": false }, { "$id": "6117", "kind": "property", "name": "illicit/violent", "serializedName": "illicit/violent", "doc": "The score for the category 'illicit/violent'.", "type": { "$id": "6118", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.illicit/violent", "serializationOptions": { "json": { "name": "illicit/violent" } }, "isHttpMetadata": false }, { "$id": "6119", "kind": "property", "name": "self-harm", "serializedName": "self-harm", "doc": "The score for the category 'self-harm'.", "type": { "$id": "6120", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.self-harm", "serializationOptions": { "json": { "name": "self-harm" } }, "isHttpMetadata": false }, { "$id": "6121", "kind": "property", "name": "self-harm/intent", "serializedName": "self-harm/intent", "doc": "The score for the category 'self-harm/intent'.", "type": { "$id": "6122", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.self-harm/intent", "serializationOptions": { "json": { "name": "self-harm/intent" } }, "isHttpMetadata": false }, { "$id": "6123", "kind": "property", "name": "self-harm/instructions", "serializedName": "self-harm/instructions", "doc": "The score for the category 'self-harm/instructions'.", "type": { "$id": "6124", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.self-harm/instructions", "serializationOptions": { "json": { "name": "self-harm/instructions" } }, "isHttpMetadata": false }, { "$id": "6125", "kind": "property", "name": "sexual", "serializedName": "sexual", "doc": "The score for the category 'sexual'.", "type": { "$id": "6126", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.sexual", "serializationOptions": { "json": { "name": "sexual" } }, "isHttpMetadata": false }, { "$id": "6127", "kind": "property", "name": "sexual/minors", "serializedName": "sexual/minors", "doc": "The score for the category 'sexual/minors'.", "type": { "$id": "6128", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.sexual/minors", "serializationOptions": { "json": { "name": "sexual/minors" } }, "isHttpMetadata": false }, { "$id": "6129", "kind": "property", "name": "violence", "serializedName": "violence", "doc": "The score for the category 'violence'.", "type": { "$id": "6130", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.violence", "serializationOptions": { "json": { "name": "violence" } }, "isHttpMetadata": false }, { "$id": "6131", "kind": "property", "name": "violence/graphic", "serializedName": "violence/graphic", "doc": "The score for the category 'violence/graphic'.", "type": { "$id": "6132", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores.anonymous.violence/graphic", "serializationOptions": { "json": { "name": "violence/graphic" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_scores", "serializationOptions": { "json": { "name": "category_scores" } }, "isHttpMetadata": false }, { "$id": "6133", "kind": "property", "name": "category_applied_input_types", "serializedName": "category_applied_input_types", "doc": "A list of the categories along with the input type(s) that the score applies to.", "type": { "$id": "6134", "kind": "model", "name": "CreateModerationResponseResultCategoryAppliedInputTypes", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6135", "kind": "property", "name": "hate", "serializedName": "hate", "doc": "The applied input type(s) for the category 'hate'.", "type": { "$id": "6136", "kind": "array", "name": "Array31", "valueType": { "$id": "6137", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1388" }, "enumType": { "$id": "6138", "kind": "enum", "decorators": [], "name": "ModerationAppliedInputType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6139", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6140", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "valueType": { "$ref": "6139" }, "enumType": { "$ref": "6138" } }, { "$id": "6141", "kind": "enumvalue", "decorators": [], "name": "image", "value": "image", "valueType": { "$ref": "6139" }, "enumType": { "$ref": "6138" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ModerationAppliedInputType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.hate", "serializationOptions": { "json": { "name": "hate" } }, "isHttpMetadata": false }, { "$id": "6142", "kind": "property", "name": "hate/threatening", "serializedName": "hate/threatening", "doc": "The applied input type(s) for the category 'hate/threatening'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.hate/threatening", "serializationOptions": { "json": { "name": "hate/threatening" } }, "isHttpMetadata": false }, { "$id": "6143", "kind": "property", "name": "harassment", "serializedName": "harassment", "doc": "The applied input type(s) for the category 'harassment'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.harassment", "serializationOptions": { "json": { "name": "harassment" } }, "isHttpMetadata": false }, { "$id": "6144", "kind": "property", "name": "harassment/threatening", "serializedName": "harassment/threatening", "doc": "The applied input type(s) for the category 'harassment/threatening'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.harassment/threatening", "serializationOptions": { "json": { "name": "harassment/threatening" } }, "isHttpMetadata": false }, { "$id": "6145", "kind": "property", "name": "illicit", "serializedName": "illicit", "doc": "The applied input type(s) for the category 'illicit'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.illicit", "serializationOptions": { "json": { "name": "illicit" } }, "isHttpMetadata": false }, { "$id": "6146", "kind": "property", "name": "illicit/violent", "serializedName": "illicit/violent", "doc": "The applied input type(s) for the category 'illicit/violent'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.illicit/violent", "serializationOptions": { "json": { "name": "illicit/violent" } }, "isHttpMetadata": false }, { "$id": "6147", "kind": "property", "name": "self-harm", "serializedName": "self-harm", "doc": "The applied input type(s) for the category 'self-harm'.", "type": { "$id": "6148", "kind": "array", "name": "Array32", "valueType": { "$id": "6149", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesSelfHarm", "variantTypes": [ { "$ref": "6137" }, { "$id": "6150", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "1388" }, "enumType": { "$ref": "6138" }, "decorators": [] } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.self-harm", "serializationOptions": { "json": { "name": "self-harm" } }, "isHttpMetadata": false }, { "$id": "6151", "kind": "property", "name": "self-harm/intent", "serializedName": "self-harm/intent", "doc": "The applied input type(s) for the category 'self-harm/intent'.", "type": { "$id": "6152", "kind": "array", "name": "Array33", "valueType": { "$id": "6153", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesSelfHarmIntent", "variantTypes": [ { "$ref": "6137" }, { "$ref": "6150" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.self-harm/intent", "serializationOptions": { "json": { "name": "self-harm/intent" } }, "isHttpMetadata": false }, { "$id": "6154", "kind": "property", "name": "self-harm/instructions", "serializedName": "self-harm/instructions", "doc": "The applied input type(s) for the category 'self-harm/instructions'.", "type": { "$id": "6155", "kind": "array", "name": "Array34", "valueType": { "$id": "6156", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesSelfHarmInstruction", "variantTypes": [ { "$ref": "6137" }, { "$ref": "6150" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.self-harm/instructions", "serializationOptions": { "json": { "name": "self-harm/instructions" } }, "isHttpMetadata": false }, { "$id": "6157", "kind": "property", "name": "sexual", "serializedName": "sexual", "doc": "The applied input type(s) for the category 'sexual'.", "type": { "$id": "6158", "kind": "array", "name": "Array35", "valueType": { "$id": "6159", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesSexual", "variantTypes": [ { "$ref": "6137" }, { "$ref": "6150" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.sexual", "serializationOptions": { "json": { "name": "sexual" } }, "isHttpMetadata": false }, { "$id": "6160", "kind": "property", "name": "sexual/minors", "serializedName": "sexual/minors", "doc": "The applied input type(s) for the category 'sexual/minors'.", "type": { "$ref": "6136" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.sexual/minors", "serializationOptions": { "json": { "name": "sexual/minors" } }, "isHttpMetadata": false }, { "$id": "6161", "kind": "property", "name": "violence", "serializedName": "violence", "doc": "The applied input type(s) for the category 'violence'.", "type": { "$id": "6162", "kind": "array", "name": "Array36", "valueType": { "$id": "6163", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesViolence", "variantTypes": [ { "$ref": "6137" }, { "$ref": "6150" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.violence", "serializationOptions": { "json": { "name": "violence" } }, "isHttpMetadata": false }, { "$id": "6164", "kind": "property", "name": "violence/graphic", "serializedName": "violence/graphic", "doc": "The applied input type(s) for the category 'violence/graphic'.", "type": { "$id": "6165", "kind": "array", "name": "Array37", "valueType": { "$id": "6166", "kind": "union", "name": "CreateModerationResponseResultCategoryAppliedInputTypesViolenceGraphic", "variantTypes": [ { "$ref": "6137" }, { "$ref": "6150" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types.anonymous.violence/graphic", "serializationOptions": { "json": { "name": "violence/graphic" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponseResult.category_applied_input_types", "serializationOptions": { "json": { "name": "category_applied_input_types" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateModerationResponse.results", "serializationOptions": { "json": { "name": "results" } }, "isHttpMetadata": false } ] }, { "$ref": "6074" }, { "$ref": "6078" }, { "$ref": "6106" }, { "$ref": "6134" }, { "$id": "6167", "kind": "model", "name": "CreateThreadAndRunRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6168", "kind": "property", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.", "type": { "$id": "6169", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.assistant_id", "serializationOptions": { "json": { "name": "assistant_id" } }, "isHttpMetadata": false }, { "$id": "6170", "kind": "property", "name": "thread", "serializedName": "thread", "type": { "$id": "6171", "kind": "model", "name": "CreateThreadRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest", "usage": "Input,Json", "doc": "Options to create a new thread. If no thread is provided when running a\nrequest, an empty thread will be created.", "decorators": [], "properties": [ { "$id": "6172", "kind": "property", "name": "messages", "serializedName": "messages", "doc": "A list of [messages](/docs/api-reference/messages) to start the thread with.", "type": { "$id": "6173", "kind": "array", "name": "ArrayCreateMessageRequest", "valueType": { "$ref": "5904" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.messages", "serializationOptions": { "json": { "name": "messages" } }, "isHttpMetadata": false }, { "$id": "6174", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "6175", "kind": "nullable", "type": { "$id": "6176", "kind": "model", "name": "CreateThreadRequestToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6177", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "6178", "kind": "model", "name": "CreateThreadRequestToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources.code_interpreter.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6179", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "6180", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$ref": "2460" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "6181", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.thread", "serializationOptions": { "json": { "name": "thread" } }, "isHttpMetadata": false }, { "$id": "6182", "kind": "property", "name": "model", "serializedName": "model", "doc": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", "type": { "$id": "6183", "kind": "nullable", "type": { "$ref": "899" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6184", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", "type": { "$id": "6185", "kind": "nullable", "type": { "$id": "6186", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "6187", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", "type": { "$id": "6188", "kind": "nullable", "type": { "$ref": "2330" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "6189", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "6190", "kind": "nullable", "type": { "$id": "6191", "kind": "model", "name": "CreateThreadAndRunRequestToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6192", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "6193", "kind": "model", "name": "CreateThreadAndRunRequestToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources.code_interpreter.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6194", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "6195", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$ref": "2376" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "6196", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "6197", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.", "type": { "$id": "6198", "kind": "nullable", "type": { "$id": "6199", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "6200", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", "type": { "$id": "6201", "kind": "nullable", "type": { "$id": "6202", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "6203", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.", "type": { "$id": "6204", "kind": "nullable", "type": { "$id": "6205", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false }, { "$id": "6206", "kind": "property", "name": "max_prompt_tokens", "serializedName": "max_prompt_tokens", "doc": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.", "type": { "$id": "6207", "kind": "nullable", "type": { "$id": "6208", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.max_prompt_tokens", "serializationOptions": { "json": { "name": "max_prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "6209", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.", "type": { "$id": "6210", "kind": "nullable", "type": { "$id": "6211", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "6212", "kind": "property", "name": "truncation_strategy", "serializedName": "truncation_strategy", "type": { "$id": "6213", "kind": "nullable", "type": { "$id": "6214", "kind": "model", "name": "TruncationObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.TruncationObject", "usage": "Input,Output,Json", "doc": "Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.", "decorators": [], "properties": [ { "$id": "6215", "kind": "property", "name": "type", "serializedName": "type", "doc": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", "type": { "$ref": "933" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TruncationObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6216", "kind": "property", "name": "last_messages", "serializedName": "last_messages", "doc": "The number of most recent messages from the thread when constructing the context for the run.", "type": { "$id": "6217", "kind": "nullable", "type": { "$id": "6218", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.TruncationObject.last_messages", "serializationOptions": { "json": { "name": "last_messages" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.truncation_strategy", "serializationOptions": { "json": { "name": "truncation_strategy" } }, "isHttpMetadata": false }, { "$id": "6219", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$id": "6220", "kind": "nullable", "type": { "$id": "6221", "kind": "union", "name": "AssistantsApiToolChoiceOption", "variantTypes": [ { "$ref": "937" }, { "$id": "6222", "kind": "model", "name": "AssistantsNamedToolChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice", "usage": "Input,Output,Json", "doc": "Specifies a tool the model should use. Use to force the model to call a specific tool.", "decorators": [], "properties": [ { "$id": "6223", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the tool. If type is `function`, the function name must be set", "type": { "$ref": "942" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6224", "kind": "property", "name": "function", "serializedName": "function", "type": { "$id": "6225", "kind": "model", "name": "AssistantsNamedToolChoiceFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice.function.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "6226", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function to call.", "type": { "$id": "6227", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantsNamedToolChoice.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "6228", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "type": { "$id": "6229", "kind": "boolean", "name": "ParallelToolCalls", "crossLanguageDefinitionId": "OpenAI.ParallelToolCalls", "baseType": { "$id": "6230", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "6231", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "6232", "kind": "nullable", "type": { "$ref": "2391" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateThreadAndRunRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, { "$ref": "6171" }, { "$ref": "6176" }, { "$ref": "6178" }, { "$ref": "6191" }, { "$ref": "6193" }, { "$ref": "6214" }, { "$ref": "6222" }, { "$ref": "6225" }, { "$id": "6233", "kind": "model", "name": "RunObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunObject", "usage": "Output,Json", "doc": "Represents an execution run on a [thread](/docs/api-reference/threads).", "decorators": [], "properties": [ { "$id": "6234", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "6235", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6236", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `thread.run`.", "type": { "$ref": "1625" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6237", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the run was created.", "type": { "$id": "6238", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6239", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6240", "kind": "property", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", "type": { "$id": "6241", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.thread_id", "serializationOptions": { "json": { "name": "thread_id" } }, "isHttpMetadata": false }, { "$id": "6242", "kind": "property", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.", "type": { "$id": "6243", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.assistant_id", "serializationOptions": { "json": { "name": "assistant_id" } }, "isHttpMetadata": false }, { "$id": "6244", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.", "type": { "$ref": "947" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6245", "kind": "property", "name": "required_action", "serializedName": "required_action", "doc": "Details on the action required to continue the run. Will be `null` if no action is required.", "type": { "$id": "6246", "kind": "nullable", "type": { "$id": "6247", "kind": "model", "name": "RunObjectRequiredAction1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunObject.required_action.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6248", "kind": "property", "name": "type", "serializedName": "type", "doc": "For now, this is always `submit_tool_outputs`.", "type": { "$ref": "1627" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.required_action.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6249", "kind": "property", "name": "submit_tool_outputs", "serializedName": "submit_tool_outputs", "doc": "Details on the tool outputs needed for this run to continue.", "type": { "$id": "6250", "kind": "model", "name": "RunObjectRequiredActionSubmitToolOutputs", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunObject.required_action.submit_tool_outputs.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6251", "kind": "property", "name": "tool_calls", "serializedName": "tool_calls", "doc": "A list of the relevant tool calls.", "type": { "$id": "6252", "kind": "array", "name": "ArrayRunToolCallObject", "valueType": { "$id": "6253", "kind": "model", "name": "RunToolCallObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunToolCallObject", "usage": "Output,Json", "doc": "Tool call objects", "decorators": [], "properties": [ { "$id": "6254", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint.", "type": { "$id": "6255", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6256", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool call the output is required for. For now, this is always `function`.", "type": { "$ref": "1629" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6257", "kind": "property", "name": "function", "serializedName": "function", "doc": "The function definition.", "type": { "$id": "6258", "kind": "model", "name": "RunToolCallObjectFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.function.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6259", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function.", "type": { "$id": "6260", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6261", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "The arguments that the model expects you to pass to the function.", "type": { "$id": "6262", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.function.anonymous.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunToolCallObject.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.required_action.submit_tool_outputs.anonymous.tool_calls", "serializationOptions": { "json": { "name": "tool_calls" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.required_action.anonymous.submit_tool_outputs", "serializationOptions": { "json": { "name": "submit_tool_outputs" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.required_action", "serializationOptions": { "json": { "name": "required_action" } }, "isHttpMetadata": false }, { "$id": "6263", "kind": "property", "name": "last_error", "serializedName": "last_error", "doc": "The last error associated with this run. Will be `null` if there are no errors.", "type": { "$id": "6264", "kind": "nullable", "type": { "$id": "6265", "kind": "model", "name": "RunObjectLastError1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunObject.last_error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6266", "kind": "property", "name": "code", "serializedName": "code", "doc": "One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`.", "type": { "$ref": "958" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.last_error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "6267", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable description of the error.", "type": { "$id": "6268", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.last_error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.last_error", "serializationOptions": { "json": { "name": "last_error" } }, "isHttpMetadata": false }, { "$id": "6269", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when the run will expire.", "type": { "$id": "6270", "kind": "nullable", "type": { "$id": "6271", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6272", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "6273", "kind": "property", "name": "started_at", "serializedName": "started_at", "doc": "The Unix timestamp (in seconds) for when the run was started.", "type": { "$id": "6274", "kind": "nullable", "type": { "$id": "6275", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6276", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.started_at", "serializationOptions": { "json": { "name": "started_at" } }, "isHttpMetadata": false }, { "$id": "6277", "kind": "property", "name": "cancelled_at", "serializedName": "cancelled_at", "doc": "The Unix timestamp (in seconds) for when the run was cancelled.", "type": { "$id": "6278", "kind": "nullable", "type": { "$id": "6279", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6280", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.cancelled_at", "serializationOptions": { "json": { "name": "cancelled_at" } }, "isHttpMetadata": false }, { "$id": "6281", "kind": "property", "name": "failed_at", "serializedName": "failed_at", "doc": "The Unix timestamp (in seconds) for when the run failed.", "type": { "$id": "6282", "kind": "nullable", "type": { "$id": "6283", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6284", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.failed_at", "serializationOptions": { "json": { "name": "failed_at" } }, "isHttpMetadata": false }, { "$id": "6285", "kind": "property", "name": "completed_at", "serializedName": "completed_at", "doc": "The Unix timestamp (in seconds) for when the run was completed.", "type": { "$id": "6286", "kind": "nullable", "type": { "$id": "6287", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6288", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.completed_at", "serializationOptions": { "json": { "name": "completed_at" } }, "isHttpMetadata": false }, { "$id": "6289", "kind": "property", "name": "incomplete_details", "serializedName": "incomplete_details", "doc": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", "type": { "$id": "6290", "kind": "nullable", "type": { "$id": "6291", "kind": "model", "name": "RunObjectIncompleteDetails1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunObject.incomplete_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6292", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", "type": { "$ref": "963" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.incomplete_details.anonymous.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.incomplete_details", "serializationOptions": { "json": { "name": "incomplete_details" } }, "isHttpMetadata": false }, { "$id": "6293", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "$id": "6294", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6295", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The instructions that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "$id": "6296", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "6297", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.", "type": { "$ref": "2330" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "6298", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "6299", "kind": "property", "name": "usage", "serializedName": "usage", "type": { "$id": "6300", "kind": "nullable", "type": { "$id": "6301", "kind": "model", "name": "RunCompletionUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunCompletionUsage", "usage": "Output,Json", "doc": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", "decorators": [], "properties": [ { "$id": "6302", "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", "doc": "Number of completion tokens used over the course of the run.", "type": { "$id": "6303", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCompletionUsage.completion_tokens", "serializationOptions": { "json": { "name": "completion_tokens" } }, "isHttpMetadata": false }, { "$id": "6304", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "Number of prompt tokens used over the course of the run.", "type": { "$id": "6305", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCompletionUsage.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "6306", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "Total number of tokens used (prompt + completion).", "type": { "$id": "6307", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCompletionUsage.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false }, { "$id": "6308", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "The sampling temperature used for this run. If not set, defaults to 1.", "type": { "$id": "6309", "kind": "nullable", "type": { "$id": "6310", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "6311", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "The nucleus sampling value used for this run. If not set, defaults to 1.", "type": { "$id": "6312", "kind": "nullable", "type": { "$id": "6313", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "6314", "kind": "property", "name": "max_prompt_tokens", "serializedName": "max_prompt_tokens", "doc": "The maximum number of prompt tokens specified to have been used over the course of the run.", "type": { "$id": "6315", "kind": "nullable", "type": { "$id": "6316", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.max_prompt_tokens", "serializationOptions": { "json": { "name": "max_prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "6317", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of completion tokens specified to have been used over the course of the run.", "type": { "$id": "6318", "kind": "nullable", "type": { "$id": "6319", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "6320", "kind": "property", "name": "truncation_strategy", "serializedName": "truncation_strategy", "type": { "$id": "6321", "kind": "nullable", "type": { "$ref": "6214" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.truncation_strategy", "serializationOptions": { "json": { "name": "truncation_strategy" } }, "isHttpMetadata": false }, { "$id": "6322", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$id": "6323", "kind": "nullable", "type": { "$ref": "6221" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "6324", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "type": { "$id": "6325", "kind": "boolean", "name": "ParallelToolCalls", "crossLanguageDefinitionId": "OpenAI.ParallelToolCalls", "baseType": { "$id": "6326", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "6327", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "6328", "kind": "nullable", "type": { "$ref": "2391" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunObject.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, { "$ref": "6247" }, { "$ref": "6250" }, { "$ref": "6253" }, { "$ref": "6258" }, { "$ref": "6265" }, { "$ref": "6291" }, { "$ref": "6301" }, { "$id": "6329", "kind": "model", "name": "CreateRunRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateRunRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6330", "kind": "property", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.", "type": { "$id": "6331", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.assistant_id", "serializationOptions": { "json": { "name": "assistant_id" } }, "isHttpMetadata": false }, { "$id": "6332", "kind": "property", "name": "model", "serializedName": "model", "doc": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", "type": { "$id": "6333", "kind": "nullable", "type": { "$ref": "15" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6334", "kind": "property", "name": "reasoning_effort", "serializedName": "reasoning_effort", "type": { "$id": "6335", "kind": "nullable", "type": { "$ref": "53" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.reasoning_effort", "serializationOptions": { "json": { "name": "reasoning_effort" } }, "isHttpMetadata": false }, { "$id": "6336", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.", "type": { "$id": "6337", "kind": "nullable", "type": { "$id": "6338", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "6339", "kind": "property", "name": "additional_instructions", "serializedName": "additional_instructions", "doc": "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.", "type": { "$id": "6340", "kind": "nullable", "type": { "$id": "6341", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.additional_instructions", "serializationOptions": { "json": { "name": "additional_instructions" } }, "isHttpMetadata": false }, { "$id": "6342", "kind": "property", "name": "additional_messages", "serializedName": "additional_messages", "doc": "Adds additional messages to the thread before creating the run.", "type": { "$id": "6343", "kind": "nullable", "type": { "$ref": "6173" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.additional_messages", "serializationOptions": { "json": { "name": "additional_messages" } }, "isHttpMetadata": false }, { "$id": "6344", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", "type": { "$id": "6345", "kind": "nullable", "type": { "$ref": "2330" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "6346", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "6347", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.", "type": { "$id": "6348", "kind": "nullable", "type": { "$id": "6349", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "6350", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.", "type": { "$id": "6351", "kind": "nullable", "type": { "$id": "6352", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "6353", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.", "type": { "$id": "6354", "kind": "nullable", "type": { "$id": "6355", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false }, { "$id": "6356", "kind": "property", "name": "max_prompt_tokens", "serializedName": "max_prompt_tokens", "doc": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.", "type": { "$id": "6357", "kind": "nullable", "type": { "$id": "6358", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.max_prompt_tokens", "serializationOptions": { "json": { "name": "max_prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "6359", "kind": "property", "name": "max_completion_tokens", "serializedName": "max_completion_tokens", "doc": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.", "type": { "$id": "6360", "kind": "nullable", "type": { "$id": "6361", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.max_completion_tokens", "serializationOptions": { "json": { "name": "max_completion_tokens" } }, "isHttpMetadata": false }, { "$id": "6362", "kind": "property", "name": "truncation_strategy", "serializedName": "truncation_strategy", "type": { "$id": "6363", "kind": "nullable", "type": { "$ref": "6214" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.truncation_strategy", "serializationOptions": { "json": { "name": "truncation_strategy" } }, "isHttpMetadata": false }, { "$id": "6364", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$id": "6365", "kind": "nullable", "type": { "$ref": "6221" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "6366", "kind": "property", "name": "parallel_tool_calls", "serializedName": "parallel_tool_calls", "type": { "$id": "6367", "kind": "boolean", "name": "ParallelToolCalls", "crossLanguageDefinitionId": "OpenAI.ParallelToolCalls", "baseType": { "$id": "6368", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.parallel_tool_calls", "serializationOptions": { "json": { "name": "parallel_tool_calls" } }, "isHttpMetadata": false }, { "$id": "6369", "kind": "property", "name": "response_format", "serializedName": "response_format", "type": { "$id": "6370", "kind": "nullable", "type": { "$ref": "2391" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateRunRequest.response_format", "serializationOptions": { "json": { "name": "response_format" } }, "isHttpMetadata": false } ] }, { "$id": "6371", "kind": "model", "name": "ListRunsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListRunsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6372", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1631" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6373", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6374", "kind": "array", "name": "ArrayRunObject", "valueType": { "$ref": "6233" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6375", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "6376", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunsResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "6377", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "6378", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunsResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "6379", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "6380", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$id": "6381", "kind": "model", "name": "ModifyRunRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyRunRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6382", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyRunRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "6383", "kind": "model", "name": "SubmitToolOutputsRunRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6384", "kind": "property", "name": "tool_outputs", "serializedName": "tool_outputs", "doc": "A list of tools for which the outputs are being submitted.", "type": { "$id": "6385", "kind": "array", "name": "Array38", "valueType": { "$id": "6386", "kind": "model", "name": "SubmitToolOutputsRunRequestToolOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest.tool_output.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6387", "kind": "property", "name": "tool_call_id", "serializedName": "tool_call_id", "doc": "The ID of the tool call in the `required_action` object within the run object the output is being submitted for.", "type": { "$id": "6388", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest.tool_output.anonymous.tool_call_id", "serializationOptions": { "json": { "name": "tool_call_id" } }, "isHttpMetadata": false }, { "$id": "6389", "kind": "property", "name": "output", "serializedName": "output", "doc": "The output of the tool call to be submitted to continue the run.", "type": { "$id": "6390", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest.tool_output.anonymous.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest.tool_outputs", "serializationOptions": { "json": { "name": "tool_outputs" } }, "isHttpMetadata": false }, { "$id": "6391", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.", "type": { "$id": "6392", "kind": "nullable", "type": { "$id": "6393", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.SubmitToolOutputsRunRequest.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false } ] }, { "$ref": "6386" }, { "$id": "6394", "kind": "model", "name": "ListRunStepsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6395", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1633" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6396", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6397", "kind": "array", "name": "ArrayRunStepObject", "valueType": { "$id": "6398", "kind": "model", "name": "RunStepObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepObject", "usage": "Output,Json", "doc": "Represents a step in execution of a run.", "decorators": [], "properties": [ { "$id": "6399", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "$id": "6400", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6401", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `thread.run.step`.", "type": { "$ref": "1635" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6402", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the run step was created.", "type": { "$id": "6403", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6404", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6405", "kind": "property", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", "type": { "$id": "6406", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.assistant_id", "serializationOptions": { "json": { "name": "assistant_id" } }, "isHttpMetadata": false }, { "$id": "6407", "kind": "property", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "$id": "6408", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.thread_id", "serializationOptions": { "json": { "name": "thread_id" } }, "isHttpMetadata": false }, { "$id": "6409", "kind": "property", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", "type": { "$id": "6410", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.run_id", "serializationOptions": { "json": { "name": "run_id" } }, "isHttpMetadata": false }, { "$id": "6411", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of run step, which can be either `message_creation` or `tool_calls`.", "type": { "$ref": "967" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6412", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", "type": { "$ref": "971" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6413", "kind": "property", "name": "step_details", "serializedName": "step_details", "doc": "The details of the run step.", "type": { "$id": "6414", "kind": "model", "name": "RunStepObjectStepDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepObjectStepDetails", "usage": "Output,Json", "doc": "Abstractly represents a run step details object.", "decorators": [], "discriminatorProperty": { "$id": "6415", "kind": "property", "name": "type", "serializedName": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "978" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObjectStepDetails.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6415" } ], "discriminatedSubtypes": { "message_creation": { "$id": "6416", "kind": "model", "name": "RunStepDetailsMessageCreationObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsMessageCreationObject", "usage": "Output,Json", "doc": "Details of the message creation by the run step.", "discriminatorValue": "message_creation", "decorators": [], "baseModel": { "$ref": "6414" }, "properties": [ { "$id": "6417", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `message_creation`.", "type": { "$id": "6418", "kind": "enumvalue", "name": "message_creation", "value": "message_creation", "valueType": { "$ref": "979" }, "enumType": { "$id": "6419", "kind": "enum", "decorators": [], "name": "RunStepDetailsType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6420", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6421", "kind": "enumvalue", "decorators": [], "name": "message_creation", "value": "message_creation", "valueType": { "$ref": "6420" }, "enumType": { "$ref": "6419" } }, { "$id": "6422", "kind": "enumvalue", "decorators": [], "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "6420" }, "enumType": { "$ref": "6419" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsMessageCreationObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6423", "kind": "property", "name": "message_creation", "serializedName": "message_creation", "type": { "$id": "6424", "kind": "model", "name": "RunStepDetailsMessageCreationObjectMessageCreation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsMessageCreationObject.message_creation.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6425", "kind": "property", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message that was created by this run step.", "type": { "$id": "6426", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsMessageCreationObject.message_creation.anonymous.message_id", "serializationOptions": { "json": { "name": "message_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsMessageCreationObject.message_creation", "serializationOptions": { "json": { "name": "message_creation" } }, "isHttpMetadata": false } ] }, "tool_calls": { "$id": "6427", "kind": "model", "name": "RunStepDetailsToolCallsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObject", "usage": "Output,Json", "doc": "Details of the tool call.", "discriminatorValue": "tool_calls", "decorators": [], "baseModel": { "$ref": "6414" }, "properties": [ { "$id": "6428", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `tool_calls`.", "type": { "$id": "6429", "kind": "enumvalue", "name": "tool_calls", "value": "tool_calls", "valueType": { "$ref": "979" }, "enumType": { "$ref": "6419" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6430", "kind": "property", "name": "tool_calls", "serializedName": "tool_calls", "doc": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.", "type": { "$id": "6431", "kind": "array", "name": "ArrayRunStepDetailsToolCallsObjectToolCallsObject", "valueType": { "$id": "6432", "kind": "model", "name": "RunStepDetailsToolCallsObjectToolCallsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObjectToolCallsObject", "usage": "Output,Json", "doc": "Abstractly represents a run step tool call details inner object.", "decorators": [], "discriminatorProperty": { "$id": "6433", "kind": "property", "name": "type", "serializedName": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "982" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObjectToolCallsObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6433" }, { "$id": "6434", "kind": "property", "name": "id", "serializedName": "id", "doc": "The ID of the tool call object.", "type": { "$id": "6435", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObjectToolCallsObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "code_interpreter": { "$id": "6436", "kind": "model", "name": "RunStepDetailsToolCallsCodeObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject", "usage": "Output,Json", "doc": "Details of the Code Interpreter tool call the run step was involved in.", "discriminatorValue": "code_interpreter", "decorators": [], "baseModel": { "$ref": "6432" }, "properties": [ { "$id": "6437", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "$id": "6438", "kind": "enumvalue", "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "983" }, "enumType": { "$id": "6439", "kind": "enum", "decorators": [], "name": "RunStepDetailsToolCallType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6440", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6441", "kind": "enumvalue", "decorators": [], "name": "code_interpreter", "value": "code_interpreter", "valueType": { "$ref": "6440" }, "enumType": { "$ref": "6439" } }, { "$id": "6442", "kind": "enumvalue", "decorators": [], "name": "file_search", "value": "file_search", "valueType": { "$ref": "6440" }, "enumType": { "$ref": "6439" } }, { "$id": "6443", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "valueType": { "$ref": "6440" }, "enumType": { "$ref": "6439" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6444", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "doc": "The Code Interpreter tool call definition.", "type": { "$id": "6445", "kind": "model", "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject.code_interpreter.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6446", "kind": "property", "name": "input", "serializedName": "input", "doc": "The input to the Code Interpreter tool call.", "type": { "$id": "6447", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject.code_interpreter.anonymous.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false }, { "$id": "6448", "kind": "property", "name": "outputs", "serializedName": "outputs", "doc": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "$id": "6449", "kind": "array", "name": "ArrayRunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "valueType": { "$id": "6450", "kind": "model", "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "usage": "Output,Json", "doc": "Abstractly represents a run step tool call details code interpreter output.", "decorators": [], "discriminatorProperty": { "$id": "6451", "kind": "property", "name": "type", "serializedName": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "987" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6451" } ], "discriminatedSubtypes": { "logs": { "$id": "6452", "kind": "model", "name": "RunStepDetailsToolCallsCodeOutputLogsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject", "usage": "Output,Json", "doc": "Text output from the Code Interpreter tool call as part of a run step.", "discriminatorValue": "logs", "decorators": [], "baseModel": { "$ref": "6450" }, "properties": [ { "$id": "6453", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `logs`.", "type": { "$id": "6454", "kind": "enumvalue", "name": "logs", "value": "logs", "valueType": { "$ref": "988" }, "enumType": { "$id": "6455", "kind": "enum", "decorators": [], "name": "RunStepDetailsCodeInterpreterOutputType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6456", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6457", "kind": "enumvalue", "decorators": [], "name": "logs", "value": "logs", "valueType": { "$ref": "6456" }, "enumType": { "$ref": "6455" } }, { "$id": "6458", "kind": "enumvalue", "decorators": [], "name": "image", "value": "image", "valueType": { "$ref": "6456" }, "enumType": { "$ref": "6455" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsCodeInterpreterOutputType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6459", "kind": "property", "name": "logs", "serializedName": "logs", "doc": "The text output from the Code Interpreter tool call.", "type": { "$id": "6460", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject.logs", "serializationOptions": { "json": { "name": "logs" } }, "isHttpMetadata": false } ] }, "image": { "$id": "6461", "kind": "model", "name": "RunStepDetailsToolCallsCodeOutputImageObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputImageObject", "usage": "Output,Json", "discriminatorValue": "image", "decorators": [], "baseModel": { "$ref": "6450" }, "properties": [ { "$id": "6462", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `image`.", "type": { "$id": "6463", "kind": "enumvalue", "name": "image", "value": "image", "valueType": { "$ref": "988" }, "enumType": { "$ref": "6455" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputImageObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6464", "kind": "property", "name": "image", "serializedName": "image", "type": { "$id": "6465", "kind": "model", "name": "RunStepDetailsToolCallsCodeOutputImageObjectImage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputImageObject.image.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6466", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The [file](/docs/api-reference/files) ID of the image.", "type": { "$id": "6467", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputImageObject.image.anonymous.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeOutputImageObject.image", "serializationOptions": { "json": { "name": "image" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject.code_interpreter.anonymous.outputs", "serializationOptions": { "json": { "name": "outputs" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsCodeObject.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false } ] }, "file_search": { "$id": "6468", "kind": "model", "name": "RunStepDetailsToolCallsFileSearchObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject", "usage": "Output,Json", "discriminatorValue": "file_search", "decorators": [], "baseModel": { "$ref": "6432" }, "properties": [ { "$id": "6469", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "$id": "6470", "kind": "enumvalue", "name": "file_search", "value": "file_search", "valueType": { "$ref": "983" }, "enumType": { "$ref": "6439" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6471", "kind": "property", "name": "file_search", "serializedName": "file_search", "doc": "For now, this is always going to be an empty object.", "type": { "$id": "6472", "kind": "model", "name": "RunStepDetailsToolCallsFileSearchObjectFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject.file_search.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6473", "kind": "property", "name": "ranking_options", "serializedName": "ranking_options", "type": { "$id": "6474", "kind": "model", "name": "RunStepDetailsToolCallsFileSearchRankingOptionsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject", "usage": "Output,Json", "doc": "The ranking options for the file search.", "decorators": [], "properties": [ { "$id": "6475", "kind": "property", "name": "ranker", "serializedName": "ranker", "type": { "$ref": "6" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject.ranker", "serializationOptions": { "json": { "name": "ranker" } }, "isHttpMetadata": false }, { "$id": "6476", "kind": "property", "name": "score_threshold", "serializedName": "score_threshold", "doc": "The score threshold for the file search. All values must be a floating point number between 0 and 1.", "type": { "$id": "6477", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject.score_threshold", "serializationOptions": { "json": { "name": "score_threshold" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject.file_search.anonymous.ranking_options", "serializationOptions": { "json": { "name": "ranking_options" } }, "isHttpMetadata": false }, { "$id": "6478", "kind": "property", "name": "results", "serializedName": "results", "doc": "The results of the file search.", "type": { "$id": "6479", "kind": "array", "name": "ArrayRunStepDetailsToolCallsFileSearchResultObject", "valueType": { "$id": "6480", "kind": "model", "name": "RunStepDetailsToolCallsFileSearchResultObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject", "usage": "Output,Json", "doc": "A result instance of the file search.", "decorators": [], "properties": [ { "$id": "6481", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file that result was found in.", "type": { "$id": "6482", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "6483", "kind": "property", "name": "file_name", "serializedName": "file_name", "doc": "The name of the file that result was found in.", "type": { "$id": "6484", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.file_name", "serializationOptions": { "json": { "name": "file_name" } }, "isHttpMetadata": false }, { "$id": "6485", "kind": "property", "name": "score", "serializedName": "score", "doc": "The score of the result. All values must be a floating point number between 0 and 1.", "type": { "$id": "6486", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.score", "serializationOptions": { "json": { "name": "score" } }, "isHttpMetadata": false }, { "$id": "6487", "kind": "property", "name": "content", "serializedName": "content", "doc": "The content of the result that was found. The content is only included if requested via the include query parameter.", "type": { "$id": "6488", "kind": "array", "name": "Array39", "valueType": { "$id": "6489", "kind": "model", "name": "RunStepDetailsToolCallsFileSearchResultObjectContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.content.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6490", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of the content.", "type": { "$id": "6491", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1395" }, "enumType": { "$id": "6492", "kind": "enum", "decorators": [], "name": "RunStepDetailsToolCallsFileSearchResultObjectContentType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6493", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6494", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "enumType": { "$ref": "6492" }, "valueType": { "$ref": "6493" } } ], "isFixed": true, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContentType", "apiVersions": [], "isUnionAsEnum": false, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.content.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6495", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text content of the file.", "type": { "$id": "6496", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.content.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchResultObject.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject.file_search.anonymous.results", "serializationOptions": { "json": { "name": "results" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFileSearchObject.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "function": { "$id": "6497", "kind": "model", "name": "RunStepDetailsToolCallsFunctionObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject", "usage": "Output,Json", "discriminatorValue": "function", "decorators": [], "baseModel": { "$ref": "6432" }, "properties": [ { "$id": "6498", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "$id": "6499", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "983" }, "enumType": { "$ref": "6439" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6500", "kind": "property", "name": "function", "serializedName": "function", "doc": "The definition of the function that was called.", "type": { "$id": "6501", "kind": "model", "name": "RunStepDetailsToolCallsFunctionObjectFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.function.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6502", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the function.", "type": { "$id": "6503", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6504", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "The arguments passed to the function.", "type": { "$id": "6505", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.function.anonymous.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false }, { "$id": "6506", "kind": "property", "name": "output", "serializedName": "output", "doc": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "$id": "6507", "kind": "nullable", "type": { "$id": "6508", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.function.anonymous.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsFunctionObject.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDetailsToolCallsObject.tool_calls", "serializationOptions": { "json": { "name": "tool_calls" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.step_details", "serializationOptions": { "json": { "name": "step_details" } }, "isHttpMetadata": false }, { "$id": "6509", "kind": "property", "name": "last_error", "serializedName": "last_error", "doc": "The last error associated with this run step. Will be `null` if there are no errors.", "type": { "$id": "6510", "kind": "nullable", "type": { "$id": "6511", "kind": "model", "name": "RunStepObjectLastError1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepObject.last_error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6512", "kind": "property", "name": "code", "serializedName": "code", "doc": "One of `server_error` or `rate_limit_exceeded`.", "type": { "$ref": "991" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.last_error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "6513", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable description of the error.", "type": { "$id": "6514", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.last_error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.last_error", "serializationOptions": { "json": { "name": "last_error" } }, "isHttpMetadata": false }, { "$id": "6515", "kind": "property", "name": "expired_at", "serializedName": "expired_at", "doc": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", "type": { "$id": "6516", "kind": "nullable", "type": { "$id": "6517", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6518", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.expired_at", "serializationOptions": { "json": { "name": "expired_at" } }, "isHttpMetadata": false }, { "$id": "6519", "kind": "property", "name": "cancelled_at", "serializedName": "cancelled_at", "doc": "The Unix timestamp (in seconds) for when the run step was cancelled.", "type": { "$id": "6520", "kind": "nullable", "type": { "$id": "6521", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6522", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.cancelled_at", "serializationOptions": { "json": { "name": "cancelled_at" } }, "isHttpMetadata": false }, { "$id": "6523", "kind": "property", "name": "failed_at", "serializedName": "failed_at", "doc": "The Unix timestamp (in seconds) for when the run step failed.", "type": { "$id": "6524", "kind": "nullable", "type": { "$id": "6525", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6526", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.failed_at", "serializationOptions": { "json": { "name": "failed_at" } }, "isHttpMetadata": false }, { "$id": "6527", "kind": "property", "name": "completed_at", "serializedName": "completed_at", "doc": "The Unix timestamp (in seconds) for when the run step completed.", "type": { "$id": "6528", "kind": "nullable", "type": { "$id": "6529", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6530", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.completed_at", "serializationOptions": { "json": { "name": "completed_at" } }, "isHttpMetadata": false }, { "$id": "6531", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "6532", "kind": "property", "name": "usage", "serializedName": "usage", "type": { "$id": "6533", "kind": "nullable", "type": { "$id": "6534", "kind": "model", "name": "RunStepCompletionUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepCompletionUsage", "usage": "Output,Json", "doc": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", "decorators": [], "properties": [ { "$id": "6535", "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", "doc": "Number of completion tokens used over the course of the run step.", "type": { "$id": "6536", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCompletionUsage.completion_tokens", "serializationOptions": { "json": { "name": "completion_tokens" } }, "isHttpMetadata": false }, { "$id": "6537", "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", "doc": "Number of prompt tokens used over the course of the run step.", "type": { "$id": "6538", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCompletionUsage.prompt_tokens", "serializationOptions": { "json": { "name": "prompt_tokens" } }, "isHttpMetadata": false }, { "$id": "6539", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "Total number of tokens used (prompt + completion).", "type": { "$id": "6540", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCompletionUsage.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepObject.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6541", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "6542", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "6543", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "6544", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "6545", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "6546", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListRunStepsResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "6398" }, { "$ref": "6414" }, { "$ref": "6416" }, { "$ref": "6424" }, { "$ref": "6427" }, { "$ref": "6432" }, { "$ref": "6436" }, { "$ref": "6445" }, { "$ref": "6450" }, { "$ref": "6452" }, { "$ref": "6461" }, { "$ref": "6465" }, { "$ref": "6468" }, { "$ref": "6472" }, { "$ref": "6474" }, { "$ref": "6480" }, { "$ref": "6489" }, { "$ref": "6497" }, { "$ref": "6501" }, { "$ref": "6511" }, { "$ref": "6534" }, { "$id": "6547", "kind": "model", "name": "ThreadObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ThreadObject", "usage": "Output,Json", "doc": "Represents a thread that contains [messages](/docs/api-reference/messages).", "decorators": [], "properties": [ { "$id": "6548", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "6549", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6550", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `thread`.", "type": { "$ref": "1637" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6551", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the thread was created.", "type": { "$id": "6552", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6553", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6554", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "6555", "kind": "nullable", "type": { "$id": "6556", "kind": "model", "name": "ThreadObjectToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6557", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "6558", "kind": "model", "name": "ThreadObjectToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.code_interpreter.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6559", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "6560", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$id": "6561", "kind": "model", "name": "ThreadObjectToolResourcesFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.file_search.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6562", "kind": "property", "name": "vector_store_ids", "serializedName": "vector_store_ids", "doc": "The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.file_search.anonymous.vector_store_ids", "serializationOptions": { "json": { "name": "vector_store_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "6563", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ThreadObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "6556" }, { "$ref": "6558" }, { "$ref": "6561" }, { "$id": "6564", "kind": "model", "name": "ModifyThreadRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6565", "kind": "property", "name": "tool_resources", "serializedName": "tool_resources", "doc": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.", "type": { "$id": "6566", "kind": "nullable", "type": { "$id": "6567", "kind": "model", "name": "ModifyThreadRequestToolResources1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6568", "kind": "property", "name": "code_interpreter", "serializedName": "code_interpreter", "type": { "$id": "6569", "kind": "model", "name": "ModifyThreadRequestToolResourcesCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources.code_interpreter.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6570", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources.code_interpreter.anonymous.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources.anonymous.code_interpreter", "serializationOptions": { "json": { "name": "code_interpreter" } }, "isHttpMetadata": false }, { "$id": "6571", "kind": "property", "name": "file_search", "serializedName": "file_search", "type": { "$ref": "2376" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources.anonymous.file_search", "serializationOptions": { "json": { "name": "file_search" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.tool_resources", "serializationOptions": { "json": { "name": "tool_resources" } }, "isHttpMetadata": false }, { "$id": "6572", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ModifyThreadRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$ref": "6567" }, { "$ref": "6569" }, { "$id": "6573", "kind": "model", "name": "DeleteThreadResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteThreadResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6574", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "6575", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteThreadResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6576", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "6577", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteThreadResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "6578", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1639" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteThreadResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "6579", "kind": "model", "name": "ListVectorStoresResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6580", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1641" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6581", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6582", "kind": "array", "name": "ArrayVectorStoreObject", "valueType": { "$id": "6583", "kind": "model", "name": "VectorStoreObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreObject", "usage": "Output,Json", "doc": "A vector store is a collection of processed files can be used by the `file_search` tool.", "decorators": [], "properties": [ { "$id": "6584", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "6585", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6586", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `vector_store`.", "type": { "$ref": "1643" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6587", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the vector store was created.", "type": { "$id": "6588", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6589", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6590", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the vector store.", "type": { "$id": "6591", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6592", "kind": "property", "name": "usage_bytes", "serializedName": "usage_bytes", "doc": "The total number of bytes used by the files in the vector store.", "type": { "$id": "6593", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.usage_bytes", "serializationOptions": { "json": { "name": "usage_bytes" } }, "isHttpMetadata": false }, { "$id": "6594", "kind": "property", "name": "file_counts", "serializedName": "file_counts", "type": { "$id": "6595", "kind": "model", "name": "VectorStoreObjectFileCounts", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6596", "kind": "property", "name": "in_progress", "serializedName": "in_progress", "doc": "The number of files that are currently being processed.", "type": { "$id": "6597", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous.in_progress", "serializationOptions": { "json": { "name": "in_progress" } }, "isHttpMetadata": false }, { "$id": "6598", "kind": "property", "name": "completed", "serializedName": "completed", "doc": "The number of files that have been successfully processed.", "type": { "$id": "6599", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous.completed", "serializationOptions": { "json": { "name": "completed" } }, "isHttpMetadata": false }, { "$id": "6600", "kind": "property", "name": "failed", "serializedName": "failed", "doc": "The number of files that have failed to process.", "type": { "$id": "6601", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous.failed", "serializationOptions": { "json": { "name": "failed" } }, "isHttpMetadata": false }, { "$id": "6602", "kind": "property", "name": "cancelled", "serializedName": "cancelled", "doc": "The number of files that were cancelled.", "type": { "$id": "6603", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous.cancelled", "serializationOptions": { "json": { "name": "cancelled" } }, "isHttpMetadata": false }, { "$id": "6604", "kind": "property", "name": "total", "serializedName": "total", "doc": "The total number of files.", "type": { "$id": "6605", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts.anonymous.total", "serializationOptions": { "json": { "name": "total" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.file_counts", "serializationOptions": { "json": { "name": "file_counts" } }, "isHttpMetadata": false }, { "$id": "6606", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.", "type": { "$ref": "995" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6607", "kind": "property", "name": "expires_after", "serializedName": "expires_after", "type": { "$id": "6608", "kind": "model", "name": "VectorStoreExpirationAfter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreExpirationAfter", "usage": "Input,Output,Json", "doc": "The expiration policy for a vector store.", "decorators": [], "properties": [ { "$id": "6609", "kind": "property", "name": "anchor", "serializedName": "anchor", "doc": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.", "type": { "$id": "6610", "kind": "enumvalue", "name": "last_active_at", "value": "last_active_at", "valueType": { "$ref": "1398" }, "enumType": { "$id": "6611", "kind": "enum", "decorators": [], "name": "VectorStoreExpirationAnchor", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6612", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6613", "kind": "enumvalue", "decorators": [], "name": "last_active_at", "value": "last_active_at", "enumType": { "$ref": "6611" }, "valueType": { "$ref": "6612" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.VectorStoreExpirationAnchor", "apiVersions": [], "isUnionAsEnum": false, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreExpirationAfter.anchor", "serializationOptions": { "json": { "name": "anchor" } }, "isHttpMetadata": false }, { "$id": "6614", "kind": "property", "name": "days", "serializedName": "days", "doc": "The number of days after the anchor time that the vector store will expire.", "type": { "$id": "6615", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreExpirationAfter.days", "serializationOptions": { "json": { "name": "days" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.expires_after", "serializationOptions": { "json": { "name": "expires_after" } }, "isHttpMetadata": false }, { "$id": "6616", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when the vector store will expire.", "type": { "$id": "6617", "kind": "nullable", "type": { "$id": "6618", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6619", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "6620", "kind": "property", "name": "last_active_at", "serializedName": "last_active_at", "doc": "The Unix timestamp (in seconds) for when the vector store was last active.", "type": { "$id": "6621", "kind": "nullable", "type": { "$id": "6622", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6623", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.last_active_at", "serializationOptions": { "json": { "name": "last_active_at" } }, "isHttpMetadata": false }, { "$id": "6624", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreObject.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6625", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "6626", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "6627", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "6628", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "6629", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "6630", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoresResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "6583" }, { "$ref": "6595" }, { "$ref": "6608" }, { "$id": "6631", "kind": "model", "name": "CreateVectorStoreRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6632", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false }, { "$id": "6633", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the vector store.", "type": { "$id": "6634", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6635", "kind": "property", "name": "expires_after", "serializedName": "expires_after", "type": { "$ref": "6608" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest.expires_after", "serializationOptions": { "json": { "name": "expires_after" } }, "isHttpMetadata": false }, { "$id": "6636", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "doc": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", "type": { "$id": "6637", "kind": "union", "name": "CreateVectorStoreRequestChunkingStrategy", "variantTypes": [ { "$ref": "2469" }, { "$ref": "2476" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest.chunking_strategy", "serializationOptions": { "json": { "name": "chunking_strategy" } }, "isHttpMetadata": false }, { "$id": "6638", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "6639", "kind": "model", "name": "UpdateVectorStoreRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6640", "kind": "property", "name": "name", "serializedName": "name", "doc": "The name of the vector store.", "type": { "$id": "6641", "kind": "nullable", "type": { "$id": "6642", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreRequest.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6643", "kind": "property", "name": "expires_after", "serializedName": "expires_after", "type": { "$id": "6644", "kind": "nullable", "type": { "$ref": "6608" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreRequest.expires_after", "serializationOptions": { "json": { "name": "expires_after" } }, "isHttpMetadata": false }, { "$id": "6645", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreRequest.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] }, { "$id": "6646", "kind": "model", "name": "DeleteVectorStoreResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6647", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "6648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6649", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "6650", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "6651", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1645" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "6652", "kind": "model", "name": "CreateVectorStoreFileBatchRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileBatchRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6653", "kind": "property", "name": "file_ids", "serializedName": "file_ids", "doc": "A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileBatchRequest.file_ids", "serializationOptions": { "json": { "name": "file_ids" } }, "isHttpMetadata": false }, { "$id": "6654", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "type": { "$ref": "2467" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileBatchRequest.chunking_strategy", "serializationOptions": { "json": { "name": "chunking_strategy" } }, "isHttpMetadata": false }, { "$id": "6655", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$id": "6656", "kind": "nullable", "type": { "$ref": "3883" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileBatchRequest.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false } ] }, { "$id": "6657", "kind": "model", "name": "VectorStoreFileBatchObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject", "usage": "Output,Json", "doc": "A batch of files attached to a vector store.", "decorators": [], "properties": [ { "$id": "6658", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "6659", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6660", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `vector_store.file_batch`.", "type": { "$ref": "1647" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6661", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the vector store files batch was created.", "type": { "$id": "6662", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6663", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6664", "kind": "property", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.", "type": { "$id": "6665", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.vector_store_id", "serializationOptions": { "json": { "name": "vector_store_id" } }, "isHttpMetadata": false }, { "$id": "6666", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.", "type": { "$ref": "1000" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6667", "kind": "property", "name": "file_counts", "serializedName": "file_counts", "type": { "$id": "6668", "kind": "model", "name": "VectorStoreFileBatchObjectFileCounts", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6669", "kind": "property", "name": "in_progress", "serializedName": "in_progress", "doc": "The number of files that are currently being processed.", "type": { "$id": "6670", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous.in_progress", "serializationOptions": { "json": { "name": "in_progress" } }, "isHttpMetadata": false }, { "$id": "6671", "kind": "property", "name": "completed", "serializedName": "completed", "doc": "The number of files that have been processed.", "type": { "$id": "6672", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous.completed", "serializationOptions": { "json": { "name": "completed" } }, "isHttpMetadata": false }, { "$id": "6673", "kind": "property", "name": "failed", "serializedName": "failed", "doc": "The number of files that have failed to process.", "type": { "$id": "6674", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous.failed", "serializationOptions": { "json": { "name": "failed" } }, "isHttpMetadata": false }, { "$id": "6675", "kind": "property", "name": "cancelled", "serializedName": "cancelled", "doc": "The number of files that where cancelled.", "type": { "$id": "6676", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous.cancelled", "serializationOptions": { "json": { "name": "cancelled" } }, "isHttpMetadata": false }, { "$id": "6677", "kind": "property", "name": "total", "serializedName": "total", "doc": "The total number of files.", "type": { "$id": "6678", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts.anonymous.total", "serializationOptions": { "json": { "name": "total" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileBatchObject.file_counts", "serializationOptions": { "json": { "name": "file_counts" } }, "isHttpMetadata": false } ] }, { "$ref": "6668" }, { "$id": "6679", "kind": "model", "name": "ListVectorStoreFilesResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6680", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1649" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6681", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6682", "kind": "array", "name": "ArrayVectorStoreFileObject", "valueType": { "$id": "6683", "kind": "model", "name": "VectorStoreFileObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject", "usage": "Output,Json", "doc": "A list of files attached to a vector store.", "decorators": [], "properties": [ { "$id": "6684", "kind": "property", "name": "id", "serializedName": "id", "doc": "The identifier, which can be referenced in API endpoints.", "type": { "$id": "6685", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6686", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `vector_store.file`.", "type": { "$ref": "1651" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6687", "kind": "property", "name": "usage_bytes", "serializedName": "usage_bytes", "doc": "The total vector store usage in bytes. Note that this may be different from the original file size.", "type": { "$id": "6688", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.usage_bytes", "serializationOptions": { "json": { "name": "usage_bytes" } }, "isHttpMetadata": false }, { "$id": "6689", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the vector store file was created.", "type": { "$id": "6690", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6691", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "6692", "kind": "property", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.", "type": { "$id": "6693", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.vector_store_id", "serializationOptions": { "json": { "name": "vector_store_id" } }, "isHttpMetadata": false }, { "$id": "6694", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.", "type": { "$ref": "1006" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "6695", "kind": "property", "name": "last_error", "serializedName": "last_error", "doc": "The last error associated with this vector store file. Will be `null` if there are no errors.", "type": { "$id": "6696", "kind": "nullable", "type": { "$id": "6697", "kind": "model", "name": "VectorStoreFileObjectLastError1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.last_error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6698", "kind": "property", "name": "code", "serializedName": "code", "doc": "One of `server_error` or `rate_limit_exceeded`.", "type": { "$ref": "1012" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.last_error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "6699", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable description of the error.", "type": { "$id": "6700", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.last_error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.last_error", "serializationOptions": { "json": { "name": "last_error" } }, "isHttpMetadata": false }, { "$id": "6701", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "doc": "The strategy used to chunk the file.", "type": { "$id": "6702", "kind": "model", "name": "ChunkingStrategyResponseParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyResponseParam", "usage": "Output,Json", "decorators": [], "discriminatorProperty": { "$id": "6703", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1017" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyResponseParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6703" } ], "discriminatedSubtypes": { "other": { "$id": "6704", "kind": "model", "name": "OtherChunkingStrategyResponseParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.OtherChunkingStrategyResponseParam", "usage": "Output,Json", "doc": "This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.", "discriminatorValue": "other", "decorators": [], "baseModel": { "$ref": "6702" }, "properties": [ { "$id": "6705", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `other`.", "type": { "$id": "6706", "kind": "enumvalue", "name": "other", "value": "other", "valueType": { "$ref": "1018" }, "enumType": { "$id": "6707", "kind": "enum", "decorators": [], "name": "ChunkingStrategyResponseParamType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "6708", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6709", "kind": "enumvalue", "decorators": [], "name": "static", "value": "static", "valueType": { "$ref": "6708" }, "enumType": { "$ref": "6707" } }, { "$id": "6710", "kind": "enumvalue", "decorators": [], "name": "other", "value": "other", "valueType": { "$ref": "6708" }, "enumType": { "$ref": "6707" } } ], "isFixed": true, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.ChunkingStrategyResponseParam.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.OtherChunkingStrategyResponseParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "static": { "$id": "6711", "kind": "model", "name": "StaticChunkingStrategyResponseParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyResponseParam", "usage": "Output,Json", "discriminatorValue": "static", "decorators": [], "baseModel": { "$ref": "6702" }, "properties": [ { "$id": "6712", "kind": "property", "name": "type", "serializedName": "type", "doc": "Always `static`.", "type": { "$id": "6713", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "1018" }, "enumType": { "$ref": "6707" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyResponseParam.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6714", "kind": "property", "name": "static", "serializedName": "static", "type": { "$ref": "2480" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.StaticChunkingStrategyResponseParam.static", "serializationOptions": { "json": { "name": "static" } }, "isHttpMetadata": false } ] } } }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.chunking_strategy", "serializationOptions": { "json": { "name": "chunking_strategy" } }, "isHttpMetadata": false }, { "$id": "6715", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$id": "6716", "kind": "nullable", "type": { "$ref": "3883" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileObject.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6717", "kind": "property", "name": "first_id", "serializedName": "first_id", "type": { "$id": "6718", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse.first_id", "serializationOptions": { "json": { "name": "first_id" } }, "isHttpMetadata": false }, { "$id": "6719", "kind": "property", "name": "last_id", "serializedName": "last_id", "type": { "$id": "6720", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse.last_id", "serializationOptions": { "json": { "name": "last_id" } }, "isHttpMetadata": false }, { "$id": "6721", "kind": "property", "name": "has_more", "serializedName": "has_more", "type": { "$id": "6722", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVectorStoreFilesResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false } ] }, { "$ref": "6683" }, { "$ref": "6697" }, { "$ref": "6702" }, { "$ref": "6704" }, { "$ref": "6711" }, { "$id": "6723", "kind": "model", "name": "CreateVectorStoreFileRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6724", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files.", "type": { "$id": "6725", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileRequest.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "6726", "kind": "property", "name": "chunking_strategy", "serializedName": "chunking_strategy", "type": { "$ref": "2467" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileRequest.chunking_strategy", "serializationOptions": { "json": { "name": "chunking_strategy" } }, "isHttpMetadata": false }, { "$id": "6727", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$id": "6728", "kind": "nullable", "type": { "$ref": "3883" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVectorStoreFileRequest.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false } ] }, { "$id": "6729", "kind": "model", "name": "DeleteVectorStoreFileResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreFileResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6730", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "6731", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreFileResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6732", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "6733", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreFileResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "6734", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1653" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVectorStoreFileResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "6735", "kind": "model", "name": "UpdateVectorStoreFileAttributesRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreFileAttributesRequest", "usage": "Spread,Json", "decorators": [], "properties": [ { "$id": "6736", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$id": "6737", "kind": "nullable", "type": { "$ref": "3883" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UpdateVectorStoreFileAttributesRequest.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false } ] }, { "$id": "6738", "kind": "model", "name": "VectorStoreFileContentResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse", "usage": "Output,Json", "doc": "Represents the parsed content of a vector store file.", "decorators": [], "properties": [ { "$id": "6739", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `vector_store.file_content.page`", "type": { "$ref": "1655" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6740", "kind": "property", "name": "data", "serializedName": "data", "doc": "Parsed content of the file.", "type": { "$id": "6741", "kind": "array", "name": "Array40", "valueType": { "$id": "6742", "kind": "model", "name": "VectorStoreFileContentResponseDatum", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.datum.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6743", "kind": "property", "name": "type", "serializedName": "type", "doc": "The content type (currently only `\"text\"`)", "type": { "$id": "6744", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.datum.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6745", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text content", "type": { "$id": "6746", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.datum.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6747", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates if there are more content pages to fetch.", "type": { "$id": "6748", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false }, { "$id": "6749", "kind": "property", "name": "next_page", "serializedName": "next_page", "doc": "The token for the next page, if any.", "type": { "$id": "6750", "kind": "nullable", "type": { "$id": "6751", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileContentResponse.next_page", "serializationOptions": { "json": { "name": "next_page" } }, "isHttpMetadata": false } ] }, { "$ref": "6742" }, { "$id": "6752", "kind": "model", "name": "VectorStoreSearchRequestRankingOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.ranking_options.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6753", "kind": "property", "name": "ranker", "serializedName": "ranker", "type": { "$ref": "1021" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.ranking_options.anonymous.ranker", "serializationOptions": { "json": { "name": "ranker" } }, "isHttpMetadata": false }, { "$id": "6754", "kind": "property", "name": "score_threshold", "serializedName": "score_threshold", "type": { "$id": "6755", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.ranking_options.anonymous.score_threshold", "serializationOptions": { "json": { "name": "score_threshold" } }, "isHttpMetadata": false } ] }, { "$id": "6756", "kind": "model", "name": "VectorStoreSearchRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest", "usage": "Spread,Json", "decorators": [], "properties": [ { "$id": "6757", "kind": "property", "name": "query", "serializedName": "query", "doc": "A query string for a search", "type": { "$id": "6758", "kind": "union", "name": "VectorStoreSearchRequestQuery", "variantTypes": [ { "$id": "6759", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2373" } ], "namespace": "OpenAI", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.query", "serializationOptions": { "json": { "name": "query" } }, "isHttpMetadata": false }, { "$id": "6760", "kind": "property", "name": "rewrite_query", "serializedName": "rewrite_query", "doc": "Whether to rewrite the natural language query for vector search.", "type": { "$id": "6761", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.rewrite_query", "serializationOptions": { "json": { "name": "rewrite_query" } }, "isHttpMetadata": false }, { "$id": "6762", "kind": "property", "name": "max_num_results", "serializedName": "max_num_results", "doc": "The maximum number of results to return. This number should be between 1 and 50 inclusive.", "type": { "$id": "6763", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.max_num_results", "serializationOptions": { "json": { "name": "max_num_results" } }, "isHttpMetadata": false }, { "$id": "6764", "kind": "property", "name": "filters", "serializedName": "filters", "doc": "A filter to apply based on file attributes.", "type": { "$id": "6765", "kind": "union", "name": "VectorStoreSearchRequestFilters", "variantTypes": [ { "$ref": "4325" }, { "$ref": "4360" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.filters", "serializationOptions": { "json": { "name": "filters" } }, "isHttpMetadata": false }, { "$id": "6766", "kind": "property", "name": "ranking_options", "serializedName": "ranking_options", "doc": "Ranking options for search.", "type": { "$ref": "6752" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchRequest.ranking_options", "serializationOptions": { "json": { "name": "ranking_options" } }, "isHttpMetadata": false } ] }, { "$id": "6767", "kind": "model", "name": "VectorStoreSearchResultsPage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6768", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `vector_store.search_results.page`", "type": { "$ref": "1657" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6769", "kind": "property", "name": "search_query", "serializedName": "search_query", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage.search_query", "serializationOptions": { "json": { "name": "search_query" } }, "isHttpMetadata": false }, { "$id": "6770", "kind": "property", "name": "data", "serializedName": "data", "doc": "The list of search result items.", "type": { "$id": "6771", "kind": "array", "name": "ArrayVectorStoreSearchResultItem", "valueType": { "$id": "6772", "kind": "model", "name": "VectorStoreSearchResultItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6773", "kind": "property", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the vector store file.", "type": { "$id": "6774", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem.file_id", "serializationOptions": { "json": { "name": "file_id" } }, "isHttpMetadata": false }, { "$id": "6775", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the vector store file.", "type": { "$id": "6776", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "6777", "kind": "property", "name": "score", "serializedName": "score", "doc": "The similarity score for the result.", "type": { "$id": "6778", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem.score", "serializationOptions": { "json": { "name": "score" } }, "isHttpMetadata": false }, { "$id": "6779", "kind": "property", "name": "attributes", "serializedName": "attributes", "type": { "$id": "6780", "kind": "nullable", "type": { "$ref": "3883" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem.attributes", "serializationOptions": { "json": { "name": "attributes" } }, "isHttpMetadata": false }, { "$id": "6781", "kind": "property", "name": "content", "serializedName": "content", "doc": "Content chunks from the file.", "type": { "$id": "6782", "kind": "array", "name": "ArrayVectorStoreSearchResultContentObject", "valueType": { "$id": "6783", "kind": "model", "name": "VectorStoreSearchResultContentObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultContentObject", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6784", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of content.", "type": { "$ref": "1659" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultContentObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6785", "kind": "property", "name": "text", "serializedName": "text", "doc": "The text content returned from search.", "type": { "$id": "6786", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultContentObject.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false }, { "$id": "6787", "kind": "property", "name": "has_more", "serializedName": "has_more", "doc": "Indicates if there are more results to fetch.", "type": { "$id": "6788", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage.has_more", "serializationOptions": { "json": { "name": "has_more" } }, "isHttpMetadata": false }, { "$id": "6789", "kind": "property", "name": "next_page", "serializedName": "next_page", "doc": "The token for the next page, if any.", "type": { "$id": "6790", "kind": "nullable", "type": { "$id": "6791", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreSearchResultsPage.next_page", "serializationOptions": { "json": { "name": "next_page" } }, "isHttpMetadata": false } ] }, { "$ref": "6772" }, { "$ref": "6783" }, { "$id": "6792", "kind": "model", "name": "CreateCompletionRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6793", "kind": "property", "name": "model", "serializedName": "model", "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.", "type": { "$ref": "1025" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6794", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.", "type": { "$id": "6795", "kind": "nullable", "type": { "$id": "6796", "kind": "union", "name": "CreateCompletionRequestPrompt", "variantTypes": [ { "$id": "6797", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, { "$ref": "2373" }, { "$ref": "2606" }, { "$ref": "3351" } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false }, { "$id": "6798", "kind": "property", "name": "best_of", "serializedName": "best_of", "doc": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", "type": { "$id": "6799", "kind": "nullable", "type": { "$id": "6800", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.best_of", "serializationOptions": { "json": { "name": "best_of" } }, "isHttpMetadata": false }, { "$id": "6801", "kind": "property", "name": "echo", "serializedName": "echo", "doc": "Echo back the prompt in addition to the completion", "type": { "$id": "6802", "kind": "nullable", "type": { "$id": "6803", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.echo", "serializationOptions": { "json": { "name": "echo" } }, "isHttpMetadata": false }, { "$id": "6804", "kind": "property", "name": "frequency_penalty", "serializedName": "frequency_penalty", "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)", "type": { "$id": "6805", "kind": "nullable", "type": { "$id": "6806", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.frequency_penalty", "serializationOptions": { "json": { "name": "frequency_penalty" } }, "isHttpMetadata": false }, { "$id": "6807", "kind": "property", "name": "logit_bias", "serializedName": "logit_bias", "doc": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.", "type": { "$id": "6808", "kind": "nullable", "type": { "$ref": "3104" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.logit_bias", "serializationOptions": { "json": { "name": "logit_bias" } }, "isHttpMetadata": false }, { "$id": "6809", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.", "type": { "$id": "6810", "kind": "nullable", "type": { "$id": "6811", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false }, { "$id": "6812", "kind": "property", "name": "max_tokens", "serializedName": "max_tokens", "doc": "The maximum number of [tokens](/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.", "type": { "$id": "6813", "kind": "nullable", "type": { "$id": "6814", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.max_tokens", "serializationOptions": { "json": { "name": "max_tokens" } }, "isHttpMetadata": false }, { "$id": "6815", "kind": "property", "name": "n", "serializedName": "n", "doc": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", "type": { "$id": "6816", "kind": "nullable", "type": { "$id": "6817", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.n", "serializationOptions": { "json": { "name": "n" } }, "isHttpMetadata": false }, { "$id": "6818", "kind": "property", "name": "presence_penalty", "serializedName": "presence_penalty", "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)", "type": { "$id": "6819", "kind": "nullable", "type": { "$id": "6820", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.presence_penalty", "serializationOptions": { "json": { "name": "presence_penalty" } }, "isHttpMetadata": false }, { "$id": "6821", "kind": "property", "name": "seed", "serializedName": "seed", "doc": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.", "type": { "$id": "6822", "kind": "nullable", "type": { "$id": "6823", "kind": "int64", "name": "int64", "crossLanguageDefinitionId": "TypeSpec.int64", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.seed", "serializationOptions": { "json": { "name": "seed" } }, "isHttpMetadata": false }, { "$id": "6824", "kind": "property", "name": "stop", "serializedName": "stop", "type": { "$id": "6825", "kind": "nullable", "type": { "$ref": "3100" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.stop", "serializationOptions": { "json": { "name": "stop" } }, "isHttpMetadata": false }, { "$id": "6826", "kind": "property", "name": "stream", "serializedName": "stream", "doc": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).", "type": { "$id": "6827", "kind": "nullable", "type": { "$id": "6828", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.stream", "serializationOptions": { "json": { "name": "stream" } }, "isHttpMetadata": false }, { "$id": "6829", "kind": "property", "name": "stream_options", "serializedName": "stream_options", "type": { "$id": "6830", "kind": "nullable", "type": { "$ref": "3134" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.stream_options", "serializationOptions": { "json": { "name": "stream_options" } }, "isHttpMetadata": false }, { "$id": "6831", "kind": "property", "name": "suffix", "serializedName": "suffix", "doc": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.", "type": { "$id": "6832", "kind": "nullable", "type": { "$id": "6833", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.suffix", "serializationOptions": { "json": { "name": "suffix" } }, "isHttpMetadata": false }, { "$id": "6834", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", "type": { "$id": "6835", "kind": "nullable", "type": { "$id": "6836", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "6837", "kind": "property", "name": "top_p", "serializedName": "top_p", "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$id": "6838", "kind": "nullable", "type": { "$id": "6839", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.top_p", "serializationOptions": { "json": { "name": "top_p" } }, "isHttpMetadata": false }, { "$id": "6840", "kind": "property", "name": "user", "serializedName": "user", "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).", "type": { "$id": "6841", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionRequest.user", "serializationOptions": { "json": { "name": "user" } }, "isHttpMetadata": false } ] }, { "$id": "6842", "kind": "model", "name": "CreateCompletionResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse", "usage": "Output,Json", "doc": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).", "decorators": [], "properties": [ { "$id": "6843", "kind": "property", "name": "id", "serializedName": "id", "doc": "A unique identifier for the completion.", "type": { "$id": "6844", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6845", "kind": "property", "name": "choices", "serializedName": "choices", "doc": "The list of completion choices the model generated for the input prompt.", "type": { "$id": "6846", "kind": "array", "name": "Array41", "valueType": { "$id": "6847", "kind": "model", "name": "CreateCompletionResponseChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6848", "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.", "type": { "$ref": "1030" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.anonymous.finish_reason", "serializationOptions": { "json": { "name": "finish_reason" } }, "isHttpMetadata": false }, { "$id": "6849", "kind": "property", "name": "index", "serializedName": "index", "type": { "$id": "6850", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.anonymous.index", "serializationOptions": { "json": { "name": "index" } }, "isHttpMetadata": false }, { "$id": "6851", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "type": { "$id": "6852", "kind": "nullable", "type": { "$id": "6853", "kind": "model", "name": "CreateCompletionResponseChoiceLogprobs1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.logprobs.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6854", "kind": "property", "name": "text_offset", "serializedName": "text_offset", "type": { "$ref": "2606" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.logprobs.anonymous.text_offset", "serializationOptions": { "json": { "name": "text_offset" } }, "isHttpMetadata": false }, { "$id": "6855", "kind": "property", "name": "token_logprobs", "serializedName": "token_logprobs", "type": { "$ref": "2627" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.logprobs.anonymous.token_logprobs", "serializationOptions": { "json": { "name": "token_logprobs" } }, "isHttpMetadata": false }, { "$id": "6856", "kind": "property", "name": "tokens", "serializedName": "tokens", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.logprobs.anonymous.tokens", "serializationOptions": { "json": { "name": "tokens" } }, "isHttpMetadata": false }, { "$id": "6857", "kind": "property", "name": "top_logprobs", "serializedName": "top_logprobs", "type": { "$id": "6858", "kind": "array", "name": "ArrayRecord1", "valueType": { "$id": "6859", "kind": "dict", "keyType": { "$id": "6860", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "valueType": { "$id": "6861", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.logprobs.anonymous.top_logprobs", "serializationOptions": { "json": { "name": "top_logprobs" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.anonymous.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false }, { "$id": "6862", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "6863", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choice.anonymous.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.choices", "serializationOptions": { "json": { "name": "choices" } }, "isHttpMetadata": false }, { "$id": "6864", "kind": "property", "name": "created", "serializedName": "created", "doc": "The Unix timestamp (in seconds) of when the completion was created.", "type": { "$id": "6865", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6866", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.created", "serializationOptions": { "json": { "name": "created" } }, "isHttpMetadata": false }, { "$id": "6867", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model used for completion.", "type": { "$id": "6868", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6869", "kind": "property", "name": "system_fingerprint", "serializedName": "system_fingerprint", "doc": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.", "type": { "$id": "6870", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.system_fingerprint", "serializationOptions": { "json": { "name": "system_fingerprint" } }, "isHttpMetadata": false }, { "$id": "6871", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"text_completion\"", "type": { "$ref": "1661" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6872", "kind": "property", "name": "usage", "serializedName": "usage", "type": { "$ref": "2880" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false } ] }, { "$ref": "6847" }, { "$ref": "6853" }, { "$id": "6873", "kind": "model", "name": "ListModelsResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ListModelsResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6874", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1663" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListModelsResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6875", "kind": "property", "name": "data", "serializedName": "data", "type": { "$id": "6876", "kind": "array", "name": "ArrayModel", "valueType": { "$id": "6877", "kind": "model", "name": "Model", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Model", "usage": "Output,Json", "doc": "Describes an OpenAI model offering that can be used with the API.", "decorators": [], "properties": [ { "$id": "6878", "kind": "property", "name": "id", "serializedName": "id", "doc": "The model identifier, which can be referenced in the API endpoints.", "type": { "$id": "6879", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Model.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6880", "kind": "property", "name": "created", "serializedName": "created", "doc": "The Unix timestamp (in seconds) when the model was created.", "type": { "$id": "6881", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "6882", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Model.created", "serializationOptions": { "json": { "name": "created" } }, "isHttpMetadata": false }, { "$id": "6883", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"model\".", "type": { "$ref": "1665" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Model.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "6884", "kind": "property", "name": "owned_by", "serializedName": "owned_by", "doc": "The organization that owns the model.", "type": { "$id": "6885", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Model.owned_by", "serializationOptions": { "json": { "name": "owned_by" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListModelsResponse.data", "serializationOptions": { "json": { "name": "data" } }, "isHttpMetadata": false } ] }, { "$ref": "6877" }, { "$id": "6886", "kind": "model", "name": "DeleteModelResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeleteModelResponse", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "6887", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "6888", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteModelResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "6889", "kind": "property", "name": "deleted", "serializedName": "deleted", "type": { "$id": "6890", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteModelResponse.deleted", "serializationOptions": { "json": { "name": "deleted" } }, "isHttpMetadata": false }, { "$id": "6891", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1667" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteModelResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "6892", "kind": "model", "name": "RealtimeClientEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEvent", "usage": "Input,Json", "doc": "A realtime client event.", "decorators": [], "discriminatorProperty": { "$id": "6893", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of event.", "type": { "$ref": "1035" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6893" }, { "$id": "6894", "kind": "property", "name": "event_id", "serializedName": "event_id", "type": { "$id": "6895", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEvent.event_id", "serializationOptions": { "json": { "name": "event_id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "session.update": { "$id": "6896", "kind": "model", "name": "RealtimeClientEventSessionUpdate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventSessionUpdate", "usage": "Input,Json", "doc": "Send this event to update the session’s default configuration.\nThe client may send this event at any time to update any field,\nexcept for `voice`. However, note that once a session has been\ninitialized with a particular `model`, it can’t be changed to\nanother model using `session.update`.\n\nWhen the server receives a `session.update`, it will respond\nwith a `session.updated` event showing the full, effective configuration.\nOnly the fields that are present are updated. To clear a field like\n`instructions`, pass an empty string.", "discriminatorValue": "session.update", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "6897", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `session.update`.", "type": { "$id": "6898", "kind": "enumvalue", "name": "session_update", "value": "session.update", "valueType": { "$ref": "1036" }, "enumType": { "$id": "6899", "kind": "enum", "decorators": [], "name": "RealtimeClientEventType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6900", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6901", "kind": "enumvalue", "decorators": [], "name": "session_update", "value": "session.update", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6902", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_append", "value": "input_audio_buffer.append", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6903", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_commit", "value": "input_audio_buffer.commit", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6904", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_clear", "value": "input_audio_buffer.clear", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6905", "kind": "enumvalue", "decorators": [], "name": "output_audio_buffer_clear", "value": "output_audio_buffer.clear", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6906", "kind": "enumvalue", "decorators": [], "name": "conversation_item_create", "value": "conversation.item.create", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6907", "kind": "enumvalue", "decorators": [], "name": "conversation_item_retrieve", "value": "conversation.item.retrieve", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6908", "kind": "enumvalue", "decorators": [], "name": "conversation_item_truncate", "value": "conversation.item.truncate", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6909", "kind": "enumvalue", "decorators": [], "name": "conversation_item_delete", "value": "conversation.item.delete", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6910", "kind": "enumvalue", "decorators": [], "name": "response_create", "value": "response.create", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6911", "kind": "enumvalue", "decorators": [], "name": "response_cancel", "value": "response.cancel", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } }, { "$id": "6912", "kind": "enumvalue", "decorators": [], "name": "transcription_session_update", "value": "transcription_session.update", "valueType": { "$ref": "6900" }, "enumType": { "$ref": "6899" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventSessionUpdate.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6913", "kind": "property", "name": "session", "serializedName": "session", "type": { "$id": "6914", "kind": "model", "name": "RealtimeRequestSession", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "6915", "kind": "property", "name": "modalities", "serializedName": "modalities", "type": { "$id": "6916", "kind": "array", "name": "ArrayRealtimeModality", "valueType": { "$ref": "1049" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "6917", "kind": "property", "name": "instructions", "serializedName": "instructions", "type": { "$id": "6918", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "6919", "kind": "property", "name": "model", "serializedName": "model", "type": { "$ref": "1053" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6920", "kind": "property", "name": "voice", "serializedName": "voice", "type": { "$ref": "68" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "6921", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "6922", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "6923", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "type": { "$id": "6924", "kind": "nullable", "type": { "$id": "6925", "kind": "model", "name": "RealtimeAudioInputTranscriptionSettings", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioInputTranscriptionSettings", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "6926", "kind": "property", "name": "model", "serializedName": "model", "type": { "$ref": "1065" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioInputTranscriptionSettings.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "6927", "kind": "property", "name": "language", "serializedName": "language", "type": { "$id": "6928", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioInputTranscriptionSettings.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "6929", "kind": "property", "name": "prompt", "serializedName": "prompt", "type": { "$id": "6930", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioInputTranscriptionSettings.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "6931", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "type": { "$id": "6932", "kind": "nullable", "type": { "$id": "6933", "kind": "model", "name": "RealtimeTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetection", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "6934", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1068" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetection.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6934" }, { "$id": "6935", "kind": "property", "name": "create_response", "serializedName": "create_response", "doc": "Whether or not to automatically generate a response when VAD is enabled. true by default.", "type": { "$id": "6936", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetection.create_response", "serializationOptions": { "json": { "name": "create_response" } }, "isHttpMetadata": false }, { "$id": "6937", "kind": "property", "name": "interrupt_response", "serializedName": "interrupt_response", "doc": "Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. `conversation` of `auto`) when a VAD start event occurs.", "type": { "$id": "6938", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetection.interrupt_response", "serializationOptions": { "json": { "name": "interrupt_response" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "server_vad": { "$id": "6939", "kind": "model", "name": "RealtimeServerVadTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerVadTurnDetection", "usage": "Input,Output,Json", "discriminatorValue": "server_vad", "decorators": [], "baseModel": { "$ref": "6933" }, "properties": [ { "$id": "6940", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "6941", "kind": "enumvalue", "name": "server_vad", "value": "server_vad", "valueType": { "$ref": "1069" }, "enumType": { "$id": "6942", "kind": "enum", "decorators": [], "name": "RealtimeTurnDetectionType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6943", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6944", "kind": "enumvalue", "decorators": [], "doc": "Indicates that server-side voice activity detection (VAD) should be enabled, allowing the server to determine when\nadd_user_audio commands present ends of speech and should be automatically committed.\n\nThe API will also detect when the user begins talking, sending a generation_canceled command.", "name": "server_vad", "value": "server_vad", "valueType": { "$ref": "6943" }, "enumType": { "$ref": "6942" } }, { "$id": "6945", "kind": "enumvalue", "decorators": [], "name": "semantic_vad", "value": "semantic_vad", "valueType": { "$ref": "6943" }, "enumType": { "$ref": "6942" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeTurnDetectionType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "doc": "Indicates that server-side voice activity detection (VAD) should be enabled, allowing the server to determine when\nadd_user_audio commands present ends of speech and should be automatically committed.\n\nThe API will also detect when the user begins talking, sending a generation_canceled command.", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerVadTurnDetection.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6946", "kind": "property", "name": "threshold", "serializedName": "threshold", "doc": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.", "type": { "$id": "6947", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerVadTurnDetection.threshold", "serializationOptions": { "json": { "name": "threshold" } }, "isHttpMetadata": false }, { "$id": "6948", "kind": "property", "name": "prefix_padding_ms", "serializedName": "prefix_padding_ms", "doc": "Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.", "type": { "$id": "6949", "kind": "duration", "name": "duration", "encode": "ISO8601", "wireType": { "$id": "6950", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerVadTurnDetection.prefix_padding_ms", "serializationOptions": { "json": { "name": "prefix_padding_ms" } }, "isHttpMetadata": false }, { "$id": "6951", "kind": "property", "name": "silence_duration_ms", "serializedName": "silence_duration_ms", "doc": "Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.", "type": { "$id": "6952", "kind": "duration", "name": "duration", "encode": "ISO8601", "wireType": { "$id": "6953", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerVadTurnDetection.silence_duration_ms", "serializationOptions": { "json": { "name": "silence_duration_ms" } }, "isHttpMetadata": false } ] }, "semantic_vad": { "$id": "6954", "kind": "model", "name": "RealtimeSemanticVadTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSemanticVadTurnDetection", "usage": "Input,Output,Json", "discriminatorValue": "semantic_vad", "decorators": [], "baseModel": { "$ref": "6933" }, "properties": [ { "$id": "6955", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "6956", "kind": "enumvalue", "name": "semantic_vad", "value": "semantic_vad", "valueType": { "$ref": "1069" }, "enumType": { "$ref": "6942" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSemanticVadTurnDetection.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6957", "kind": "property", "name": "eagerness", "serializedName": "eagerness", "doc": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`.", "type": { "$ref": "1072" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSemanticVadTurnDetection.eagerness", "serializationOptions": { "json": { "name": "eagerness" } }, "isHttpMetadata": false } ] } } }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false }, { "$id": "6958", "kind": "property", "name": "input_audio_noise_reduction", "serializedName": "input_audio_noise_reduction", "type": { "$id": "6959", "kind": "model", "name": "RealtimeAudioNoiseReduction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNoiseReduction", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "6960", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1078" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNoiseReduction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6960" } ], "discriminatedSubtypes": { "near_field": { "$id": "6961", "kind": "model", "name": "RealtimeAudioNearFieldNoiseReduction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNearFieldNoiseReduction", "usage": "Input,Output,Json", "discriminatorValue": "near_field", "decorators": [], "baseModel": { "$ref": "6959" }, "properties": [ { "$id": "6962", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "6963", "kind": "enumvalue", "name": "near_field", "value": "near_field", "valueType": { "$ref": "1079" }, "enumType": { "$id": "6964", "kind": "enum", "decorators": [], "name": "RealtimeAudioNoiseReductionType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6965", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6966", "kind": "enumvalue", "decorators": [], "name": "near_field", "value": "near_field", "valueType": { "$ref": "6965" }, "enumType": { "$ref": "6964" } }, { "$id": "6967", "kind": "enumvalue", "decorators": [], "name": "far_field", "value": "far_field", "valueType": { "$ref": "6965" }, "enumType": { "$ref": "6964" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNoiseReductionType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioNearFieldNoiseReduction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "far_field": { "$id": "6968", "kind": "model", "name": "RealtimeAudioFarFieldNoiseReduction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeAudioFarFieldNoiseReduction", "usage": "Input,Output,Json", "discriminatorValue": "far_field", "decorators": [], "baseModel": { "$ref": "6959" }, "properties": [ { "$id": "6969", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "6970", "kind": "enumvalue", "name": "far_field", "value": "far_field", "valueType": { "$ref": "1079" }, "enumType": { "$ref": "6964" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeAudioFarFieldNoiseReduction.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] } } }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.input_audio_noise_reduction", "serializationOptions": { "json": { "name": "input_audio_noise_reduction" } }, "isHttpMetadata": false }, { "$id": "6971", "kind": "property", "name": "tools", "serializedName": "tools", "type": { "$id": "6972", "kind": "array", "name": "ArrayRealtimeTool", "valueType": { "$id": "6973", "kind": "model", "name": "RealtimeTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTool", "usage": "Input,Output,Json", "doc": "The base representation of a realtime tool definition.", "decorators": [], "discriminatorProperty": { "$id": "6974", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1082" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6974" } ], "discriminatedSubtypes": { "function": { "$id": "6975", "kind": "model", "name": "RealtimeFunctionTool", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeFunctionTool", "usage": "Input,Output,Json", "doc": "The definition of a function tool as used by the realtime endpoint.", "discriminatorValue": "function", "decorators": [], "baseModel": { "$ref": "6973" }, "properties": [ { "$id": "6976", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "6977", "kind": "enumvalue", "name": "function", "value": "function", "valueType": { "$ref": "1083" }, "enumType": { "$id": "6978", "kind": "enum", "decorators": [], "doc": "The supported tool type discriminators for realtime tools.\nCurrently, only 'function' tools are supported.", "name": "RealtimeToolType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "6979", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "6980", "kind": "enumvalue", "decorators": [], "name": "function", "value": "function", "valueType": { "$ref": "6979" }, "enumType": { "$ref": "6978" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeToolType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeFunctionTool.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6981", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "6982", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeFunctionTool.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "6983", "kind": "property", "name": "description", "serializedName": "description", "type": { "$id": "6984", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeFunctionTool.description", "serializationOptions": { "json": { "name": "description" } }, "isHttpMetadata": false }, { "$id": "6985", "kind": "property", "name": "parameters", "serializedName": "parameters", "type": { "$id": "6986", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeFunctionTool.parameters", "serializationOptions": { "json": { "name": "parameters" } }, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "6987", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$id": "6988", "kind": "union", "name": "RealtimeToolChoice", "variantTypes": [ { "$ref": "1085" }, { "$id": "6989", "kind": "model", "name": "RealtimeToolChoiceObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceObject", "usage": "Input,Output,Json", "doc": "A base representation for a realtime tool_choice selecting a named tool.", "decorators": [], "discriminatorProperty": { "$id": "6990", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1082" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "6990" } ], "discriminatedSubtypes": { "function": { "$id": "6991", "kind": "model", "name": "RealtimeToolChoiceFunctionObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceFunctionObject", "usage": "Input,Output,Json", "doc": "The representation of a realtime tool_choice selecting a named function tool.", "discriminatorValue": "function", "decorators": [], "baseModel": { "$ref": "6989" }, "properties": [ { "$id": "6992", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "6977" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceFunctionObject.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "6993", "kind": "property", "name": "function", "serializedName": "function", "type": { "$id": "6994", "kind": "model", "name": "RealtimeToolChoiceFunctionObjectFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceFunctionObject.function.anonymous", "usage": "Input,Output,Json", "decorators": [], "properties": [ { "$id": "6995", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "6996", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceFunctionObject.function.anonymous.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeToolChoiceFunctionObject.function", "serializationOptions": { "json": { "name": "function" } }, "isHttpMetadata": false } ] } } } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "6997", "kind": "property", "name": "temperature", "serializedName": "temperature", "type": { "$id": "6998", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "6999", "kind": "property", "name": "max_response_output_tokens", "serializedName": "max_response_output_tokens", "type": { "$id": "7000", "kind": "union", "name": "RealtimeRequestSessionMaxResponseOutputTokens", "variantTypes": [ { "$id": "7001", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1669" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSession.max_response_output_tokens", "serializationOptions": { "json": { "name": "max_response_output_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventSessionUpdate.session", "serializationOptions": { "json": { "name": "session" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.append": { "$id": "7002", "kind": "model", "name": "RealtimeClientEventInputAudioBufferAppend", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferAppend", "usage": "Input,Json", "doc": "Send this event to append audio bytes to the input audio buffer. The audio\nbuffer is temporary storage you can write to and later commit. In Server VAD\nmode, the audio buffer is used to detect speech and the server will decide\nwhen to commit. When Server VAD is disabled, you must commit the audio buffer\nmanually.\n\nThe client may choose how much audio to place in each event up to a maximum\nof 15 MiB, for example streaming smaller chunks from the client may allow the\nVAD to be more responsive. Unlike made other client events, the server will\nnot send a confirmation response to this event.", "discriminatorValue": "input_audio_buffer.append", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7003", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.append`.", "type": { "$id": "7004", "kind": "enumvalue", "name": "input_audio_buffer_append", "value": "input_audio_buffer.append", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferAppend.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7005", "kind": "property", "name": "audio", "serializedName": "audio", "doc": "Base64-encoded audio bytes. This must be in the format specified by the\n`input_audio_format` field in the session configuration.", "type": { "$id": "7006", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferAppend.audio", "serializationOptions": { "json": { "name": "audio" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.commit": { "$id": "7007", "kind": "model", "name": "RealtimeClientEventInputAudioBufferCommit", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferCommit", "usage": "Input,Json", "doc": "Send this event to commit the user input audio buffer, which will create a\nnew user message item in the conversation. This event will produce an error\nif the input audio buffer is empty. When in Server VAD mode, the client does\nnot need to send this event, the server will commit the audio buffer\nautomatically.\n\nCommitting the input audio buffer will trigger input audio transcription\n(if enabled in session configuration), but it will not create a response\nfrom the model. The server will respond with an `input_audio_buffer.committed`\nevent.", "discriminatorValue": "input_audio_buffer.commit", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7008", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.commit`.", "type": { "$id": "7009", "kind": "enumvalue", "name": "input_audio_buffer_commit", "value": "input_audio_buffer.commit", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferCommit.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.clear": { "$id": "7010", "kind": "model", "name": "RealtimeClientEventInputAudioBufferClear", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferClear", "usage": "Input,Json", "doc": "Send this event to clear the audio bytes in the buffer. The server will\nrespond with an `input_audio_buffer.cleared` event.", "discriminatorValue": "input_audio_buffer.clear", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7011", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.clear`.", "type": { "$id": "7012", "kind": "enumvalue", "name": "input_audio_buffer_clear", "value": "input_audio_buffer.clear", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventInputAudioBufferClear.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "output_audio_buffer.clear": { "$id": "7013", "kind": "model", "name": "RealtimeClientEventOutputAudioBufferClear", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventOutputAudioBufferClear", "usage": "Input,Json", "doc": "**WebRTC Only:** Emit to cut off the current audio response. This will trigger the server to\nstop generating audio and emit a `output_audio_buffer.cleared` event. This\nevent should be preceded by a `response.cancel` client event to stop the\ngeneration of the current response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).", "discriminatorValue": "output_audio_buffer.clear", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7014", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `output_audio_buffer.clear`.", "type": { "$id": "7015", "kind": "enumvalue", "name": "output_audio_buffer_clear", "value": "output_audio_buffer.clear", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventOutputAudioBufferClear.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "conversation.item.create": { "$id": "7016", "kind": "model", "name": "RealtimeClientEventConversationItemCreate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemCreate", "usage": "Input,Json", "doc": "Add a new Item to the Conversation's context, including messages, function\ncalls, and function call responses. This event can be used both to populate a\n\"history\" of the conversation and to add new items mid-stream, but has the\ncurrent limitation that it cannot populate assistant audio messages.\n\nIf successful, the server will respond with a `conversation.item.created`\nevent, otherwise an `error` event will be sent.", "discriminatorValue": "conversation.item.create", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7017", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.create`.", "type": { "$id": "7018", "kind": "enumvalue", "name": "conversation_item_create", "value": "conversation.item.create", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemCreate.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7019", "kind": "property", "name": "previous_item_id", "serializedName": "previous_item_id", "doc": "The ID of the preceding item after which the new item will be inserted.\nIf not set, the new item will be appended to the end of the conversation.\nIf set to `root`, the new item will be added to the beginning of the conversation.\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the\nID cannot be found, an error will be returned and the item will not be added.", "type": { "$id": "7020", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemCreate.previous_item_id", "serializationOptions": { "json": { "name": "previous_item_id" } }, "isHttpMetadata": false }, { "$id": "7021", "kind": "property", "name": "item", "serializedName": "item", "type": { "$id": "7022", "kind": "model", "name": "RealtimeConversationRequestItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeConversationRequestItem", "usage": "Input,Json", "decorators": [], "discriminatorProperty": { "$id": "7023", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1090" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeConversationRequestItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "7023" }, { "$id": "7024", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "7025", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeConversationRequestItem.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "message": { "$id": "7026", "kind": "model", "name": "RealtimeRequestMessageItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestMessageItem", "usage": "Input,Json", "discriminatorValue": "message", "decorators": [], "discriminatorProperty": { "$id": "7027", "kind": "property", "name": "role", "serializedName": "role", "type": { "$ref": "1095" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestMessageItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, "baseModel": { "$ref": "7022" }, "properties": [ { "$id": "7028", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7029", "kind": "enumvalue", "name": "message", "value": "message", "valueType": { "$ref": "1091" }, "enumType": { "$id": "7030", "kind": "enum", "decorators": [], "name": "RealtimeItemType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "7031", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "7032", "kind": "enumvalue", "decorators": [], "name": "message", "value": "message", "valueType": { "$ref": "7031" }, "enumType": { "$ref": "7030" } }, { "$id": "7033", "kind": "enumvalue", "decorators": [], "name": "function_call", "value": "function_call", "valueType": { "$ref": "7031" }, "enumType": { "$ref": "7030" } }, { "$id": "7034", "kind": "enumvalue", "decorators": [], "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "7031" }, "enumType": { "$ref": "7030" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeItemType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestMessageItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$ref": "7027" }, { "$id": "7035", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "1100" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestMessageItem.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "system": { "$id": "7036", "kind": "model", "name": "RealtimeRequestSystemMessageItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSystemMessageItem", "usage": "Input,Json", "discriminatorValue": "system", "decorators": [], "baseModel": { "$ref": "7026" }, "properties": [ { "$id": "7037", "kind": "property", "name": "role", "serializedName": "role", "type": { "$id": "7038", "kind": "enumvalue", "name": "system", "value": "system", "valueType": { "$ref": "1096" }, "enumType": { "$id": "7039", "kind": "enum", "decorators": [], "name": "RealtimeMessageRole", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "7040", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "7041", "kind": "enumvalue", "decorators": [], "name": "system", "value": "system", "valueType": { "$ref": "7040" }, "enumType": { "$ref": "7039" } }, { "$id": "7042", "kind": "enumvalue", "decorators": [], "name": "user", "value": "user", "valueType": { "$ref": "7040" }, "enumType": { "$ref": "7039" } }, { "$id": "7043", "kind": "enumvalue", "decorators": [], "name": "assistant", "value": "assistant", "valueType": { "$ref": "7040" }, "enumType": { "$ref": "7039" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeMessageRole", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSystemMessageItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "7044", "kind": "property", "name": "content", "serializedName": "content", "type": { "$id": "7045", "kind": "array", "name": "ArrayRealtimeRequestTextContentPart", "valueType": { "$id": "7046", "kind": "model", "name": "RealtimeRequestTextContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestTextContentPart", "usage": "Input,Output,Json", "discriminatorValue": "input_text", "decorators": [], "baseModel": { "$id": "7047", "kind": "model", "name": "RealtimeContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeContentPart", "usage": "Input,Output,Json", "decorators": [], "discriminatorProperty": { "$id": "7048", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1105" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "7048" } ], "discriminatedSubtypes": { "input_text": { "$ref": "7046" }, "input_audio": { "$id": "7049", "kind": "model", "name": "RealtimeRequestAudioContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAudioContentPart", "usage": "Input,Output,Json", "discriminatorValue": "input_audio", "decorators": [], "baseModel": { "$ref": "7047" }, "properties": [ { "$id": "7050", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7051", "kind": "enumvalue", "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "1106" }, "enumType": { "$id": "7052", "kind": "enum", "decorators": [], "name": "RealtimeContentPartType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "7053", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "7054", "kind": "enumvalue", "decorators": [], "name": "input_text", "value": "input_text", "valueType": { "$ref": "7053" }, "enumType": { "$ref": "7052" } }, { "$id": "7055", "kind": "enumvalue", "decorators": [], "name": "input_audio", "value": "input_audio", "valueType": { "$ref": "7053" }, "enumType": { "$ref": "7052" } }, { "$id": "7056", "kind": "enumvalue", "decorators": [], "name": "text", "value": "text", "valueType": { "$ref": "7053" }, "enumType": { "$ref": "7052" } }, { "$id": "7057", "kind": "enumvalue", "decorators": [], "name": "audio", "value": "audio", "valueType": { "$ref": "7053" }, "enumType": { "$ref": "7052" } } ], "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeContentPartType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAudioContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7058", "kind": "property", "name": "transcript", "serializedName": "transcript", "type": { "$id": "7059", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAudioContentPart.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false } ] }, "text": { "$id": "7060", "kind": "model", "name": "RealtimeResponseTextContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseTextContentPart", "usage": "Output,Json", "discriminatorValue": "text", "decorators": [], "baseModel": { "$ref": "7047" }, "properties": [ { "$id": "7061", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7062", "kind": "enumvalue", "name": "text", "value": "text", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "7052" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseTextContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7063", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "7064", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseTextContentPart.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "audio": { "$id": "7065", "kind": "model", "name": "RealtimeResponseAudioContentPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseAudioContentPart", "usage": "Output,Json", "discriminatorValue": "audio", "decorators": [], "baseModel": { "$ref": "7047" }, "properties": [ { "$id": "7066", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7067", "kind": "enumvalue", "name": "audio", "value": "audio", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "7052" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseAudioContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7068", "kind": "property", "name": "transcript", "serializedName": "transcript", "type": { "$id": "7069", "kind": "nullable", "type": { "$id": "7070", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseAudioContentPart.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false } ] } } }, "properties": [ { "$id": "7071", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7072", "kind": "enumvalue", "name": "input_text", "value": "input_text", "valueType": { "$ref": "1106" }, "enumType": { "$ref": "7052" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestTextContentPart.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7073", "kind": "property", "name": "text", "serializedName": "text", "type": { "$id": "7074", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestTextContentPart.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestSystemMessageItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "user": { "$id": "7075", "kind": "model", "name": "RealtimeRequestUserMessageItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestUserMessageItem", "usage": "Input,Json", "discriminatorValue": "user", "decorators": [], "baseModel": { "$ref": "7026" }, "properties": [ { "$id": "7076", "kind": "property", "name": "role", "serializedName": "role", "type": { "$id": "7077", "kind": "enumvalue", "name": "user", "value": "user", "valueType": { "$ref": "1096" }, "enumType": { "$ref": "7039" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestUserMessageItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "7078", "kind": "property", "name": "content", "serializedName": "content", "type": { "$id": "7079", "kind": "array", "name": "Array42", "valueType": { "$id": "7080", "kind": "union", "name": "RealtimeRequestUserMessageItemContent", "variantTypes": [ { "$ref": "7046" }, { "$ref": "7049" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestUserMessageItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] }, "assistant": { "$id": "7081", "kind": "model", "name": "RealtimeRequestAssistantMessageItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAssistantMessageItem", "usage": "Input,Json", "discriminatorValue": "assistant", "decorators": [], "baseModel": { "$ref": "7026" }, "properties": [ { "$id": "7082", "kind": "property", "name": "role", "serializedName": "role", "type": { "$id": "7083", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "1096" }, "enumType": { "$ref": "7039" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAssistantMessageItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "7084", "kind": "property", "name": "content", "serializedName": "content", "type": { "$ref": "7045" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestAssistantMessageItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false } ] } } }, "function_call": { "$id": "7085", "kind": "model", "name": "RealtimeRequestFunctionCallItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem", "usage": "Input,Json", "discriminatorValue": "function_call", "decorators": [], "baseModel": { "$ref": "7022" }, "properties": [ { "$id": "7086", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7087", "kind": "enumvalue", "name": "function_call", "value": "function_call", "valueType": { "$ref": "1091" }, "enumType": { "$ref": "7030" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7088", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "7089", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "7090", "kind": "property", "name": "call_id", "serializedName": "call_id", "type": { "$id": "7091", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7092", "kind": "property", "name": "arguments", "serializedName": "arguments", "type": { "$id": "7093", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false }, { "$id": "7094", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "1100" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallItem.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false } ] }, "function_call_output": { "$id": "7095", "kind": "model", "name": "RealtimeRequestFunctionCallOutputItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallOutputItem", "usage": "Input,Json", "discriminatorValue": "function_call_output", "decorators": [], "baseModel": { "$ref": "7022" }, "properties": [ { "$id": "7096", "kind": "property", "name": "type", "serializedName": "type", "type": { "$id": "7097", "kind": "enumvalue", "name": "function_call_output", "value": "function_call_output", "valueType": { "$ref": "1091" }, "enumType": { "$ref": "7030" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallOutputItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7098", "kind": "property", "name": "call_id", "serializedName": "call_id", "type": { "$id": "7099", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallOutputItem.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7100", "kind": "property", "name": "output", "serializedName": "output", "type": { "$id": "7101", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeRequestFunctionCallOutputItem.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemCreate.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "conversation.item.truncate": { "$id": "7102", "kind": "model", "name": "RealtimeClientEventConversationItemTruncate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemTruncate", "usage": "Input,Json", "doc": "Send this event to truncate a previous assistant message’s audio. The server\nwill produce audio faster than realtime, so this event is useful when the user\ninterrupts to truncate audio that has already been sent to the client but not\nyet played. This will synchronize the server's understanding of the audio with\nthe client's playback.\n\nTruncating audio will delete the server-side text transcript to ensure there\nis not text in the context that hasn't been heard by the user.\n\nIf successful, the server will respond with a `conversation.item.truncated`\nevent.", "discriminatorValue": "conversation.item.truncate", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7103", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.truncate`.", "type": { "$id": "7104", "kind": "enumvalue", "name": "conversation_item_truncate", "value": "conversation.item.truncate", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemTruncate.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7105", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the assistant message item to truncate. Only assistant message\nitems can be truncated.", "type": { "$id": "7106", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemTruncate.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7107", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part to truncate. Set this to 0.", "type": { "$id": "7108", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemTruncate.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7109", "kind": "property", "name": "audio_end_ms", "serializedName": "audio_end_ms", "doc": "Inclusive duration up to which audio is truncated, in milliseconds. If\nthe audio_end_ms is greater than the actual audio duration, the server\nwill respond with an error.", "type": { "$id": "7110", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemTruncate.audio_end_ms", "serializationOptions": { "json": { "name": "audio_end_ms" } }, "isHttpMetadata": false } ] }, "conversation.item.delete": { "$id": "7111", "kind": "model", "name": "RealtimeClientEventConversationItemDelete", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemDelete", "usage": "Input,Json", "doc": "Send this event when you want to remove any item from the conversation\nhistory. The server will respond with a `conversation.item.deleted` event,\nunless the item does not exist in the conversation history, in which case the\nserver will respond with an error.", "discriminatorValue": "conversation.item.delete", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7112", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.delete`.", "type": { "$id": "7113", "kind": "enumvalue", "name": "conversation_item_delete", "value": "conversation.item.delete", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemDelete.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7114", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to delete.", "type": { "$id": "7115", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemDelete.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.create": { "$id": "7116", "kind": "model", "name": "RealtimeClientEventResponseCreate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCreate", "usage": "Input,Json", "doc": "This event instructs the server to create a Response, which means triggering\nmodel inference. When in Server VAD mode, the server will create Responses\nautomatically.\n\nA Response will include at least one Item, and may have two, in which case\nthe second will be a function call. These Items will be appended to the\nconversation history.\n\nThe server will respond with a `response.created` event, events for Items\nand content created, and finally a `response.done` event to indicate the\nResponse is complete.\n\nThe `response.create` event includes inference configuration like\n`instructions`, and `temperature`. These fields will override the Session's\nconfiguration for this Response only.", "discriminatorValue": "response.create", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7117", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.create`.", "type": { "$id": "7118", "kind": "enumvalue", "name": "response_create", "value": "response.create", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCreate.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7119", "kind": "property", "name": "response", "serializedName": "response", "type": { "$id": "7120", "kind": "model", "name": "RealtimeResponseCreateParams", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams", "usage": "Input,Json", "doc": "Create a new Realtime response with these parameters", "decorators": [], "properties": [ { "$id": "7121", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].", "type": { "$ref": "6916" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7122", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The default system instructions (i.e. system message) prepended to model\ncalls. This field allows the client to guide the model on desired\nresponses. The model can be instructed on response content and format,\n(e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good\nresponses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion\ninto your voice\", \"laugh frequently\"). The instructions are not guaranteed\nto be followed by the model, but they provide guidance to the model on the\ndesired behavior.\n\nNote that the server sets default instructions which will be used if this\nfield is not set and are visible in the `session.created` event at the\nstart of the session.", "type": { "$id": "7123", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "7124", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`,\n`onyx`, `nova`, `sage`, `shimmer`, and `verse`.", "type": { "$ref": "68" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "7125", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "doc": "The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "7126", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "Tools (functions) available to the model.", "type": { "$ref": "6972" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "7127", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "doc": "How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function, like `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}`.", "type": { "$id": "7128", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "7129", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.", "type": { "$id": "7130", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "7131", "kind": "property", "name": "max_output_tokens", "serializedName": "max_output_tokens", "doc": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.", "type": { "$id": "7132", "kind": "union", "name": "RealtimeResponseCreateParamsMaxOutputTokens", "variantTypes": [ { "$id": "7133", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1671" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.max_output_tokens", "serializationOptions": { "json": { "name": "max_output_tokens" } }, "isHttpMetadata": false }, { "$id": "7134", "kind": "property", "name": "conversation", "serializedName": "conversation", "doc": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.", "type": { "$ref": "1111" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.conversation", "serializationOptions": { "json": { "name": "conversation" } }, "isHttpMetadata": false }, { "$id": "7135", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "7136", "kind": "property", "name": "input", "serializedName": "input", "doc": "Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items from the default conversation.", "type": { "$id": "7137", "kind": "array", "name": "ArrayRealtimeConversationRequestItem", "valueType": { "$ref": "7022" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseCreateParams.input", "serializationOptions": { "json": { "name": "input" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCreate.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.cancel": { "$id": "7138", "kind": "model", "name": "RealtimeClientEventResponseCancel", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCancel", "usage": "Input,Json", "doc": "Send this event to cancel an in-progress response. The server will respond\nwith a `response.cancelled` event or an error if there is no response to\ncancel.", "discriminatorValue": "response.cancel", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7139", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.cancel`.", "type": { "$id": "7140", "kind": "enumvalue", "name": "response_cancel", "value": "response.cancel", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCancel.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7141", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "A specific response ID to cancel - if not provided, will cancel an\nin-progress response in the default conversation.", "type": { "$id": "7142", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventResponseCancel.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false } ] }, "conversation.item.retrieve": { "$id": "7143", "kind": "model", "name": "RealtimeClientEventConversationItemRetrieve", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemRetrieve", "usage": "Input,Json", "doc": "Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.\nThe server will respond with a `conversation.item.retrieved` event,\nunless the item does not exist in the conversation history, in which case the\nserver will respond with an error.", "discriminatorValue": "conversation.item.retrieve", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7144", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.retrieve`.", "type": { "$id": "7145", "kind": "enumvalue", "name": "conversation_item_retrieve", "value": "conversation.item.retrieve", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemRetrieve.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7146", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to retrieve.", "type": { "$id": "7147", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventConversationItemRetrieve.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "transcription_session.update": { "$id": "7148", "kind": "model", "name": "RealtimeClientEventTranscriptionSessionUpdate", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventTranscriptionSessionUpdate", "usage": "Input,Json", "doc": "Send this event to update a transcription session.", "discriminatorValue": "transcription_session.update", "decorators": [], "baseModel": { "$ref": "6892" }, "properties": [ { "$id": "7149", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `transcription_session.update`.", "type": { "$id": "7150", "kind": "enumvalue", "name": "transcription_session_update", "value": "transcription_session.update", "valueType": { "$ref": "1036" }, "enumType": { "$ref": "6899" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventTranscriptionSessionUpdate.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7151", "kind": "property", "name": "session", "serializedName": "session", "type": { "$id": "7152", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest", "usage": "Input,Json", "doc": "Realtime transcription session object configuration.", "decorators": [], "properties": [ { "$id": "7153", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].", "type": { "$id": "7154", "kind": "array", "name": "Array43", "valueType": { "$ref": "1115" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7155", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "doc": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate,\nsingle channel (mono), and little-endian byte order.", "type": { "$ref": "1119" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "7156", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "doc": "Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.", "type": { "$id": "7157", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequestInputAudioTranscription", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7158", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for transcription, current options are `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `whisper-1`.", "type": { "$ref": "1124" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription.anonymous.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "7159", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.", "type": { "$id": "7160", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription.anonymous.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "7161", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models, the prompt is a free text string, for example \"expect words related to technology\".", "type": { "$id": "7162", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription.anonymous.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "7163", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "doc": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\nSemantic VAD is more advanced and uses a turn detection model (in conjuction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.", "type": { "$id": "7164", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequestTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7165", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of turn detection.", "type": { "$ref": "1129" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7166", "kind": "property", "name": "eagerness", "serializedName": "eagerness", "doc": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`.", "type": { "$ref": "1133" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.eagerness", "serializationOptions": { "json": { "name": "eagerness" } }, "isHttpMetadata": false }, { "$id": "7167", "kind": "property", "name": "threshold", "serializedName": "threshold", "doc": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.", "type": { "$id": "7168", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.threshold", "serializationOptions": { "json": { "name": "threshold" } }, "isHttpMetadata": false }, { "$id": "7169", "kind": "property", "name": "prefix_padding_ms", "serializedName": "prefix_padding_ms", "doc": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.", "type": { "$id": "7170", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.prefix_padding_ms", "serializationOptions": { "json": { "name": "prefix_padding_ms" } }, "isHttpMetadata": false }, { "$id": "7171", "kind": "property", "name": "silence_duration_ms", "serializedName": "silence_duration_ms", "doc": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.", "type": { "$id": "7172", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.silence_duration_ms", "serializationOptions": { "json": { "name": "silence_duration_ms" } }, "isHttpMetadata": false }, { "$id": "7173", "kind": "property", "name": "create_response", "serializedName": "create_response", "doc": "Whether or not to automatically generate a response when a VAD stop event occurs. Not available for transcription sessions.", "type": { "$id": "7174", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.create_response", "serializationOptions": { "json": { "name": "create_response" } }, "isHttpMetadata": false }, { "$id": "7175", "kind": "property", "name": "interrupt_response", "serializedName": "interrupt_response", "doc": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. Not available for transcription sessions.", "type": { "$id": "7176", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection.anonymous.interrupt_response", "serializationOptions": { "json": { "name": "interrupt_response" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false }, { "$id": "7177", "kind": "property", "name": "input_audio_noise_reduction", "serializedName": "input_audio_noise_reduction", "doc": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.", "type": { "$id": "7178", "kind": "nullable", "type": { "$id": "7179", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_noise_reduction.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7180", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.", "type": { "$ref": "1139" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_noise_reduction.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.input_audio_noise_reduction", "serializationOptions": { "json": { "name": "input_audio_noise_reduction" } }, "isHttpMetadata": false }, { "$id": "7181", "kind": "property", "name": "include", "serializedName": "include", "doc": "The set of items to include in the transcription. Current available items are:\n- `item.input_audio_transcription.logprobs`", "type": { "$ref": "2373" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.include", "serializationOptions": { "json": { "name": "include" } }, "isHttpMetadata": false }, { "$id": "7182", "kind": "property", "name": "client_secret", "serializedName": "client_secret", "doc": "Configuration options for the generated client secret.", "type": { "$id": "7183", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequestClientSecret", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7184", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "Configuration for the ephemeral token expiration.", "type": { "$id": "7185", "kind": "model", "name": "RealtimeTranscriptionSessionCreateRequestClientSecretExpiresAt", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret.expires_at.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7186", "kind": "property", "name": "anchor", "serializedName": "anchor", "doc": "The anchor point for the ephemeral token expiration. Only `created_at` is currently supported.", "type": { "$ref": "1143" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret.expires_at.anonymous.anchor", "serializationOptions": { "json": { "name": "anchor" } }, "isHttpMetadata": false }, { "$id": "7187", "kind": "property", "name": "seconds", "serializedName": "seconds", "doc": "The number of seconds from the anchor point to the expiration. Select a value between `10` and `7200`.", "type": { "$id": "7188", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret.expires_at.anonymous.seconds", "serializationOptions": { "json": { "name": "seconds" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret.anonymous.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateRequest.client_secret", "serializationOptions": { "json": { "name": "client_secret" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeClientEventTranscriptionSessionUpdate.session", "serializationOptions": { "json": { "name": "session" } }, "isHttpMetadata": false } ] } } }, { "$ref": "6896" }, { "$ref": "6914" }, { "$ref": "6925" }, { "$ref": "6933" }, { "$ref": "6939" }, { "$ref": "6954" }, { "$ref": "6959" }, { "$ref": "6961" }, { "$ref": "6968" }, { "$ref": "6973" }, { "$ref": "6975" }, { "$ref": "6989" }, { "$ref": "6991" }, { "$ref": "6994" }, { "$ref": "7002" }, { "$ref": "7007" }, { "$ref": "7010" }, { "$ref": "7013" }, { "$ref": "7016" }, { "$ref": "7022" }, { "$ref": "7026" }, { "$ref": "7036" }, { "$ref": "7046" }, { "$ref": "7047" }, { "$ref": "7049" }, { "$ref": "7060" }, { "$ref": "7065" }, { "$ref": "7075" }, { "$ref": "7081" }, { "$ref": "7085" }, { "$ref": "7095" }, { "$ref": "7102" }, { "$ref": "7111" }, { "$ref": "7116" }, { "$ref": "7120" }, { "$ref": "7138" }, { "$ref": "7143" }, { "$ref": "7148" }, { "$ref": "7152" }, { "$ref": "7157" }, { "$ref": "7164" }, { "$ref": "7179" }, { "$ref": "7183" }, { "$ref": "7185" }, { "$id": "7189", "kind": "model", "name": "RealtimeServerEvent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEvent", "usage": "Output,Json", "doc": "A realtime server event.", "decorators": [], "discriminatorProperty": { "$id": "7190", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of event.", "type": { "$ref": "1147" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEvent.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$ref": "7190" }, { "$id": "7191", "kind": "property", "name": "event_id", "serializedName": "event_id", "type": { "$id": "7192", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEvent.event_id", "serializationOptions": { "json": { "name": "event_id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "error": { "$id": "7193", "kind": "model", "name": "RealtimeServerEventError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError", "usage": "Output,Json", "doc": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.", "discriminatorValue": "error", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7194", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `error`.", "type": { "$id": "7195", "kind": "enumvalue", "name": "error", "value": "error", "valueType": { "$ref": "1148" }, "enumType": { "$id": "7196", "kind": "enum", "decorators": [], "name": "RealtimeServerEventType", "isGeneratedName": false, "namespace": "OpenAI", "valueType": { "$id": "7197", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "7198", "kind": "enumvalue", "decorators": [], "name": "error", "value": "error", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7199", "kind": "enumvalue", "decorators": [], "name": "session_created", "value": "session.created", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7200", "kind": "enumvalue", "decorators": [], "name": "session_updated", "value": "session.updated", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7201", "kind": "enumvalue", "decorators": [], "name": "conversation_created", "value": "conversation.created", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7202", "kind": "enumvalue", "decorators": [], "name": "conversation_item_input_audio_transcription_completed", "value": "conversation.item.input_audio_transcription.completed", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7203", "kind": "enumvalue", "decorators": [], "name": "conversation_item_input_audio_transcription_delta", "value": "conversation.item.input_audio_transcription.delta", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7204", "kind": "enumvalue", "decorators": [], "name": "conversation_item_input_audio_transcription_failed", "value": "conversation.item.input_audio_transcription.failed", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7205", "kind": "enumvalue", "decorators": [], "name": "conversation_item_created", "value": "conversation.item.created", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7206", "kind": "enumvalue", "decorators": [], "name": "conversation_item_retrieved", "value": "conversation.item.retrieved", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7207", "kind": "enumvalue", "decorators": [], "name": "conversation_item_truncated", "value": "conversation.item.truncated", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7208", "kind": "enumvalue", "decorators": [], "name": "conversation_item_deleted", "value": "conversation.item.deleted", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7209", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_committed", "value": "input_audio_buffer.committed", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7210", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_cleared", "value": "input_audio_buffer.cleared", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7211", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_speech_started", "value": "input_audio_buffer.speech_started", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7212", "kind": "enumvalue", "decorators": [], "name": "input_audio_buffer_speech_stopped", "value": "input_audio_buffer.speech_stopped", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7213", "kind": "enumvalue", "decorators": [], "name": "output_audio_buffer_cleared", "value": "output_audio_buffer.cleared", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7214", "kind": "enumvalue", "decorators": [], "name": "output_audio_buffer_started", "value": "output_audio_buffer.started", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7215", "kind": "enumvalue", "decorators": [], "name": "output_audio_buffer_stopped", "value": "output_audio_buffer.stopped", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7216", "kind": "enumvalue", "decorators": [], "name": "response_created", "value": "response.created", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7217", "kind": "enumvalue", "decorators": [], "name": "response_done", "value": "response.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7218", "kind": "enumvalue", "decorators": [], "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7219", "kind": "enumvalue", "decorators": [], "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7220", "kind": "enumvalue", "decorators": [], "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7221", "kind": "enumvalue", "decorators": [], "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7222", "kind": "enumvalue", "decorators": [], "name": "response_text_delta", "value": "response.text.delta", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7223", "kind": "enumvalue", "decorators": [], "name": "response_text_done", "value": "response.text.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7224", "kind": "enumvalue", "decorators": [], "name": "response_audio_transcript_delta", "value": "response.audio_transcript.delta", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7225", "kind": "enumvalue", "decorators": [], "name": "response_audio_transcript_done", "value": "response.audio_transcript.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7226", "kind": "enumvalue", "decorators": [], "name": "response_audio_delta", "value": "response.audio.delta", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7227", "kind": "enumvalue", "decorators": [], "name": "response_audio_done", "value": "response.audio.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7228", "kind": "enumvalue", "decorators": [], "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7229", "kind": "enumvalue", "decorators": [], "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7230", "kind": "enumvalue", "decorators": [], "name": "transcription_session_updated", "value": "transcription_session.updated", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } }, { "$id": "7231", "kind": "enumvalue", "decorators": [], "name": "rate_limits_updated", "value": "rate_limits.updated", "valueType": { "$ref": "7197" }, "enumType": { "$ref": "7196" } } ], "isFixed": false, "isFlags": false, "usage": "Output,Json", "access": "public", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventType", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7232", "kind": "property", "name": "error", "serializedName": "error", "doc": "Details of the error.", "type": { "$id": "7233", "kind": "model", "name": "RealtimeServerEventErrorError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7234", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of error (e.g., \"invalid_request_error\", \"server_error\").", "type": { "$id": "7235", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7236", "kind": "property", "name": "code", "serializedName": "code", "doc": "Error code, if any.", "type": { "$id": "7237", "kind": "nullable", "type": { "$id": "7238", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "7239", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable error message.", "type": { "$id": "7240", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "7241", "kind": "property", "name": "param", "serializedName": "param", "doc": "Parameter related to the error, if any.", "type": { "$id": "7242", "kind": "nullable", "type": { "$id": "7243", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false }, { "$id": "7244", "kind": "property", "name": "event_id", "serializedName": "event_id", "doc": "The event_id of the client event that caused the error, if applicable.", "type": { "$id": "7245", "kind": "nullable", "type": { "$id": "7246", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error.anonymous.event_id", "serializationOptions": { "json": { "name": "event_id" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventError.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "session.created": { "$id": "7247", "kind": "model", "name": "RealtimeServerEventSessionCreated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionCreated", "usage": "Output,Json", "doc": "Returned when a Session is created. Emitted automatically when a new\nconnection is established as the first server event. This event will contain\nthe default Session configuration.", "discriminatorValue": "session.created", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7248", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `session.created`.", "type": { "$id": "7249", "kind": "enumvalue", "name": "session_created", "value": "session.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionCreated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7250", "kind": "property", "name": "session", "serializedName": "session", "type": { "$id": "7251", "kind": "model", "name": "RealtimeResponseSession", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7252", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1673" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "7253", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "7254", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "7255", "kind": "property", "name": "model", "serializedName": "model", "type": { "$id": "7256", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "7257", "kind": "property", "name": "modalities", "serializedName": "modalities", "type": { "$ref": "6916" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7258", "kind": "property", "name": "instructions", "serializedName": "instructions", "type": { "$id": "7259", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "7260", "kind": "property", "name": "voice", "serializedName": "voice", "type": { "$ref": "68" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "7261", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "type": { "$ref": "1060" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "7262", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "type": { "$ref": "1060" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "7263", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "type": { "$id": "7264", "kind": "nullable", "type": { "$ref": "6925" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "7265", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "type": { "$ref": "6933" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false }, { "$id": "7266", "kind": "property", "name": "input_audio_noise_reduction", "serializedName": "input_audio_noise_reduction", "type": { "$ref": "6959" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.input_audio_noise_reduction", "serializationOptions": { "json": { "name": "input_audio_noise_reduction" } }, "isHttpMetadata": false }, { "$id": "7267", "kind": "property", "name": "tools", "serializedName": "tools", "type": { "$ref": "6972" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "7268", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "type": { "$ref": "6988" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "7269", "kind": "property", "name": "temperature", "serializedName": "temperature", "type": { "$id": "7270", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "7271", "kind": "property", "name": "max_response_output_tokens", "serializedName": "max_response_output_tokens", "type": { "$id": "7272", "kind": "nullable", "type": { "$id": "7273", "kind": "union", "name": "RealtimeResponseSessionMaxResponseOutputTokens", "variantTypes": [ { "$id": "7274", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1675" } ], "namespace": "OpenAI", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseSession.max_response_output_tokens", "serializationOptions": { "json": { "name": "max_response_output_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionCreated.session", "serializationOptions": { "json": { "name": "session" } }, "isHttpMetadata": false } ] }, "session.updated": { "$id": "7275", "kind": "model", "name": "RealtimeServerEventSessionUpdated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionUpdated", "usage": "Output,Json", "doc": "Returned when a session is updated with a `session.update` event, unless\nthere is an error.", "discriminatorValue": "session.updated", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7276", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `session.updated`.", "type": { "$id": "7277", "kind": "enumvalue", "name": "session_updated", "value": "session.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionUpdated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7278", "kind": "property", "name": "session", "serializedName": "session", "type": { "$ref": "7251" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventSessionUpdated.session", "serializationOptions": { "json": { "name": "session" } }, "isHttpMetadata": false } ] }, "conversation.created": { "$id": "7279", "kind": "model", "name": "RealtimeServerEventConversationCreated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated", "usage": "Output,Json", "doc": "Returned when a conversation is created. Emitted right after session creation.", "discriminatorValue": "conversation.created", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7280", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.created`.", "type": { "$id": "7281", "kind": "enumvalue", "name": "conversation_created", "value": "conversation.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7282", "kind": "property", "name": "conversation", "serializedName": "conversation", "doc": "The conversation resource.", "type": { "$id": "7283", "kind": "model", "name": "RealtimeServerEventConversationCreatedConversation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated.conversation.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7284", "kind": "property", "name": "id", "serializedName": "id", "doc": "The unique ID of the conversation.", "type": { "$id": "7285", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated.conversation.anonymous.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "7286", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, must be `realtime.conversation`.", "type": { "$id": "7287", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated.conversation.anonymous.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationCreated.conversation", "serializationOptions": { "json": { "name": "conversation" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.committed": { "$id": "7288", "kind": "model", "name": "RealtimeServerEventInputAudioBufferCommitted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCommitted", "usage": "Output,Json", "doc": "Returned when an input audio buffer is committed, either by the client or\nautomatically in server VAD mode. The `item_id` property is the ID of the user\nmessage item that will be created, thus a `conversation.item.created` event\nwill also be sent to the client.", "discriminatorValue": "input_audio_buffer.committed", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7289", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.committed`.", "type": { "$id": "7290", "kind": "enumvalue", "name": "input_audio_buffer_committed", "value": "input_audio_buffer.committed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCommitted.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7291", "kind": "property", "name": "previous_item_id", "serializedName": "previous_item_id", "doc": "The ID of the preceding item after which the new item will be inserted.", "type": { "$id": "7292", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCommitted.previous_item_id", "serializationOptions": { "json": { "name": "previous_item_id" } }, "isHttpMetadata": false }, { "$id": "7293", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the user message item that will be created.", "type": { "$id": "7294", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCommitted.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.cleared": { "$id": "7295", "kind": "model", "name": "RealtimeServerEventInputAudioBufferCleared", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCleared", "usage": "Output,Json", "doc": "Returned when the input audio buffer is cleared by the client with a\n`input_audio_buffer.clear` event.", "discriminatorValue": "input_audio_buffer.cleared", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7296", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.cleared`.", "type": { "$id": "7297", "kind": "enumvalue", "name": "input_audio_buffer_cleared", "value": "input_audio_buffer.cleared", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferCleared.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.speech_started": { "$id": "7298", "kind": "model", "name": "RealtimeServerEventInputAudioBufferSpeechStarted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStarted", "usage": "Output,Json", "doc": "Sent by the server when in `server_vad` mode to indicate that speech has been\ndetected in the audio buffer. This can happen any time audio is added to the\nbuffer (unless speech is already detected). The client may want to use this\nevent to interrupt audio playback or provide visual feedback to the user.\n\nThe client should expect to receive a `input_audio_buffer.speech_stopped` event\nwhen speech stops. The `item_id` property is the ID of the user message item\nthat will be created when speech stops and will also be included in the\n`input_audio_buffer.speech_stopped` event (unless the client manually commits\nthe audio buffer during VAD activation).", "discriminatorValue": "input_audio_buffer.speech_started", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7299", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.speech_started`.", "type": { "$id": "7300", "kind": "enumvalue", "name": "input_audio_buffer_speech_started", "value": "input_audio_buffer.speech_started", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStarted.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7301", "kind": "property", "name": "audio_start_ms", "serializedName": "audio_start_ms", "doc": "Milliseconds from the start of all audio written to the buffer during the\nsession when speech was first detected. This will correspond to the\nbeginning of audio sent to the model, and thus includes the\n`prefix_padding_ms` configured in the Session.", "type": { "$id": "7302", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStarted.audio_start_ms", "serializationOptions": { "json": { "name": "audio_start_ms" } }, "isHttpMetadata": false }, { "$id": "7303", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the user message item that will be created when speech stops.", "type": { "$id": "7304", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStarted.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "input_audio_buffer.speech_stopped": { "$id": "7305", "kind": "model", "name": "RealtimeServerEventInputAudioBufferSpeechStopped", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStopped", "usage": "Output,Json", "doc": "Returned in `server_vad` mode when the server detects the end of speech in\nthe audio buffer. The server will also send an `conversation.item.created`\nevent with the user message item that is created from the audio buffer.", "discriminatorValue": "input_audio_buffer.speech_stopped", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7306", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `input_audio_buffer.speech_stopped`.", "type": { "$id": "7307", "kind": "enumvalue", "name": "input_audio_buffer_speech_stopped", "value": "input_audio_buffer.speech_stopped", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStopped.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7308", "kind": "property", "name": "audio_end_ms", "serializedName": "audio_end_ms", "doc": "Milliseconds since the session started when speech stopped. This will\ncorrespond to the end of audio sent to the model, and thus includes the\n`min_silence_duration_ms` configured in the Session.", "type": { "$id": "7309", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStopped.audio_end_ms", "serializationOptions": { "json": { "name": "audio_end_ms" } }, "isHttpMetadata": false }, { "$id": "7310", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the user message item that will be created.", "type": { "$id": "7311", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventInputAudioBufferSpeechStopped.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "output_audio_buffer.cleared": { "$id": "7312", "kind": "model", "name": "RealtimeServerEventOutputAudioBufferCleared", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferCleared", "usage": "Output,Json", "doc": "**WebRTC Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).", "discriminatorValue": "output_audio_buffer.cleared", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7313", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `output_audio_buffer.cleared`.", "type": { "$id": "7314", "kind": "enumvalue", "name": "output_audio_buffer_cleared", "value": "output_audio_buffer.cleared", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferCleared.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7315", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The unique ID of the response that produced the audio.", "type": { "$id": "7316", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferCleared.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false } ] }, "output_audio_buffer.started": { "$id": "7317", "kind": "model", "name": "RealtimeServerEventOutputAudioBufferStarted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStarted", "usage": "Output,Json", "doc": "**WebRTC Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).", "discriminatorValue": "output_audio_buffer.started", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7318", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `output_audio_buffer.started`.", "type": { "$id": "7319", "kind": "enumvalue", "name": "output_audio_buffer_started", "value": "output_audio_buffer.started", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStarted.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7320", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The unique ID of the response that produced the audio.", "type": { "$id": "7321", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStarted.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false } ] }, "output_audio_buffer.stopped": { "$id": "7322", "kind": "model", "name": "RealtimeServerEventOutputAudioBufferStopped", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStopped", "usage": "Output,Json", "doc": "**WebRTC Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).", "discriminatorValue": "output_audio_buffer.stopped", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7323", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `output_audio_buffer.stopped`.", "type": { "$id": "7324", "kind": "enumvalue", "name": "output_audio_buffer_stopped", "value": "output_audio_buffer.stopped", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStopped.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7325", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The unique ID of the response that produced the audio.", "type": { "$id": "7326", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventOutputAudioBufferStopped.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false } ] }, "conversation.item.created": { "$id": "7327", "kind": "model", "name": "RealtimeServerEventConversationItemCreated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemCreated", "usage": "Output,Json", "doc": "Returned when a conversation item is created. There are several scenarios that produce this event:\n - The server is generating a Response, which if successful will produce\n either one or two Items, which will be of type `message`\n (role `assistant`) or type `function_call`.\n - The input audio buffer has been committed, either by the client or the\n server (in `server_vad` mode). The server will take the content of the\n input audio buffer and add it to a new user message Item.\n - The client has sent a `conversation.item.create` event to add a new Item\n to the Conversation.", "discriminatorValue": "conversation.item.created", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7328", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.created`.", "type": { "$id": "7329", "kind": "enumvalue", "name": "conversation_item_created", "value": "conversation.item.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemCreated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7330", "kind": "property", "name": "previous_item_id", "serializedName": "previous_item_id", "doc": "The ID of the preceding item in the Conversation context, allows the\nclient to understand the order of the conversation.", "type": { "$id": "7331", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemCreated.previous_item_id", "serializationOptions": { "json": { "name": "previous_item_id" } }, "isHttpMetadata": false }, { "$id": "7332", "kind": "property", "name": "item", "serializedName": "item", "type": { "$id": "7333", "kind": "model", "name": "RealtimeConversationResponseItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeConversationResponseItem", "usage": "Output,Json", "decorators": [], "discriminatorProperty": { "$id": "7334", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "1090" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeConversationResponseItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, "properties": [ { "$id": "7335", "kind": "property", "name": "object", "serializedName": "object", "type": { "$ref": "1677" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeConversationResponseItem.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$ref": "7334" }, { "$id": "7336", "kind": "property", "name": "id", "serializedName": "id", "type": { "$id": "7337", "kind": "nullable", "type": { "$id": "7338", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeConversationResponseItem.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false } ], "discriminatedSubtypes": { "message": { "$id": "7339", "kind": "model", "name": "RealtimeResponseMessageItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseMessageItem", "usage": "Output,Json", "discriminatorValue": "message", "decorators": [], "baseModel": { "$ref": "7333" }, "properties": [ { "$id": "7340", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "7029" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseMessageItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7341", "kind": "property", "name": "role", "serializedName": "role", "type": { "$ref": "1095" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseMessageItem.role", "serializationOptions": { "json": { "name": "role" } }, "isHttpMetadata": false }, { "$id": "7342", "kind": "property", "name": "content", "serializedName": "content", "type": { "$id": "7343", "kind": "array", "name": "ArrayRealtimeContentPart", "valueType": { "$ref": "7047" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseMessageItem.content", "serializationOptions": { "json": { "name": "content" } }, "isHttpMetadata": false }, { "$id": "7344", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "1100" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseMessageItem.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false } ] }, "function_call": { "$id": "7345", "kind": "model", "name": "RealtimeResponseFunctionCallItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem", "usage": "Output,Json", "discriminatorValue": "function_call", "decorators": [], "baseModel": { "$ref": "7333" }, "properties": [ { "$id": "7346", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "7087" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7347", "kind": "property", "name": "name", "serializedName": "name", "type": { "$id": "7348", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "7349", "kind": "property", "name": "call_id", "serializedName": "call_id", "type": { "$id": "7350", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7351", "kind": "property", "name": "arguments", "serializedName": "arguments", "type": { "$id": "7352", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false }, { "$id": "7353", "kind": "property", "name": "status", "serializedName": "status", "type": { "$ref": "1100" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallItem.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false } ] }, "function_call_output": { "$id": "7354", "kind": "model", "name": "RealtimeResponseFunctionCallOutputItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallOutputItem", "usage": "Output,Json", "discriminatorValue": "function_call_output", "decorators": [], "baseModel": { "$ref": "7333" }, "properties": [ { "$id": "7355", "kind": "property", "name": "type", "serializedName": "type", "type": { "$ref": "7097" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallOutputItem.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7356", "kind": "property", "name": "call_id", "serializedName": "call_id", "type": { "$id": "7357", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallOutputItem.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7358", "kind": "property", "name": "output", "serializedName": "output", "type": { "$id": "7359", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponseFunctionCallOutputItem.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false } ] } } }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemCreated.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "conversation.item.input_audio_transcription.completed": { "$id": "7360", "kind": "model", "name": "RealtimeServerEventConversationItemInputAudioTranscriptionCompleted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted", "usage": "Output,Json", "doc": "This event is the output of audio transcription for user audio written to the\nuser audio buffer. Transcription begins when the input audio buffer is\ncommitted by the client or server (in `server_vad` mode). Transcription runs\nasynchronously with Response creation, so this event may come before or after\nthe Response events.\n\nRealtime API models accept audio natively, and thus input transcription is a\nseparate process run on a separate ASR (Automatic Speech Recognition) model,\ncurrently always `whisper-1`. Thus the transcript may diverge somewhat from\nthe model's interpretation, and should be treated as a rough guide.", "discriminatorValue": "conversation.item.input_audio_transcription.completed", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7361", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be\n`conversation.item.input_audio_transcription.completed`.", "type": { "$id": "7362", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_completed", "value": "conversation.item.input_audio_transcription.completed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7363", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the user message item containing the audio.", "type": { "$id": "7364", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7365", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part containing the audio.", "type": { "$id": "7366", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7367", "kind": "property", "name": "transcript", "serializedName": "transcript", "doc": "The transcribed text.", "type": { "$id": "7368", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false }, { "$id": "7369", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "The log probabilities of the transcription.", "type": { "$id": "7370", "kind": "nullable", "type": { "$id": "7371", "kind": "array", "name": "ArrayLogProbProperties", "valueType": { "$id": "7372", "kind": "model", "name": "LogProbProperties", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.LogProbProperties", "usage": "Output,Json", "doc": "A log probability object.", "decorators": [], "properties": [ { "$id": "7373", "kind": "property", "name": "token", "serializedName": "token", "doc": "The token that was used to generate the log probability.", "type": { "$id": "7374", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProbProperties.token", "serializationOptions": { "json": { "name": "token" } }, "isHttpMetadata": false }, { "$id": "7375", "kind": "property", "name": "logprob", "serializedName": "logprob", "doc": "The log probability of the token.", "type": { "$id": "7376", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProbProperties.logprob", "serializationOptions": { "json": { "name": "logprob" } }, "isHttpMetadata": false }, { "$id": "7377", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "The bytes that were used to generate the log probability.", "type": { "$ref": "2606" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.LogProbProperties.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false } ] }, "conversation.item.input_audio_transcription.failed": { "$id": "7378", "kind": "model", "name": "RealtimeServerEventConversationItemInputAudioTranscriptionFailed", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed", "usage": "Output,Json", "doc": "Returned when input audio transcription is configured, and a transcription\nrequest for a user message failed. These events are separate from other\n`error` events so that the client can identify the related Item.", "discriminatorValue": "conversation.item.input_audio_transcription.failed", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7379", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be\n`conversation.item.input_audio_transcription.failed`.", "type": { "$id": "7380", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_failed", "value": "conversation.item.input_audio_transcription.failed", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7381", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the user message item.", "type": { "$id": "7382", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7383", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part containing the audio.", "type": { "$id": "7384", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7385", "kind": "property", "name": "error", "serializedName": "error", "doc": "Details of the transcription error.", "type": { "$id": "7386", "kind": "model", "name": "RealtimeServerEventConversationItemInputAudioTranscriptionFailedError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7387", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of error.", "type": { "$id": "7388", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7389", "kind": "property", "name": "code", "serializedName": "code", "doc": "Error code, if any.", "type": { "$id": "7390", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false }, { "$id": "7391", "kind": "property", "name": "message", "serializedName": "message", "doc": "A human-readable error message.", "type": { "$id": "7392", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error.anonymous.message", "serializationOptions": { "json": { "name": "message" } }, "isHttpMetadata": false }, { "$id": "7393", "kind": "property", "name": "param", "serializedName": "param", "doc": "Parameter related to the error, if any.", "type": { "$id": "7394", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error.anonymous.param", "serializationOptions": { "json": { "name": "param" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionFailed.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "conversation.item.truncated": { "$id": "7395", "kind": "model", "name": "RealtimeServerEventConversationItemTruncated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemTruncated", "usage": "Output,Json", "doc": "Returned when an earlier assistant audio message item is truncated by the\nclient with a `conversation.item.truncate` event. This event is used to\nsynchronize the server's understanding of the audio with the client's playback.\n\nThis action will truncate the audio and remove the server-side text transcript\nto ensure there is no text in the context that hasn't been heard by the user.", "discriminatorValue": "conversation.item.truncated", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7396", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.truncated`.", "type": { "$id": "7397", "kind": "enumvalue", "name": "conversation_item_truncated", "value": "conversation.item.truncated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemTruncated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7398", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the assistant message item that was truncated.", "type": { "$id": "7399", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemTruncated.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7400", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part that was truncated.", "type": { "$id": "7401", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemTruncated.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7402", "kind": "property", "name": "audio_end_ms", "serializedName": "audio_end_ms", "doc": "The duration up to which the audio was truncated, in milliseconds.", "type": { "$id": "7403", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemTruncated.audio_end_ms", "serializationOptions": { "json": { "name": "audio_end_ms" } }, "isHttpMetadata": false } ] }, "conversation.item.deleted": { "$id": "7404", "kind": "model", "name": "RealtimeServerEventConversationItemDeleted", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemDeleted", "usage": "Output,Json", "doc": "Returned when an item in the conversation is deleted by the client with a\n`conversation.item.delete` event. This event is used to synchronize the\nserver's understanding of the conversation history with the client's view.", "discriminatorValue": "conversation.item.deleted", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7405", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.deleted`.", "type": { "$id": "7406", "kind": "enumvalue", "name": "conversation_item_deleted", "value": "conversation.item.deleted", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemDeleted.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7407", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item that was deleted.", "type": { "$id": "7408", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemDeleted.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false } ] }, "response.created": { "$id": "7409", "kind": "model", "name": "RealtimeServerEventResponseCreated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseCreated", "usage": "Output,Json", "doc": "Returned when a new Response is created. The first event of response creation,\nwhere the response is in an initial state of `in_progress`.", "discriminatorValue": "response.created", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7410", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.created`.", "type": { "$id": "7411", "kind": "enumvalue", "name": "response_created", "value": "response.created", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseCreated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7412", "kind": "property", "name": "response", "serializedName": "response", "type": { "$id": "7413", "kind": "model", "name": "RealtimeResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse", "usage": "Output,Json", "doc": "The response resource.", "decorators": [], "properties": [ { "$id": "7414", "kind": "property", "name": "id", "serializedName": "id", "doc": "The unique ID of the response.", "type": { "$id": "7415", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "7416", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, must be `realtime.response`.", "type": { "$ref": "1183" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "7417", "kind": "property", "name": "status", "serializedName": "status", "doc": "The final status of the response (`completed`, `cancelled`, `failed`, or\n`incomplete`).", "type": { "$ref": "1187" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "7418", "kind": "property", "name": "status_details", "serializedName": "status_details", "doc": "Additional details about the status.", "type": { "$id": "7419", "kind": "model", "name": "RealtimeResponseStatusDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7420", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of error that caused the response to fail, corresponding\nwith the `status` field (`completed`, `cancelled`, `incomplete`,\n`failed`).", "type": { "$ref": "1193" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7421", "kind": "property", "name": "reason", "serializedName": "reason", "doc": "The reason the Response did not complete. For a `cancelled` Response,\none of `turn_detected` (the server VAD detected a new start of speech)\nor `client_cancelled` (the client sent a cancel event). For an\n`incomplete` Response, one of `max_output_tokens` or `content_filter`\n(the server-side safety filter activated and cut off the response).", "type": { "$ref": "1199" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.anonymous.reason", "serializationOptions": { "json": { "name": "reason" } }, "isHttpMetadata": false }, { "$id": "7422", "kind": "property", "name": "error", "serializedName": "error", "doc": "A description of the error that caused the response to fail,\npopulated when the `status` is `failed`.", "type": { "$id": "7423", "kind": "model", "name": "RealtimeResponseStatusDetailsError", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.error.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7424", "kind": "property", "name": "type", "serializedName": "type", "doc": "The type of error.", "type": { "$id": "7425", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.error.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7426", "kind": "property", "name": "code", "serializedName": "code", "doc": "Error code, if any.", "type": { "$id": "7427", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.error.anonymous.code", "serializationOptions": { "json": { "name": "code" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details.anonymous.error", "serializationOptions": { "json": { "name": "error" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.status_details", "serializationOptions": { "json": { "name": "status_details" } }, "isHttpMetadata": false }, { "$id": "7428", "kind": "property", "name": "output", "serializedName": "output", "doc": "The list of output items generated by the response.", "type": { "$id": "7429", "kind": "array", "name": "ArrayRealtimeConversationResponseItem", "valueType": { "$ref": "7333" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.output", "serializationOptions": { "json": { "name": "output" } }, "isHttpMetadata": false }, { "$id": "7430", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2379" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false }, { "$id": "7431", "kind": "property", "name": "usage", "serializedName": "usage", "doc": "Usage statistics for the Response, this will correspond to billing. A\nRealtime API session will maintain a conversation context and append new\nItems to the Conversation, thus output from previous turns (text and\naudio tokens) will become the input for later turns.", "type": { "$id": "7432", "kind": "model", "name": "RealtimeResponseUsage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7433", "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", "doc": "The total number of tokens in the Response including input and output\ntext and audio tokens.", "type": { "$id": "7434", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous.total_tokens", "serializationOptions": { "json": { "name": "total_tokens" } }, "isHttpMetadata": false }, { "$id": "7435", "kind": "property", "name": "input_tokens", "serializedName": "input_tokens", "doc": "The number of input tokens used in the Response, including text and\naudio tokens.", "type": { "$id": "7436", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous.input_tokens", "serializationOptions": { "json": { "name": "input_tokens" } }, "isHttpMetadata": false }, { "$id": "7437", "kind": "property", "name": "output_tokens", "serializedName": "output_tokens", "doc": "The number of output tokens sent in the Response, including text and\naudio tokens.", "type": { "$id": "7438", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous.output_tokens", "serializationOptions": { "json": { "name": "output_tokens" } }, "isHttpMetadata": false }, { "$id": "7439", "kind": "property", "name": "input_token_details", "serializedName": "input_token_details", "doc": "Details about the input tokens used in the Response.", "type": { "$id": "7440", "kind": "model", "name": "RealtimeResponseUsageInputTokenDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.input_token_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7441", "kind": "property", "name": "cached_tokens", "serializedName": "cached_tokens", "doc": "The number of cached tokens used in the Response.", "type": { "$id": "7442", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.input_token_details.anonymous.cached_tokens", "serializationOptions": { "json": { "name": "cached_tokens" } }, "isHttpMetadata": false }, { "$id": "7443", "kind": "property", "name": "text_tokens", "serializedName": "text_tokens", "doc": "The number of text tokens used in the Response.", "type": { "$id": "7444", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.input_token_details.anonymous.text_tokens", "serializationOptions": { "json": { "name": "text_tokens" } }, "isHttpMetadata": false }, { "$id": "7445", "kind": "property", "name": "audio_tokens", "serializedName": "audio_tokens", "doc": "The number of audio tokens used in the Response.", "type": { "$id": "7446", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.input_token_details.anonymous.audio_tokens", "serializationOptions": { "json": { "name": "audio_tokens" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous.input_token_details", "serializationOptions": { "json": { "name": "input_token_details" } }, "isHttpMetadata": false }, { "$id": "7447", "kind": "property", "name": "output_token_details", "serializedName": "output_token_details", "doc": "Details about the output tokens used in the Response.", "type": { "$id": "7448", "kind": "model", "name": "RealtimeResponseUsageOutputTokenDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.output_token_details.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7449", "kind": "property", "name": "text_tokens", "serializedName": "text_tokens", "doc": "The number of text tokens used in the Response.", "type": { "$id": "7450", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.output_token_details.anonymous.text_tokens", "serializationOptions": { "json": { "name": "text_tokens" } }, "isHttpMetadata": false }, { "$id": "7451", "kind": "property", "name": "audio_tokens", "serializedName": "audio_tokens", "doc": "The number of audio tokens used in the Response.", "type": { "$id": "7452", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.output_token_details.anonymous.audio_tokens", "serializationOptions": { "json": { "name": "audio_tokens" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage.anonymous.output_token_details", "serializationOptions": { "json": { "name": "output_token_details" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.usage", "serializationOptions": { "json": { "name": "usage" } }, "isHttpMetadata": false }, { "$id": "7453", "kind": "property", "name": "conversation_id", "serializedName": "conversation_id", "doc": "Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nby server VAD, the response will be added to the default conversation, thus\nthe `conversation_id` will be an id like `conv_1234`.", "type": { "$id": "7454", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.conversation_id", "serializationOptions": { "json": { "name": "conversation_id" } }, "isHttpMetadata": false }, { "$id": "7455", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice the model used to respond.\nCurrent voice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`,\n`onyx`, `nova`, `sage`, `shimmer`, and `verse`.", "type": { "$ref": "68" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "7456", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model used to respond. If there are multiple modalities,\nthe model will pick one, for example if `modalities` is `[\"text\", \"audio\"]`, the model\ncould be responding in either text or audio.", "type": { "$id": "7457", "kind": "array", "name": "Array44", "valueType": { "$ref": "1205" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7458", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "doc": "The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.", "type": { "$ref": "1209" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "7459", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.", "type": { "$id": "7460", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "7461", "kind": "property", "name": "max_output_tokens", "serializedName": "max_output_tokens", "doc": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.", "type": { "$id": "7462", "kind": "union", "name": "RealtimeResponseMaxOutputTokens", "variantTypes": [ { "$id": "7463", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1679" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeResponse.max_output_tokens", "serializationOptions": { "json": { "name": "max_output_tokens" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseCreated.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.done": { "$id": "7464", "kind": "model", "name": "RealtimeServerEventResponseDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseDone", "usage": "Output,Json", "doc": "Returned when a Response is done streaming. Always emitted, no matter the\nfinal state. The Response object included in the `response.done` event will\ninclude all output Items in the Response but will omit the raw audio data.", "discriminatorValue": "response.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7465", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.done`.", "type": { "$id": "7466", "kind": "enumvalue", "name": "response_done", "value": "response.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7467", "kind": "property", "name": "response", "serializedName": "response", "type": { "$ref": "7413" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseDone.response", "serializationOptions": { "json": { "name": "response" } }, "isHttpMetadata": false } ] }, "response.output_item.added": { "$id": "7468", "kind": "model", "name": "RealtimeServerEventResponseOutputItemAdded", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemAdded", "usage": "Output,Json", "doc": "Returned when a new Item is created during Response generation.", "discriminatorValue": "response.output_item.added", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7469", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.output_item.added`.", "type": { "$id": "7470", "kind": "enumvalue", "name": "response_output_item_added", "value": "response.output_item.added", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemAdded.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7471", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the Response to which the item belongs.", "type": { "$id": "7472", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemAdded.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7473", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the Response.", "type": { "$id": "7474", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemAdded.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7475", "kind": "property", "name": "item", "serializedName": "item", "type": { "$ref": "7333" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemAdded.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "response.output_item.done": { "$id": "7476", "kind": "model", "name": "RealtimeServerEventResponseOutputItemDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemDone", "usage": "Output,Json", "doc": "Returned when an Item is done streaming. Also emitted when a Response is\ninterrupted, incomplete, or cancelled.", "discriminatorValue": "response.output_item.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7477", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.output_item.done`.", "type": { "$id": "7478", "kind": "enumvalue", "name": "response_output_item_done", "value": "response.output_item.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7479", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the Response to which the item belongs.", "type": { "$id": "7480", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7481", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the Response.", "type": { "$id": "7482", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7483", "kind": "property", "name": "item", "serializedName": "item", "type": { "$ref": "7333" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseOutputItemDone.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "response.content_part.added": { "$id": "7484", "kind": "model", "name": "RealtimeServerEventResponseContentPartAdded", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded", "usage": "Output,Json", "doc": "Returned when a new content part is added to an assistant message item during\nresponse generation.", "discriminatorValue": "response.content_part.added", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7485", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.content_part.added`.", "type": { "$id": "7486", "kind": "enumvalue", "name": "response_content_part_added", "value": "response.content_part.added", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7487", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7489", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to which the content part was added.", "type": { "$id": "7490", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7491", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7492", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7493", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7494", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7495", "kind": "property", "name": "part", "serializedName": "part", "doc": "The content part that was added.", "type": { "$ref": "7047" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartAdded.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.content_part.done": { "$id": "7496", "kind": "model", "name": "RealtimeServerEventResponseContentPartDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone", "usage": "Output,Json", "doc": "Returned when a content part is done streaming in an assistant message item.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.", "discriminatorValue": "response.content_part.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7497", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.content_part.done`.", "type": { "$id": "7498", "kind": "enumvalue", "name": "response_content_part_done", "value": "response.content_part.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7499", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7500", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7501", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7502", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7503", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7504", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7505", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7506", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7507", "kind": "property", "name": "part", "serializedName": "part", "doc": "The content part that is done.", "type": { "$ref": "7047" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseContentPartDone.part", "serializationOptions": { "json": { "name": "part" } }, "isHttpMetadata": false } ] }, "response.text.delta": { "$id": "7508", "kind": "model", "name": "RealtimeServerEventResponseTextDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta", "usage": "Output,Json", "doc": "Returned when the text value of a \"text\" content part is updated.", "discriminatorValue": "response.text.delta", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7509", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.text.delta`.", "type": { "$id": "7510", "kind": "enumvalue", "name": "response_text_delta", "value": "response.text.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7511", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7512", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7513", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7514", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7515", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7516", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7517", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7518", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7519", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The text delta.", "type": { "$id": "7520", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDelta.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.text.done": { "$id": "7521", "kind": "model", "name": "RealtimeServerEventResponseTextDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone", "usage": "Output,Json", "doc": "Returned when the text value of a \"text\" content part is done streaming. Also\nemitted when a Response is interrupted, incomplete, or cancelled.", "discriminatorValue": "response.text.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7522", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.text.done`.", "type": { "$id": "7523", "kind": "enumvalue", "name": "response_text_done", "value": "response.text.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7524", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7525", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7526", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7527", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7528", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7529", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7530", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7531", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7532", "kind": "property", "name": "text", "serializedName": "text", "doc": "The final text content.", "type": { "$id": "7533", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseTextDone.text", "serializationOptions": { "json": { "name": "text" } }, "isHttpMetadata": false } ] }, "response.audio_transcript.delta": { "$id": "7534", "kind": "model", "name": "RealtimeServerEventResponseAudioTranscriptDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta", "usage": "Output,Json", "doc": "Returned when the model-generated transcription of audio output is updated.", "discriminatorValue": "response.audio_transcript.delta", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7535", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.audio_transcript.delta`.", "type": { "$id": "7536", "kind": "enumvalue", "name": "response_audio_transcript_delta", "value": "response.audio_transcript.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7537", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7538", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7539", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7540", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7541", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7542", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7543", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7544", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7545", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The transcript delta.", "type": { "$id": "7546", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDelta.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.audio_transcript.done": { "$id": "7547", "kind": "model", "name": "RealtimeServerEventResponseAudioTranscriptDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone", "usage": "Output,Json", "doc": "Returned when the model-generated transcription of audio output is done\nstreaming. Also emitted when a Response is interrupted, incomplete, or\ncancelled.", "discriminatorValue": "response.audio_transcript.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7548", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.audio_transcript.done`.", "type": { "$id": "7549", "kind": "enumvalue", "name": "response_audio_transcript_done", "value": "response.audio_transcript.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7550", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7551", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7552", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7553", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7554", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7555", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7556", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7557", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7558", "kind": "property", "name": "transcript", "serializedName": "transcript", "doc": "The final transcript of the audio.", "type": { "$id": "7559", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioTranscriptDone.transcript", "serializationOptions": { "json": { "name": "transcript" } }, "isHttpMetadata": false } ] }, "response.audio.delta": { "$id": "7560", "kind": "model", "name": "RealtimeServerEventResponseAudioDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta", "usage": "Output,Json", "doc": "Returned when the model-generated audio is updated.", "discriminatorValue": "response.audio.delta", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7561", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.audio.delta`.", "type": { "$id": "7562", "kind": "enumvalue", "name": "response_audio_delta", "value": "response.audio.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7563", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7564", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7565", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7566", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7567", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7568", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7569", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7570", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7571", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "Base64-encoded audio data delta.", "type": { "$id": "7572", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDelta.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.audio.done": { "$id": "7573", "kind": "model", "name": "RealtimeServerEventResponseAudioDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone", "usage": "Output,Json", "doc": "Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.", "discriminatorValue": "response.audio.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7574", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.audio.done`.", "type": { "$id": "7575", "kind": "enumvalue", "name": "response_audio_done", "value": "response.audio.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7576", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7577", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7578", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7579", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7580", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7581", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7582", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7583", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseAudioDone.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false } ] }, "response.function_call_arguments.delta": { "$id": "7584", "kind": "model", "name": "RealtimeServerEventResponseFunctionCallArgumentsDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta", "usage": "Output,Json", "doc": "Returned when the model-generated function call arguments are updated.", "discriminatorValue": "response.function_call_arguments.delta", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7585", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.function_call_arguments.delta`.", "type": { "$id": "7586", "kind": "enumvalue", "name": "response_function_call_arguments_delta", "value": "response.function_call_arguments.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7587", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7588", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7589", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the function call item.", "type": { "$id": "7590", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7591", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7592", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7593", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The ID of the function call.", "type": { "$id": "7594", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7595", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The arguments delta as a JSON string.", "type": { "$id": "7596", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDelta.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false } ] }, "response.function_call_arguments.done": { "$id": "7597", "kind": "model", "name": "RealtimeServerEventResponseFunctionCallArgumentsDone", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone", "usage": "Output,Json", "doc": "Returned when the model-generated function call arguments are done streaming.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.", "discriminatorValue": "response.function_call_arguments.done", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7598", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `response.function_call_arguments.done`.", "type": { "$id": "7599", "kind": "enumvalue", "name": "response_function_call_arguments_done", "value": "response.function_call_arguments.done", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7600", "kind": "property", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response.", "type": { "$id": "7601", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.response_id", "serializationOptions": { "json": { "name": "response_id" } }, "isHttpMetadata": false }, { "$id": "7602", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the function call item.", "type": { "$id": "7603", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7604", "kind": "property", "name": "output_index", "serializedName": "output_index", "doc": "The index of the output item in the response.", "type": { "$id": "7605", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.output_index", "serializationOptions": { "json": { "name": "output_index" } }, "isHttpMetadata": false }, { "$id": "7606", "kind": "property", "name": "call_id", "serializedName": "call_id", "doc": "The ID of the function call.", "type": { "$id": "7607", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.call_id", "serializationOptions": { "json": { "name": "call_id" } }, "isHttpMetadata": false }, { "$id": "7608", "kind": "property", "name": "arguments", "serializedName": "arguments", "doc": "The final arguments as a JSON string.", "type": { "$id": "7609", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventResponseFunctionCallArgumentsDone.arguments", "serializationOptions": { "json": { "name": "arguments" } }, "isHttpMetadata": false } ] }, "rate_limits.updated": { "$id": "7610", "kind": "model", "name": "RealtimeServerEventRateLimitsUpdated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdated", "usage": "Output,Json", "doc": "Emitted at the beginning of a Response to indicate the updated rate limits.\nWhen a Response is created some tokens will be \"reserved\" for the output\ntokens, the rate limits shown here reflect that reservation, which is then\nadjusted accordingly once the Response is completed.", "discriminatorValue": "rate_limits.updated", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7611", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `rate_limits.updated`.", "type": { "$id": "7612", "kind": "enumvalue", "name": "rate_limits_updated", "value": "rate_limits.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7613", "kind": "property", "name": "rate_limits", "serializedName": "rate_limits", "doc": "List of rate limit information.", "type": { "$id": "7614", "kind": "array", "name": "ArrayRealtimeServerEventRateLimitsUpdatedRateLimitsItem", "valueType": { "$id": "7615", "kind": "model", "name": "RealtimeServerEventRateLimitsUpdatedRateLimitsItem", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdatedRateLimitsItem", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7616", "kind": "property", "name": "name", "serializedName": "name", "doc": "The rate limit property name that this item includes information about.", "type": { "$id": "7617", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdatedRateLimitsItem.name", "serializationOptions": { "json": { "name": "name" } }, "isHttpMetadata": false }, { "$id": "7618", "kind": "property", "name": "limit", "serializedName": "limit", "doc": "The maximum configured limit for this rate limit property.", "type": { "$id": "7619", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdatedRateLimitsItem.limit", "serializationOptions": { "json": { "name": "limit" } }, "isHttpMetadata": false }, { "$id": "7620", "kind": "property", "name": "remaining", "serializedName": "remaining", "doc": "The remaining quota available against the configured limit for this rate limit property.", "type": { "$id": "7621", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdatedRateLimitsItem.remaining", "serializationOptions": { "json": { "name": "remaining" } }, "isHttpMetadata": false }, { "$id": "7622", "kind": "property", "name": "reset_seconds", "serializedName": "reset_seconds", "doc": "The remaining time, in seconds, until this rate limit property is reset.", "type": { "$id": "7623", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "7624", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdatedRateLimitsItem.reset_seconds", "serializationOptions": { "json": { "name": "reset_seconds" } }, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventRateLimitsUpdated.rate_limits", "serializationOptions": { "json": { "name": "rate_limits" } }, "isHttpMetadata": false } ] }, "conversation.item.input_audio_transcription.delta": { "$id": "7625", "kind": "model", "name": "RealtimeServerEventConversationItemInputAudioTranscriptionDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta", "usage": "Output,Json", "doc": "Returned when the text value of an input audio transcription content part is updated.", "discriminatorValue": "conversation.item.input_audio_transcription.delta", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7626", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.input_audio_transcription.delta`.", "type": { "$id": "7627", "kind": "enumvalue", "name": "conversation_item_input_audio_transcription_delta", "value": "conversation.item.input_audio_transcription.delta", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7628", "kind": "property", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item.", "type": { "$id": "7629", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta.item_id", "serializationOptions": { "json": { "name": "item_id" } }, "isHttpMetadata": false }, { "$id": "7630", "kind": "property", "name": "content_index", "serializedName": "content_index", "doc": "The index of the content part in the item's content array.", "type": { "$id": "7631", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta.content_index", "serializationOptions": { "json": { "name": "content_index" } }, "isHttpMetadata": false }, { "$id": "7632", "kind": "property", "name": "delta", "serializedName": "delta", "doc": "The text delta.", "type": { "$id": "7633", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta.delta", "serializationOptions": { "json": { "name": "delta" } }, "isHttpMetadata": false }, { "$id": "7634", "kind": "property", "name": "logprobs", "serializedName": "logprobs", "doc": "The log probabilities of the transcription.", "type": { "$id": "7635", "kind": "nullable", "type": { "$ref": "7371" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemInputAudioTranscriptionDelta.logprobs", "serializationOptions": { "json": { "name": "logprobs" } }, "isHttpMetadata": false } ] }, "conversation.item.retrieved": { "$id": "7636", "kind": "model", "name": "RealtimeServerEventConversationItemRetrieved", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemRetrieved", "usage": "Output,Json", "doc": "Returned when a conversation item is retrieved with `conversation.item.retrieve`.", "discriminatorValue": "conversation.item.retrieved", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7637", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `conversation.item.retrieved`.", "type": { "$id": "7638", "kind": "enumvalue", "name": "conversation_item_retrieved", "value": "conversation.item.retrieved", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemRetrieved.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7639", "kind": "property", "name": "item", "serializedName": "item", "type": { "$ref": "7333" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventConversationItemRetrieved.item", "serializationOptions": { "json": { "name": "item" } }, "isHttpMetadata": false } ] }, "transcription_session.updated": { "$id": "7640", "kind": "model", "name": "RealtimeServerEventTranscriptionSessionUpdated", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventTranscriptionSessionUpdated", "usage": "Output,Json", "doc": "Returned when a transcription session is updated with a `transcription_session.update` event, unless\nthere is an error.", "discriminatorValue": "transcription_session.updated", "decorators": [], "baseModel": { "$ref": "7189" }, "properties": [ { "$id": "7641", "kind": "property", "name": "type", "serializedName": "type", "doc": "The event type, must be `transcription_session.updated`.", "type": { "$id": "7642", "kind": "enumvalue", "name": "transcription_session_updated", "value": "transcription_session.updated", "valueType": { "$ref": "1148" }, "enumType": { "$ref": "7196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventTranscriptionSessionUpdated.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7643", "kind": "property", "name": "session", "serializedName": "session", "type": { "$id": "7644", "kind": "model", "name": "RealtimeTranscriptionSessionCreateResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse", "usage": "Output,Json", "doc": "A new Realtime transcription session configuration.\n\nWhen a session is created on the server via REST API, the session object\nalso contains an ephemeral key. Default TTL for keys is 10 minutes. This\nproperty is not present when a session is updated via the WebSocket API.", "decorators": [], "properties": [ { "$id": "7645", "kind": "property", "name": "client_secret", "serializedName": "client_secret", "doc": "Ephemeral key returned by the API. Only present when the session is\ncreated on the server via REST API.", "type": { "$id": "7646", "kind": "model", "name": "RealtimeTranscriptionSessionCreateResponseClientSecret", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.client_secret.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7647", "kind": "property", "name": "value", "serializedName": "value", "doc": "Ephemeral key usable in client environments to authenticate connections\nto the Realtime API. Use this in client-side environments rather than\na standard API token, which should only be used server-side.", "type": { "$id": "7648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.client_secret.anonymous.value", "serializationOptions": { "json": { "name": "value" } }, "isHttpMetadata": false }, { "$id": "7649", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.", "type": { "$id": "7650", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "7651", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.client_secret.anonymous.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.client_secret", "serializationOptions": { "json": { "name": "client_secret" } }, "isHttpMetadata": false }, { "$id": "7652", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].", "type": { "$id": "7653", "kind": "array", "name": "Array45", "valueType": { "$ref": "1214" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7654", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "doc": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.", "type": { "$id": "7655", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "7656", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "doc": "Configuration of the transcription model.", "type": { "$id": "7657", "kind": "model", "name": "RealtimeTranscriptionSessionCreateResponseInputAudioTranscription", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7658", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for transcription. Can be `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, or `whisper-1`.", "type": { "$ref": "1218" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription.anonymous.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "7659", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.", "type": { "$id": "7660", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription.anonymous.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "7661", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "An optional text to guide the model's style or continue a previous audio\nsegment. The [prompt](/docs/guides/speech-to-text#prompting) should match\nthe audio language.", "type": { "$id": "7662", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription.anonymous.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "7663", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "doc": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.", "type": { "$id": "7664", "kind": "model", "name": "RealtimeTranscriptionSessionCreateResponseTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7665", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of turn detection, only `server_vad` is currently supported.", "type": { "$id": "7666", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7667", "kind": "property", "name": "threshold", "serializedName": "threshold", "doc": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.", "type": { "$id": "7668", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection.anonymous.threshold", "serializationOptions": { "json": { "name": "threshold" } }, "isHttpMetadata": false }, { "$id": "7669", "kind": "property", "name": "prefix_padding_ms", "serializedName": "prefix_padding_ms", "doc": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.", "type": { "$id": "7670", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection.anonymous.prefix_padding_ms", "serializationOptions": { "json": { "name": "prefix_padding_ms" } }, "isHttpMetadata": false }, { "$id": "7671", "kind": "property", "name": "silence_duration_ms", "serializedName": "silence_duration_ms", "doc": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.", "type": { "$id": "7672", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection.anonymous.silence_duration_ms", "serializationOptions": { "json": { "name": "silence_duration_ms" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeTranscriptionSessionCreateResponse.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeServerEventTranscriptionSessionUpdated.session", "serializationOptions": { "json": { "name": "session" } }, "isHttpMetadata": false } ] } } }, { "$ref": "7193" }, { "$ref": "7233" }, { "$ref": "7247" }, { "$ref": "7251" }, { "$ref": "7275" }, { "$ref": "7279" }, { "$ref": "7283" }, { "$ref": "7288" }, { "$ref": "7295" }, { "$ref": "7298" }, { "$ref": "7305" }, { "$ref": "7312" }, { "$ref": "7317" }, { "$ref": "7322" }, { "$ref": "7327" }, { "$ref": "7333" }, { "$ref": "7339" }, { "$ref": "7345" }, { "$ref": "7354" }, { "$ref": "7360" }, { "$ref": "7372" }, { "$ref": "7378" }, { "$ref": "7386" }, { "$ref": "7395" }, { "$ref": "7404" }, { "$ref": "7409" }, { "$ref": "7413" }, { "$ref": "7419" }, { "$ref": "7423" }, { "$ref": "7432" }, { "$ref": "7440" }, { "$ref": "7448" }, { "$ref": "7464" }, { "$ref": "7468" }, { "$ref": "7476" }, { "$ref": "7484" }, { "$ref": "7496" }, { "$ref": "7508" }, { "$ref": "7521" }, { "$ref": "7534" }, { "$ref": "7547" }, { "$ref": "7560" }, { "$ref": "7573" }, { "$ref": "7584" }, { "$ref": "7597" }, { "$ref": "7610" }, { "$ref": "7615" }, { "$ref": "7625" }, { "$ref": "7636" }, { "$ref": "7640" }, { "$ref": "7644" }, { "$ref": "7646" }, { "$ref": "7657" }, { "$ref": "7664" }, { "$id": "7673", "kind": "model", "name": "RealtimeSessionCreateRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest", "usage": "Input,Json", "doc": "Realtime session object configuration.", "decorators": [], "properties": [ { "$id": "7674", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].", "type": { "$ref": "6916" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7675", "kind": "property", "name": "model", "serializedName": "model", "doc": "The Realtime model used for this session.", "type": { "$ref": "1223" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "7676", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.", "type": { "$id": "7677", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "7678", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`,\n`onyx`, `nova`, `sage`, `shimmer`, and `verse`.", "type": { "$ref": "68" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "7679", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "doc": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate,\nsingle channel (mono), and little-endian byte order.", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "7680", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "doc": "The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, output audio is sampled at a rate of 24kHz.", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "7681", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "doc": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.", "type": { "$id": "7682", "kind": "model", "name": "RealtimeSessionCreateRequestInputAudioTranscription", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_transcription.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7683", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for transcription, current options are `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `whisper-1`.", "type": { "$id": "7684", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_transcription.anonymous.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false }, { "$id": "7685", "kind": "property", "name": "language", "serializedName": "language", "doc": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.", "type": { "$id": "7686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_transcription.anonymous.language", "serializationOptions": { "json": { "name": "language" } }, "isHttpMetadata": false }, { "$id": "7687", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models, the prompt is a free text string, for example \"expect words related to technology\".", "type": { "$id": "7688", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_transcription.anonymous.prompt", "serializationOptions": { "json": { "name": "prompt" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "7689", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "doc": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\nSemantic VAD is more advanced and uses a turn detection model (in conjuction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.", "type": { "$id": "7690", "kind": "model", "name": "RealtimeSessionCreateRequestTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7691", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of turn detection.", "type": { "$ref": "1231" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7692", "kind": "property", "name": "eagerness", "serializedName": "eagerness", "doc": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`.", "type": { "$ref": "1235" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.eagerness", "serializationOptions": { "json": { "name": "eagerness" } }, "isHttpMetadata": false }, { "$id": "7693", "kind": "property", "name": "threshold", "serializedName": "threshold", "doc": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.", "type": { "$id": "7694", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.threshold", "serializationOptions": { "json": { "name": "threshold" } }, "isHttpMetadata": false }, { "$id": "7695", "kind": "property", "name": "prefix_padding_ms", "serializedName": "prefix_padding_ms", "doc": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.", "type": { "$id": "7696", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.prefix_padding_ms", "serializationOptions": { "json": { "name": "prefix_padding_ms" } }, "isHttpMetadata": false }, { "$id": "7697", "kind": "property", "name": "silence_duration_ms", "serializedName": "silence_duration_ms", "doc": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.", "type": { "$id": "7698", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.silence_duration_ms", "serializationOptions": { "json": { "name": "silence_duration_ms" } }, "isHttpMetadata": false }, { "$id": "7699", "kind": "property", "name": "create_response", "serializedName": "create_response", "doc": "Whether or not to automatically generate a response when a VAD stop event occurs.", "type": { "$id": "7700", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.create_response", "serializationOptions": { "json": { "name": "create_response" } }, "isHttpMetadata": false }, { "$id": "7701", "kind": "property", "name": "interrupt_response", "serializedName": "interrupt_response", "doc": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.", "type": { "$id": "7702", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection.anonymous.interrupt_response", "serializationOptions": { "json": { "name": "interrupt_response" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false }, { "$id": "7703", "kind": "property", "name": "input_audio_noise_reduction", "serializedName": "input_audio_noise_reduction", "doc": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.", "type": { "$id": "7704", "kind": "nullable", "type": { "$id": "7705", "kind": "model", "name": "RealtimeSessionCreateRequestInputAudioNoiseReduction1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_noise_reduction.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7706", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.", "type": { "$ref": "1241" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_noise_reduction.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.input_audio_noise_reduction", "serializationOptions": { "json": { "name": "input_audio_noise_reduction" } }, "isHttpMetadata": false }, { "$id": "7707", "kind": "property", "name": "speed", "serializedName": "speed", "doc": "The speed of the model's spoken response. 1.0 is the default speed. 0.25 is\nthe minimum speed. 1.5 is the maximum speed. This value can only be changed\nin between model turns, not while a response is in progress.", "type": { "$id": "7708", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.speed", "serializationOptions": { "json": { "name": "speed" } }, "isHttpMetadata": false }, { "$id": "7709", "kind": "property", "name": "tracing", "serializedName": "tracing", "doc": "Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.", "type": { "$id": "7710", "kind": "union", "name": "RealtimeSessionCreateRequestTracing", "variantTypes": [ { "$ref": "1681" }, { "$id": "7711", "kind": "model", "name": "RealtimeSessionCreateRequestTracing1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tracing.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7712", "kind": "property", "name": "workflow_name", "serializedName": "workflow_name", "doc": "The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.", "type": { "$id": "7713", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tracing.anonymous.workflow_name", "serializationOptions": { "json": { "name": "workflow_name" } }, "isHttpMetadata": false }, { "$id": "7714", "kind": "property", "name": "group_id", "serializedName": "group_id", "doc": "The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.", "type": { "$id": "7715", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tracing.anonymous.group_id", "serializationOptions": { "json": { "name": "group_id" } }, "isHttpMetadata": false }, { "$id": "7716", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.", "type": { "$id": "7717", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tracing.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tracing", "serializationOptions": { "json": { "name": "tracing" } }, "isHttpMetadata": false }, { "$id": "7718", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "Tools (functions) available to the model.", "type": { "$ref": "6972" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "7719", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "doc": "How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.", "type": { "$id": "7720", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "7721", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Sampling temperature for the model, limited to [0.6, 1.2]. For audio models a temperature of 0.8 is highly recommended for best performance.", "type": { "$id": "7722", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "7723", "kind": "property", "name": "max_response_output_tokens", "serializedName": "max_response_output_tokens", "doc": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.", "type": { "$id": "7724", "kind": "union", "name": "RealtimeSessionCreateRequestMaxResponseOutputTokens", "variantTypes": [ { "$id": "7725", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1683" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.max_response_output_tokens", "serializationOptions": { "json": { "name": "max_response_output_tokens" } }, "isHttpMetadata": false }, { "$id": "7726", "kind": "property", "name": "client_secret", "serializedName": "client_secret", "doc": "Configuration options for the generated client secret.", "type": { "$id": "7727", "kind": "model", "name": "RealtimeSessionCreateRequestClientSecret", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7728", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "Configuration for the ephemeral token expiration.", "type": { "$id": "7729", "kind": "model", "name": "RealtimeSessionCreateRequestClientSecretExpiresAt", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret.expires_at.anonymous", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7730", "kind": "property", "name": "anchor", "serializedName": "anchor", "doc": "The anchor point for the ephemeral token expiration. Only `created_at` is currently supported.", "type": { "$ref": "1245" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret.expires_at.anonymous.anchor", "serializationOptions": { "json": { "name": "anchor" } }, "isHttpMetadata": false }, { "$id": "7731", "kind": "property", "name": "seconds", "serializedName": "seconds", "doc": "The number of seconds from the anchor point to the expiration. Select a value between `10` and `7200`.", "type": { "$id": "7732", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret.expires_at.anonymous.seconds", "serializationOptions": { "json": { "name": "seconds" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret.anonymous.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateRequest.client_secret", "serializationOptions": { "json": { "name": "client_secret" } }, "isHttpMetadata": false } ] }, { "$ref": "7682" }, { "$ref": "7690" }, { "$ref": "7705" }, { "$ref": "7711" }, { "$ref": "7727" }, { "$ref": "7729" }, { "$id": "7733", "kind": "model", "name": "RealtimeSessionCreateResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse", "usage": "Output,Json", "doc": "A new Realtime session configuration, with an ephermeral key. Default TTL\nfor keys is one minute.", "decorators": [], "properties": [ { "$id": "7734", "kind": "property", "name": "client_secret", "serializedName": "client_secret", "doc": "Ephemeral key returned by the API.", "type": { "$id": "7735", "kind": "model", "name": "RealtimeSessionCreateResponseClientSecret", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.client_secret.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7736", "kind": "property", "name": "value", "serializedName": "value", "doc": "Ephemeral key usable in client environments to authenticate connections\nto the Realtime API. Use this in client-side environments rather than\na standard API token, which should only be used server-side.", "type": { "$id": "7737", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.client_secret.anonymous.value", "serializationOptions": { "json": { "name": "value" } }, "isHttpMetadata": false }, { "$id": "7738", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.", "type": { "$id": "7739", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "7740", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.client_secret.anonymous.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.client_secret", "serializationOptions": { "json": { "name": "client_secret" } }, "isHttpMetadata": false }, { "$id": "7741", "kind": "property", "name": "modalities", "serializedName": "modalities", "doc": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].", "type": { "$ref": "6916" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.modalities", "serializationOptions": { "json": { "name": "modalities" } }, "isHttpMetadata": false }, { "$id": "7742", "kind": "property", "name": "instructions", "serializedName": "instructions", "doc": "The default system instructions (i.e. system message) prepended to model\ncalls. This field allows the client to guide the model on desired\nresponses. The model can be instructed on response content and format,\n(e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good\nresponses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion\ninto your voice\", \"laugh frequently\"). The instructions are not guaranteed\nto be followed by the model, but they provide guidance to the model on the\ndesired behavior.\n\nNote that the server sets default instructions which will be used if this\nfield is not set and are visible in the `session.created` event at the\nstart of the session.", "type": { "$id": "7743", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.instructions", "serializationOptions": { "json": { "name": "instructions" } }, "isHttpMetadata": false }, { "$id": "7744", "kind": "property", "name": "voice", "serializedName": "voice", "doc": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo` `sage`,\n`shimmer` and `verse`.", "type": { "$ref": "68" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.voice", "serializationOptions": { "json": { "name": "voice" } }, "isHttpMetadata": false }, { "$id": "7745", "kind": "property", "name": "input_audio_format", "serializedName": "input_audio_format", "doc": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.input_audio_format", "serializationOptions": { "json": { "name": "input_audio_format" } }, "isHttpMetadata": false }, { "$id": "7746", "kind": "property", "name": "output_audio_format", "serializedName": "output_audio_format", "doc": "The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.", "type": { "$ref": "1060" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.output_audio_format", "serializationOptions": { "json": { "name": "output_audio_format" } }, "isHttpMetadata": false }, { "$id": "7747", "kind": "property", "name": "input_audio_transcription", "serializedName": "input_audio_transcription", "doc": "Configuration for input audio transcription, defaults to off and can be\nset to `null` to turn off once on. Input audio transcription is not native\nto the model, since the model consumes audio directly. Transcription runs\nasynchronously through Whisper and should be treated as rough guidance\nrather than the representation understood by the model.", "type": { "$id": "7748", "kind": "model", "name": "RealtimeSessionCreateResponseInputAudioTranscription", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.input_audio_transcription.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7749", "kind": "property", "name": "model", "serializedName": "model", "doc": "The model to use for transcription, `whisper-1` is the only currently\nsupported model.", "type": { "$id": "7750", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.input_audio_transcription.anonymous.model", "serializationOptions": { "json": { "name": "model" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.input_audio_transcription", "serializationOptions": { "json": { "name": "input_audio_transcription" } }, "isHttpMetadata": false }, { "$id": "7751", "kind": "property", "name": "speed", "serializedName": "speed", "doc": "The speed of the model's spoken response. 1.0 is the default speed. 0.25 is\nthe minimum speed. 1.5 is the maximum speed. This value can only be changed\nin between model turns, not while a response is in progress.", "type": { "$id": "7752", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.speed", "serializationOptions": { "json": { "name": "speed" } }, "isHttpMetadata": false }, { "$id": "7753", "kind": "property", "name": "tracing", "serializedName": "tracing", "doc": "Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.", "type": { "$id": "7754", "kind": "union", "name": "RealtimeSessionCreateResponseTracing", "variantTypes": [ { "$ref": "1685" }, { "$id": "7755", "kind": "model", "name": "RealtimeSessionCreateResponseTracing1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tracing.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7756", "kind": "property", "name": "workflow_name", "serializedName": "workflow_name", "doc": "The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.", "type": { "$id": "7757", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tracing.anonymous.workflow_name", "serializationOptions": { "json": { "name": "workflow_name" } }, "isHttpMetadata": false }, { "$id": "7758", "kind": "property", "name": "group_id", "serializedName": "group_id", "doc": "The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.", "type": { "$id": "7759", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tracing.anonymous.group_id", "serializationOptions": { "json": { "name": "group_id" } }, "isHttpMetadata": false }, { "$id": "7760", "kind": "property", "name": "metadata", "serializedName": "metadata", "doc": "The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.", "type": { "$id": "7761", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tracing.anonymous.metadata", "serializationOptions": { "json": { "name": "metadata" } }, "isHttpMetadata": false } ] } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tracing", "serializationOptions": { "json": { "name": "tracing" } }, "isHttpMetadata": false }, { "$id": "7762", "kind": "property", "name": "turn_detection", "serializedName": "turn_detection", "doc": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.", "type": { "$id": "7763", "kind": "model", "name": "RealtimeSessionCreateResponseTurnDetection", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection.anonymous", "usage": "Output,Json", "decorators": [], "properties": [ { "$id": "7764", "kind": "property", "name": "type", "serializedName": "type", "doc": "Type of turn detection, only `server_vad` is currently supported.", "type": { "$id": "7765", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection.anonymous.type", "serializationOptions": { "json": { "name": "type" } }, "isHttpMetadata": false }, { "$id": "7766", "kind": "property", "name": "threshold", "serializedName": "threshold", "doc": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.", "type": { "$id": "7767", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection.anonymous.threshold", "serializationOptions": { "json": { "name": "threshold" } }, "isHttpMetadata": false }, { "$id": "7768", "kind": "property", "name": "prefix_padding_ms", "serializedName": "prefix_padding_ms", "doc": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.", "type": { "$id": "7769", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection.anonymous.prefix_padding_ms", "serializationOptions": { "json": { "name": "prefix_padding_ms" } }, "isHttpMetadata": false }, { "$id": "7770", "kind": "property", "name": "silence_duration_ms", "serializedName": "silence_duration_ms", "doc": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.", "type": { "$id": "7771", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection.anonymous.silence_duration_ms", "serializationOptions": { "json": { "name": "silence_duration_ms" } }, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.turn_detection", "serializationOptions": { "json": { "name": "turn_detection" } }, "isHttpMetadata": false }, { "$id": "7772", "kind": "property", "name": "tools", "serializedName": "tools", "doc": "Tools (functions) available to the model.", "type": { "$ref": "6972" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tools", "serializationOptions": { "json": { "name": "tools" } }, "isHttpMetadata": false }, { "$id": "7773", "kind": "property", "name": "tool_choice", "serializedName": "tool_choice", "doc": "How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.", "type": { "$id": "7774", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.tool_choice", "serializationOptions": { "json": { "name": "tool_choice" } }, "isHttpMetadata": false }, { "$id": "7775", "kind": "property", "name": "temperature", "serializedName": "temperature", "doc": "Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.", "type": { "$id": "7776", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.temperature", "serializationOptions": { "json": { "name": "temperature" } }, "isHttpMetadata": false }, { "$id": "7777", "kind": "property", "name": "max_response_output_tokens", "serializedName": "max_response_output_tokens", "doc": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.", "type": { "$id": "7778", "kind": "union", "name": "RealtimeSessionCreateResponseMaxResponseOutputTokens", "variantTypes": [ { "$id": "7779", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, { "$ref": "1687" } ], "namespace": "OpenAI", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RealtimeSessionCreateResponse.max_response_output_tokens", "serializationOptions": { "json": { "name": "max_response_output_tokens" } }, "isHttpMetadata": false } ] }, { "$ref": "7735" }, { "$ref": "7748" }, { "$ref": "7755" }, { "$ref": "7763" }, { "$id": "7780", "kind": "model", "name": "CreateUploadRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7781", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file to upload.", "type": { "$id": "7782", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "7783", "kind": "property", "name": "purpose", "serializedName": "purpose", "doc": "The intended purpose of the uploaded file.\n\nSee the [documentation on File purposes](/docs/api-reference/files/create#files-create-purpose).", "type": { "$ref": "1249" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest.purpose", "serializationOptions": { "json": { "name": "purpose" } }, "isHttpMetadata": false }, { "$id": "7784", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "The number of bytes in the file you are uploading.", "type": { "$id": "7785", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "7786", "kind": "property", "name": "mime_type", "serializedName": "mime_type", "doc": "The MIME type of the file.\n\nThis must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.", "type": { "$id": "7787", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateUploadRequest.mime_type", "serializationOptions": { "json": { "name": "mime_type" } }, "isHttpMetadata": false } ] }, { "$id": "7788", "kind": "model", "name": "Upload", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Upload", "usage": "Output,Json", "doc": "The Upload object can accept byte chunks in the form of Parts.", "decorators": [], "properties": [ { "$id": "7789", "kind": "property", "name": "id", "serializedName": "id", "doc": "The Upload unique identifier, which can be referenced in API endpoints.", "type": { "$id": "7790", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "7791", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the Upload was created.", "type": { "$id": "7792", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "7793", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "7794", "kind": "property", "name": "filename", "serializedName": "filename", "doc": "The name of the file to be uploaded.", "type": { "$id": "7795", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.filename", "serializationOptions": { "json": { "name": "filename" } }, "isHttpMetadata": false }, { "$id": "7796", "kind": "property", "name": "bytes", "serializedName": "bytes", "doc": "The intended number of bytes to be uploaded.", "type": { "$id": "7797", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.bytes", "serializationOptions": { "json": { "name": "bytes" } }, "isHttpMetadata": false }, { "$id": "7798", "kind": "property", "name": "purpose", "serializedName": "purpose", "doc": "The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values.", "type": { "$id": "7799", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.purpose", "serializationOptions": { "json": { "name": "purpose" } }, "isHttpMetadata": false }, { "$id": "7800", "kind": "property", "name": "status", "serializedName": "status", "doc": "The status of the Upload.", "type": { "$ref": "1255" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.status", "serializationOptions": { "json": { "name": "status" } }, "isHttpMetadata": false }, { "$id": "7801", "kind": "property", "name": "expires_at", "serializedName": "expires_at", "doc": "The Unix timestamp (in seconds) for when the Upload will expire.", "type": { "$id": "7802", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "7803", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.expires_at", "serializationOptions": { "json": { "name": "expires_at" } }, "isHttpMetadata": false }, { "$id": "7804", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always \"upload\".", "type": { "$ref": "1261" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false }, { "$id": "7805", "kind": "property", "name": "file", "serializedName": "file", "type": { "$id": "7806", "kind": "nullable", "type": { "$ref": "3383" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Upload.file", "serializationOptions": { "json": { "name": "file" } }, "isHttpMetadata": false } ] }, { "$id": "7807", "kind": "model", "name": "AddUploadPartRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AddUploadPartRequest", "usage": "Input,MultipartFormData", "decorators": [], "properties": [ { "$id": "7808", "kind": "property", "name": "data", "serializedName": "data", "doc": "The chunk of bytes for this Part.", "type": { "$id": "7809", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AddUploadPartRequest.data", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "data", "headers": [] } }, "isHttpMetadata": false } ] }, { "$id": "7810", "kind": "model", "name": "UploadPart", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.UploadPart", "usage": "Output,Json", "doc": "The upload Part represents a chunk of bytes we can add to an Upload object.", "decorators": [], "properties": [ { "$id": "7811", "kind": "property", "name": "id", "serializedName": "id", "doc": "The upload Part unique identifier, which can be referenced in API endpoints.", "type": { "$id": "7812", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UploadPart.id", "serializationOptions": { "json": { "name": "id" } }, "isHttpMetadata": false }, { "$id": "7813", "kind": "property", "name": "created_at", "serializedName": "created_at", "doc": "The Unix timestamp (in seconds) for when the Part was created.", "type": { "$id": "7814", "kind": "utcDateTime", "name": "utcDateTime", "encode": "unixTimestamp", "wireType": { "$id": "7815", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.utcDateTime", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UploadPart.created_at", "serializationOptions": { "json": { "name": "created_at" } }, "isHttpMetadata": false }, { "$id": "7816", "kind": "property", "name": "upload_id", "serializedName": "upload_id", "doc": "The ID of the Upload object that this Part was added to.", "type": { "$id": "7817", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UploadPart.upload_id", "serializationOptions": { "json": { "name": "upload_id" } }, "isHttpMetadata": false }, { "$id": "7818", "kind": "property", "name": "object", "serializedName": "object", "doc": "The object type, which is always `upload.part`.", "type": { "$ref": "1689" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UploadPart.object", "serializationOptions": { "json": { "name": "object" } }, "isHttpMetadata": false } ] }, { "$id": "7819", "kind": "model", "name": "CompleteUploadRequest", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CompleteUploadRequest", "usage": "Input,Json", "decorators": [], "properties": [ { "$id": "7820", "kind": "property", "name": "part_ids", "serializedName": "part_ids", "doc": "The ordered list of Part IDs.", "type": { "$ref": "2373" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompleteUploadRequest.part_ids", "serializationOptions": { "json": { "name": "part_ids" } }, "isHttpMetadata": false }, { "$id": "7821", "kind": "property", "name": "md5", "serializedName": "md5", "doc": "The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.", "type": { "$id": "7822", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CompleteUploadRequest.md5", "serializationOptions": { "json": { "name": "md5" } }, "isHttpMetadata": false } ] }, { "$id": "7823", "kind": "model", "name": "BatchRequestInput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.BatchRequestInput", "access": "public", "usage": "Input", "doc": "The per-line object of the batch input file", "decorators": [], "properties": [ { "$id": "7824", "kind": "property", "name": "custom_id", "doc": "A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.", "type": { "$id": "7825", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestInput.custom_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7826", "kind": "property", "name": "method", "doc": "The HTTP method to be used for the request. Currently only `POST` is supported.", "type": { "$ref": "1265" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestInput.method", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7827", "kind": "property", "name": "url", "doc": "The OpenAI API relative URL to be used for the request. Currently `/v1/chat/completions`, `/v1/embeddings`, and `/v1/completions` are supported.", "type": { "$id": "7828", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestInput.url", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "7829", "kind": "model", "name": "BatchRequestOutput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput", "access": "public", "usage": "Output", "doc": "The per-line object of the batch output and error files", "decorators": [], "properties": [ { "$id": "7830", "kind": "property", "name": "id", "type": { "$id": "7831", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7832", "kind": "property", "name": "custom_id", "doc": "A developer-provided per-request id that will be used to match outputs to inputs.", "type": { "$id": "7833", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.custom_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7834", "kind": "property", "name": "response", "type": { "$id": "7835", "kind": "nullable", "type": { "$id": "7836", "kind": "model", "name": "BatchRequestOutputResponse1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.response.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7837", "kind": "property", "name": "status_code", "doc": "The HTTP status code of the response", "type": { "$id": "7838", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.response.anonymous.status_code", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7839", "kind": "property", "name": "request_id", "doc": "An unique identifier for the OpenAI API request. Please include this request ID when contacting support.", "type": { "$id": "7840", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.response.anonymous.request_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7841", "kind": "property", "name": "body", "doc": "The JSON body of the response", "type": { "$ref": "3883" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.response.anonymous.body", "serializationOptions": {}, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.response", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7842", "kind": "property", "name": "error", "doc": "For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure.", "type": { "$id": "7843", "kind": "nullable", "type": { "$id": "7844", "kind": "model", "name": "BatchRequestOutputError1", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.error.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7845", "kind": "property", "name": "code", "doc": "A machine-readable error code.", "type": { "$id": "7846", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.error.anonymous.code", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7847", "kind": "property", "name": "message", "doc": "A human-readable error message.", "type": { "$id": "7848", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.error.anonymous.message", "serializationOptions": {}, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchRequestOutput.error", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$ref": "7836" }, { "$ref": "7844" }, { "$id": "7849", "kind": "model", "name": "ChatCompletionFunctionChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionFunctionChoice", "access": "public", "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [] }, { "$id": "7850", "kind": "model", "name": "ChatCompletionToolChoice", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionToolChoice", "access": "public", "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [] }, { "$id": "7851", "kind": "model", "name": "FineTuneChatCompletionRequestAssistantMessage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage", "usage": "Input", "decorators": [], "properties": [ { "$id": "7852", "kind": "property", "name": "weight", "doc": "Controls whether the assistant message is trained against (0 or 1)", "type": { "$ref": "1269" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.weight", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7853", "kind": "property", "name": "content", "doc": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.", "type": { "$ref": "3011" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.content", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7854", "kind": "property", "name": "refusal", "doc": "The refusal message by the assistant.", "type": { "$ref": "3017" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.refusal", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7855", "kind": "property", "name": "role", "doc": "The role of the messages author, in this case `assistant`.", "type": { "$id": "7856", "kind": "enumvalue", "name": "assistant", "value": "assistant", "valueType": { "$ref": "154" }, "enumType": { "$ref": "2820" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.role", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7857", "kind": "property", "name": "name", "doc": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.", "type": { "$id": "7858", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7859", "kind": "property", "name": "audio", "doc": "Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).", "type": { "$ref": "3024" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.audio", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7860", "kind": "property", "name": "tool_calls", "type": { "$ref": "2789" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.tool_calls", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7861", "kind": "property", "name": "function_call", "doc": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "type": { "$ref": "3030" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatCompletionRequestAssistantMessage.function_call", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "7862", "kind": "model", "name": "FineTuneChatRequestInput", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuneChatRequestInput", "access": "public", "usage": "Input", "doc": "The per-line training example of a fine-tuning input file for chat models using the supervised method.", "decorators": [], "properties": [ { "$id": "7863", "kind": "property", "name": "messages", "type": { "$id": "7864", "kind": "array", "name": "Array46", "valueType": { "$id": "7865", "kind": "union", "name": "FineTuneChatRequestInputMessage", "variantTypes": [ { "$ref": "2980" }, { "$ref": "2999" }, { "$ref": "7851" }, { "$ref": "3036" }, { "$ref": "3046" } ], "namespace": "OpenAI", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatRequestInput.messages", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7866", "kind": "property", "name": "tools", "doc": "A list of tools the model may generate JSON inputs for.", "type": { "$ref": "3138" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatRequestInput.tools", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7867", "kind": "property", "name": "parallel_tool_calls", "type": { "$id": "7868", "kind": "boolean", "name": "ParallelToolCalls", "crossLanguageDefinitionId": "OpenAI.ParallelToolCalls", "baseType": { "$id": "7869", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatRequestInput.parallel_tool_calls", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7870", "kind": "property", "name": "functions", "doc": "A list of functions the model may generate JSON inputs for.", "type": { "$ref": "3163" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuneChatRequestInput.functions", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "7871", "kind": "model", "name": "FineTuningJobsPageToken", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.FineTuningJobsPageToken", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "7872", "kind": "property", "name": "limit", "type": { "$id": "7873", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobsPageToken.limit", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7874", "kind": "property", "name": "after", "type": { "$id": "7875", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuningJobsPageToken.after", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "7876", "kind": "model", "name": "MessageDeltaContent", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContent", "access": "public", "usage": "Output", "doc": "Represents a single piece of incremental content in an Assistants API streaming response.", "decorators": [], "discriminatorProperty": { "$id": "7877", "kind": "property", "name": "type", "doc": "The discriminated type identifier for the content item.", "type": { "$ref": "857" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContent.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "7877" } ], "discriminatedSubtypes": { "image_file": { "$id": "7878", "kind": "model", "name": "MessageDeltaContentImageFileObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject", "access": "public", "usage": "Output", "doc": "References an image [File](/docs/api-reference/files) in the content of a message.", "discriminatorValue": "image_file", "decorators": [], "baseModel": { "$ref": "7876" }, "properties": [ { "$id": "7879", "kind": "property", "name": "index", "doc": "The index of the content part in the message.", "type": { "$id": "7880", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7881", "kind": "property", "name": "type", "doc": "Always `image_file`.", "type": { "$ref": "5912" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7882", "kind": "property", "name": "image_file", "type": { "$id": "7883", "kind": "model", "name": "MessageDeltaContentImageFileObjectImageFile", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.image_file.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7884", "kind": "property", "name": "file_id", "doc": "The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content.", "type": { "$id": "7885", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.image_file.anonymous.file_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7886", "kind": "property", "name": "detail", "doc": "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "$ref": "1273" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.image_file.anonymous.detail", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageFileObject.image_file", "serializationOptions": {}, "isHttpMetadata": false } ] }, "image_url": { "$id": "7887", "kind": "model", "name": "MessageDeltaContentImageUrlObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject", "access": "public", "usage": "Output", "doc": "References an image URL in the content of a message.", "discriminatorValue": "image_url", "decorators": [], "baseModel": { "$ref": "7876" }, "properties": [ { "$id": "7888", "kind": "property", "name": "index", "doc": "The index of the content part in the message.", "type": { "$id": "7889", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7890", "kind": "property", "name": "type", "doc": "Always `image_url`.", "type": { "$ref": "5974" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7891", "kind": "property", "name": "image_url", "type": { "$id": "7892", "kind": "model", "name": "MessageDeltaContentImageUrlObjectImageUrl", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.image_url.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7893", "kind": "property", "name": "url", "doc": "The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.", "type": { "$id": "7894", "kind": "url", "name": "url", "crossLanguageDefinitionId": "TypeSpec.url", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.image_url.anonymous.url", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7895", "kind": "property", "name": "detail", "doc": "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`.", "type": { "$ref": "1278" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.image_url.anonymous.detail", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentImageUrlObject.image_url", "serializationOptions": {}, "isHttpMetadata": false } ] }, "text": { "$id": "7896", "kind": "model", "name": "MessageDeltaContentTextObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject", "access": "public", "usage": "Output", "doc": "The text content that is part of a message.", "discriminatorValue": "text", "decorators": [], "baseModel": { "$ref": "7876" }, "properties": [ { "$id": "7897", "kind": "property", "name": "index", "doc": "The index of the content part in the message.", "type": { "$id": "7898", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7899", "kind": "property", "name": "type", "doc": "Always `text`.", "type": { "$ref": "5926" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7900", "kind": "property", "name": "text", "type": { "$id": "7901", "kind": "model", "name": "MessageDeltaContentTextObjectText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.text.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7902", "kind": "property", "name": "value", "doc": "The data that makes up the text.", "type": { "$id": "7903", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.text.anonymous.value", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7904", "kind": "property", "name": "annotations", "type": { "$id": "7905", "kind": "array", "name": "ArrayMessageDeltaTextContentAnnotation", "valueType": { "$id": "7906", "kind": "model", "name": "MessageDeltaTextContentAnnotation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaTextContentAnnotation", "access": "public", "usage": "Output", "decorators": [], "discriminatorProperty": { "$id": "7907", "kind": "property", "name": "type", "doc": "The discriminated type identifier for the content item.", "type": { "$ref": "868" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaTextContentAnnotation.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "7907" } ], "discriminatedSubtypes": { "file_citation": { "$id": "7908", "kind": "model", "name": "MessageDeltaContentTextAnnotationsFileCitationObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject", "access": "public", "usage": "Output", "doc": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.", "discriminatorValue": "file_citation", "decorators": [], "baseModel": { "$ref": "7906" }, "properties": [ { "$id": "7909", "kind": "property", "name": "index", "doc": "The index of the annotation in the text content part.", "type": { "$id": "7910", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7911", "kind": "property", "name": "type", "doc": "Always `file_citation`.", "type": { "$ref": "5939" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7912", "kind": "property", "name": "text", "doc": "The text in the message content that needs to be replaced.", "type": { "$id": "7913", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.text", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7914", "kind": "property", "name": "file_citation", "type": { "$id": "7915", "kind": "model", "name": "MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.file_citation.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7916", "kind": "property", "name": "file_id", "doc": "The ID of the specific File the citation is from.", "type": { "$id": "7917", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.file_citation.anonymous.file_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7918", "kind": "property", "name": "quote", "doc": "The specific quote in the file.", "type": { "$id": "7919", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.file_citation.anonymous.quote", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.file_citation", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7920", "kind": "property", "name": "start_index", "type": { "$id": "7921", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.start_index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7922", "kind": "property", "name": "end_index", "type": { "$id": "7923", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFileCitationObject.end_index", "serializationOptions": {}, "isHttpMetadata": false } ] }, "file_path": { "$id": "7924", "kind": "model", "name": "MessageDeltaContentTextAnnotationsFilePathObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject", "access": "public", "usage": "Output", "doc": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", "discriminatorValue": "file_path", "decorators": [], "baseModel": { "$ref": "7906" }, "properties": [ { "$id": "7925", "kind": "property", "name": "index", "doc": "The index of the annotation in the text content part.", "type": { "$id": "7926", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7927", "kind": "property", "name": "type", "doc": "Always `file_path`.", "type": { "$ref": "5956" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7928", "kind": "property", "name": "text", "doc": "The text in the message content that needs to be replaced.", "type": { "$id": "7929", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.text", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7930", "kind": "property", "name": "file_path", "type": { "$id": "7931", "kind": "model", "name": "MessageDeltaContentTextAnnotationsFilePathObjectFilePath", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.file_path.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7932", "kind": "property", "name": "file_id", "doc": "The ID of the file that was generated.", "type": { "$id": "7933", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.file_path.anonymous.file_id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.file_path", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7934", "kind": "property", "name": "start_index", "type": { "$id": "7935", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.start_index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7936", "kind": "property", "name": "end_index", "type": { "$id": "7937", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextAnnotationsFilePathObject.end_index", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.text.anonymous.annotations", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentTextObject.text", "serializationOptions": {}, "isHttpMetadata": false } ] }, "refusal": { "$id": "7938", "kind": "model", "name": "MessageDeltaContentRefusalObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentRefusalObject", "usage": "Output", "doc": "The refusal content that is part of a message.", "discriminatorValue": "refusal", "decorators": [], "baseModel": { "$ref": "7876" }, "properties": [ { "$id": "7939", "kind": "property", "name": "index", "doc": "The index of the refusal part in the message.", "type": { "$id": "7940", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentRefusalObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7941", "kind": "property", "name": "type", "doc": "Always `refusal`.", "type": { "$ref": "5969" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentRefusalObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7942", "kind": "property", "name": "refusal", "type": { "$id": "7943", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaContentRefusalObject.refusal", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, { "$ref": "7878" }, { "$ref": "7883" }, { "$ref": "7887" }, { "$ref": "7892" }, { "$ref": "7896" }, { "$ref": "7901" }, { "$ref": "7906" }, { "$ref": "7908" }, { "$ref": "7915" }, { "$ref": "7924" }, { "$ref": "7931" }, { "$ref": "7938" }, { "$id": "7944", "kind": "model", "name": "MessageDeltaObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject", "access": "public", "usage": "Output", "doc": "Represents a message delta i.e. any changed fields on a message during streaming.", "decorators": [], "properties": [ { "$id": "7945", "kind": "property", "name": "id", "doc": "The identifier of the message, which can be referenced in API endpoints.", "type": { "$id": "7946", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7947", "kind": "property", "name": "object", "doc": "The object type, which is always `thread.message.delta`.", "type": { "$ref": "1691" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7948", "kind": "property", "name": "delta", "doc": "The delta containing the fields that have changed on the Message.", "type": { "$id": "7949", "kind": "model", "name": "MessageDeltaObjectDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.delta.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7950", "kind": "property", "name": "role", "doc": "The entity that produced the message. One of `user` or `assistant`.", "type": { "$ref": "1283" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.delta.anonymous.role", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7951", "kind": "property", "name": "content", "doc": "The content of the message in array of text and/or images.", "type": { "$id": "7952", "kind": "array", "name": "ArrayMessageDeltaContent", "valueType": { "$ref": "7876" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.delta.anonymous.content", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageDeltaObject.delta", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$ref": "7949" }, { "$id": "7953", "kind": "model", "name": "RunStepDeltaObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject", "access": "public", "usage": "Output", "doc": "Represents a run step delta i.e. any changed fields on a run step during streaming.", "decorators": [], "properties": [ { "$id": "7954", "kind": "property", "name": "id", "doc": "The identifier of the run step, which can be referenced in API endpoints.", "type": { "$id": "7955", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7956", "kind": "property", "name": "object", "doc": "The object type, which is always `thread.run.step.delta`.", "type": { "$ref": "1693" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7957", "kind": "property", "name": "delta", "doc": "The delta containing the fields that have changed on the run step.", "type": { "$id": "7958", "kind": "model", "name": "RunStepDeltaObjectDelta", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject.delta.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7959", "kind": "property", "name": "step_details", "doc": "The details of the run step.", "type": { "$id": "7960", "kind": "model", "name": "RunStepDeltaStepDetails", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetails", "usage": "Output", "decorators": [], "discriminatorProperty": { "$id": "7961", "kind": "property", "name": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "978" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetails.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "7961" } ], "discriminatedSubtypes": { "message_creation": { "$id": "7962", "kind": "model", "name": "RunStepDeltaStepDetailsMessageCreationObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsMessageCreationObject", "access": "public", "usage": "Output", "doc": "Details of the message creation by the run step.", "discriminatorValue": "message_creation", "decorators": [], "baseModel": { "$ref": "7960" }, "properties": [ { "$id": "7963", "kind": "property", "name": "type", "doc": "Always `message_creation`.", "type": { "$ref": "6418" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsMessageCreationObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7964", "kind": "property", "name": "message_creation", "type": { "$id": "7965", "kind": "model", "name": "RunStepDeltaStepDetailsMessageCreationObjectMessageCreation", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsMessageCreationObject.message_creation.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7966", "kind": "property", "name": "message_id", "doc": "The ID of the message that was created by this run step.", "type": { "$id": "7967", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsMessageCreationObject.message_creation.anonymous.message_id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsMessageCreationObject.message_creation", "serializationOptions": {}, "isHttpMetadata": false } ] }, "tool_calls": { "$id": "7968", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsObject", "access": "public", "usage": "Output", "doc": "Details of the tool call.", "discriminatorValue": "tool_calls", "decorators": [], "baseModel": { "$ref": "7960" }, "properties": [ { "$id": "7969", "kind": "property", "name": "type", "doc": "Always `tool_calls`.", "type": { "$ref": "6429" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7970", "kind": "property", "name": "tool_calls", "doc": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.", "type": { "$id": "7971", "kind": "array", "name": "ArrayRunStepDeltaStepDetailsToolCallsObjectToolCallsObject", "valueType": { "$id": "7972", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsObjectToolCallsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsObjectToolCallsObject", "usage": "Output", "doc": "Abstractly represents a run step tool call details inner object.", "decorators": [], "discriminatorProperty": { "$id": "7973", "kind": "property", "name": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "982" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsObjectToolCallsObject.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "7973" } ], "discriminatedSubtypes": { "code_interpreter": { "$id": "7974", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject", "access": "public", "usage": "Output", "doc": "Details of the Code Interpreter tool call the run step was involved in.", "discriminatorValue": "code_interpreter", "decorators": [], "baseModel": { "$ref": "7972" }, "properties": [ { "$id": "7975", "kind": "property", "name": "index", "doc": "The index of the tool call in the tool calls array.", "type": { "$id": "7976", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7977", "kind": "property", "name": "id", "doc": "The ID of the tool call.", "type": { "$id": "7978", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7979", "kind": "property", "name": "type", "doc": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", "type": { "$ref": "6438" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7980", "kind": "property", "name": "code_interpreter", "doc": "The Code Interpreter tool call definition.", "type": { "$id": "7981", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.code_interpreter.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "7982", "kind": "property", "name": "input", "doc": "The input to the Code Interpreter tool call.", "type": { "$id": "7983", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.code_interpreter.anonymous.input", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7984", "kind": "property", "name": "outputs", "doc": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", "type": { "$id": "7985", "kind": "array", "name": "ArrayRunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "valueType": { "$id": "7986", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject", "usage": "Output", "doc": "Abstractly represents a run step tool call details code interpreter output.", "decorators": [], "discriminatorProperty": { "$id": "7987", "kind": "property", "name": "type", "doc": "The discriminated type identifier for the details object.", "type": { "$ref": "987" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "7987" } ], "discriminatedSubtypes": { "logs": { "$id": "7988", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject", "access": "public", "usage": "Output", "doc": "Text output from the Code Interpreter tool call as part of a run step.", "discriminatorValue": "logs", "decorators": [], "baseModel": { "$ref": "7986" }, "properties": [ { "$id": "7989", "kind": "property", "name": "index", "doc": "The index of the output in the outputs array.", "type": { "$id": "7990", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7991", "kind": "property", "name": "type", "doc": "Always `logs`.", "type": { "$ref": "6454" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7992", "kind": "property", "name": "logs", "doc": "The text output from the Code Interpreter tool call.", "type": { "$id": "7993", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.logs", "serializationOptions": {}, "isHttpMetadata": false } ] }, "image": { "$id": "7994", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeOutputImageObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject", "access": "public", "usage": "Output", "discriminatorValue": "image", "decorators": [], "baseModel": { "$ref": "7986" }, "properties": [ { "$id": "7995", "kind": "property", "name": "index", "doc": "The index of the output in the outputs array.", "type": { "$id": "7996", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7997", "kind": "property", "name": "type", "doc": "Always `image`.", "type": { "$ref": "6463" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "7998", "kind": "property", "name": "image", "type": { "$id": "7999", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.image.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "8000", "kind": "property", "name": "file_id", "doc": "The [file](/docs/api-reference/files) ID of the image.", "type": { "$id": "8001", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.image.anonymous.file_id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.image", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.code_interpreter.anonymous.outputs", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsCodeObject.code_interpreter", "serializationOptions": {}, "isHttpMetadata": false } ] }, "file_search": { "$id": "8002", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsFileSearchObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject", "access": "public", "usage": "Output", "discriminatorValue": "file_search", "decorators": [], "baseModel": { "$ref": "7972" }, "properties": [ { "$id": "8003", "kind": "property", "name": "index", "doc": "The index of the tool call in the tool calls array.", "type": { "$id": "8004", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8005", "kind": "property", "name": "id", "doc": "The ID of the tool call object.", "type": { "$id": "8006", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8007", "kind": "property", "name": "type", "doc": "The type of tool call. This is always going to be `file_search` for this type of tool call.", "type": { "$ref": "6470" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8008", "kind": "property", "name": "file_search", "doc": "For now, this is always going to be an empty object.", "type": { "$id": "8009", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsFileSearchObjectFileSearch", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.file_search.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "8010", "kind": "property", "name": "ranking_options", "type": { "$ref": "6474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.file_search.anonymous.ranking_options", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8011", "kind": "property", "name": "results", "doc": "The results of the file search.", "type": { "$ref": "6479" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.file_search.anonymous.results", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFileSearchObject.file_search", "serializationOptions": {}, "isHttpMetadata": false } ] }, "function": { "$id": "8012", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsFunctionObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject", "access": "public", "usage": "Output", "discriminatorValue": "function", "decorators": [], "baseModel": { "$ref": "7972" }, "properties": [ { "$id": "8013", "kind": "property", "name": "index", "doc": "The index of the tool call in the tool calls array.", "type": { "$id": "8014", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.index", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8015", "kind": "property", "name": "id", "doc": "The ID of the tool call object.", "type": { "$id": "8016", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8017", "kind": "property", "name": "type", "doc": "The type of tool call. This is always going to be `function` for this type of tool call.", "type": { "$ref": "6499" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8018", "kind": "property", "name": "function", "doc": "The definition of the function that was called.", "type": { "$id": "8019", "kind": "model", "name": "RunStepDeltaStepDetailsToolCallsFunctionObjectFunction", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.function.anonymous", "usage": "Output", "decorators": [], "properties": [ { "$id": "8020", "kind": "property", "name": "name", "doc": "The name of the function.", "type": { "$id": "8021", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.function.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8022", "kind": "property", "name": "arguments", "doc": "The arguments passed to the function.", "type": { "$id": "8023", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.function.anonymous.arguments", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8024", "kind": "property", "name": "output", "doc": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", "type": { "$id": "8025", "kind": "nullable", "type": { "$id": "8026", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.function.anonymous.output", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsFunctionObject.function", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaStepDetailsToolCallsObject.tool_calls", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject.delta.anonymous.step_details", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepDeltaObject.delta", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$ref": "7958" }, { "$ref": "7960" }, { "$ref": "7962" }, { "$ref": "7965" }, { "$ref": "7968" }, { "$ref": "7972" }, { "$ref": "7974" }, { "$ref": "7981" }, { "$ref": "7986" }, { "$ref": "7988" }, { "$ref": "7994" }, { "$ref": "7999" }, { "$ref": "8002" }, { "$ref": "8009" }, { "$ref": "8012" }, { "$ref": "8019" }, { "$id": "8027", "kind": "model", "name": "CreateThreadRequestToolResourcesFileSearchBase", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateThreadRequestToolResourcesFileSearchBase", "access": "public", "usage": "Input", "decorators": [], "properties": [] }, { "$id": "8028", "kind": "model", "name": "AssistantCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8029", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8030", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8031", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8032", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8033", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8034", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8035", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1287" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.AssistantCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8036", "kind": "model", "name": "MessageCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.MessageCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8037", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8038", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8039", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8040", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8041", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8042", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8043", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1291" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.MessageCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8044", "kind": "model", "name": "RunCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8045", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8046", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8047", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8048", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8049", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8050", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8051", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1295" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8052", "kind": "model", "name": "RunStepCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8053", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8054", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8055", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8056", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8057", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8058", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8059", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1299" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RunStepCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8060", "kind": "model", "name": "DotNetChatResponseFormat", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormat", "access": "public", "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "discriminatorProperty": { "$id": "8061", "kind": "property", "name": "type", "type": { "$ref": "10" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormat.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "8061" } ], "discriminatedSubtypes": { "text": { "$id": "8062", "kind": "model", "name": "DotNetChatResponseFormatText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatText", "access": "public", "usage": "Input,Output", "discriminatorValue": "text", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "8060" }, "properties": [ { "$id": "8063", "kind": "property", "name": "type", "doc": "The type of response format being defined. Always `text`.", "type": { "$ref": "2419" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatText.type", "serializationOptions": {}, "isHttpMetadata": false } ] }, "json_object": { "$id": "8064", "kind": "model", "name": "DotNetChatResponseFormatJsonObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonObject", "access": "public", "usage": "Input,Output", "discriminatorValue": "json_object", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "8060" }, "properties": [ { "$id": "8065", "kind": "property", "name": "type", "doc": "The type of response format being defined. Always `json_object`.", "type": { "$ref": "2397" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonObject.type", "serializationOptions": {}, "isHttpMetadata": false } ] }, "json_schema": { "$id": "8066", "kind": "model", "name": "DotNetChatResponseFormatJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema", "access": "public", "usage": "Input,Output", "discriminatorValue": "json_schema", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "baseModel": { "$ref": "8060" }, "properties": [ { "$id": "8067", "kind": "property", "name": "type", "type": { "$ref": "2405" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8068", "kind": "property", "name": "json_schema", "type": { "$id": "8069", "kind": "model", "name": "DotNetChatResponseFormatJsonSchemaJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema.anonymous", "usage": "Input,Output", "decorators": [], "properties": [ { "$id": "8070", "kind": "property", "name": "description", "type": { "$id": "8071", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema.anonymous.description", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8072", "kind": "property", "name": "name", "type": { "$id": "8073", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8074", "kind": "property", "name": "schema", "type": { "$id": "8075", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema.anonymous.schema", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8076", "kind": "property", "name": "strict", "type": { "$id": "8077", "kind": "nullable", "type": { "$id": "8078", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema.anonymous.strict", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetChatResponseFormatJsonSchema.json_schema", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, { "$ref": "8062" }, { "$ref": "8064" }, { "$ref": "8066" }, { "$ref": "8069" }, { "$id": "8079", "kind": "model", "name": "DotNetAssistantResponseFormat", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormat", "access": "public", "usage": "Input,Output", "decorators": [], "discriminatorProperty": { "$id": "8080", "kind": "property", "name": "type", "type": { "$ref": "10" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormat.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "8080" } ], "discriminatedSubtypes": { "text": { "$id": "8081", "kind": "model", "name": "DotNetAssistantResponseFormatText", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatText", "access": "public", "usage": "Input,Output", "discriminatorValue": "text", "decorators": [], "baseModel": { "$ref": "8079" }, "properties": [ { "$id": "8082", "kind": "property", "name": "type", "doc": "The type of response format being defined. Always `text`.", "type": { "$ref": "2419" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatText.type", "serializationOptions": {}, "isHttpMetadata": false } ] }, "json_object": { "$id": "8083", "kind": "model", "name": "DotNetAssistantResponseFormatJsonObject", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonObject", "access": "public", "usage": "Input,Output", "discriminatorValue": "json_object", "decorators": [], "baseModel": { "$ref": "8079" }, "properties": [ { "$id": "8084", "kind": "property", "name": "type", "doc": "The type of response format being defined. Always `json_object`.", "type": { "$ref": "2397" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonObject.type", "serializationOptions": {}, "isHttpMetadata": false } ] }, "json_schema": { "$id": "8085", "kind": "model", "name": "DotNetAssistantResponseFormatJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema", "access": "public", "usage": "Input,Output", "discriminatorValue": "json_schema", "decorators": [], "baseModel": { "$ref": "8079" }, "properties": [ { "$id": "8086", "kind": "property", "name": "type", "type": { "$ref": "2405" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8087", "kind": "property", "name": "json_schema", "type": { "$id": "8088", "kind": "model", "name": "DotNetAssistantResponseFormatJsonSchemaJsonSchema", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema.anonymous", "usage": "Input,Output", "decorators": [], "properties": [ { "$id": "8089", "kind": "property", "name": "description", "type": { "$id": "8090", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema.anonymous.description", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8091", "kind": "property", "name": "name", "type": { "$id": "8092", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema.anonymous.name", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8093", "kind": "property", "name": "schema", "type": { "$id": "8094", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema.anonymous.schema", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8095", "kind": "property", "name": "strict", "type": { "$id": "8096", "kind": "nullable", "type": { "$id": "8097", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema.anonymous.strict", "serializationOptions": {}, "isHttpMetadata": false } ] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAssistantResponseFormatJsonSchema.json_schema", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, { "$ref": "8081" }, { "$ref": "8083" }, { "$ref": "8085" }, { "$ref": "8088" }, { "$id": "8098", "kind": "model", "name": "DotNetAudioLogProbsProperties", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetAudioLogProbsProperties", "access": "public", "usage": "Output", "decorators": [], "properties": [ { "$id": "8099", "kind": "property", "name": "token", "doc": "The token that was used to generate the log probability.", "type": { "$id": "8100", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAudioLogProbsProperties.token", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8101", "kind": "property", "name": "logprob", "doc": "The log probability of the token.", "type": { "$id": "8102", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAudioLogProbsProperties.logprob", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8103", "kind": "property", "name": "bytes", "doc": "The bytes that were used to generate the log probability.", "type": { "$ref": "2606" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetAudioLogProbsProperties.bytes", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8104", "kind": "model", "name": "DotNetRealtimeLogProbsProperties", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetRealtimeLogProbsProperties", "access": "public", "usage": "Output", "decorators": [], "properties": [ { "$id": "8105", "kind": "property", "name": "token", "doc": "The token that was used to generate the log probability.", "type": { "$id": "8106", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetRealtimeLogProbsProperties.token", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8107", "kind": "property", "name": "logprob", "doc": "The log probability of the token.", "type": { "$id": "8108", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetRealtimeLogProbsProperties.logprob", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8109", "kind": "property", "name": "bytes", "doc": "The bytes that were used to generate the log probability.", "type": { "$ref": "2606" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetRealtimeLogProbsProperties.bytes", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8110", "kind": "model", "name": "DotNetCombinedJsonTranscriptionResponse", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse", "access": "public", "usage": "Output", "decorators": [], "properties": [ { "$id": "8111", "kind": "property", "name": "task", "doc": "The task label.", "type": { "$ref": "1695" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.task", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8112", "kind": "property", "name": "language", "doc": "The language of the input audio.", "type": { "$id": "8113", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.language", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8114", "kind": "property", "name": "duration", "doc": "The duration of the input audio.", "type": { "$id": "8115", "kind": "duration", "name": "duration", "encode": "seconds", "wireType": { "$id": "8116", "kind": "float32", "name": "float32", "crossLanguageDefinitionId": "TypeSpec.float32", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.duration", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.duration", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8117", "kind": "property", "name": "text", "doc": "The transcribed text.", "type": { "$id": "8118", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.text", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8119", "kind": "property", "name": "words", "doc": "Extracted words and their corresponding timestamps.", "type": { "$ref": "2580" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.words", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8120", "kind": "property", "name": "segments", "doc": "Segments of the transcribed text and their corresponding details.", "type": { "$ref": "2591" }, "optional": true, "readOnly": true, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.segments", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8121", "kind": "property", "name": "logprobs", "type": { "$ref": "7371" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedJsonTranscriptionResponse.logprobs", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8122", "kind": "model", "name": "BatchCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.BatchCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8123", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8124", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8125", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8126", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.BatchCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8127", "kind": "model", "name": "ChatCompletionCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions", "access": "public", "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8128", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8129", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8130", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8131", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8132", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1303" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8133", "kind": "property", "name": "metadata", "type": { "$ref": "2380" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions.metadata", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8134", "kind": "property", "name": "model", "type": { "$id": "8135", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionCollectionOptions.model", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8136", "kind": "model", "name": "ChatCompletionMessageCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageCollectionOptions", "access": "public", "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8137", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8138", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8139", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8140", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8141", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1307" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ChatCompletionMessageCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8142", "kind": "model", "name": "ContainerCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8143", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8144", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8145", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8146", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8147", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1311" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8148", "kind": "model", "name": "ContainerFileCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ContainerFileCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8149", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8150", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8151", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8152", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8153", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1311" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ContainerFileCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8154", "kind": "model", "name": "ConversationItemCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ConversationItemCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8155", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8156", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8157", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8158", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8159", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1315" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8160", "kind": "model", "name": "DotNetResponseItemCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8161", "kind": "property", "name": "response_id", "type": { "$id": "8162", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions.response_id", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8163", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8164", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8165", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8166", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8167", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8168", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8169", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1319" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetResponseItemCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8170", "kind": "model", "name": "DotNetGetResponseOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions", "access": "public", "usage": "Input", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8171", "kind": "property", "name": "response_id", "type": { "$id": "8172", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions.response_id", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8173", "kind": "property", "name": "startingAfter", "type": { "$id": "8174", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions.startingAfter", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8175", "kind": "property", "name": "includeObfuscation", "type": { "$id": "8176", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions.includeObfuscation", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8177", "kind": "property", "name": "includedProperties", "type": { "$id": "8178", "kind": "nullable", "type": { "$ref": "5100" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions.includedProperties", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8179", "kind": "property", "name": "streamingEnabled", "type": { "$id": "8180", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetGetResponseOptions.streamingEnabled", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8181", "kind": "model", "name": "DotNetCustomToolCallApprovalPolicy", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCustomToolCallApprovalPolicy", "access": "public", "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8182", "kind": "property", "name": "always", "doc": "A list of tools that always require approval.", "type": { "$ref": "4474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCustomToolCallApprovalPolicy.always", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8183", "kind": "property", "name": "never", "doc": "A list of tools that never require approval.", "type": { "$ref": "4474" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCustomToolCallApprovalPolicy.never", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8184", "kind": "model", "name": "DotNetToolCallApprovalPolicy", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetToolCallApprovalPolicy", "access": "public", "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8185", "kind": "property", "name": "global_policy", "type": { "$ref": "1323" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetToolCallApprovalPolicy.global_policy", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8186", "kind": "property", "name": "custom_policy", "type": { "$ref": "8181" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetToolCallApprovalPolicy.custom_policy", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8187", "kind": "model", "name": "DotNetCodeInterpreterToolContainer", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCodeInterpreterToolContainer", "access": "public", "usage": "Input,Output", "decorators": [ { "name": "TypeSpec.HttpClient.CSharp.@dynamicModel", "arguments": {} } ], "properties": [ { "$id": "8188", "kind": "property", "name": "container_id", "type": { "$id": "8189", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCodeInterpreterToolContainer.container_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8190", "kind": "property", "name": "container", "type": { "$ref": "4427" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCodeInterpreterToolContainer.container", "serializationOptions": {}, "isHttpMetadata": false } ] }, { "$id": "8191", "kind": "model", "name": "DotNetCombinedChunkingStrategyParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedChunkingStrategyParam", "usage": "Input,Output", "decorators": [], "discriminatorProperty": { "$id": "8192", "kind": "property", "name": "type", "type": { "$ref": "1327" }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedChunkingStrategyParam.type", "serializationOptions": {}, "isHttpMetadata": false }, "properties": [ { "$ref": "8192" } ], "discriminatedSubtypes": { "auto": { "$id": "8193", "kind": "model", "name": "DotNetCombinedAutoChunkingStrategyParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedAutoChunkingStrategyParam", "access": "public", "usage": "Input,Output", "discriminatorValue": "auto", "decorators": [], "baseModel": { "$ref": "8191" }, "properties": [ { "$id": "8194", "kind": "property", "name": "type", "doc": "Always `auto`.", "type": { "$id": "8195", "kind": "enumvalue", "name": "auto", "value": "auto", "valueType": { "$ref": "1328" }, "enumType": { "$id": "8196", "kind": "enum", "decorators": [], "name": "DotNetCombinedChunkingStrategyParamType", "isGeneratedName": true, "namespace": "OpenAI", "valueType": { "$id": "8197", "kind": "string", "decorators": [], "doc": "A sequence of textual characters.", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "values": [ { "$id": "8198", "kind": "enumvalue", "decorators": [], "name": "auto", "value": "auto", "valueType": { "$ref": "8197" }, "enumType": { "$ref": "8196" } }, { "$id": "8199", "kind": "enumvalue", "decorators": [], "name": "static", "value": "static", "valueType": { "$ref": "8197" }, "enumType": { "$ref": "8196" } }, { "$id": "8200", "kind": "enumvalue", "decorators": [], "name": "other", "value": "other", "valueType": { "$ref": "8197" }, "enumType": { "$ref": "8196" } } ], "isFixed": true, "isFlags": false, "usage": "Input,Output", "access": "public", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedChunkingStrategyParam.type.anonymous", "apiVersions": [], "isUnionAsEnum": true, "__accessSet": true }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedAutoChunkingStrategyParam.type", "serializationOptions": {}, "isHttpMetadata": false } ] }, "static": { "$id": "8201", "kind": "model", "name": "DotNetCombinedStaticChunkingStrategyParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedStaticChunkingStrategyParam", "access": "public", "usage": "Input,Output", "discriminatorValue": "static", "decorators": [], "baseModel": { "$ref": "8191" }, "properties": [ { "$id": "8202", "kind": "property", "name": "type", "doc": "Always `static`.", "type": { "$id": "8203", "kind": "enumvalue", "name": "static", "value": "static", "valueType": { "$ref": "1328" }, "enumType": { "$ref": "8196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedStaticChunkingStrategyParam.type", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "8204", "kind": "property", "name": "static", "type": { "$ref": "2480" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedStaticChunkingStrategyParam.static", "serializationOptions": {}, "isHttpMetadata": false } ] }, "other": { "$id": "8205", "kind": "model", "name": "DotNetCombinedOtherChunkingStrategyParam", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DotNetCombinedOtherChunkingStrategyParam", "access": "public", "usage": "Input,Output", "discriminatorValue": "other", "decorators": [], "baseModel": { "$ref": "8191" }, "properties": [ { "$id": "8206", "kind": "property", "name": "type", "doc": "Always `other`.", "type": { "$id": "8207", "kind": "enumvalue", "name": "other", "value": "other", "valueType": { "$ref": "1328" }, "enumType": { "$ref": "8196" }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": true, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DotNetCombinedOtherChunkingStrategyParam.type", "serializationOptions": {}, "isHttpMetadata": false } ] } } }, { "$ref": "8193" }, { "$ref": "8201" }, { "$ref": "8205" }, { "$id": "8208", "kind": "model", "name": "VectorStoreCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8209", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8210", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8211", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8212", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8213", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8214", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8215", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8216", "kind": "model", "name": "VectorStoreFileCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8217", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8218", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8219", "kind": "property", "name": "beforeId", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, starting with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8220", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions.beforeId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8221", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8222", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8223", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1336" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8224", "kind": "property", "name": "filter", "type": { "$ref": "1340" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStoreFileCollectionOptions.filter", "serializationOptions": {}, "isHttpMetadata": true } ] }, { "$id": "8225", "kind": "model", "name": "VideoCollectionOptions", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VideoCollectionOptions", "access": "public", "usage": "Input", "decorators": [], "properties": [ { "$id": "8226", "kind": "property", "name": "afterId", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8227", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoCollectionOptions.afterId", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8228", "kind": "property", "name": "pageSizeLimit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8229", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoCollectionOptions.pageSizeLimit", "serializationOptions": {}, "isHttpMetadata": true }, { "$id": "8230", "kind": "property", "name": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1346" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoCollectionOptions.order", "serializationOptions": {}, "isHttpMetadata": true } ] } ], "clients": [ { "$id": "8231", "kind": "client", "name": "OpenAIClient", "namespace": "OpenAI", "methods": [], "parameters": [ { "$id": "8232", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8233", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8234", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 1, "decorators": [], "crossLanguageDefinitionId": "OpenAI", "apiVersions": [], "children": [ { "$id": "8235", "kind": "client", "name": "Assistants", "namespace": "OpenAI", "methods": [ { "$id": "8236", "kind": "paging", "name": "GetAssistants", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of assistants.", "operation": { "$id": "8237", "name": "GetAssistants", "resourceName": "Assistants", "summary": "Returns a list of assistants.", "accessibility": "public", "parameters": [ { "$id": "8238", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1697" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.accept" }, { "$id": "8239", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1699" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.openAIBeta" }, { "$id": "8240", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8241", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.limit", "readOnly": false }, { "$id": "8242", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.order", "readOnly": false }, { "$id": "8243", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8244", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.after", "readOnly": false }, { "$id": "8245", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8246", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.before", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2307" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/assistants", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants", "decorators": [] }, "parameters": [ { "$id": "8247", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1701" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8248", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1703" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8249", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8250", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8251", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8252", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8253", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8254", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "8255", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants.before", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2310" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Assistants.listAssistants", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8243" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "8256", "kind": "basic", "name": "createAssistant", "accessibility": "public", "apiVersions": [], "summary": "Create an assistant with a model and instructions.", "operation": { "$id": "8257", "name": "createAssistant", "resourceName": "Assistants", "summary": "Create an assistant with a model and instructions.", "accessibility": "public", "parameters": [ { "$id": "8258", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1705" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.accept" }, { "$id": "8259", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1707" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.openAIBeta" }, { "$id": "8260", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1709" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.contentType" }, { "$id": "8261", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2439" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2311" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/assistants", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant", "decorators": [] }, "parameters": [ { "$id": "8262", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1711" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8263", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1713" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8264", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2439" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8265", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1709" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2311" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Assistants.createAssistant" }, { "$id": "8266", "kind": "basic", "name": "getAssistant", "accessibility": "public", "apiVersions": [], "summary": "Retrieves an assistant.", "operation": { "$id": "8267", "name": "getAssistant", "resourceName": "Assistants", "summary": "Retrieves an assistant.", "accessibility": "public", "parameters": [ { "$id": "8268", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1715" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.accept" }, { "$id": "8269", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1717" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.openAIBeta" }, { "$id": "8270", "kind": "path", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to retrieve.", "type": { "$id": "8271", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.assistant_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2311" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/assistants/{assistant_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant", "decorators": [] }, "parameters": [ { "$id": "8272", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1719" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8273", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1721" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8274", "kind": "method", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to retrieve.", "type": { "$id": "8275", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant.assistant_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2311" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Assistants.getAssistant" }, { "$id": "8276", "kind": "basic", "name": "modifyAssistant", "accessibility": "public", "apiVersions": [], "summary": "Modifies an assistant.", "operation": { "$id": "8277", "name": "modifyAssistant", "resourceName": "Assistants", "summary": "Modifies an assistant.", "accessibility": "public", "parameters": [ { "$id": "8278", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1723" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.accept" }, { "$id": "8279", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1725" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.openAIBeta" }, { "$id": "8280", "kind": "path", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to modify.", "type": { "$id": "8281", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.assistant_id" }, { "$id": "8282", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1727" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.contentType" }, { "$id": "8283", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2495" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2311" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/assistants/{assistant_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant", "decorators": [] }, "parameters": [ { "$id": "8284", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1729" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8285", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1731" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8286", "kind": "method", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to modify.", "type": { "$id": "8287", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.assistant_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8288", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2495" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8289", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1727" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2311" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Assistants.modifyAssistant" }, { "$id": "8290", "kind": "basic", "name": "deleteAssistant", "accessibility": "public", "apiVersions": [], "summary": "Delete an assistant.", "operation": { "$id": "8291", "name": "deleteAssistant", "resourceName": "Assistants", "summary": "Delete an assistant.", "accessibility": "public", "parameters": [ { "$id": "8292", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1733" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.accept" }, { "$id": "8293", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1735" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.openAIBeta" }, { "$id": "8294", "kind": "path", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to delete.", "type": { "$id": "8295", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.assistant_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2525" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/assistants/{assistant_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant", "decorators": [] }, "parameters": [ { "$id": "8296", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1737" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8297", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1739" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8298", "kind": "method", "name": "assistant_id", "serializedName": "assistant_id", "doc": "The ID of the assistant to delete.", "type": { "$id": "8299", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant.assistant_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2525" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Assistants.deleteAssistant" } ], "parameters": [ { "$id": "8300", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8301", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8302", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Assistants", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8303", "kind": "client", "name": "Audio", "namespace": "OpenAI", "methods": [ { "$id": "8304", "kind": "basic", "name": "GenerateSpeech", "accessibility": "public", "apiVersions": [], "summary": "Generates audio from the input text.", "operation": { "$id": "8305", "name": "GenerateSpeech", "resourceName": "Audio", "summary": "Generates audio from the input text.", "accessibility": "public", "parameters": [ { "$id": "8306", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1741" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.accept" }, { "$id": "8307", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1743" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.contentType" }, { "$id": "8308", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2531" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8309", "kind": "bytes", "name": "bytes", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "headers": [ { "name": "transferEncoding", "nameInResponse": "Transfer-Encoding", "doc": "chunked", "type": { "$id": "8310", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] } }, { "name": "contentType", "nameInResponse": "content-type", "type": { "$ref": "1745" } } ], "isErrorResponse": false, "contentTypes": [ "application/octet-stream" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/audio/speech", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech", "decorators": [] }, "parameters": [ { "$id": "8311", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1747" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8312", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2531" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8313", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1743" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8309" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Audio.createSpeech" }, { "$id": "8314", "kind": "basic", "name": "TranscribeAudio", "accessibility": "public", "apiVersions": [], "summary": "Transcribes audio into the input language.", "operation": { "$id": "8315", "name": "TranscribeAudio", "resourceName": "Audio", "summary": "Transcribes audio into the input language.", "accessibility": "public", "parameters": [ { "$id": "8316", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.accept" }, { "$id": "8317", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1749" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.contentType" }, { "$id": "8318", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2541" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8319", "kind": "union", "name": "", "variantTypes": [ { "$id": "8320", "kind": "union", "name": "", "variantTypes": [ { "$ref": "2570" }, { "$ref": "2616" } ], "namespace": "", "decorators": [] }, { "$ref": "2629" } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "Content-Type", "type": { "$ref": "1751" } } ], "isErrorResponse": false, "contentTypes": [ "application/json", "application/json", "text/event-stream" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/audio/transcriptions", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription", "decorators": [] }, "parameters": [ { "$id": "8321", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8322", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1753" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8323", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2541" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8319" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Audio.createTranscription" }, { "$id": "8324", "kind": "basic", "name": "TranslateAudio", "accessibility": "public", "apiVersions": [], "summary": "Translates audio into English..", "operation": { "$id": "8325", "name": "TranslateAudio", "resourceName": "Audio", "summary": "Translates audio into English..", "accessibility": "public", "parameters": [ { "$id": "8326", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1755" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.accept" }, { "$id": "8327", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1757" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.contentType" }, { "$id": "8328", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2661" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8329", "kind": "union", "name": "", "variantTypes": [ { "$id": "8330", "kind": "union", "name": "", "variantTypes": [ { "$ref": "2671" }, { "$ref": "2681" } ], "namespace": "", "decorators": [] }, { "$id": "8331", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "content-type", "type": { "$ref": "1759" } } ], "isErrorResponse": false, "contentTypes": [ "application/json", "application/json", "text/plain" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/audio/translations", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation", "decorators": [] }, "parameters": [ { "$id": "8332", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1761" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8333", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1763" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8334", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2661" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8329" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Audio.createTranslation" } ], "parameters": [ { "$id": "8335", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8336", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8337", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Audio", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8338", "kind": "client", "name": "Batches", "namespace": "OpenAI", "methods": [ { "$id": "8339", "kind": "basic", "name": "createBatch", "accessibility": "public", "apiVersions": [], "summary": "Creates and executes a batch from an uploaded file of requests", "operation": { "$id": "8340", "name": "createBatch", "resourceName": "Batches", "summary": "Creates and executes a batch from an uploaded file of requests", "accessibility": "public", "parameters": [ { "$id": "8341", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1765" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.accept" }, { "$id": "8342", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1767" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.contentType" }, { "$id": "8343", "kind": "body", "name": "createBatchRequest", "serializedName": "createBatchRequest", "type": { "$ref": "2684" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Spread", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2690" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/batches", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Batches.createBatch", "decorators": [] }, "parameters": [ { "$id": "8344", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1769" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8345", "kind": "method", "name": "input_file_id", "serializedName": "input_file_id", "doc": "The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](/docs/api-reference/files/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](/docs/api-reference/batch/requestInput),\nand must be uploaded with the purpose `batch`.", "type": { "$id": "8346", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.input_file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8347", "kind": "method", "name": "endpoint", "serializedName": "endpoint", "doc": "The endpoint to be used for all requests in the batch. Currently `/v1/chat/completions` and\n`/v1/embeddings` are supported.", "type": { "$ref": "122" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.endpoint", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8348", "kind": "method", "name": "completion_window", "serializedName": "completion_window", "doc": "The time frame within which the batch should be processed. Currently only `24h` is supported.", "type": { "$ref": "1471" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.completion_window", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8349", "kind": "method", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "location": "Body", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.metadata", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8350", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1767" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.createBatch.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2690" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Batches.createBatch" }, { "$id": "8351", "kind": "paging", "name": "GetBatches", "accessibility": "public", "apiVersions": [], "summary": "List your organization's batches.", "operation": { "$id": "8352", "name": "GetBatches", "resourceName": "Batches", "summary": "List your organization's batches.", "accessibility": "public", "parameters": [ { "$id": "8353", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1773" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.accept" }, { "$id": "8354", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8355", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.after", "readOnly": false }, { "$id": "8356", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8357", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.limit", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2757" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/batches", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Batches.listBatches", "decorators": [] }, "parameters": [ { "$id": "8358", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1775" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8359", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8360", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8361", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8362", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.listBatches.limit", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2759" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Batches.listBatches", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8354" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "8363", "kind": "basic", "name": "GetBatch", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a batch.", "operation": { "$id": "8364", "name": "GetBatch", "resourceName": "Batches", "summary": "Retrieves a batch.", "accessibility": "public", "parameters": [ { "$id": "8365", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1777" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch.accept" }, { "$id": "8366", "kind": "path", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the batch to retrieve.", "type": { "$id": "8367", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch.batch_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2690" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/batches/{batch_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch", "decorators": [] }, "parameters": [ { "$id": "8368", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1779" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8369", "kind": "method", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the batch to retrieve.", "type": { "$id": "8370", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch.batch_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2690" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Batches.retrieveBatch" }, { "$id": "8371", "kind": "basic", "name": "cancelBatch", "accessibility": "public", "apiVersions": [], "summary": "Cancels an in-progress batch.", "operation": { "$id": "8372", "name": "cancelBatch", "resourceName": "Batches", "summary": "Cancels an in-progress batch.", "accessibility": "public", "parameters": [ { "$id": "8373", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1781" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch.accept" }, { "$id": "8374", "kind": "path", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the batch to cancel.", "type": { "$id": "8375", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch.batch_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2690" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/batches/{batch_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch", "decorators": [] }, "parameters": [ { "$id": "8376", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1783" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8377", "kind": "method", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the batch to cancel.", "type": { "$id": "8378", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch.batch_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2690" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Batches.cancelBatch" } ], "parameters": [ { "$id": "8379", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8380", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8381", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Batches", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8382", "kind": "client", "name": "Chat", "namespace": "OpenAI", "methods": [ { "$id": "8383", "kind": "paging", "name": "listChatCompletions", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of chat completions.", "operation": { "$id": "8384", "name": "listChatCompletions", "resourceName": "Chat", "summary": "Returns a list of chat completions.", "accessibility": "public", "parameters": [ { "$id": "8385", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8386", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.after", "readOnly": false }, { "$id": "8387", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8388", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.limit", "readOnly": false }, { "$id": "8389", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.order", "readOnly": false }, { "$id": "8390", "kind": "query", "name": "metadata", "serializedName": "metadata", "type": { "$ref": "2380" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.metadata", "readOnly": false }, { "$id": "8391", "kind": "query", "name": "model", "serializedName": "model", "type": { "$id": "8392", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.model", "readOnly": false }, { "$id": "8393", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1785" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2767" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/chat/completions", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions", "decorators": [] }, "parameters": [ { "$id": "8394", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8395", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8396", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8397", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8398", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8399", "kind": "method", "name": "metadata", "serializedName": "metadata", "type": { "$ref": "2380" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.metadata", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8400", "kind": "method", "name": "model", "serializedName": "model", "type": { "$id": "8401", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.model", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8402", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1785" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2770" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.listChatCompletions", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8385" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "8403", "kind": "basic", "name": "CompleteChat", "accessibility": "public", "apiVersions": [], "summary": "Creates a model response for the given chat conversation.", "operation": { "$id": "8404", "name": "CompleteChat", "resourceName": "Chat", "summary": "Creates a model response for the given chat conversation.", "accessibility": "public", "parameters": [ { "$id": "8405", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1787" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.accept" }, { "$id": "8406", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1789" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.contentType" }, { "$id": "8407", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2909" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8408", "kind": "union", "name": "", "variantTypes": [ { "$ref": "2771" }, { "$ref": "3171" } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "Content-Type", "type": { "$ref": "1791" } } ], "isErrorResponse": false, "contentTypes": [ "application/json", "text/event-stream" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/chat/completions", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion", "decorators": [] }, "parameters": [ { "$id": "8409", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1793" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8410", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "2909" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8411", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1789" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8408" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.createChatCompletion" }, { "$id": "8412", "kind": "basic", "name": "getChatCompletion", "accessibility": "public", "apiVersions": [], "summary": "Get a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.", "operation": { "$id": "8413", "name": "getChatCompletion", "resourceName": "Chat", "summary": "Get a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.", "accessibility": "public", "parameters": [ { "$id": "8414", "kind": "path", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to retrieve.", "type": { "$id": "8415", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion.completion_id" }, { "$id": "8416", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1795" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2771" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/chat/completions/{completion_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion", "decorators": [] }, "parameters": [ { "$id": "8417", "kind": "method", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to retrieve.", "type": { "$id": "8418", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion.completion_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8419", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1795" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2771" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletion" }, { "$id": "8420", "kind": "basic", "name": "updateChatCompletion", "accessibility": "public", "apiVersions": [], "summary": "Modify a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be modified. Currently, the only supported modification is to update the `metadata` field.\")", "operation": { "$id": "8421", "name": "updateChatCompletion", "resourceName": "Chat", "summary": "Modify a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be modified. Currently, the only supported modification is to update the `metadata` field.\")", "accessibility": "public", "parameters": [ { "$id": "8422", "kind": "path", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to update.", "type": { "$id": "8423", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.completion_id" }, { "$id": "8424", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1797" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.contentType" }, { "$id": "8425", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1799" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.accept" }, { "$id": "8426", "kind": "body", "name": "updateChatCompletionRequest", "serializedName": "updateChatCompletionRequest", "type": { "$ref": "3239" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Spread", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "2771" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/chat/completions/{completion_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion", "decorators": [] }, "parameters": [ { "$id": "8427", "kind": "method", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to update.", "type": { "$id": "8428", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.completion_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8429", "kind": "method", "name": "metadata", "serializedName": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "type": { "$ref": "2380" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.metadata", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8430", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1797" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8431", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1799" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "2771" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.updateChatCompletion" }, { "$id": "8432", "kind": "basic", "name": "deleteChatCompletion", "accessibility": "public", "apiVersions": [], "summary": "Delete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be deleted.", "operation": { "$id": "8433", "name": "deleteChatCompletion", "resourceName": "Chat", "summary": "Delete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be deleted.", "accessibility": "public", "parameters": [ { "$id": "8434", "kind": "path", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to delete.", "type": { "$id": "8435", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion.completion_id" }, { "$id": "8436", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1801" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3241" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/chat/completions/{completion_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion", "decorators": [] }, "parameters": [ { "$id": "8437", "kind": "method", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to delete.", "type": { "$id": "8438", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion.completion_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8439", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1801" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3241" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.deleteChatCompletion" }, { "$id": "8440", "kind": "paging", "name": "getChatCompletionMessages", "accessibility": "public", "apiVersions": [], "summary": "Get the messages of a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.", "operation": { "$id": "8441", "name": "getChatCompletionMessages", "resourceName": "Chat", "summary": "Get the messages of a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.", "accessibility": "public", "parameters": [ { "$id": "8442", "kind": "path", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to retrieve messages for.", "type": { "$id": "8443", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.completion_id" }, { "$id": "8444", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8445", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.after", "readOnly": false }, { "$id": "8446", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8447", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.limit", "readOnly": false }, { "$id": "8448", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.order", "readOnly": false }, { "$id": "8449", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1803" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3247" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/chat/completions/{completion_id}/messages", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages", "decorators": [] }, "parameters": [ { "$id": "8450", "kind": "method", "name": "completion_id", "serializedName": "completion_id", "doc": "The ID of the stored chat completion to retrieve messages for.", "type": { "$id": "8451", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.completion_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8452", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8453", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8454", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8455", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8456", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8457", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1803" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3250" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Chat.getChatCompletionMessages", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8444" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } } ], "parameters": [ { "$id": "8458", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8459", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8460", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Chat", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8461", "kind": "client", "name": "Containers", "namespace": "OpenAI", "methods": [ { "$id": "8462", "kind": "paging", "name": "listContainers", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8463", "name": "listContainers", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8464", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8465", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.limit", "readOnly": false }, { "$id": "8466", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.order", "readOnly": false }, { "$id": "8467", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8468", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.after", "readOnly": false }, { "$id": "8469", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1805" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3270" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/containers", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.listContainers", "decorators": [] }, "parameters": [ { "$id": "8470", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8471", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8472", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8473", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8474", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8475", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1805" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.listContainers.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3273" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.listContainers", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8467" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "8476", "kind": "basic", "name": "createContainer", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8477", "name": "createContainer", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8478", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1807" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.contentType" }, { "$id": "8479", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1809" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.accept" }, { "$id": "8480", "kind": "body", "name": "body", "serializedName": "body", "type": { "$ref": "3297" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3274" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/containers", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.createContainer", "decorators": [] }, "parameters": [ { "$id": "8481", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "3297" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8482", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1807" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8483", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1809" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.createContainer.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3274" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.createContainer" }, { "$id": "8484", "kind": "basic", "name": "GetContainer", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8485", "name": "GetContainer", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8486", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8487", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer.container_id" }, { "$id": "8488", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1811" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3274" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/containers/{container_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer", "decorators": [] }, "parameters": [ { "$id": "8489", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8490", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8491", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1811" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3274" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainer" }, { "$id": "8492", "kind": "basic", "name": "deleteContainer", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8493", "name": "deleteContainer", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8494", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8495", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer.container_id" }, { "$id": "8496", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1813" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3306" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/containers/{container_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer", "decorators": [] }, "parameters": [ { "$id": "8497", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8498", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8499", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1813" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3306" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainer" }, { "$id": "8500", "kind": "basic", "name": "createContainerFile", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8501", "name": "createContainerFile", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8502", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8503", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.container_id" }, { "$id": "8504", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1815" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.contentType" }, { "$id": "8505", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1817" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.accept" }, { "$id": "8506", "kind": "body", "name": "body", "serializedName": "body", "type": { "$ref": "3311" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3316" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/containers/{container_id}/files", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile", "decorators": [] }, "parameters": [ { "$id": "8507", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8508", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8509", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1819" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8510", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "3311" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8511", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1817" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3316" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.createContainerFile" }, { "$id": "8512", "kind": "paging", "name": "listContainerFiles", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8513", "name": "listContainerFiles", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8514", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8515", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.container_id" }, { "$id": "8516", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8517", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.limit", "readOnly": false }, { "$id": "8518", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.order", "readOnly": false }, { "$id": "8519", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8520", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.after", "readOnly": false }, { "$id": "8521", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1821" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3332" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/containers/{container_id}/files", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles", "decorators": [] }, "parameters": [ { "$id": "8522", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8523", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8524", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8525", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8526", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8527", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8528", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8529", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1821" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3335" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.listContainerFiles", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "8519" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "8530", "kind": "basic", "name": "GetContainerFile", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8531", "name": "GetContainerFile", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8532", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8533", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.container_id" }, { "$id": "8534", "kind": "path", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8535", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.file_id" }, { "$id": "8536", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1823" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3316" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/containers/{container_id}/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile", "decorators": [] }, "parameters": [ { "$id": "8537", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8538", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8539", "kind": "method", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8540", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8541", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1823" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3316" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFile" }, { "$id": "8542", "kind": "basic", "name": "deleteContainerFile", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8543", "name": "deleteContainerFile", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8544", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8545", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.container_id" }, { "$id": "8546", "kind": "path", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8547", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.file_id" }, { "$id": "8548", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1825" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3342" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/containers/{container_id}/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile", "decorators": [] }, "parameters": [ { "$id": "8549", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8550", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8551", "kind": "method", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8552", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8553", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1825" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3342" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.deleteContainerFile" }, { "$id": "8554", "kind": "basic", "name": "DownloadContainerFile", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8555", "name": "DownloadContainerFile", "resourceName": "Containers", "accessibility": "public", "parameters": [ { "$id": "8556", "kind": "path", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8557", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.container_id" }, { "$id": "8558", "kind": "path", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8559", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.file_id" }, { "$id": "8560", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1827" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8561", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/octet-stream" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/containers/{container_id}/files/{file_id}/content", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent", "decorators": [] }, "parameters": [ { "$id": "8562", "kind": "method", "name": "container_id", "serializedName": "container_id", "type": { "$id": "8563", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.container_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8564", "kind": "method", "name": "file_id", "serializedName": "file_id", "type": { "$id": "8565", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8566", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1827" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8561" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Containers.retrieveContainerFileContent" } ], "parameters": [ { "$id": "8567", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8568", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8569", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Containers", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8570", "kind": "client", "name": "Embeddings", "namespace": "OpenAI", "methods": [ { "$id": "8571", "kind": "basic", "name": "GenerateEmbeddings", "accessibility": "public", "apiVersions": [], "summary": "Creates an embedding vector representing the input text.", "operation": { "$id": "8572", "name": "GenerateEmbeddings", "resourceName": "Embeddings", "summary": "Creates an embedding vector representing the input text.", "accessibility": "public", "parameters": [ { "$id": "8573", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1829" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.accept" }, { "$id": "8574", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1831" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.contentType" }, { "$id": "8575", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3347" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3358" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/embeddings", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding", "decorators": [] }, "parameters": [ { "$id": "8576", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1833" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8577", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3347" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8578", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1831" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3358" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Embeddings.createEmbedding" } ], "parameters": [ { "$id": "8579", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8580", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8581", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Embeddings", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8582", "kind": "client", "name": "Files", "namespace": "OpenAI", "methods": [ { "$id": "8583", "kind": "basic", "name": "GetFiles", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of files that belong to the user's organization.", "operation": { "$id": "8584", "name": "GetFiles", "resourceName": "Files", "summary": "Returns a list of files that belong to the user's organization.", "accessibility": "public", "parameters": [ { "$id": "8585", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1835" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.listFiles.accept" }, { "$id": "8586", "kind": "query", "name": "purpose", "serializedName": "purpose", "doc": "Only return files with the given purpose.", "type": { "$id": "8587", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.listFiles.purpose", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3379" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/files", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Files.listFiles", "decorators": [] }, "parameters": [ { "$id": "8588", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1837" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.listFiles.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8589", "kind": "method", "name": "purpose", "serializedName": "purpose", "doc": "Only return files with the given purpose.", "type": { "$id": "8590", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Files.listFiles.purpose", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3379" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Files.listFiles" }, { "$id": "8591", "kind": "basic", "name": "UploadFile", "accessibility": "public", "apiVersions": [], "summary": "Upload a file that can be used across various endpoints. The size of all the files uploaded by\none organization can be up to 100 GB.\n\nThe size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See\nthe [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files\nsupported. The Fine-tuning API only supports `.jsonl` files.\n\nPlease [contact us](https://help.openai.com/) if you need to increase these storage limits.", "operation": { "$id": "8592", "name": "UploadFile", "resourceName": "Files", "summary": "Upload a file that can be used across various endpoints. The size of all the files uploaded by\none organization can be up to 100 GB.\n\nThe size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See\nthe [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files\nsupported. The Fine-tuning API only supports `.jsonl` files.\n\nPlease [contact us](https://help.openai.com/) if you need to increase these storage limits.", "accessibility": "public", "parameters": [ { "$id": "8593", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1839" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.createFile.accept" }, { "$id": "8594", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1841" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.createFile.contentType" }, { "$id": "8595", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3408" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Files.createFile.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3383" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/files", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Files.createFile", "decorators": [] }, "parameters": [ { "$id": "8596", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1843" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.createFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8597", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1845" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.createFile.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8598", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3408" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Files.createFile.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3383" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Files.createFile" }, { "$id": "8599", "kind": "basic", "name": "deleteFile", "accessibility": "public", "apiVersions": [], "summary": "Delete a file", "operation": { "$id": "8600", "name": "deleteFile", "resourceName": "Files", "summary": "Delete a file", "accessibility": "public", "parameters": [ { "$id": "8601", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1847" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.deleteFile.accept" }, { "$id": "8602", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8603", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Files.deleteFile.file_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3412" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Files.deleteFile", "decorators": [] }, "parameters": [ { "$id": "8604", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1849" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.deleteFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8605", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8606", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Files.deleteFile.file_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3412" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Files.deleteFile" }, { "$id": "8607", "kind": "basic", "name": "GetFile", "accessibility": "public", "apiVersions": [], "summary": "Returns information about a specific file.", "operation": { "$id": "8608", "name": "GetFile", "resourceName": "Files", "summary": "Returns information about a specific file.", "accessibility": "public", "parameters": [ { "$id": "8609", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1851" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile.accept" }, { "$id": "8610", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8611", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile.file_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3383" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile", "decorators": [] }, "parameters": [ { "$id": "8612", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1853" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8613", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8614", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile.file_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3383" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Files.retrieveFile" }, { "$id": "8615", "kind": "basic", "name": "downloadFile", "accessibility": "public", "apiVersions": [], "summary": "Returns the contents of the specified file.", "operation": { "$id": "8616", "name": "downloadFile", "resourceName": "Files", "summary": "Returns the contents of the specified file.", "accessibility": "public", "parameters": [ { "$id": "8617", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1855" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files.downloadFile.accept" }, { "$id": "8618", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8619", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Files.downloadFile.file_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8620", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/octet-stream" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/files/{file_id}/content", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Files.downloadFile", "decorators": [] }, "parameters": [ { "$id": "8621", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1857" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Files.downloadFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8622", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to use for this request.", "type": { "$id": "8623", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Files.downloadFile.file_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8620" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Files.downloadFile" } ], "parameters": [ { "$id": "8624", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8625", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8626", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Files", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8627", "kind": "client", "name": "FineTuning", "namespace": "OpenAI", "methods": [ { "$id": "8628", "kind": "basic", "name": "listFineTuningCheckpointPermissions", "accessibility": "public", "apiVersions": [], "summary": "NOTE: This endpoint requires an admin API key.\nOrganization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.", "operation": { "$id": "8629", "name": "listFineTuningCheckpointPermissions", "resourceName": "FineTuning", "summary": "NOTE: This endpoint requires an admin API key.\nOrganization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.", "accessibility": "public", "parameters": [ { "$id": "8630", "kind": "path", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to get permissions for.", "type": { "$id": "8631", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.fine_tuned_model_checkpoint" }, { "$id": "8632", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8633", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.after", "readOnly": false }, { "$id": "8634", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8635", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.limit", "readOnly": false }, { "$id": "8636", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.order", "readOnly": false }, { "$id": "8637", "kind": "query", "name": "project_id", "serializedName": "project_id", "doc": "The ID of the project to get permissions for.", "type": { "$id": "8638", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.project_id", "readOnly": false }, { "$id": "8639", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1859" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3418" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions", "decorators": [] }, "parameters": [ { "$id": "8640", "kind": "method", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to get permissions for.", "type": { "$id": "8641", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.fine_tuned_model_checkpoint", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8642", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "8643", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8644", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "8645", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8646", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8647", "kind": "method", "name": "project_id", "serializedName": "project_id", "doc": "The ID of the project to get permissions for.", "type": { "$id": "8648", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.project_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8649", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1859" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3418" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningCheckpointPermissions" }, { "$id": "8650", "kind": "basic", "name": "createFineTuningCheckpointPermission", "accessibility": "public", "apiVersions": [], "summary": "NOTE: This endpoint requires an admin API key.\nThis enables organization owners to share fine-tuned models with other projects in their organization.", "operation": { "$id": "8651", "name": "createFineTuningCheckpointPermission", "resourceName": "FineTuning", "summary": "NOTE: This endpoint requires an admin API key.\nThis enables organization owners to share fine-tuned models with other projects in their organization.", "accessibility": "public", "parameters": [ { "$id": "8652", "kind": "path", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to create a permission for.", "type": { "$id": "8653", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.fine_tuned_model_checkpoint" }, { "$id": "8654", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1861" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.contentType" }, { "$id": "8655", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1863" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.accept" }, { "$id": "8656", "kind": "body", "name": "createFineTuningCheckpointPermissionRequest", "serializedName": "createFineTuningCheckpointPermissionRequest", "type": { "$ref": "3439" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Spread", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3418" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission", "decorators": [] }, "parameters": [ { "$id": "8657", "kind": "method", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to create a permission for.", "type": { "$id": "8658", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.fine_tuned_model_checkpoint", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8659", "kind": "method", "name": "project_ids", "serializedName": "project_ids", "doc": "The project identifiers to grant access to.", "type": { "$ref": "2373" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.project_ids", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8660", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1861" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8661", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1863" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3418" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningCheckpointPermission" }, { "$id": "8662", "kind": "basic", "name": "deleteFineTuningCheckpointPermission", "accessibility": "public", "apiVersions": [], "summary": "NOTE: This endpoint requires an admin API key.\nOrganization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.", "operation": { "$id": "8663", "name": "deleteFineTuningCheckpointPermission", "resourceName": "FineTuning", "summary": "NOTE: This endpoint requires an admin API key.\nOrganization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.", "accessibility": "public", "parameters": [ { "$id": "8664", "kind": "path", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to delete a permission for.", "type": { "$id": "8665", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.fine_tuned_model_checkpoint" }, { "$id": "8666", "kind": "path", "name": "permission_id", "serializedName": "permission_id", "doc": "The ID of the permission to delete.", "type": { "$id": "8667", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.permission_id" }, { "$id": "8668", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1865" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3441" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission", "decorators": [] }, "parameters": [ { "$id": "8669", "kind": "method", "name": "fine_tuned_model_checkpoint", "serializedName": "fine_tuned_model_checkpoint", "doc": "The ID of the fine-tuned model checkpoint to delete a permission for.", "type": { "$id": "8670", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.fine_tuned_model_checkpoint", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8671", "kind": "method", "name": "permission_id", "serializedName": "permission_id", "doc": "The ID of the permission to delete.", "type": { "$id": "8672", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.permission_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8673", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1865" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3441" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.deleteFineTuningCheckpointPermission" }, { "$id": "8674", "kind": "basic", "name": "createFineTuningJob", "accessibility": "public", "apiVersions": [], "summary": "Creates a fine-tuning job which begins the process of creating a new model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the fine-tuned models once complete.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", "operation": { "$id": "8675", "name": "createFineTuningJob", "resourceName": "FineTuning", "summary": "Creates a fine-tuning job which begins the process of creating a new model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the fine-tuned models once complete.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", "accessibility": "public", "parameters": [ { "$id": "8676", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1867" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.accept" }, { "$id": "8677", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1869" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.contentType" }, { "$id": "8678", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3447" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3643" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/jobs", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob", "decorators": [] }, "parameters": [ { "$id": "8679", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1871" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8680", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "3447" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8681", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1869" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3643" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.createFineTuningJob" }, { "$id": "8682", "kind": "basic", "name": "listPaginatedFineTuningJobs", "accessibility": "public", "apiVersions": [], "summary": "List your organization's fine-tuning jobs", "operation": { "$id": "8683", "name": "listPaginatedFineTuningJobs", "resourceName": "FineTuning", "summary": "List your organization's fine-tuning jobs", "accessibility": "public", "parameters": [ { "$id": "8684", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1873" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.accept" }, { "$id": "8685", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last job from the previous pagination request.", "type": { "$id": "8686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.after", "readOnly": false }, { "$id": "8687", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "Number of fine-tuning jobs to retrieve.", "type": { "$id": "8688", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.limit", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3726" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/fine_tuning/jobs", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs", "decorators": [] }, "parameters": [ { "$id": "8689", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1875" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8690", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last job from the previous pagination request.", "type": { "$id": "8691", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8692", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "Number of fine-tuning jobs to retrieve.", "type": { "$id": "8693", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs.limit", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3726" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listPaginatedFineTuningJobs" }, { "$id": "8694", "kind": "basic", "name": "retrieveFineTuningJob", "accessibility": "public", "apiVersions": [], "summary": "Get info about a fine-tuning job.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", "operation": { "$id": "8695", "name": "retrieveFineTuningJob", "resourceName": "FineTuning", "summary": "Get info about a fine-tuning job.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", "accessibility": "public", "parameters": [ { "$id": "8696", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1877" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob.accept" }, { "$id": "8697", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job.", "type": { "$id": "8698", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob.fine_tuning_job_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3643" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob", "decorators": [] }, "parameters": [ { "$id": "8699", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1879" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8700", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job.", "type": { "$id": "8701", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3643" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.retrieveFineTuningJob" }, { "$id": "8702", "kind": "basic", "name": "cancelFineTuningJob", "accessibility": "public", "apiVersions": [], "summary": "Immediately cancel a fine-tune job.", "operation": { "$id": "8703", "name": "cancelFineTuningJob", "resourceName": "FineTuning", "summary": "Immediately cancel a fine-tune job.", "accessibility": "public", "parameters": [ { "$id": "8704", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1881" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob.accept" }, { "$id": "8705", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to cancel.", "type": { "$id": "8706", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob.fine_tuning_job_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3643" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob", "decorators": [] }, "parameters": [ { "$id": "8707", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1883" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8708", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to cancel.", "type": { "$id": "8709", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3643" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.cancelFineTuningJob" }, { "$id": "8710", "kind": "basic", "name": "listFineTuningJobCheckpoints", "accessibility": "public", "apiVersions": [], "summary": "List the checkpoints for a fine-tuning job.", "operation": { "$id": "8711", "name": "listFineTuningJobCheckpoints", "resourceName": "FineTuning", "summary": "List the checkpoints for a fine-tuning job.", "accessibility": "public", "parameters": [ { "$id": "8712", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1885" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.accept" }, { "$id": "8713", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to get checkpoints for.", "type": { "$id": "8714", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.fine_tuning_job_id" }, { "$id": "8715", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last checkpoint ID from the previous pagination request.", "type": { "$id": "8716", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.after", "readOnly": false }, { "$id": "8717", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "Number of checkpoints to retrieve.", "type": { "$id": "8718", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.limit", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3732" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints", "decorators": [] }, "parameters": [ { "$id": "8719", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1887" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8720", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to get checkpoints for.", "type": { "$id": "8721", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8722", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last checkpoint ID from the previous pagination request.", "type": { "$id": "8723", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8724", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "Number of checkpoints to retrieve.", "type": { "$id": "8725", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints.limit", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3732" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningJobCheckpoints" }, { "$id": "8726", "kind": "basic", "name": "listFineTuningEvents", "accessibility": "public", "apiVersions": [], "summary": "Get status updates for a fine-tuning job.", "operation": { "$id": "8727", "name": "listFineTuningEvents", "resourceName": "FineTuning", "summary": "Get status updates for a fine-tuning job.", "accessibility": "public", "parameters": [ { "$id": "8728", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1889" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.accept" }, { "$id": "8729", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to get events for.", "type": { "$id": "8730", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.fine_tuning_job_id" }, { "$id": "8731", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last event from the previous pagination request.", "type": { "$id": "8732", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.after", "readOnly": false }, { "$id": "8733", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "Number of events to retrieve.", "type": { "$id": "8734", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.limit", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3773" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}/events", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents", "decorators": [] }, "parameters": [ { "$id": "8735", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1891" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8736", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to get events for.", "type": { "$id": "8737", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8738", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last event from the previous pagination request.", "type": { "$id": "8739", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8740", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "Number of events to retrieve.", "type": { "$id": "8741", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents.limit", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3773" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.listFineTuningEvents" }, { "$id": "8742", "kind": "basic", "name": "pauseFineTuningJob", "accessibility": "public", "apiVersions": [], "summary": "Pause a fine-tune job.", "operation": { "$id": "8743", "name": "pauseFineTuningJob", "resourceName": "FineTuning", "summary": "Pause a fine-tune job.", "accessibility": "public", "parameters": [ { "$id": "8744", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to pause.", "type": { "$id": "8745", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob.fine_tuning_job_id" }, { "$id": "8746", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1893" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3643" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}/pause", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob", "decorators": [] }, "parameters": [ { "$id": "8747", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to pause.", "type": { "$id": "8748", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8749", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1893" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3643" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.pauseFineTuningJob" }, { "$id": "8750", "kind": "basic", "name": "resumeFineTuningJob", "accessibility": "public", "apiVersions": [], "summary": "Resume a paused fine-tune job.", "operation": { "$id": "8751", "name": "resumeFineTuningJob", "resourceName": "FineTuning", "summary": "Resume a paused fine-tune job.", "accessibility": "public", "parameters": [ { "$id": "8752", "kind": "path", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to resume.", "type": { "$id": "8753", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob.fine_tuning_job_id" }, { "$id": "8754", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1895" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3643" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/jobs/{fine_tuning_job_id}/resume", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob", "decorators": [] }, "parameters": [ { "$id": "8755", "kind": "method", "name": "fine_tuning_job_id", "serializedName": "fine_tuning_job_id", "doc": "The ID of the fine-tuning job to resume.", "type": { "$id": "8756", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob.fine_tuning_job_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8757", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1895" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3643" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.FineTuning.resumeFineTuningJob" } ], "parameters": [ { "$id": "8758", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8759", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8760", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.FineTuning", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8761", "kind": "client", "name": "Graders", "namespace": "OpenAI", "methods": [ { "$id": "8762", "kind": "basic", "name": "runGrader", "accessibility": "public", "apiVersions": [], "summary": "Run a grader.", "operation": { "$id": "8763", "name": "runGrader", "resourceName": "Graders", "summary": "Run a grader.", "accessibility": "public", "parameters": [ { "$id": "8764", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1897" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.contentType" }, { "$id": "8765", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1899" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.accept" }, { "$id": "8766", "kind": "body", "name": "request", "serializedName": "request", "type": { "$ref": "3792" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.request" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3799" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/alpha/graders/run", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.Graders.runGrader", "decorators": [] }, "parameters": [ { "$id": "8767", "kind": "method", "name": "request", "serializedName": "request", "type": { "$ref": "3792" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.request", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8768", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1897" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8769", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1899" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Graders.runGrader.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3799" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Graders.runGrader" }, { "$id": "8770", "kind": "basic", "name": "validateGrader", "accessibility": "public", "apiVersions": [], "summary": "Validate a grader.", "operation": { "$id": "8771", "name": "validateGrader", "resourceName": "Graders", "summary": "Validate a grader.", "accessibility": "public", "parameters": [ { "$id": "8772", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1901" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.contentType" }, { "$id": "8773", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1903" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.accept" }, { "$id": "8774", "kind": "body", "name": "request", "serializedName": "request", "type": { "$ref": "3855" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.request" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3858" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/fine_tuning/alpha/graders/validate", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader", "decorators": [] }, "parameters": [ { "$id": "8775", "kind": "method", "name": "request", "serializedName": "request", "type": { "$ref": "3855" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.request", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8776", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1901" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8777", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1903" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3858" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Graders.validateGrader" } ], "parameters": [ { "$id": "8778", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8779", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8780", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Graders", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8781", "kind": "client", "name": "Evals", "namespace": "OpenAI", "methods": [ { "$id": "8782", "kind": "basic", "name": "listEvals", "accessibility": "public", "apiVersions": [], "summary": "List evaluations for a project.", "operation": { "$id": "8783", "name": "listEvals", "resourceName": "Evals", "summary": "List evaluations for a project.", "accessibility": "public", "parameters": [ { "$id": "8784", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last eval from the previous pagination request.", "type": { "$id": "8785", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.after", "readOnly": false }, { "$id": "8786", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of evals to be returned in a single pagination response.", "type": { "$id": "8787", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.limit", "readOnly": false }, { "$id": "8788", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order for evals by timestamp. Use `asc` for ascending order or\n`desc` for descending order.", "type": { "$ref": "1360" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.order", "readOnly": false }, { "$id": "8789", "kind": "query", "name": "order_by", "serializedName": "order_by", "doc": "Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated\ntime.", "type": { "$ref": "1364" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.order_by", "readOnly": false }, { "$id": "8790", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1905" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3861" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.listEvals", "decorators": [] }, "parameters": [ { "$id": "8791", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last eval from the previous pagination request.", "type": { "$id": "8792", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8793", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of evals to be returned in a single pagination response.", "type": { "$id": "8794", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8795", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order for evals by timestamp. Use `asc` for ascending order or\n`desc` for descending order.", "type": { "$ref": "1360" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8796", "kind": "method", "name": "order_by", "serializedName": "order_by", "doc": "Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated\ntime.", "type": { "$ref": "1364" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.order_by", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8797", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1905" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.listEvals.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3861" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.listEvals" }, { "$id": "8798", "kind": "basic", "name": "createEval", "accessibility": "public", "apiVersions": [], "doc": "Create the structure of an evaluation that can be used to test a model's\nperformance.\n\nAn evaluation is a set of testing criteria and a datasource. After\ncreating an evaluation, you can run it on different models and model\nparameters. We support several types of graders and datasources.\n\nFor more information, see the [Evals guide](/docs/guides/evals).", "operation": { "$id": "8799", "name": "createEval", "resourceName": "Evals", "doc": "Create the structure of an evaluation that can be used to test a model's\nperformance.\n\nAn evaluation is a set of testing criteria and a datasource. After\ncreating an evaluation, you can run it on different models and model\nparameters. We support several types of graders and datasources.\n\nFor more information, see the [Evals guide](/docs/guides/evals).", "accessibility": "public", "parameters": [ { "$id": "8800", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1907" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.createEval.contentType" }, { "$id": "8801", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1909" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.createEval.accept" }, { "$id": "8802", "kind": "body", "name": "body", "serializedName": "body", "type": { "$ref": "3953" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.createEval.body" } ], "responses": [ { "statusCodes": [ 201 ], "bodyType": { "$ref": "3865" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/evals", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.createEval", "decorators": [] }, "parameters": [ { "$id": "8803", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "3953" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.createEval.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8804", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1907" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.createEval.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8805", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1909" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.createEval.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3865" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.createEval" }, { "$id": "8806", "kind": "basic", "name": "getEval", "accessibility": "public", "apiVersions": [], "summary": "Retrieve an evaluation by its ID.", "operation": { "$id": "8807", "name": "getEval", "resourceName": "Evals", "summary": "Retrieve an evaluation by its ID.", "accessibility": "public", "parameters": [ { "$id": "8808", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "type": { "$id": "8809", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEval.eval_id" }, { "$id": "8810", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1911" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEval.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3865" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals/{eval_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEval", "decorators": [] }, "parameters": [ { "$id": "8811", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "type": { "$id": "8812", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEval.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8813", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1911" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.getEval.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3865" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEval" }, { "$id": "8814", "kind": "basic", "name": "updateEval", "accessibility": "public", "apiVersions": [], "doc": "Update select, mutable properties of a specified evaluation.", "operation": { "$id": "8815", "name": "updateEval", "resourceName": "Evals", "doc": "Update select, mutable properties of a specified evaluation.", "accessibility": "public", "parameters": [ { "$id": "8816", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to update.", "type": { "$id": "8817", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.eval_id" }, { "$id": "8818", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1913" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.contentType" }, { "$id": "8819", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1915" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.accept" }, { "$id": "8820", "kind": "body", "name": "body", "serializedName": "body", "type": { "$ref": "4033" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "3865" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/evals/{eval_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.updateEval", "decorators": [] }, "parameters": [ { "$id": "8821", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to update.", "type": { "$id": "8822", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8823", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "4033" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8824", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1913" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8825", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1915" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.updateEval.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "3865" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.updateEval" }, { "$id": "8826", "kind": "basic", "name": "deleteEval", "accessibility": "public", "apiVersions": [], "doc": "Delete a specified evaluation.", "operation": { "$id": "8827", "name": "deleteEval", "resourceName": "Evals", "doc": "Delete a specified evaluation.", "accessibility": "public", "parameters": [ { "$id": "8828", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to delete.", "type": { "$id": "8829", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval.eval_id" }, { "$id": "8830", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1917" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4039" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/evals/{eval_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval", "decorators": [] }, "parameters": [ { "$id": "8831", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to delete.", "type": { "$id": "8832", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8833", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1917" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4039" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEval" }, { "$id": "8834", "kind": "basic", "name": "getEvalRuns", "accessibility": "public", "apiVersions": [], "doc": "Retrieve a list of runs for a specified evaluation.", "summary": "", "operation": { "$id": "8835", "name": "getEvalRuns", "resourceName": "Evals", "summary": "", "doc": "Retrieve a list of runs for a specified evaluation.", "accessibility": "public", "parameters": [ { "$id": "8836", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to retrieve runs for.", "type": { "$id": "8837", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.eval_id" }, { "$id": "8838", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last run from the previous pagination request.", "type": { "$id": "8839", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.after", "readOnly": false }, { "$id": "8840", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of runs to be returned in a single pagination response.", "type": { "$id": "8841", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.limit", "readOnly": false }, { "$id": "8842", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$ref": "1368" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.order", "readOnly": false }, { "$id": "8843", "kind": "query", "name": "status", "serializedName": "status", "doc": "Filter runs by their status. Possible values are `queued`, `in_progress`, `completed`, `canceled`, and `failed`.", "type": { "$ref": "1372" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.status", "readOnly": false }, { "$id": "8844", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1919" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4045" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns", "decorators": [] }, "parameters": [ { "$id": "8845", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to retrieve runs for.", "type": { "$id": "8846", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8847", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last run from the previous pagination request.", "type": { "$id": "8848", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8849", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of runs to be returned in a single pagination response.", "type": { "$id": "8850", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8851", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$ref": "1368" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8852", "kind": "method", "name": "status", "serializedName": "status", "doc": "Filter runs by their status. Possible values are `queued`, `in_progress`, `completed`, `canceled`, and `failed`.", "type": { "$ref": "1372" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.status", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8853", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1919" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4045" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRuns" }, { "$id": "8854", "kind": "basic", "name": "createEvalRun", "accessibility": "public", "apiVersions": [], "doc": "Create a new evaluation run, beginning the grading process.", "operation": { "$id": "8855", "name": "createEvalRun", "resourceName": "Evals", "doc": "Create a new evaluation run, beginning the grading process.", "accessibility": "public", "parameters": [ { "$id": "8856", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to run.", "type": { "$id": "8857", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.eval_id" }, { "$id": "8858", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1921" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.contentType" }, { "$id": "8859", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1923" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.accept" }, { "$id": "8860", "kind": "body", "name": "body", "serializedName": "body", "type": { "$ref": "4116" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.body" } ], "responses": [ { "statusCodes": [ 201 ], "bodyType": { "$ref": "4049" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun", "decorators": [] }, "parameters": [ { "$id": "8861", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation to run.", "type": { "$id": "8862", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8863", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "4116" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8864", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1921" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8865", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1923" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4049" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.createEvalRun" }, { "$id": "8866", "kind": "basic", "name": "getEvalRun", "accessibility": "public", "apiVersions": [], "doc": "Retrieve a specific evaluation run by its ID.", "operation": { "$id": "8867", "name": "getEvalRun", "resourceName": "Evals", "doc": "Retrieve a specific evaluation run by its ID.", "accessibility": "public", "parameters": [ { "$id": "8868", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8869", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.eval_id" }, { "$id": "8870", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to retrieve.", "type": { "$id": "8871", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.run_id" }, { "$id": "8872", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1925" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4049" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs/{run_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun", "decorators": [] }, "parameters": [ { "$id": "8873", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8874", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8875", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to retrieve.", "type": { "$id": "8876", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8877", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1925" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4049" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRun" }, { "$id": "8878", "kind": "basic", "name": "cancelEvalRun", "accessibility": "public", "apiVersions": [], "doc": "Cancel a specific evaluation run by its ID.", "operation": { "$id": "8879", "name": "cancelEvalRun", "resourceName": "Evals", "doc": "Cancel a specific evaluation run by its ID.", "accessibility": "public", "parameters": [ { "$id": "8880", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8881", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.eval_id" }, { "$id": "8882", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to cancel.", "type": { "$id": "8883", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.run_id" }, { "$id": "8884", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1927" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4049" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs/{run_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun", "decorators": [] }, "parameters": [ { "$id": "8885", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8886", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8887", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to cancel.", "type": { "$id": "8888", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8889", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1927" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4049" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.cancelEvalRun" }, { "$id": "8890", "kind": "basic", "name": "deleteEvalRun", "accessibility": "public", "apiVersions": [], "doc": "Delete a specific evaluation run by its ID.", "operation": { "$id": "8891", "name": "deleteEvalRun", "resourceName": "Evals", "doc": "Delete a specific evaluation run by its ID.", "accessibility": "public", "parameters": [ { "$id": "8892", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8893", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.eval_id" }, { "$id": "8894", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to delete.", "type": { "$id": "8895", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.run_id" }, { "$id": "8896", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1929" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4491" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs/{run_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun", "decorators": [] }, "parameters": [ { "$id": "8897", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8898", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8899", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to delete.", "type": { "$id": "8900", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8901", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1929" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4491" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.deleteEvalRun" }, { "$id": "8902", "kind": "basic", "name": "getEvalRunOutputItems", "accessibility": "public", "apiVersions": [], "doc": "Get a list of output items for a specified evaluation run.", "operation": { "$id": "8903", "name": "getEvalRunOutputItems", "resourceName": "Evals", "doc": "Get a list of output items for a specified evaluation run.", "accessibility": "public", "parameters": [ { "$id": "8904", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8905", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.eval_id" }, { "$id": "8906", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to retrieve output items for.", "type": { "$id": "8907", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.run_id" }, { "$id": "8908", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last output item from the previous pagination request.", "type": { "$id": "8909", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.after", "readOnly": false }, { "$id": "8910", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of output items to be returned in a single pagination response.", "type": { "$id": "8911", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.limit", "readOnly": false }, { "$id": "8912", "kind": "query", "name": "status", "serializedName": "status", "doc": "Filter output items by their status. Possible values are `fail` and `pass`.", "type": { "$ref": "1379" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.status", "readOnly": false }, { "$id": "8913", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$ref": "1383" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.order", "readOnly": false }, { "$id": "8914", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1931" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4497" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs/{run_id}/output_items", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems", "decorators": [] }, "parameters": [ { "$id": "8915", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8916", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8917", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run to retrieve output items for.", "type": { "$id": "8918", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8919", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last output item from the previous pagination request.", "type": { "$id": "8920", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8921", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of output items to be returned in a single pagination response.", "type": { "$id": "8922", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8923", "kind": "method", "name": "status", "serializedName": "status", "doc": "Filter output items by their status. Possible values are `fail` and `pass`.", "type": { "$ref": "1379" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.status", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8924", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$ref": "1383" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8925", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1931" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4497" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItems" }, { "$id": "8926", "kind": "basic", "name": "getEvalRunOutputItem", "accessibility": "public", "apiVersions": [], "doc": "Retrieve a specific output item from an evaluation run by its ID.", "operation": { "$id": "8927", "name": "getEvalRunOutputItem", "resourceName": "Evals", "doc": "Retrieve a specific output item from an evaluation run by its ID.", "accessibility": "public", "parameters": [ { "$id": "8928", "kind": "path", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8929", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.eval_id" }, { "$id": "8930", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run the output item belongs to.", "type": { "$id": "8931", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.run_id" }, { "$id": "8932", "kind": "path", "name": "output_item_id", "serializedName": "output_item_id", "doc": "The ID of the output item to retrieve.", "type": { "$id": "8933", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.output_item_id" }, { "$id": "8934", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1933" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "4501" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem", "decorators": [] }, "parameters": [ { "$id": "8935", "kind": "method", "name": "eval_id", "serializedName": "eval_id", "doc": "The ID of the evaluation the run belongs to.", "type": { "$id": "8936", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.eval_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8937", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the evaluation run the output item belongs to.", "type": { "$id": "8938", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8939", "kind": "method", "name": "output_item_id", "serializedName": "output_item_id", "doc": "The ID of the output item to retrieve.", "type": { "$id": "8940", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.output_item_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8941", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1933" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "4501" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Evals.getEvalRunOutputItem" } ], "parameters": [ { "$id": "8942", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "8943", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "8944", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Evals", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "8945", "kind": "client", "name": "Responses", "namespace": "OpenAI", "methods": [ { "$id": "8946", "kind": "basic", "name": "createResponse", "accessibility": "public", "apiVersions": [], "doc": "Creates a model response.", "operation": { "$id": "8947", "name": "createResponse", "resourceName": "Responses", "doc": "Creates a model response.", "accessibility": "public", "parameters": [ { "$id": "8948", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.accept" }, { "$id": "8949", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1935" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.contentType" }, { "$id": "8950", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "4564" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8951", "kind": "union", "name": "", "variantTypes": [ { "$ref": "5114" }, { "$ref": "5308" } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "Content-Type", "type": { "$ref": "1937" } } ], "isErrorResponse": false, "contentTypes": [ "application/json", "text/event-stream" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/responses", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Responses.createResponse", "decorators": [] }, "parameters": [ { "$id": "8952", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8953", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "4564" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8954", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1935" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Responses.createResponse.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8951" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Responses.createResponse" }, { "$id": "8955", "kind": "basic", "name": "getResponse", "accessibility": "public", "apiVersions": [], "doc": "Retrieves a model response with the given ID.", "operation": { "$id": "8956", "name": "getResponse", "resourceName": "Responses", "doc": "Retrieves a model response with the given ID.", "accessibility": "public", "parameters": [ { "$id": "8957", "kind": "path", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to retrieve.", "type": { "$id": "8958", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.response_id" }, { "$id": "8959", "kind": "query", "name": "include", "serializedName": "include[]", "doc": "Specifies additional output data to include in the model response.", "type": { "$ref": "5100" }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.include", "readOnly": false }, { "$id": "8960", "kind": "query", "name": "stream", "serializedName": "stream", "doc": "If set to true, model response data will be streamed to the client as it is generated using server-sent events.", "type": { "$id": "8961", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.stream", "readOnly": false }, { "$id": "8962", "kind": "query", "name": "starting_after", "serializedName": "starting_after", "doc": "The sequence number of the event after which to start streaming.", "type": { "$id": "8963", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.starting_after", "readOnly": false }, { "$id": "8964", "kind": "query", "name": "include_obfuscation", "serializedName": "include_obfuscation", "type": { "$id": "8965", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.include_obfuscation", "readOnly": false }, { "$id": "8966", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$id": "8967", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "8968", "kind": "union", "name": "", "variantTypes": [ { "$ref": "5114" }, { "$ref": "5308" } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "Content-Type", "type": { "$ref": "1939" } } ], "isErrorResponse": false, "contentTypes": [ "application/json", "text/event-stream" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/responses/{response_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Responses.getResponse", "decorators": [] }, "parameters": [ { "$id": "8969", "kind": "method", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to retrieve.", "type": { "$id": "8970", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.response_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8971", "kind": "method", "name": "include", "serializedName": "include[]", "doc": "Specifies additional output data to include in the model response.", "type": { "$ref": "5100" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.include", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8972", "kind": "method", "name": "stream", "serializedName": "stream", "doc": "If set to true, model response data will be streamed to the client as it is generated using server-sent events.", "type": { "$id": "8973", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.stream", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8974", "kind": "method", "name": "starting_after", "serializedName": "starting_after", "doc": "The sequence number of the event after which to start streaming.", "type": { "$id": "8975", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.starting_after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8976", "kind": "method", "name": "include_obfuscation", "serializedName": "include_obfuscation", "type": { "$id": "8977", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.include_obfuscation", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8978", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "8967" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.getResponse.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "8968" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Responses.getResponse" }, { "$id": "8979", "kind": "basic", "name": "deleteResponse", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8980", "name": "deleteResponse", "resourceName": "Responses", "accessibility": "public", "parameters": [ { "$id": "8981", "kind": "path", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to delete.", "type": { "$id": "8982", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse.response_id" }, { "$id": "8983", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1941" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5794" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/responses/{response_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse", "decorators": [] }, "parameters": [ { "$id": "8984", "kind": "method", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to delete.", "type": { "$id": "8985", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse.response_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8986", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1941" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5794" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Responses.deleteResponse" }, { "$id": "8987", "kind": "basic", "name": "cancelResponse", "accessibility": "public", "apiVersions": [], "operation": { "$id": "8988", "name": "cancelResponse", "resourceName": "Responses", "accessibility": "public", "parameters": [ { "$id": "8989", "kind": "path", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to cancel.", "type": { "$id": "8990", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse.response_id" }, { "$id": "8991", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1943" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5114" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/responses/{response_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse", "decorators": [] }, "parameters": [ { "$id": "8992", "kind": "method", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to cancel.", "type": { "$id": "8993", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse.response_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "8994", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1943" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5114" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Responses.cancelResponse" }, { "$id": "8995", "kind": "paging", "name": "GetResponseInputItems", "accessibility": "public", "apiVersions": [], "doc": "Returns a list of input items for a given response.", "operation": { "$id": "8996", "name": "GetResponseInputItems", "resourceName": "Responses", "doc": "Returns a list of input items for a given response.", "accessibility": "public", "parameters": [ { "$id": "8997", "kind": "path", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to retrieve.", "type": { "$id": "8998", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.response_id" }, { "$id": "8999", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9000", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.limit", "readOnly": false }, { "$id": "9001", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.order", "readOnly": false }, { "$id": "9002", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9003", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.after", "readOnly": false }, { "$id": "9004", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9005", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.before", "readOnly": false }, { "$id": "9006", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1945" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5800" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/responses/{response_id}/input_items", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems", "decorators": [] }, "parameters": [ { "$id": "9007", "kind": "method", "name": "response_id", "serializedName": "response_id", "doc": "The ID of the response to retrieve.", "type": { "$id": "9008", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.response_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9009", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9010", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9011", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9012", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9013", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9014", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9015", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.before", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9016", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1945" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5161" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Responses.listInputItems", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9002" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } } ], "parameters": [ { "$id": "9017", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9018", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9019", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Responses", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9020", "kind": "client", "name": "Images", "namespace": "OpenAI", "methods": [ { "$id": "9021", "kind": "basic", "name": "GenerateImages", "accessibility": "public", "apiVersions": [], "summary": "Creates an image given a prompt", "operation": { "$id": "9022", "name": "GenerateImages", "resourceName": "Images", "summary": "Creates an image given a prompt", "accessibility": "public", "parameters": [ { "$id": "9023", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1947" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImage.accept" }, { "$id": "9024", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1949" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImage.contentType" }, { "$id": "9025", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5809" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Images.createImage.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5836" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/images/generations", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Images.createImage", "decorators": [] }, "parameters": [ { "$id": "9026", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1951" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImage.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9027", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5809" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Images.createImage.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9028", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1949" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImage.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5836" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Images.createImage" }, { "$id": "9029", "kind": "basic", "name": "GenerateImageEdits", "accessibility": "public", "apiVersions": [], "summary": "Creates an edited or extended image given an original image and a prompt.", "operation": { "$id": "9030", "name": "GenerateImageEdits", "resourceName": "Images", "summary": "Creates an edited or extended image given an original image and a prompt.", "accessibility": "public", "parameters": [ { "$id": "9031", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1953" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.accept" }, { "$id": "9032", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1955" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.contentType" }, { "$id": "9033", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5863" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5836" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/images/edits", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit", "decorators": [] }, "parameters": [ { "$id": "9034", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1957" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9035", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1959" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9036", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5863" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5836" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Images.createImageEdit" }, { "$id": "9037", "kind": "basic", "name": "GenerateImageVariations", "accessibility": "public", "apiVersions": [], "summary": "Creates an edited or extended image given an original image and a prompt.", "operation": { "$id": "9038", "name": "GenerateImageVariations", "resourceName": "Images", "summary": "Creates an edited or extended image given an original image and a prompt.", "accessibility": "public", "parameters": [ { "$id": "9039", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1961" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.accept" }, { "$id": "9040", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1963" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.contentType" }, { "$id": "9041", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5889" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5836" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/images/variations", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation", "decorators": [] }, "parameters": [ { "$id": "9042", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1965" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9043", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "1967" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9044", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5889" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5836" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Images.createImageVariation" } ], "parameters": [ { "$id": "9045", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9046", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9047", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Images", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9048", "kind": "client", "name": "Messages", "namespace": "OpenAI", "methods": [ { "$id": "9049", "kind": "basic", "name": "createMessage", "accessibility": "public", "apiVersions": [], "summary": "Create a message.", "operation": { "$id": "9050", "name": "createMessage", "resourceName": "Messages", "summary": "Create a message.", "accessibility": "public", "parameters": [ { "$id": "9051", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1969" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.accept" }, { "$id": "9052", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1971" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.openAIBeta" }, { "$id": "9053", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to create a message for.", "type": { "$id": "9054", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.thread_id" }, { "$id": "9055", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1973" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.contentType" }, { "$id": "9056", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5904" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5992" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/messages", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Messages.createMessage", "decorators": [] }, "parameters": [ { "$id": "9057", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1975" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9058", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1977" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9059", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to create a message for.", "type": { "$id": "9060", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9061", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "5904" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9062", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1973" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.createMessage.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5992" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Messages.createMessage" }, { "$id": "9063", "kind": "paging", "name": "listMessages", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of messages for a given thread.", "operation": { "$id": "9064", "name": "listMessages", "resourceName": "Messages", "summary": "Returns a list of messages for a given thread.", "accessibility": "public", "parameters": [ { "$id": "9065", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1979" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.accept" }, { "$id": "9066", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1981" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.openAIBeta" }, { "$id": "9067", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) the messages belong to.", "type": { "$id": "9068", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.thread_id" }, { "$id": "9069", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9070", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.limit", "readOnly": false }, { "$id": "9071", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.order", "readOnly": false }, { "$id": "9072", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9073", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.after", "readOnly": false }, { "$id": "9074", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9075", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.before", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6032" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/messages", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Messages.listMessages", "decorators": [] }, "parameters": [ { "$id": "9076", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1983" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9077", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1985" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9078", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) the messages belong to.", "type": { "$id": "9079", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9080", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9081", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9082", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9083", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9084", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9085", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9086", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.listMessages.before", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6035" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Messages.listMessages", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9072" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9087", "kind": "basic", "name": "getMessage", "accessibility": "public", "apiVersions": [], "summary": "Retrieve a message.", "operation": { "$id": "9088", "name": "getMessage", "resourceName": "Messages", "summary": "Retrieve a message.", "accessibility": "public", "parameters": [ { "$id": "9089", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1987" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.accept" }, { "$id": "9090", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1989" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.openAIBeta" }, { "$id": "9091", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs.", "type": { "$id": "9092", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.thread_id" }, { "$id": "9093", "kind": "path", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to retrieve.", "type": { "$id": "9094", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.message_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5992" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/messages/{message_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Messages.getMessage", "decorators": [] }, "parameters": [ { "$id": "9095", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1991" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9096", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1993" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9097", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs.", "type": { "$id": "9098", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9099", "kind": "method", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to retrieve.", "type": { "$id": "9100", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.getMessage.message_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5992" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Messages.getMessage" }, { "$id": "9101", "kind": "basic", "name": "modifyMessage", "accessibility": "public", "apiVersions": [], "summary": "Modifies a message.", "operation": { "$id": "9102", "name": "modifyMessage", "resourceName": "Messages", "summary": "Modifies a message.", "accessibility": "public", "parameters": [ { "$id": "9103", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1995" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.accept" }, { "$id": "9104", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "1997" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.openAIBeta" }, { "$id": "9105", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this message belongs.", "type": { "$id": "9106", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.thread_id" }, { "$id": "9107", "kind": "path", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to modify.", "type": { "$id": "9108", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.message_id" }, { "$id": "9109", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1999" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.contentType" }, { "$id": "9110", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6042" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5992" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/messages/{message_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage", "decorators": [] }, "parameters": [ { "$id": "9111", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2001" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9112", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2003" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9113", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this message belongs.", "type": { "$id": "9114", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9115", "kind": "method", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to modify.", "type": { "$id": "9116", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.message_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9117", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6042" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9118", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "1999" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5992" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Messages.modifyMessage" }, { "$id": "9119", "kind": "basic", "name": "deleteMessage", "accessibility": "public", "apiVersions": [], "summary": "Deletes a message.", "operation": { "$id": "9120", "name": "deleteMessage", "resourceName": "Messages", "summary": "Deletes a message.", "accessibility": "public", "parameters": [ { "$id": "9121", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2005" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.accept" }, { "$id": "9122", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2007" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.openAIBeta" }, { "$id": "9123", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this message belongs.", "type": { "$id": "9124", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.thread_id" }, { "$id": "9125", "kind": "path", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to delete.", "type": { "$id": "9126", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.message_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6044" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/threads/{thread_id}/messages/{message_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage", "decorators": [] }, "parameters": [ { "$id": "9127", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2009" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9128", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2011" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9129", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this message belongs.", "type": { "$id": "9130", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9131", "kind": "method", "name": "message_id", "serializedName": "message_id", "doc": "The ID of the message to delete.", "type": { "$id": "9132", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage.message_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6044" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Messages.deleteMessage" } ], "parameters": [ { "$id": "9133", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9134", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9135", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Messages", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9136", "kind": "client", "name": "Moderations", "namespace": "OpenAI", "methods": [ { "$id": "9137", "kind": "basic", "name": "ClassifyText", "accessibility": "public", "apiVersions": [], "summary": "Classifies if text is potentially harmful.", "operation": { "$id": "9138", "name": "ClassifyText", "resourceName": "Moderations", "summary": "Classifies if text is potentially harmful.", "accessibility": "public", "parameters": [ { "$id": "9139", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2013" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.accept" }, { "$id": "9140", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2015" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.contentType" }, { "$id": "9141", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6050" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6067" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/moderations", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration", "decorators": [] }, "parameters": [ { "$id": "9142", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2017" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9143", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6050" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9144", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2015" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6067" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Moderations.createModeration" } ], "parameters": [ { "$id": "9145", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9146", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9147", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Moderations", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9148", "kind": "client", "name": "Runs", "namespace": "OpenAI", "methods": [ { "$id": "9149", "kind": "basic", "name": "createThreadAndRun", "accessibility": "public", "apiVersions": [], "summary": "Create a thread and run it in one request.", "operation": { "$id": "9150", "name": "createThreadAndRun", "resourceName": "Runs", "summary": "Create a thread and run it in one request.", "accessibility": "public", "parameters": [ { "$id": "9151", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.accept" }, { "$id": "9152", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2019" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.openAIBeta" }, { "$id": "9153", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2021" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.contentType" }, { "$id": "9154", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6167" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/runs", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun", "decorators": [] }, "parameters": [ { "$id": "9155", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9156", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2023" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9157", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6167" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9158", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2021" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.createThreadAndRun" }, { "$id": "9159", "kind": "basic", "name": "createRun", "accessibility": "public", "apiVersions": [], "summary": "Create a run.", "operation": { "$id": "9160", "name": "createRun", "resourceName": "Runs", "summary": "Create a run.", "accessibility": "public", "parameters": [ { "$id": "9161", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createRun.accept" }, { "$id": "9162", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2025" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createRun.openAIBeta" }, { "$id": "9163", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to run.", "type": { "$id": "9164", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.createRun.thread_id" }, { "$id": "9165", "kind": "query", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$id": "9166", "kind": "array", "name": "ArrayIncludedRunStepProperty", "valueType": { "$ref": "1391" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "isApiVersion": false, "explode": false, "arraySerializationDelimiter": ",", "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createRun.include[]", "readOnly": false }, { "$id": "9167", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2027" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.createRun.contentType" }, { "$id": "9168", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6329" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.createRun.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.createRun", "decorators": [] }, "parameters": [ { "$id": "9169", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9170", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2029" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9171", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to run.", "type": { "$id": "9172", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9173", "kind": "method", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$ref": "9166" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.include[]", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9174", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6329" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9175", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2027" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.createRun.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.createRun" }, { "$id": "9176", "kind": "paging", "name": "listRuns", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of runs belonging to a thread.", "operation": { "$id": "9177", "name": "listRuns", "resourceName": "Runs", "summary": "Returns a list of runs belonging to a thread.", "accessibility": "public", "parameters": [ { "$id": "9178", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2031" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.accept" }, { "$id": "9179", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2033" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.openAIBeta" }, { "$id": "9180", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread the run belongs to.", "type": { "$id": "9181", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.thread_id" }, { "$id": "9182", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9183", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.limit", "readOnly": false }, { "$id": "9184", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.order", "readOnly": false }, { "$id": "9185", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9186", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.after", "readOnly": false }, { "$id": "9187", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9188", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.before", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6371" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.listRuns", "decorators": [] }, "parameters": [ { "$id": "9189", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2035" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9190", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2037" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9191", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread the run belongs to.", "type": { "$id": "9192", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9193", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9194", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9195", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9196", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9197", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9198", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9199", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRuns.before", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6374" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.listRuns", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9185" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9200", "kind": "basic", "name": "getRun", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a run.", "operation": { "$id": "9201", "name": "getRun", "resourceName": "Runs", "summary": "Retrieves a run.", "accessibility": "public", "parameters": [ { "$id": "9202", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2039" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.getRun.accept" }, { "$id": "9203", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2041" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.getRun.openAIBeta" }, { "$id": "9204", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "$id": "9205", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.getRun.thread_id" }, { "$id": "9206", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to retrieve.", "type": { "$id": "9207", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.getRun.run_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.getRun", "decorators": [] }, "parameters": [ { "$id": "9208", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2043" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.getRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9209", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2045" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.getRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9210", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "$id": "9211", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRun.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9212", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to retrieve.", "type": { "$id": "9213", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRun.run_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.getRun" }, { "$id": "9214", "kind": "basic", "name": "modifyRun", "accessibility": "public", "apiVersions": [], "summary": "Modifies a run.", "operation": { "$id": "9215", "name": "modifyRun", "resourceName": "Runs", "summary": "Modifies a run.", "accessibility": "public", "parameters": [ { "$id": "9216", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2047" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.accept" }, { "$id": "9217", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2049" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.openAIBeta" }, { "$id": "9218", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "$id": "9219", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.thread_id" }, { "$id": "9220", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to modify.", "type": { "$id": "9221", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.run_id" }, { "$id": "9222", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2051" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.contentType" }, { "$id": "9223", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6381" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun", "decorators": [] }, "parameters": [ { "$id": "9224", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2053" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9225", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2055" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9226", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) that was run.", "type": { "$id": "9227", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9228", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to modify.", "type": { "$id": "9229", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9230", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6381" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9231", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2051" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.modifyRun" }, { "$id": "9232", "kind": "basic", "name": "cancelRun", "accessibility": "public", "apiVersions": [], "summary": "Cancels a run that is `in_progress`.", "operation": { "$id": "9233", "name": "cancelRun", "resourceName": "Runs", "summary": "Cancels a run that is `in_progress`.", "accessibility": "public", "parameters": [ { "$id": "9234", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2057" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.accept" }, { "$id": "9235", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2059" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.openAIBeta" }, { "$id": "9236", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this run belongs.", "type": { "$id": "9237", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.thread_id" }, { "$id": "9238", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to cancel.", "type": { "$id": "9239", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.run_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun", "decorators": [] }, "parameters": [ { "$id": "9240", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2061" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9241", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2063" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9242", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which this run belongs.", "type": { "$id": "9243", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9244", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to cancel.", "type": { "$id": "9245", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun.run_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.cancelRun" }, { "$id": "9246", "kind": "basic", "name": "submitToolOutputsToRun", "accessibility": "public", "apiVersions": [], "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is\n`submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once\nthey're all completed. All outputs must be submitted in a single request.", "operation": { "$id": "9247", "name": "submitToolOutputsToRun", "resourceName": "Runs", "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is\n`submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once\nthey're all completed. All outputs must be submitted in a single request.", "accessibility": "public", "parameters": [ { "$id": "9248", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.accept" }, { "$id": "9249", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2065" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.openAIBeta" }, { "$id": "9250", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs.", "type": { "$id": "9251", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.thread_id" }, { "$id": "9252", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run that requires the tool output submission.", "type": { "$id": "9253", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.run_id" }, { "$id": "9254", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2067" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.contentType" }, { "$id": "9255", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6383" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6233" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun", "decorators": [] }, "parameters": [ { "$id": "9256", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "1350" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9257", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2069" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9258", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs.", "type": { "$id": "9259", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9260", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run that requires the tool output submission.", "type": { "$id": "9261", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9262", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6383" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9263", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2067" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6233" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.submitToolOutputsToRun" }, { "$id": "9264", "kind": "paging", "name": "listRunSteps", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of run steps belonging to a run.", "operation": { "$id": "9265", "name": "listRunSteps", "resourceName": "Runs", "summary": "Returns a list of run steps belonging to a run.", "accessibility": "public", "parameters": [ { "$id": "9266", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2071" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.accept" }, { "$id": "9267", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2073" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.openAIBeta" }, { "$id": "9268", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread the run and run steps belong to.", "type": { "$id": "9269", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.thread_id" }, { "$id": "9270", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run the run steps belong to.", "type": { "$id": "9271", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.run_id" }, { "$id": "9272", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9273", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.limit", "readOnly": false }, { "$id": "9274", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.order", "readOnly": false }, { "$id": "9275", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9276", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.after", "readOnly": false }, { "$id": "9277", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9278", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.before", "readOnly": false }, { "$id": "9279", "kind": "query", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$ref": "9166" }, "isApiVersion": false, "explode": false, "arraySerializationDelimiter": ",", "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.include[]", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6394" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}/steps", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps", "decorators": [] }, "parameters": [ { "$id": "9280", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2075" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9281", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2077" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9282", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread the run and run steps belong to.", "type": { "$id": "9283", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9284", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run the run steps belong to.", "type": { "$id": "9285", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9286", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9287", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9288", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9289", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9290", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9291", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9292", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.before", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9293", "kind": "method", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$ref": "9166" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps.include[]", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6397" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.listRunSteps", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9275" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9294", "kind": "basic", "name": "getRunStep", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a run step.", "operation": { "$id": "9295", "name": "getRunStep", "resourceName": "Runs", "summary": "Retrieves a run step.", "accessibility": "public", "parameters": [ { "$id": "9296", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2079" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.accept" }, { "$id": "9297", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2081" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.openAIBeta" }, { "$id": "9298", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which the run and run step belongs.", "type": { "$id": "9299", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.thread_id" }, { "$id": "9300", "kind": "path", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to which the run step belongs.", "type": { "$id": "9301", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.run_id" }, { "$id": "9302", "kind": "path", "name": "step_id", "serializedName": "step_id", "doc": "The ID of the run step to retrieve.", "type": { "$id": "9303", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.step_id" }, { "$id": "9304", "kind": "query", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$ref": "9166" }, "isApiVersion": false, "explode": false, "arraySerializationDelimiter": ",", "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.include[]", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6398" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}/runs/{run_id}/steps/{step_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep", "decorators": [] }, "parameters": [ { "$id": "9305", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2083" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9306", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2085" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9307", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to which the run and run step belongs.", "type": { "$id": "9308", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9309", "kind": "method", "name": "run_id", "serializedName": "run_id", "doc": "The ID of the run to which the run step belongs.", "type": { "$id": "9310", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.run_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9311", "kind": "method", "name": "step_id", "serializedName": "step_id", "doc": "The ID of the run step to retrieve.", "type": { "$id": "9312", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.step_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9313", "kind": "method", "name": "include[]", "serializedName": "include[]", "doc": "A list of additional fields to include in the response. Currently the only supported value is\n`step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result\ncontent.\n\nSee the\n[file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings)\nfor more information.", "type": { "$ref": "9166" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep.include[]", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6398" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Runs.getRunStep" } ], "parameters": [ { "$id": "9314", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9315", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9316", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Runs", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9317", "kind": "client", "name": "Threads", "namespace": "OpenAI", "methods": [ { "$id": "9318", "kind": "basic", "name": "createThread", "accessibility": "public", "apiVersions": [], "summary": "Create a thread.", "operation": { "$id": "9319", "name": "createThread", "resourceName": "Threads", "summary": "Create a thread.", "accessibility": "public", "parameters": [ { "$id": "9320", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2087" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.createThread.accept" }, { "$id": "9321", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2089" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.createThread.openAIBeta" }, { "$id": "9322", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2091" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.createThread.contentType" }, { "$id": "9323", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6171" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Threads.createThread.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6547" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Threads.createThread", "decorators": [] }, "parameters": [ { "$id": "9324", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2093" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.createThread.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9325", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2095" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.createThread.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9326", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6171" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Threads.createThread.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9327", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2091" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.createThread.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6547" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Threads.createThread" }, { "$id": "9328", "kind": "basic", "name": "getThread", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a thread.", "operation": { "$id": "9329", "name": "getThread", "resourceName": "Threads", "summary": "Retrieves a thread.", "accessibility": "public", "parameters": [ { "$id": "9330", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2097" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.getThread.accept" }, { "$id": "9331", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2099" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.getThread.openAIBeta" }, { "$id": "9332", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to retrieve.", "type": { "$id": "9333", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Threads.getThread.thread_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6547" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/threads/{thread_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Threads.getThread", "decorators": [] }, "parameters": [ { "$id": "9334", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2101" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.getThread.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9335", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2103" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.getThread.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9336", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to retrieve.", "type": { "$id": "9337", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Threads.getThread.thread_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6547" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Threads.getThread" }, { "$id": "9338", "kind": "basic", "name": "modifyThread", "accessibility": "public", "apiVersions": [], "summary": "Modifies a thread.", "operation": { "$id": "9339", "name": "modifyThread", "resourceName": "Threads", "summary": "Modifies a thread.", "accessibility": "public", "parameters": [ { "$id": "9340", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2105" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.accept" }, { "$id": "9341", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2107" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.openAIBeta" }, { "$id": "9342", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to modify. Only the `metadata` can be modified.", "type": { "$id": "9343", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.thread_id" }, { "$id": "9344", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2109" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.contentType" }, { "$id": "9345", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6564" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6547" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/threads/{thread_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread", "decorators": [] }, "parameters": [ { "$id": "9346", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2111" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9347", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2113" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9348", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to modify. Only the `metadata` can be modified.", "type": { "$id": "9349", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.thread_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9350", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6564" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9351", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2109" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6547" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Threads.modifyThread" }, { "$id": "9352", "kind": "basic", "name": "deleteThread", "accessibility": "public", "apiVersions": [], "summary": "Delete a thread.", "operation": { "$id": "9353", "name": "deleteThread", "resourceName": "Threads", "summary": "Delete a thread.", "accessibility": "public", "parameters": [ { "$id": "9354", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2115" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.accept" }, { "$id": "9355", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2117" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.openAIBeta" }, { "$id": "9356", "kind": "path", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to delete.", "type": { "$id": "9357", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.thread_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6573" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/threads/{thread_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread", "decorators": [] }, "parameters": [ { "$id": "9358", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2119" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9359", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2121" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9360", "kind": "method", "name": "thread_id", "serializedName": "thread_id", "doc": "The ID of the thread to delete.", "type": { "$id": "9361", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread.thread_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6573" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Threads.deleteThread" } ], "parameters": [ { "$id": "9362", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9363", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9364", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Threads", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9365", "kind": "client", "name": "VectorStores", "namespace": "OpenAI", "methods": [ { "$id": "9366", "kind": "paging", "name": "GetVectorStores", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of vector stores.", "operation": { "$id": "9367", "name": "GetVectorStores", "resourceName": "VectorStores", "summary": "Returns a list of vector stores.", "accessibility": "public", "parameters": [ { "$id": "9368", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2123" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.accept" }, { "$id": "9369", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9370", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.limit", "readOnly": false }, { "$id": "9371", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.order", "readOnly": false }, { "$id": "9372", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9373", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.after", "readOnly": false }, { "$id": "9374", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9375", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.before", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6579" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores", "decorators": [] }, "parameters": [ { "$id": "9376", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2125" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9377", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9378", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9379", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9380", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9381", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9382", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9383", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores.before", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6582" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStores", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9372" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9384", "kind": "basic", "name": "createVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Creates a vector store.", "operation": { "$id": "9385", "name": "createVectorStore", "resourceName": "VectorStores", "summary": "Creates a vector store.", "accessibility": "public", "parameters": [ { "$id": "9386", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2127" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.accept" }, { "$id": "9387", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2129" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.contentType" }, { "$id": "9388", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6631" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6583" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore", "decorators": [] }, "parameters": [ { "$id": "9389", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2131" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9390", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6631" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9391", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2129" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6583" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStore" }, { "$id": "9392", "kind": "basic", "name": "getVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a vector store.", "operation": { "$id": "9393", "name": "getVectorStore", "resourceName": "VectorStores", "summary": "Retrieves a vector store.", "accessibility": "public", "parameters": [ { "$id": "9394", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2133" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore.accept" }, { "$id": "9395", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to retrieve.", "type": { "$id": "9396", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore.vector_store_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6583" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore", "decorators": [] }, "parameters": [ { "$id": "9397", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2135" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9398", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to retrieve.", "type": { "$id": "9399", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore.vector_store_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6583" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStore" }, { "$id": "9400", "kind": "basic", "name": "modifyVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Modifies a vector store.", "operation": { "$id": "9401", "name": "modifyVectorStore", "resourceName": "VectorStores", "summary": "Modifies a vector store.", "accessibility": "public", "parameters": [ { "$id": "9402", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2137" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.accept" }, { "$id": "9403", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to modify.", "type": { "$id": "9404", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.vector_store_id" }, { "$id": "9405", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2139" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.contentType" }, { "$id": "9406", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6639" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6583" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore", "decorators": [] }, "parameters": [ { "$id": "9407", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2141" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9408", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to modify.", "type": { "$id": "9409", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9410", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6639" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9411", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2139" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6583" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.modifyVectorStore" }, { "$id": "9412", "kind": "basic", "name": "deleteVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Delete a vector store.", "operation": { "$id": "9413", "name": "deleteVectorStore", "resourceName": "VectorStores", "summary": "Delete a vector store.", "accessibility": "public", "parameters": [ { "$id": "9414", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2143" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore.accept" }, { "$id": "9415", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to delete.", "type": { "$id": "9416", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore.vector_store_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6646" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore", "decorators": [] }, "parameters": [ { "$id": "9417", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2145" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9418", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to delete.", "type": { "$id": "9419", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore.vector_store_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6646" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStore" }, { "$id": "9420", "kind": "basic", "name": "AddFileBatchToVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Create a vector store file batch.", "operation": { "$id": "9421", "name": "AddFileBatchToVectorStore", "resourceName": "VectorStores", "summary": "Create a vector store file batch.", "accessibility": "public", "parameters": [ { "$id": "9422", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2147" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.accept" }, { "$id": "9423", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store for which to create a file batch.", "type": { "$id": "9424", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.vector_store_id" }, { "$id": "9425", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2149" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.contentType" }, { "$id": "9426", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6652" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6657" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/file_batches", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch", "decorators": [] }, "parameters": [ { "$id": "9427", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2151" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9428", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store for which to create a file batch.", "type": { "$id": "9429", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9430", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6652" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9431", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2149" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6657" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFileBatch" }, { "$id": "9432", "kind": "basic", "name": "getVectorStoreFileBatch", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a vector store file batch.", "operation": { "$id": "9433", "name": "getVectorStoreFileBatch", "resourceName": "VectorStores", "summary": "Retrieves a vector store file batch.", "accessibility": "public", "parameters": [ { "$id": "9434", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2153" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.accept" }, { "$id": "9435", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9436", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.vector_store_id" }, { "$id": "9437", "kind": "path", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch being retrieved.", "type": { "$id": "9438", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.batch_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6657" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/file_batches/{batch_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch", "decorators": [] }, "parameters": [ { "$id": "9439", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2155" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9440", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9441", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9442", "kind": "method", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch being retrieved.", "type": { "$id": "9443", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch.batch_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6657" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFileBatch" }, { "$id": "9444", "kind": "basic", "name": "cancelVectorStoreFileBatch", "accessibility": "public", "apiVersions": [], "summary": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", "operation": { "$id": "9445", "name": "cancelVectorStoreFileBatch", "resourceName": "VectorStores", "summary": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", "accessibility": "public", "parameters": [ { "$id": "9446", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2157" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.accept" }, { "$id": "9447", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9448", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.vector_store_id" }, { "$id": "9449", "kind": "path", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch to cancel.", "type": { "$id": "9450", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.batch_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6657" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch", "decorators": [] }, "parameters": [ { "$id": "9451", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2159" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9452", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9453", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9454", "kind": "method", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch to cancel.", "type": { "$id": "9455", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch.batch_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6657" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.cancelVectorStoreFileBatch" }, { "$id": "9456", "kind": "paging", "name": "GetVectorStoreFilesInBatch", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of vector store files in a batch.", "operation": { "$id": "9457", "name": "GetVectorStoreFilesInBatch", "resourceName": "VectorStores", "summary": "Returns a list of vector store files in a batch.", "accessibility": "public", "parameters": [ { "$id": "9458", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2161" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.accept" }, { "$id": "9459", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9460", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.vector_store_id" }, { "$id": "9461", "kind": "path", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch that the files belong to.", "type": { "$id": "9462", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.batch_id" }, { "$id": "9463", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9464", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.limit", "readOnly": false }, { "$id": "9465", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.order", "readOnly": false }, { "$id": "9466", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9467", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.after", "readOnly": false }, { "$id": "9468", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9469", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.before", "readOnly": false }, { "$id": "9470", "kind": "query", "name": "filter", "serializedName": "filter", "doc": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", "type": { "$ref": "1340" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.filter", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6679" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/file_batches/{batch_id}/files", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch", "decorators": [] }, "parameters": [ { "$id": "9471", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2163" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9472", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file batch belongs to.", "type": { "$id": "9473", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9474", "kind": "method", "name": "batch_id", "serializedName": "batch_id", "doc": "The ID of the file batch that the files belong to.", "type": { "$id": "9475", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.batch_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9476", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9477", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9478", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9479", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9480", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9481", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9482", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.before", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9483", "kind": "method", "name": "filter", "serializedName": "filter", "doc": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", "type": { "$ref": "1340" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch.filter", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6682" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listFilesInVectorStoreBatch", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9466" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9484", "kind": "paging", "name": "listVectorStoreFiles", "accessibility": "public", "apiVersions": [], "summary": "Returns a list of vector store files.", "operation": { "$id": "9485", "name": "listVectorStoreFiles", "resourceName": "VectorStores", "summary": "Returns a list of vector store files.", "accessibility": "public", "parameters": [ { "$id": "9486", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2165" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.accept" }, { "$id": "9487", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the files belong to.", "type": { "$id": "9488", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.vector_store_id" }, { "$id": "9489", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9490", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.limit", "readOnly": false }, { "$id": "9491", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.order", "readOnly": false }, { "$id": "9492", "kind": "query", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9493", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.after", "readOnly": false }, { "$id": "9494", "kind": "query", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9495", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.before", "readOnly": false }, { "$id": "9496", "kind": "query", "name": "filter", "serializedName": "filter", "doc": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", "type": { "$ref": "1340" }, "isApiVersion": false, "explode": false, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.filter", "readOnly": false } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6679" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles", "decorators": [] }, "parameters": [ { "$id": "9497", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2167" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9498", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the files belong to.", "type": { "$id": "9499", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9500", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the\ndefault is 20.", "type": { "$id": "9501", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9502", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`\nfor descending order.", "type": { "$ref": "1332" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9503", "kind": "method", "name": "after", "serializedName": "after", "doc": "A cursor for use in pagination. `after` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include after=obj_foo in order to fetch the next page of the list.", "type": { "$id": "9504", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9505", "kind": "method", "name": "before", "serializedName": "before", "doc": "A cursor for use in pagination. `before` is an object ID that defines your place in the list.\nFor instance, if you make a list request and receive 100 objects, ending with obj_foo, your\nsubsequent call can include before=obj_foo in order to fetch the previous page of the list.", "type": { "$id": "9506", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.before", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9507", "kind": "method", "name": "filter", "serializedName": "filter", "doc": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", "type": { "$ref": "1340" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles.filter", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6682" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.listVectorStoreFiles", "pagingMetadata": { "itemPropertySegments": [ "data" ], "continuationToken": { "parameter": { "$ref": "9492" }, "responseSegments": [ "last_id" ], "responseLocation": "Body" }, "pageSizeParameterSegments": [] } }, { "$id": "9508", "kind": "basic", "name": "AddFileToVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).", "operation": { "$id": "9509", "name": "AddFileToVectorStore", "resourceName": "VectorStores", "summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).", "accessibility": "public", "parameters": [ { "$id": "9510", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2169" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.accept" }, { "$id": "9511", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store for which to create a File.", "type": { "$id": "9512", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.vector_store_id" }, { "$id": "9513", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2171" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.contentType" }, { "$id": "9514", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6723" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6683" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile", "decorators": [] }, "parameters": [ { "$id": "9515", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2173" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9516", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store for which to create a File.", "type": { "$id": "9517", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9518", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6723" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9519", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2171" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6683" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.createVectorStoreFile" }, { "$id": "9520", "kind": "basic", "name": "getVectorStoreFile", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a vector store file.", "operation": { "$id": "9521", "name": "getVectorStoreFile", "resourceName": "VectorStores", "summary": "Retrieves a vector store file.", "accessibility": "public", "parameters": [ { "$id": "9522", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2175" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.accept" }, { "$id": "9523", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9524", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.vector_store_id" }, { "$id": "9525", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file being retrieved.", "type": { "$id": "9526", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.file_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6683" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile", "decorators": [] }, "parameters": [ { "$id": "9527", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2177" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9528", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9529", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9530", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file being retrieved.", "type": { "$id": "9531", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile.file_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6683" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.getVectorStoreFile" }, { "$id": "9532", "kind": "basic", "name": "RemoveFileFromVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.", "operation": { "$id": "9533", "name": "RemoveFileFromVectorStore", "resourceName": "VectorStores", "summary": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.", "accessibility": "public", "parameters": [ { "$id": "9534", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2179" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.accept" }, { "$id": "9535", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9536", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.vector_store_id" }, { "$id": "9537", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to delete.", "type": { "$id": "9538", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.file_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6729" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files/{file_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile", "decorators": [] }, "parameters": [ { "$id": "9539", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2181" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9540", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9541", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9542", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to delete.", "type": { "$id": "9543", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile.file_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6729" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.deleteVectorStoreFile" }, { "$id": "9544", "kind": "basic", "name": "updateVectorStoreFileAttributes", "accessibility": "public", "apiVersions": [], "summary": "Update the attributes of a vector store file.", "operation": { "$id": "9545", "name": "updateVectorStoreFileAttributes", "resourceName": "VectorStores", "summary": "Update the attributes of a vector store file.", "accessibility": "public", "parameters": [ { "$id": "9546", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store the file being updated belongs to.", "type": { "$id": "9547", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.vector_store_id" }, { "$id": "9548", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to update attributes for.", "type": { "$id": "9549", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.file_id" }, { "$id": "9550", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2183" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.contentType" }, { "$id": "9551", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2185" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.accept" }, { "$id": "9552", "kind": "body", "name": "updateVectorStoreFileAttributesRequest", "serializedName": "updateVectorStoreFileAttributesRequest", "type": { "$ref": "6735" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Spread", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6683" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files/{file_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes", "decorators": [] }, "parameters": [ { "$id": "9553", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store the file being updated belongs to.", "type": { "$id": "9554", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9555", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file to update attributes for.", "type": { "$id": "9556", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9557", "kind": "method", "name": "attributes", "serializedName": "attributes", "type": { "$ref": "6737" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.attributes", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9558", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2183" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9559", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2185" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6683" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.updateVectorStoreFileAttributes" }, { "$id": "9560", "kind": "basic", "name": "retrieveVectorStoreFileContent", "accessibility": "public", "apiVersions": [], "summary": "Retrieves the content of a vector store file.", "operation": { "$id": "9561", "name": "retrieveVectorStoreFileContent", "resourceName": "VectorStores", "summary": "Retrieves the content of a vector store file.", "accessibility": "public", "parameters": [ { "$id": "9562", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9563", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.vector_store_id" }, { "$id": "9564", "kind": "path", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file with content being retrieved.", "type": { "$id": "9565", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.file_id" }, { "$id": "9566", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2187" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6738" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/files/{file_id}/content", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent", "decorators": [] }, "parameters": [ { "$id": "9567", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store that the file belongs to.", "type": { "$id": "9568", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9569", "kind": "method", "name": "file_id", "serializedName": "file_id", "doc": "The ID of the file with content being retrieved.", "type": { "$id": "9570", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.file_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9571", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2187" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6738" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.retrieveVectorStoreFileContent" }, { "$id": "9572", "kind": "basic", "name": "searchVectorStore", "accessibility": "public", "apiVersions": [], "summary": "Searches a vector store for relevant chunks based on a query and file attributes filter.", "operation": { "$id": "9573", "name": "searchVectorStore", "resourceName": "VectorStores", "summary": "Searches a vector store for relevant chunks based on a query and file attributes filter.", "accessibility": "public", "parameters": [ { "$id": "9574", "kind": "path", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to search.", "type": { "$id": "9575", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.vector_store_id" }, { "$id": "9576", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2189" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.contentType" }, { "$id": "9577", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2191" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.accept" }, { "$id": "9578", "kind": "body", "name": "vectorStoreSearchRequest", "serializedName": "vectorStoreSearchRequest", "type": { "$ref": "6756" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Spread", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6767" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/vector_stores/{vector_store_id}/search", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore", "decorators": [] }, "parameters": [ { "$id": "9579", "kind": "method", "name": "vector_store_id", "serializedName": "vector_store_id", "doc": "The ID of the vector store to search.", "type": { "$id": "9580", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.vector_store_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9581", "kind": "method", "name": "query", "serializedName": "query", "doc": "A query string for a search", "type": { "$ref": "6758" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.query", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9582", "kind": "method", "name": "rewrite_query", "serializedName": "rewrite_query", "doc": "Whether to rewrite the natural language query for vector search.", "type": { "$id": "9583", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "location": "Body", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.rewrite_query", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9584", "kind": "method", "name": "max_num_results", "serializedName": "max_num_results", "doc": "The maximum number of results to return. This number should be between 1 and 50 inclusive.", "type": { "$id": "9585", "kind": "int32", "name": "int32", "crossLanguageDefinitionId": "TypeSpec.int32", "decorators": [] }, "location": "Body", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.max_num_results", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9586", "kind": "method", "name": "filters", "serializedName": "filters", "doc": "A filter to apply based on file attributes.", "type": { "$ref": "6765" }, "location": "Body", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.filters", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9587", "kind": "method", "name": "ranking_options", "serializedName": "ranking_options", "doc": "Ranking options for search.", "type": { "$ref": "6752" }, "location": "Body", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.ranking_options", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9588", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2189" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9589", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2191" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6767" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.VectorStores.searchVectorStore" } ], "parameters": [ { "$id": "9590", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9591", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9592", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VectorStores", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9593", "kind": "client", "name": "Completions", "namespace": "OpenAI", "methods": [ { "$id": "9594", "kind": "basic", "name": "createCompletion", "accessibility": "public", "apiVersions": [], "summary": "Creates a completion for the provided prompt and parameters.", "operation": { "$id": "9595", "name": "createCompletion", "resourceName": "Completions", "summary": "Creates a completion for the provided prompt and parameters.", "accessibility": "public", "parameters": [ { "$id": "9596", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2193" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.accept" }, { "$id": "9597", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2195" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.contentType" }, { "$id": "9598", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6792" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6842" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/completions", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion", "decorators": [] }, "parameters": [ { "$id": "9599", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2197" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9600", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "6792" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9601", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2195" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6842" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Completions.createCompletion" } ], "parameters": [ { "$id": "9602", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9603", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9604", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Completions", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9605", "kind": "client", "name": "Models", "namespace": "OpenAI", "methods": [ { "$id": "9606", "kind": "basic", "name": "listModels", "accessibility": "public", "apiVersions": [], "summary": "Lists the currently available models, and provides basic information about each one such as the\nowner and availability.", "operation": { "$id": "9607", "name": "listModels", "resourceName": "Models", "summary": "Lists the currently available models, and provides basic information about each one such as the\nowner and availability.", "accessibility": "public", "parameters": [ { "$id": "9608", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2199" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Models.listModels.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6873" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/models", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Models.listModels", "decorators": [] }, "parameters": [ { "$id": "9609", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2201" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Models.listModels.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6873" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Models.listModels" }, { "$id": "9610", "kind": "basic", "name": "retrieveModel", "accessibility": "public", "apiVersions": [], "summary": "Retrieves a model instance, providing basic information about the model such as the owner and\npermissioning.", "operation": { "$id": "9611", "name": "retrieveModel", "resourceName": "Models", "summary": "Retrieves a model instance, providing basic information about the model such as the owner and\npermissioning.", "accessibility": "public", "parameters": [ { "$id": "9612", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2203" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel.accept" }, { "$id": "9613", "kind": "path", "name": "model", "serializedName": "model", "doc": "The ID of the model to use for this request.", "type": { "$id": "9614", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel.model" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6877" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/models/{model}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel", "decorators": [] }, "parameters": [ { "$id": "9615", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2205" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9616", "kind": "method", "name": "model", "serializedName": "model", "doc": "The ID of the model to use for this request.", "type": { "$id": "9617", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel.model", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6877" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Models.retrieveModel" }, { "$id": "9618", "kind": "basic", "name": "deleteModel", "accessibility": "public", "apiVersions": [], "summary": "Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.", "operation": { "$id": "9619", "name": "deleteModel", "resourceName": "Models", "summary": "Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.", "accessibility": "public", "parameters": [ { "$id": "9620", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2207" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Models.deleteModel.accept" }, { "$id": "9621", "kind": "path", "name": "model", "serializedName": "model", "doc": "The model to delete", "type": { "$id": "9622", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Models.deleteModel.model" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "6886" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/models/{model}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Models.deleteModel", "decorators": [] }, "parameters": [ { "$id": "9623", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2209" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Models.deleteModel.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9624", "kind": "method", "name": "model", "serializedName": "model", "doc": "The model to delete", "type": { "$id": "9625", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Models.deleteModel.model", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "6886" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Models.deleteModel" } ], "parameters": [ { "$id": "9626", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9627", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9628", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Models", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9629", "kind": "client", "name": "Realtime", "namespace": "OpenAI", "methods": [ { "$id": "9630", "kind": "basic", "name": "startRealtimeSession", "accessibility": "public", "apiVersions": [], "summary": "Starts a real-time session for conversation or transcription.", "operation": { "$id": "9631", "name": "startRealtimeSession", "resourceName": "Realtime", "summary": "Starts a real-time session for conversation or transcription.", "accessibility": "public", "parameters": [ { "$id": "9632", "kind": "header", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2211" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.openAIBeta" }, { "$id": "9633", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2213" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.contentType" }, { "$id": "9634", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2215" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.accept" }, { "$id": "9635", "kind": "body", "name": "requestMessages", "serializedName": "requestMessages", "type": { "$id": "9636", "kind": "array", "name": "ArrayRealtimeClientEvent", "valueType": { "$ref": "6892" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.requestMessages" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9637", "kind": "array", "name": "ArrayRealtimeServerEvent", "valueType": { "$ref": "7189" }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/realtime", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession", "decorators": [] }, "parameters": [ { "$id": "9638", "kind": "method", "name": "openAIBeta", "serializedName": "OpenAI-Beta", "type": { "$ref": "2217" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.openAIBeta", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9639", "kind": "method", "name": "requestMessages", "serializedName": "requestMessages", "type": { "$ref": "9636" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.requestMessages", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9640", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2213" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9641", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2215" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9637" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Realtime.startRealtimeSession" }, { "$id": "9642", "kind": "basic", "name": "createEphemeralToken", "accessibility": "public", "apiVersions": [], "summary": "Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the session.update client event.\n\nIt responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.", "operation": { "$id": "9643", "name": "createEphemeralToken", "resourceName": "Realtime", "summary": "Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the session.update client event.\n\nIt responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.", "accessibility": "public", "parameters": [ { "$id": "9644", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2219" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.contentType" }, { "$id": "9645", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2221" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.accept" }, { "$id": "9646", "kind": "body", "name": "request", "serializedName": "request", "type": { "$ref": "7673" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.request" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7733" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/realtime/sessions", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken", "decorators": [] }, "parameters": [ { "$id": "9647", "kind": "method", "name": "request", "serializedName": "request", "type": { "$ref": "7673" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.request", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9648", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2219" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9649", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2221" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7733" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralToken" }, { "$id": "9650", "kind": "basic", "name": "createEphemeralTranscriptionToken", "accessibility": "public", "apiVersions": [], "summary": "Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcription_session.update client event.\n\nIt responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.", "operation": { "$id": "9651", "name": "createEphemeralTranscriptionToken", "resourceName": "Realtime", "summary": "Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcription_session.update client event.\n\nIt responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.", "accessibility": "public", "parameters": [ { "$id": "9652", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2223" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.contentType" }, { "$id": "9653", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2225" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.accept" }, { "$id": "9654", "kind": "body", "name": "request", "serializedName": "request", "type": { "$ref": "7152" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.request" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7644" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/realtime/transcription_sessions", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken", "decorators": [] }, "parameters": [ { "$id": "9655", "kind": "method", "name": "request", "serializedName": "request", "type": { "$ref": "7152" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.request", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9656", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2223" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9657", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2225" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7644" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Realtime.createEphemeralTranscriptionToken" } ], "parameters": [ { "$id": "9658", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9659", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9660", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Realtime", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9661", "kind": "client", "name": "Uploads", "namespace": "OpenAI", "methods": [ { "$id": "9662", "kind": "basic", "name": "createUpload", "accessibility": "public", "apiVersions": [], "summary": "Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.\n\nOnce you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.\n\nFor certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case:\n- [Assistants](/docs/assistants/tools/file-search/supported-files)\n\nFor guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create).", "operation": { "$id": "9663", "name": "createUpload", "resourceName": "Uploads", "summary": "Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.\n\nOnce you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.\n\nFor certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case:\n- [Assistants](/docs/assistants/tools/file-search/supported-files)\n\nFor guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create).", "accessibility": "public", "parameters": [ { "$id": "9664", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2227" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.accept" }, { "$id": "9665", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2229" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.contentType" }, { "$id": "9666", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7780" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7788" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/uploads", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload", "decorators": [] }, "parameters": [ { "$id": "9667", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2231" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9668", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7780" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9669", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2229" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7788" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Uploads.createUpload" }, { "$id": "9670", "kind": "basic", "name": "addUploadPart", "accessibility": "public", "apiVersions": [], "summary": "Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. \n\nEach Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.\n\nIt is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).", "operation": { "$id": "9671", "name": "addUploadPart", "resourceName": "Uploads", "summary": "Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. \n\nEach Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.\n\nIt is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).", "accessibility": "public", "parameters": [ { "$id": "9672", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2233" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.accept" }, { "$id": "9673", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2235" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.contentType" }, { "$id": "9674", "kind": "path", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9675", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.upload_id" }, { "$id": "9676", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7807" }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7810" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/uploads/{upload_id}/parts", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart", "decorators": [] }, "parameters": [ { "$id": "9677", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2237" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9678", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2239" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9679", "kind": "method", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9680", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.upload_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9681", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7807" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart.requestBody", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7810" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Uploads.addUploadPart" }, { "$id": "9682", "kind": "basic", "name": "completeUpload", "accessibility": "public", "apiVersions": [], "summary": "Completes the [Upload](/docs/api-reference/uploads/object). \n\nWithin the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.\n\nYou can specify the order of the Parts by passing in an ordered list of the Part IDs.\n\nThe number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.", "operation": { "$id": "9683", "name": "completeUpload", "resourceName": "Uploads", "summary": "Completes the [Upload](/docs/api-reference/uploads/object). \n\nWithin the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.\n\nYou can specify the order of the Parts by passing in an ordered list of the Part IDs.\n\nThe number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.", "accessibility": "public", "parameters": [ { "$id": "9684", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2241" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.accept" }, { "$id": "9685", "kind": "path", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9686", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.upload_id" }, { "$id": "9687", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2243" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.contentType" }, { "$id": "9688", "kind": "body", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7819" }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.requestBody" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7788" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/uploads/{upload_id}/complete", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload", "decorators": [] }, "parameters": [ { "$id": "9689", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2245" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9690", "kind": "method", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9691", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.upload_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9692", "kind": "method", "name": "requestBody", "serializedName": "requestBody", "type": { "$ref": "7819" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.requestBody", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9693", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2243" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload.contentType", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7788" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Uploads.completeUpload" }, { "$id": "9694", "kind": "basic", "name": "cancelUpload", "accessibility": "public", "apiVersions": [], "summary": "Cancels the Upload. No Parts may be added after an Upload is cancelled.", "operation": { "$id": "9695", "name": "cancelUpload", "resourceName": "Uploads", "summary": "Cancels the Upload. No Parts may be added after an Upload is cancelled.", "accessibility": "public", "parameters": [ { "$id": "9696", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2247" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload.accept" }, { "$id": "9697", "kind": "path", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9698", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload.upload_id" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "7788" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/uploads/{upload_id}/cancel", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": true, "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload", "decorators": [] }, "parameters": [ { "$id": "9699", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2249" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload.accept", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9700", "kind": "method", "name": "upload_id", "serializedName": "upload_id", "type": { "$id": "9701", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload.upload_id", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "7788" } }, "isOverride": false, "generateConvenient": true, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.Uploads.cancelUpload" } ], "parameters": [ { "$id": "9702", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9703", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9704", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Uploads", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9705", "kind": "client", "name": "Conversations", "namespace": "OpenAI", "methods": [ { "$id": "9706", "kind": "paging", "name": "GetConversationItems", "accessibility": "public", "apiVersions": [], "doc": "List all items for a conversation with the given ID.", "summary": "List items", "operation": { "$id": "9707", "name": "GetConversationItems", "resourceName": "OpenAI", "summary": "List items", "doc": "List all items for a conversation with the given ID.", "accessibility": "public", "parameters": [ { "$id": "9708", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to list items for.", "type": { "$id": "9709", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.listConversationItems.conversation_id" }, { "$id": "9710", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.", "type": { "$id": "9711", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.listConversationItems.limit", "readOnly": false }, { "$id": "9712", "kind": "query", "name": "order", "serializedName": "order", "doc": "The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.", "type": { "$id": "9713", "kind": "enum", "name": "ListConversationItemsRequestOrder", "crossLanguageDefinitionId": "OpenAI.listConversationItems.RequestOrder.anonymous", "valueType": { "$id": "9714", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9715", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "9714" }, "enumType": { "$ref": "9713" }, "decorators": [] }, { "$id": "9716", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "9714" }, "enumType": { "$ref": "9713" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.listConversationItems.order", "readOnly": false }, { "$id": "9717", "kind": "query", "name": "after", "serializedName": "after", "doc": "An item ID to list items after, used in pagination.", "type": { "$id": "9718", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.listConversationItems.after", "readOnly": false }, { "$id": "9719", "kind": "query", "name": "include", "serializedName": "include", "doc": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).", "type": { "$id": "9720", "kind": "array", "name": "ArrayIncludeEnum", "valueType": { "$id": "9721", "kind": "enum", "name": "IncludeEnum", "crossLanguageDefinitionId": "OpenAI.IncludeEnum", "valueType": { "$id": "9722", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9723", "kind": "enumvalue", "name": "file_search_call.results", "value": "file_search_call.results", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9724", "kind": "enumvalue", "name": "web_search_call.results", "value": "web_search_call.results", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9725", "kind": "enumvalue", "name": "web_search_call.action.sources", "value": "web_search_call.action.sources", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9726", "kind": "enumvalue", "name": "message.input_image.image_url", "value": "message.input_image.image_url", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9727", "kind": "enumvalue", "name": "computer_call_output.output.image_url", "value": "computer_call_output.output.image_url", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9728", "kind": "enumvalue", "name": "code_interpreter_call.outputs", "value": "code_interpreter_call.outputs", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9729", "kind": "enumvalue", "name": "reasoning.encrypted_content", "value": "reasoning.encrypted_content", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] }, { "$id": "9730", "kind": "enumvalue", "name": "message.output_text.logprobs", "value": "message.output_text.logprobs", "valueType": { "$ref": "9722" }, "enumType": { "$ref": "9721" }, "decorators": [] } ], "namespace": "OpenAI", "doc": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.listConversationItems.include", "readOnly": false }, { "$id": "9731", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2251" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.listConversationItems.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9732", "kind": "model", "name": "ConversationItemList", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ConversationItemList", "usage": "None", "doc": "A list of Conversation items.", "summary": "The conversation item list", "decorators": [], "properties": [ { "$id": "9733", "kind": "property", "name": "object", "doc": "The type of object returned, must be `list`.", "type": { "$ref": "2253" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemList.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9734", "kind": "property", "name": "data", "doc": "A list of conversation items.", "type": { "$ref": "5161" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemList.data", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9735", "kind": "property", "name": "has_more", "doc": "Whether there are more items available.", "type": { "$id": "9736", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemList.has_more", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9737", "kind": "property", "name": "first_id", "doc": "The ID of the first item in the list.", "type": { "$id": "9738", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemList.first_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9739", "kind": "property", "name": "last_id", "doc": "The ID of the last item in the list.", "type": { "$id": "9740", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationItemList.last_id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/conversations/{conversation_id}/items", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.listConversationItems", "decorators": [] }, "parameters": [ { "$id": "9741", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to list items for.", "type": { "$id": "9742", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.listConversationItems.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9743", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "A limit on the number of objects to be returned. Limit can range between\n1 and 100, and the default is 20.", "type": { "$id": "9744", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.listConversationItems.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9745", "kind": "method", "name": "order", "serializedName": "order", "doc": "The order to return the input items in. Default is `desc`.\n- `asc`: Return the input items in ascending order.\n- `desc`: Return the input items in descending order.", "type": { "$ref": "9713" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.listConversationItems.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9746", "kind": "method", "name": "after", "serializedName": "after", "doc": "An item ID to list items after, used in pagination.", "type": { "$id": "9747", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.listConversationItems.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9748", "kind": "method", "name": "include", "serializedName": "include", "doc": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).", "type": { "$ref": "9720" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.listConversationItems.include", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9749", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2251" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.listConversationItems.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5161" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.listConversationItems", "pagingMetadata": { "itemPropertySegments": [ "data" ], "pageSizeParameterSegments": [] } }, { "$id": "9750", "kind": "basic", "name": "createConversationItems", "accessibility": "public", "apiVersions": [], "doc": "Create items in a conversation with the given ID.", "summary": "Create items", "operation": { "$id": "9751", "name": "createConversationItems", "resourceName": "OpenAI", "summary": "Create items", "doc": "Create items in a conversation with the given ID.", "accessibility": "public", "parameters": [ { "$id": "9752", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to add the item to.", "type": { "$id": "9753", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.createConversationItems.conversation_id" }, { "$id": "9754", "kind": "query", "name": "include", "serializedName": "include", "doc": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.", "type": { "$ref": "9720" }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.createConversationItems.include", "readOnly": false }, { "$id": "9755", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2255" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createConversationItems.contentType" }, { "$id": "9756", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2257" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createConversationItems.accept" }, { "$id": "9757", "kind": "body", "name": "body", "serializedName": "body", "type": { "$id": "9758", "kind": "model", "name": "CreateConversationItemsParametersBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateConversationItemsParametersBody", "usage": "None", "decorators": [], "properties": [ { "$id": "9759", "kind": "property", "name": "items", "type": { "$ref": "5161" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateConversationItemsParametersBody.items", "serializationOptions": {}, "isHttpMetadata": false } ] }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.createConversationItems.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9732" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/conversations/{conversation_id}/items", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.createConversationItems", "decorators": [] }, "parameters": [ { "$id": "9760", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to add the item to.", "type": { "$id": "9761", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.createConversationItems.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9762", "kind": "method", "name": "include", "serializedName": "include", "doc": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.", "type": { "$ref": "9720" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.createConversationItems.include", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9763", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "9758" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.createConversationItems.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9764", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2255" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createConversationItems.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9765", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2257" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createConversationItems.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9732" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.createConversationItems" }, { "$id": "9766", "kind": "basic", "name": "deleteConversationItem", "accessibility": "public", "apiVersions": [], "doc": "Delete an item from a conversation with the given IDs.", "summary": "Delete an item", "operation": { "$id": "9767", "name": "deleteConversationItem", "resourceName": "OpenAI", "summary": "Delete an item", "doc": "Delete an item from a conversation with the given IDs.", "accessibility": "public", "parameters": [ { "$id": "9768", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation that contains the item.", "type": { "$id": "9769", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.conversation_id" }, { "$id": "9770", "kind": "path", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to delete.", "type": { "$id": "9771", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.item_id" }, { "$id": "9772", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2259" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9773", "kind": "model", "name": "ConversationResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.ConversationResource", "usage": "None", "decorators": [], "properties": [ { "$id": "9774", "kind": "property", "name": "id", "doc": "The unique ID of the conversation.", "type": { "$id": "9775", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationResource.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9776", "kind": "property", "name": "object", "doc": "The object type, which is always `conversation`.", "type": { "$ref": "2261" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationResource.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9777", "kind": "property", "name": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "type": { "$id": "9778", "kind": "unknown", "name": "unknown", "crossLanguageDefinitionId": "", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationResource.metadata", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9779", "kind": "property", "name": "created_at", "doc": "The time at which the conversation was created, measured in seconds since the Unix epoch.", "type": { "$id": "9780", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ConversationResource.created_at", "serializationOptions": {}, "isHttpMetadata": false } ] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/conversations/{conversation_id}/items/{item_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.deleteConversationItem", "decorators": [] }, "parameters": [ { "$id": "9781", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation that contains the item.", "type": { "$id": "9782", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9783", "kind": "method", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to delete.", "type": { "$id": "9784", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.item_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9785", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2259" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.deleteConversationItem.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9773" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.deleteConversationItem" }, { "$id": "9786", "kind": "basic", "name": "getConversationItem", "accessibility": "public", "apiVersions": [], "doc": "Get a single item from a conversation with the given IDs.", "summary": "Retrieve an item", "operation": { "$id": "9787", "name": "getConversationItem", "resourceName": "OpenAI", "summary": "Retrieve an item", "doc": "Get a single item from a conversation with the given IDs.", "accessibility": "public", "parameters": [ { "$id": "9788", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation that contains the item.", "type": { "$id": "9789", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.getConversationItem.conversation_id" }, { "$id": "9790", "kind": "path", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to retrieve.", "type": { "$id": "9791", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.getConversationItem.item_id" }, { "$id": "9792", "kind": "query", "name": "include", "serializedName": "include", "doc": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.", "type": { "$ref": "9720" }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.getConversationItem.include", "readOnly": false }, { "$id": "9793", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2263" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.getConversationItem.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "5162" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/conversations/{conversation_id}/items/{item_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.getConversationItem", "decorators": [] }, "parameters": [ { "$id": "9794", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation that contains the item.", "type": { "$id": "9795", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.getConversationItem.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9796", "kind": "method", "name": "item_id", "serializedName": "item_id", "doc": "The ID of the item to retrieve.", "type": { "$id": "9797", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.getConversationItem.item_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9798", "kind": "method", "name": "include", "serializedName": "include", "doc": "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.", "type": { "$ref": "9720" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.getConversationItem.include", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9799", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2263" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.getConversationItem.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "5162" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.getConversationItem" }, { "$id": "9800", "kind": "basic", "name": "createConversation", "accessibility": "public", "apiVersions": [], "doc": "Create a conversation.", "summary": "Create a conversation", "operation": { "$id": "9801", "name": "createConversation", "resourceName": "OpenAI", "summary": "Create a conversation", "doc": "Create a conversation.", "accessibility": "public", "parameters": [ { "$id": "9802", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2265" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createConversation.contentType" }, { "$id": "9803", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2267" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createConversation.accept" }, { "$id": "9804", "kind": "body", "name": "body", "serializedName": "body", "type": { "$id": "9805", "kind": "model", "name": "CreateConversationBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateConversationBody", "usage": "None", "decorators": [], "properties": [ { "$id": "9806", "kind": "property", "name": "metadata", "type": { "$id": "9807", "kind": "nullable", "type": { "$id": "9808", "kind": "model", "name": "Metadata", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Metadata", "usage": "None", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "decorators": [], "properties": [] }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateConversationBody.metadata", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9809", "kind": "property", "name": "items", "type": { "$id": "9810", "kind": "nullable", "type": { "$ref": "5161" }, "namespace": "OpenAI" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateConversationBody.items", "serializationOptions": {}, "isHttpMetadata": false } ] }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.createConversation.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9773" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/conversations", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.createConversation", "decorators": [] }, "parameters": [ { "$id": "9811", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "9805" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.createConversation.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9812", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2265" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createConversation.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9813", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2267" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createConversation.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9773" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.createConversation" }, { "$id": "9814", "kind": "basic", "name": "deleteConversation", "accessibility": "public", "apiVersions": [], "doc": "Delete a conversation. Items in the conversation will not be deleted.", "summary": "Delete a conversation", "operation": { "$id": "9815", "name": "deleteConversation", "resourceName": "OpenAI", "summary": "Delete a conversation", "doc": "Delete a conversation. Items in the conversation will not be deleted.", "accessibility": "public", "parameters": [ { "$id": "9816", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to delete.", "type": { "$id": "9817", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.deleteConversation.conversation_id" }, { "$id": "9818", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2269" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.deleteConversation.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9819", "kind": "model", "name": "DeletedConversationResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeletedConversationResource", "usage": "None", "decorators": [], "properties": [ { "$id": "9820", "kind": "property", "name": "object", "type": { "$ref": "2271" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedConversationResource.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9821", "kind": "property", "name": "deleted", "type": { "$id": "9822", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedConversationResource.deleted", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9823", "kind": "property", "name": "id", "type": { "$id": "9824", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedConversationResource.id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/conversations/{conversation_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.deleteConversation", "decorators": [] }, "parameters": [ { "$id": "9825", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to delete.", "type": { "$id": "9826", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.deleteConversation.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9827", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2269" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.deleteConversation.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9819" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.deleteConversation" }, { "$id": "9828", "kind": "basic", "name": "getConversation", "accessibility": "public", "apiVersions": [], "doc": "Get a conversation", "summary": "Retrieve a conversation", "operation": { "$id": "9829", "name": "getConversation", "resourceName": "OpenAI", "summary": "Retrieve a conversation", "doc": "Get a conversation", "accessibility": "public", "parameters": [ { "$id": "9830", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to retrieve.", "type": { "$id": "9831", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.getConversation.conversation_id" }, { "$id": "9832", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2273" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.getConversation.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9773" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/conversations/{conversation_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.getConversation", "decorators": [] }, "parameters": [ { "$id": "9833", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to retrieve.", "type": { "$id": "9834", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.getConversation.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9835", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2273" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.getConversation.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9773" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.getConversation" }, { "$id": "9836", "kind": "basic", "name": "updateConversation", "accessibility": "public", "apiVersions": [], "doc": "Update a conversation", "summary": "Update a conversation", "operation": { "$id": "9837", "name": "updateConversation", "resourceName": "OpenAI", "summary": "Update a conversation", "doc": "Update a conversation", "accessibility": "public", "parameters": [ { "$id": "9838", "kind": "path", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to update.", "type": { "$id": "9839", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.updateConversation.conversation_id" }, { "$id": "9840", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2275" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.updateConversation.contentType" }, { "$id": "9841", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2277" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.updateConversation.accept" }, { "$id": "9842", "kind": "body", "name": "body", "serializedName": "body", "type": { "$id": "9843", "kind": "model", "name": "UpdateConversationBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.UpdateConversationBody", "usage": "None", "decorators": [], "properties": [ { "$id": "9844", "kind": "property", "name": "metadata", "doc": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "type": { "$id": "9845", "kind": "nullable", "type": { "$ref": "9808" }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.UpdateConversationBody.metadata", "serializationOptions": {}, "isHttpMetadata": false } ] }, "isApiVersion": false, "contentTypes": [ "application/json" ], "defaultContentType": "application/json", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.updateConversation.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9773" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/conversations/{conversation_id}", "requestMediaTypes": [ "application/json" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.updateConversation", "decorators": [] }, "parameters": [ { "$id": "9846", "kind": "method", "name": "conversation_id", "serializedName": "conversation_id", "doc": "The ID of the conversation to update.", "type": { "$id": "9847", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.updateConversation.conversation_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9848", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "9843" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.updateConversation.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9849", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "doc": "Body parameter's content type. Known values are application/json", "type": { "$ref": "2275" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.updateConversation.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9850", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2277" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.updateConversation.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9773" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.updateConversation" } ], "parameters": [ { "$id": "9851", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "9852", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "9853", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI", "apiVersions": [], "parent": { "$ref": "8231" } }, { "$id": "9854", "kind": "client", "name": "Videos", "namespace": "OpenAI", "methods": [ { "$id": "9855", "kind": "paging", "name": "ListVideos", "accessibility": "public", "apiVersions": [], "doc": "List videos", "summary": "List videos", "operation": { "$id": "9856", "name": "ListVideos", "resourceName": "OpenAI", "summary": "List videos", "doc": "List videos", "accessibility": "public", "parameters": [ { "$id": "9857", "kind": "query", "name": "limit", "serializedName": "limit", "doc": "Number of items to retrieve", "type": { "$id": "9858", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVideos.limit", "readOnly": false }, { "$id": "9859", "kind": "query", "name": "order", "serializedName": "order", "doc": "Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$id": "9860", "kind": "enum", "name": "OrderEnum", "crossLanguageDefinitionId": "OpenAI.OrderEnum", "valueType": { "$id": "9861", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9862", "kind": "enumvalue", "name": "asc", "value": "asc", "valueType": { "$ref": "9861" }, "enumType": { "$ref": "9860" }, "decorators": [] }, { "$id": "9863", "kind": "enumvalue", "name": "desc", "value": "desc", "valueType": { "$ref": "9861" }, "enumType": { "$ref": "9860" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVideos.order", "readOnly": false }, { "$id": "9864", "kind": "query", "name": "after", "serializedName": "after", "doc": "Identifier for the last item from the previous pagination request", "type": { "$id": "9865", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVideos.after", "readOnly": false }, { "$id": "9866", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2279" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.ListVideos.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9867", "kind": "model", "name": "VideoListResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VideoListResource", "usage": "None", "decorators": [], "properties": [ { "$id": "9868", "kind": "property", "name": "object", "doc": "The type of object returned, must be `list`.", "type": { "$ref": "2281" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoListResource.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9869", "kind": "property", "name": "data", "doc": "A list of items", "type": { "$id": "9870", "kind": "array", "name": "ArrayVideoResource", "valueType": { "$id": "9871", "kind": "model", "name": "VideoResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.VideoResource", "usage": "None", "doc": "Structured information describing a generated video job.", "summary": "Video job", "decorators": [], "properties": [ { "$id": "9872", "kind": "property", "name": "id", "doc": "Unique identifier for the video job.", "type": { "$id": "9873", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9874", "kind": "property", "name": "object", "doc": "The object type, which is always `video`.", "type": { "$ref": "2283" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9875", "kind": "property", "name": "model", "doc": "The video generation model that produced the job.", "type": { "$id": "9876", "kind": "enum", "name": "VideoModel", "crossLanguageDefinitionId": "OpenAI.VideoModel", "valueType": { "$id": "9877", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9878", "kind": "enumvalue", "name": "sora-2", "value": "sora-2", "valueType": { "$ref": "9877" }, "enumType": { "$ref": "9876" }, "decorators": [] }, { "$id": "9879", "kind": "enumvalue", "name": "sora-2-pro", "value": "sora-2-pro", "valueType": { "$ref": "9877" }, "enumType": { "$ref": "9876" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.model", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9880", "kind": "property", "name": "status", "doc": "Current lifecycle status of the video job.", "type": { "$id": "9881", "kind": "enum", "name": "VideoStatus", "crossLanguageDefinitionId": "OpenAI.VideoStatus", "valueType": { "$id": "9882", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9883", "kind": "enumvalue", "name": "queued", "value": "queued", "valueType": { "$ref": "9882" }, "enumType": { "$ref": "9881" }, "decorators": [] }, { "$id": "9884", "kind": "enumvalue", "name": "in_progress", "value": "in_progress", "valueType": { "$ref": "9882" }, "enumType": { "$ref": "9881" }, "decorators": [] }, { "$id": "9885", "kind": "enumvalue", "name": "completed", "value": "completed", "valueType": { "$ref": "9882" }, "enumType": { "$ref": "9881" }, "decorators": [] }, { "$id": "9886", "kind": "enumvalue", "name": "failed", "value": "failed", "valueType": { "$ref": "9882" }, "enumType": { "$ref": "9881" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.status", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9887", "kind": "property", "name": "progress", "doc": "Approximate completion percentage for the generation task.", "type": { "$id": "9888", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.progress", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9889", "kind": "property", "name": "created_at", "doc": "Unix timestamp (seconds) for when the job was created.", "type": { "$id": "9890", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.created_at", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9891", "kind": "property", "name": "completed_at", "type": { "$id": "9892", "kind": "nullable", "type": { "$id": "9893", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.completed_at", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9894", "kind": "property", "name": "expires_at", "type": { "$id": "9895", "kind": "nullable", "type": { "$id": "9896", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.expires_at", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9897", "kind": "property", "name": "size", "doc": "The resolution of the generated video.", "type": { "$id": "9898", "kind": "enum", "name": "VideoSize", "crossLanguageDefinitionId": "OpenAI.VideoSize", "valueType": { "$id": "9899", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9900", "kind": "enumvalue", "name": "720x1280", "value": "720x1280", "valueType": { "$ref": "9899" }, "enumType": { "$ref": "9898" }, "decorators": [] }, { "$id": "9901", "kind": "enumvalue", "name": "1280x720", "value": "1280x720", "valueType": { "$ref": "9899" }, "enumType": { "$ref": "9898" }, "decorators": [] }, { "$id": "9902", "kind": "enumvalue", "name": "1024x1792", "value": "1024x1792", "valueType": { "$ref": "9899" }, "enumType": { "$ref": "9898" }, "decorators": [] }, { "$id": "9903", "kind": "enumvalue", "name": "1792x1024", "value": "1792x1024", "valueType": { "$ref": "9899" }, "enumType": { "$ref": "9898" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.size", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9904", "kind": "property", "name": "seconds", "doc": "Duration of the generated clip in seconds.", "type": { "$id": "9905", "kind": "enum", "name": "VideoSeconds", "crossLanguageDefinitionId": "OpenAI.VideoSeconds", "valueType": { "$id": "9906", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9907", "kind": "enumvalue", "name": "4", "value": "4", "valueType": { "$ref": "9906" }, "enumType": { "$ref": "9905" }, "decorators": [] }, { "$id": "9908", "kind": "enumvalue", "name": "8", "value": "8", "valueType": { "$ref": "9906" }, "enumType": { "$ref": "9905" }, "decorators": [] }, { "$id": "9909", "kind": "enumvalue", "name": "12", "value": "12", "valueType": { "$ref": "9906" }, "enumType": { "$ref": "9905" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.seconds", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9910", "kind": "property", "name": "remixed_from_video_id", "type": { "$id": "9911", "kind": "nullable", "type": { "$id": "9912", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.remixed_from_video_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9913", "kind": "property", "name": "error", "type": { "$id": "9914", "kind": "nullable", "type": { "$id": "9915", "kind": "model", "name": "Error-2", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.Error-2", "usage": "None", "decorators": [], "properties": [ { "$id": "9916", "kind": "property", "name": "code", "type": { "$id": "9917", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error-2.code", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9918", "kind": "property", "name": "message", "type": { "$id": "9919", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.Error-2.message", "serializationOptions": {}, "isHttpMetadata": false } ] }, "namespace": "OpenAI" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoResource.error", "serializationOptions": {}, "isHttpMetadata": false } ] }, "crossLanguageDefinitionId": "TypeSpec.Array", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoListResource.data", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9920", "kind": "property", "name": "first_id", "type": { "$id": "9921", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoListResource.first_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9922", "kind": "property", "name": "last_id", "type": { "$id": "9923", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoListResource.last_id", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9924", "kind": "property", "name": "has_more", "doc": "Whether there are more items available.", "type": { "$id": "9925", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.VideoListResource.has_more", "serializationOptions": {}, "isHttpMetadata": false } ] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/videos", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.ListVideos", "decorators": [] }, "parameters": [ { "$id": "9926", "kind": "method", "name": "limit", "serializedName": "limit", "doc": "Number of items to retrieve", "type": { "$id": "9927", "kind": "integer", "name": "integer", "crossLanguageDefinitionId": "TypeSpec.integer", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.ListVideos.limit", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9928", "kind": "method", "name": "order", "serializedName": "order", "doc": "Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.", "type": { "$ref": "9860" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.ListVideos.order", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9929", "kind": "method", "name": "after", "serializedName": "after", "doc": "Identifier for the last item from the previous pagination request", "type": { "$id": "9930", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.ListVideos.after", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9931", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2279" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.ListVideos.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9870" }, "resultSegments": [ "data" ] }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.ListVideos", "pagingMetadata": { "itemPropertySegments": [ "data" ], "pageSizeParameterSegments": [] } }, { "$id": "9932", "kind": "basic", "name": "createVideo", "accessibility": "public", "apiVersions": [], "doc": "Create a video", "summary": "Create video", "operation": { "$id": "9933", "name": "createVideo", "resourceName": "OpenAI", "summary": "Create video", "doc": "Create a video", "accessibility": "public", "parameters": [ { "$id": "9934", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2285" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createVideo.contentType" }, { "$id": "9935", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2287" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.createVideo.accept" }, { "$id": "9936", "kind": "body", "name": "body", "serializedName": "body", "type": { "$id": "9937", "kind": "model", "name": "CreateVideoBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateVideoBody", "usage": "None", "doc": "Parameters for creating a new video generation job.", "summary": "Create video request", "decorators": [], "properties": [ { "$id": "9938", "kind": "property", "name": "model", "serializedName": "model", "doc": "The video generation model to use. Defaults to `sora-2`.", "type": { "$ref": "9876" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoBody.model", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "model", "headers": [] } }, "isHttpMetadata": false }, { "$id": "9939", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "Text prompt that describes the video to generate.", "type": { "$id": "9940", "kind": "string", "name": "VideoPrompt", "crossLanguageDefinitionId": "OpenAI.VideoPrompt", "baseType": { "$id": "9941", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoBody.prompt", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "prompt", "headers": [] } }, "isHttpMetadata": false }, { "$id": "9942", "kind": "property", "name": "input_reference", "serializedName": "input_reference", "doc": "Optional image reference that guides generation.", "type": { "$id": "9943", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoBody.input_reference", "serializationOptions": { "multipart": { "isFilePart": true, "isMulti": false, "defaultContentTypes": [ "application/octet-stream" ], "name": "input_reference", "headers": [] } }, "isHttpMetadata": false }, { "$id": "9944", "kind": "property", "name": "seconds", "serializedName": "seconds", "doc": "Clip duration in seconds. Defaults to 4 seconds.", "type": { "$ref": "9905" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoBody.seconds", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "seconds", "headers": [] } }, "isHttpMetadata": false }, { "$id": "9945", "kind": "property", "name": "size", "serializedName": "size", "doc": "Output resolution formatted as width x height. Defaults to 720x1280.", "type": { "$ref": "9898" }, "optional": true, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoBody.size", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "application/json" ], "name": "size", "headers": [] } }, "isHttpMetadata": false } ] }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.createVideo.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9871" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/videos", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.createVideo", "decorators": [] }, "parameters": [ { "$id": "9946", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2289" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createVideo.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9947", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "9937" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.createVideo.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9948", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2287" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.createVideo.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9871" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.createVideo" }, { "$id": "9949", "kind": "basic", "name": "DeleteVideo", "accessibility": "public", "apiVersions": [], "doc": "Delete a video", "summary": "Delete video", "operation": { "$id": "9950", "name": "DeleteVideo", "resourceName": "OpenAI", "summary": "Delete video", "doc": "Delete a video", "accessibility": "public", "parameters": [ { "$id": "9951", "kind": "path", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video to delete.", "type": { "$id": "9952", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.DeleteVideo.video_id" }, { "$id": "9953", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2291" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeleteVideo.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9954", "kind": "model", "name": "DeletedVideoResource", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.DeletedVideoResource", "usage": "None", "doc": "Confirmation payload returned after deleting a video.", "summary": "Deleted video response", "decorators": [], "properties": [ { "$id": "9955", "kind": "property", "name": "object", "doc": "The object type that signals the deletion response.", "type": { "$ref": "2293" }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedVideoResource.object", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9956", "kind": "property", "name": "deleted", "doc": "Indicates that the video resource was deleted.", "type": { "$id": "9957", "kind": "boolean", "name": "boolean", "crossLanguageDefinitionId": "TypeSpec.boolean", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedVideoResource.deleted", "serializationOptions": {}, "isHttpMetadata": false }, { "$id": "9958", "kind": "property", "name": "id", "doc": "Identifier of the deleted video.", "type": { "$id": "9959", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.DeletedVideoResource.id", "serializationOptions": {}, "isHttpMetadata": false } ] }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "DELETE", "uri": "{endpoint}", "path": "/videos/{video_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.DeleteVideo", "decorators": [] }, "parameters": [ { "$id": "9960", "kind": "method", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video to delete.", "type": { "$id": "9961", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.DeleteVideo.video_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9962", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2291" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.DeleteVideo.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9954" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.DeleteVideo" }, { "$id": "9963", "kind": "basic", "name": "GetVideo", "accessibility": "public", "apiVersions": [], "doc": "Retrieve a video", "summary": "Retrieve video", "operation": { "$id": "9964", "name": "GetVideo", "resourceName": "OpenAI", "summary": "Retrieve video", "doc": "Retrieve a video", "accessibility": "public", "parameters": [ { "$id": "9965", "kind": "path", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video to retrieve.", "type": { "$id": "9966", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.GetVideo.video_id" }, { "$id": "9967", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2295" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.GetVideo.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9871" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/videos/{video_id}", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.GetVideo", "decorators": [] }, "parameters": [ { "$id": "9968", "kind": "method", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video to retrieve.", "type": { "$id": "9969", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.GetVideo.video_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9970", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2295" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.GetVideo.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9871" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.GetVideo" }, { "$id": "9971", "kind": "basic", "name": "DownloadVideo", "accessibility": "public", "apiVersions": [], "doc": "Download video content", "summary": "Retrieve video content", "operation": { "$id": "9972", "name": "DownloadVideo", "resourceName": "OpenAI", "summary": "Retrieve video content", "doc": "Download video content", "accessibility": "public", "parameters": [ { "$id": "9973", "kind": "path", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video whose media to download.", "type": { "$id": "9974", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.video_id" }, { "$id": "9975", "kind": "query", "name": "variant", "serializedName": "variant", "doc": "Which downloadable asset to return. Defaults to the MP4 video.", "type": { "$id": "9976", "kind": "enum", "name": "VideoContentVariant", "crossLanguageDefinitionId": "OpenAI.VideoContentVariant", "valueType": { "$id": "9977", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "values": [ { "$id": "9978", "kind": "enumvalue", "name": "video", "value": "video", "valueType": { "$ref": "9977" }, "enumType": { "$ref": "9976" }, "decorators": [] }, { "$id": "9979", "kind": "enumvalue", "name": "thumbnail", "value": "thumbnail", "valueType": { "$ref": "9977" }, "enumType": { "$ref": "9976" }, "decorators": [] }, { "$id": "9980", "kind": "enumvalue", "name": "spritesheet", "value": "spritesheet", "valueType": { "$ref": "9977" }, "enumType": { "$ref": "9976" }, "decorators": [] } ], "namespace": "OpenAI", "isFixed": true, "isFlags": false, "usage": "None", "decorators": [] }, "isApiVersion": false, "explode": true, "optional": true, "scope": "Method", "decorators": [], "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.variant", "readOnly": false }, { "$id": "9981", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$id": "9982", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Method", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.accept" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$id": "9983", "kind": "union", "name": "", "variantTypes": [ { "$id": "9984", "kind": "bytes", "name": "bytes", "encode": "base64", "crossLanguageDefinitionId": "TypeSpec.bytes", "decorators": [] }, { "$id": "9985", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] } ], "namespace": "", "decorators": [] }, "headers": [ { "name": "contentType", "nameInResponse": "content-type", "type": { "$ref": "2297" } }, { "name": "contentType", "nameInResponse": "content-type", "type": { "$ref": "2299" } } ], "isErrorResponse": false, "contentTypes": [ "video/mp4", "image/webp", "text/plain" ] } ], "httpMethod": "GET", "uri": "{endpoint}", "path": "/videos/{video_id}/content", "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent", "decorators": [] }, "parameters": [ { "$id": "9986", "kind": "method", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the video whose media to download.", "type": { "$id": "9987", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.video_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9988", "kind": "method", "name": "variant", "serializedName": "variant", "doc": "Which downloadable asset to return. Defaults to the MP4 video.", "type": { "$ref": "9976" }, "location": "Query", "isApiVersion": false, "optional": true, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.variant", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "9989", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "9982" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9983" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.RetrieveVideoContent" }, { "$id": "9990", "kind": "basic", "name": "CreateVideoRemix", "accessibility": "public", "apiVersions": [], "doc": "Create a video remix", "summary": "Remix video", "operation": { "$id": "9991", "name": "CreateVideoRemix", "resourceName": "OpenAI", "summary": "Remix video", "doc": "Create a video remix", "accessibility": "public", "parameters": [ { "$id": "9992", "kind": "path", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the completed video to remix.", "type": { "$id": "9993", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "isApiVersion": false, "explode": false, "style": "simple", "allowReserved": false, "skipUrlEncoding": false, "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.video_id" }, { "$id": "9994", "kind": "header", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2301" }, "isApiVersion": false, "optional": false, "isContentType": true, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.contentType" }, { "$id": "9995", "kind": "header", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2303" }, "isApiVersion": false, "optional": false, "isContentType": false, "scope": "Constant", "readOnly": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.accept" }, { "$id": "9996", "kind": "body", "name": "body", "serializedName": "body", "type": { "$id": "9997", "kind": "model", "name": "CreateVideoRemixBody", "namespace": "OpenAI", "crossLanguageDefinitionId": "OpenAI.CreateVideoRemixBody", "usage": "None", "doc": "Parameters for remixing an existing generated video.", "summary": "Create video remix request", "decorators": [], "properties": [ { "$id": "9998", "kind": "property", "name": "prompt", "serializedName": "prompt", "doc": "Updated text prompt that directs the remix generation.", "type": { "$id": "9999", "kind": "string", "name": "VideoPrompt", "crossLanguageDefinitionId": "OpenAI.VideoPrompt", "baseType": { "$id": "10000", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "decorators": [] }, "optional": false, "readOnly": false, "discriminator": false, "flatten": false, "decorators": [], "crossLanguageDefinitionId": "OpenAI.CreateVideoRemixBody.prompt", "serializationOptions": { "multipart": { "isFilePart": false, "isMulti": false, "defaultContentTypes": [ "text/plain" ], "name": "prompt", "headers": [] } }, "isHttpMetadata": false } ] }, "isApiVersion": false, "contentTypes": [ "multipart/form-data" ], "defaultContentType": "multipart/form-data", "optional": false, "scope": "Method", "decorators": [], "readOnly": false, "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.body" } ], "responses": [ { "statusCodes": [ 200 ], "bodyType": { "$ref": "9871" }, "headers": [], "isErrorResponse": false, "contentTypes": [ "application/json" ] } ], "httpMethod": "POST", "uri": "{endpoint}", "path": "/videos/{video_id}/remix", "requestMediaTypes": [ "multipart/form-data" ], "bufferResponse": true, "generateProtocolMethod": true, "generateConvenienceMethod": false, "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix", "decorators": [] }, "parameters": [ { "$id": "10001", "kind": "method", "name": "video_id", "serializedName": "video_id", "doc": "The identifier of the completed video to remix.", "type": { "$id": "10002", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string", "decorators": [] }, "location": "Path", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.video_id", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "10003", "kind": "method", "name": "contentType", "serializedName": "Content-Type", "type": { "$ref": "2305" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.contentType", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "10004", "kind": "method", "name": "body", "serializedName": "body", "type": { "$ref": "9997" }, "location": "Body", "isApiVersion": false, "optional": false, "scope": "Method", "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.body", "readOnly": false, "access": "public", "decorators": [] }, { "$id": "10005", "kind": "method", "name": "accept", "serializedName": "Accept", "type": { "$ref": "2303" }, "location": "Header", "isApiVersion": false, "optional": false, "scope": "Constant", "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix.accept", "readOnly": false, "access": "public", "decorators": [] } ], "response": { "type": { "$ref": "9871" } }, "isOverride": false, "generateConvenient": false, "generateProtocol": true, "crossLanguageDefinitionId": "OpenAI.CreateVideoRemix" } ], "parameters": [ { "$id": "10006", "kind": "endpoint", "name": "endpoint", "serializedName": "endpoint", "doc": "Service host", "type": { "$id": "10007", "kind": "url", "name": "endpoint", "crossLanguageDefinitionId": "TypeSpec.url" }, "isApiVersion": false, "optional": false, "scope": "Client", "isEndpoint": true, "defaultValue": { "type": { "$id": "10008", "kind": "string", "name": "string", "crossLanguageDefinitionId": "TypeSpec.string" }, "value": "https://api.openai.com/v1" }, "serverUrlTemplate": "{endpoint}", "skipUrlEncoding": false, "readOnly": false, "crossLanguageDefinitionId": "OpenAI.endpoint" } ], "initializedBy": 0, "decorators": [], "crossLanguageDefinitionId": "OpenAI", "apiVersions": [], "parent": { "$ref": "8231" } } ] } ], "auth": { "apiKey": { "name": "Authorization", "in": "header", "prefix": "Bearer" } } }