ogx_open_client 1.0.3.dev5__tar.gz → 1.1.0.dev0__tar.gz

ogx_open_client-1.1.0.dev0/PKG-INFO

@@ -0,0 +1,752 @@
+Metadata-Version: 2.4
+Name: ogx_open_client
+Version: 1.1.0.dev0
+Summary: OpenAPI-generated Python client for OGX (alternative SDK with OpenAPI Generator tooling)
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: The OGX Contributors <contributors@ogx.dev>
+License: MIT
+Project-URL: Homepage, https://ogx-ai.github.io
+Project-URL: Documentation, https://ogx-ai.github.io/docs
+Project-URL: Repository, https://github.com/ogx-ai/ogx
+Project-URL: Bug Tracker, https://github.com/ogx-ai/ogx/issues
+Keywords: ogx,ai,ml,openai,llm,inference,agents,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: requests>=2.34.2
+Requires-Dist: fire
+Dynamic: author
+
+# ogx-open-client
+This is the specification of the OGX that provides
+                    a set of endpoints and their corresponding interfaces that are
+    tailored to
+                    best leverage Llama Models.
+
+    **🔗 COMBINED**: This specification includes both stable production-ready APIs
+    and experimental pre-release APIs. Use stable APIs for production deployments
+    and experimental APIs for testing new features.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v1
+- Package version: 1.1.1.dev0
+- Generator version: 7.19.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import ogx_open_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import ogx_open_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import ogx_open_client
+from ogx_open_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://any-hosted-ogx.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = ogx_open_client.Configuration(
+    host = "http://any-hosted-ogx.com"
+)
+
+
+
+# Enter a context with an instance of the API client
+with ogx_open_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = ogx_open_client.AdminApi(api_client)
+    provider_id = 'provider_id_example' # str | The ID of the provider to inspect.
+
+    try:
+        # Get provider details
+        api_response = api_instance.inspect_provider(provider_id)
+        print("The response of AdminApi->inspect_provider:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AdminApi->inspect_provider: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://any-hosted-ogx.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AdminApi* | [**inspect_provider**](docs/AdminApi.md#inspect_provider) | **GET** /v1alpha/admin/providers/{provider_id} | Get provider details
+*AdminApi* | [**list_providers**](docs/AdminApi.md#list_providers) | **GET** /v1alpha/admin/providers | List all available providers
+*AdminApi* | [**list_routes**](docs/AdminApi.md#list_routes) | **GET** /v1alpha/admin/inspect/routes | List all available API routes
+*AdminApi* | [**health**](docs/AdminApi.md#health) | **GET** /v1alpha/admin/health | Get service health status
+*AdminApi* | [**version**](docs/AdminApi.md#version) | **GET** /v1alpha/admin/version | Get service version
+*AlphaApi* | [**dummy**](docs/AlphaApi.md#dummy) | **GET** /dummy/alpha | Placeholder for alpha resource group
+*BatchesApi* | [**cancel**](docs/BatchesApi.md#cancel) | **POST** /v1/batches/{batch_id}/cancel | Cancel a batch that is in progress.
+*BatchesApi* | [**retrieve**](docs/BatchesApi.md#retrieve) | **GET** /v1/batches/{batch_id} | Retrieve information about a specific batch.
+*BatchesApi* | [**create**](docs/BatchesApi.md#create) | **POST** /v1/batches | Create a new batch for processing multiple API requests.
+*BatchesApi* | [**list**](docs/BatchesApi.md#list) | **GET** /v1/batches | List all batches for the current user.
+*ChatApi* | [**dummy**](docs/ChatApi.md#dummy) | **GET** /dummy/chat | Placeholder for chat resource group
+*ChatCompletionsApi* | [**retrieve**](docs/ChatCompletionsApi.md#retrieve) | **GET** /v1/chat/completions/{completion_id} | Get chat completion.
+*ChatCompletionsApi* | [**create**](docs/ChatCompletionsApi.md#create) | **POST** /v1/chat/completions | Create chat completions.
+*ChatCompletionsApi* | [**list**](docs/ChatCompletionsApi.md#list) | **GET** /v1/chat/completions | List chat completions.
+*CompletionsApi* | [**create**](docs/CompletionsApi.md#create) | **POST** /v1/completions | Create completion.
+*ConnectorsApi* | [**connector_tool_v1alpha_admin_connectors_connector_id_tools_tool_name_get**](docs/ConnectorsApi.md#connector_tool_v1alpha_admin_connectors_connector_id_tools_tool_name_get) | **GET** /v1alpha/admin/connectors/{connector_id}/tools/{tool_name} | Get a tool by name from a connector.
+*ConnectorsApi* | [**connector_tools_v1alpha_admin_connectors_connector_id_tools_get**](docs/ConnectorsApi.md#connector_tools_v1alpha_admin_connectors_connector_id_tools_get) | **GET** /v1alpha/admin/connectors/{connector_id}/tools | List tools from a connector.
+*ConnectorsApi* | [**connector_v1alpha_admin_connectors_connector_id_get**](docs/ConnectorsApi.md#connector_v1alpha_admin_connectors_connector_id_get) | **GET** /v1alpha/admin/connectors/{connector_id} | Get a connector by its ID.
+*ConnectorsApi* | [**connectors_v1alpha_admin_connectors_get**](docs/ConnectorsApi.md#connectors_v1alpha_admin_connectors_get) | **GET** /v1alpha/admin/connectors | List all connectors.
+*ConversationsApi* | [**delete**](docs/ConversationsApi.md#delete) | **DELETE** /v1/conversations/{conversation_id} | Delete a conversation.
+*ConversationsApi* | [**retrieve**](docs/ConversationsApi.md#retrieve) | **GET** /v1/conversations/{conversation_id} | Retrieve a conversation.
+*ConversationsApi* | [**update**](docs/ConversationsApi.md#update) | **POST** /v1/conversations/{conversation_id} | Update a conversation.
+*ConversationsApi* | [**create**](docs/ConversationsApi.md#create) | **POST** /v1/conversations | Create a conversation.
+*EmbeddingsApi* | [**create**](docs/EmbeddingsApi.md#create) | **POST** /v1/embeddings | Create embeddings.
+*FileBatchesApi* | [**cancel**](docs/FileBatchesApi.md#cancel) | **POST** /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel | Cancel a vector store file batch (OpenAI-compatible).
+*FileBatchesApi* | [**create**](docs/FileBatchesApi.md#create) | **POST** /v1/vector_stores/{vector_store_id}/file_batches | Create a vector store file batch (OpenAI-compatible).
+*FileBatchesApi* | [**list_files**](docs/FileBatchesApi.md#list_files) | **GET** /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files | List files in a vector store file batch (OpenAI-compatible).
+*FileBatchesApi* | [**retrieve**](docs/FileBatchesApi.md#retrieve) | **GET** /v1/vector_stores/{vector_store_id}/file_batches/{batch_id} | Retrieve a vector store file batch (OpenAI-compatible).
+*FileProcessorsApi* | [**file_v1alpha_file_processors_process_post**](docs/FileProcessorsApi.md#file_v1alpha_file_processors_process_post) | **POST** /v1alpha/file-processors/process | Process a file into chunks ready for vector database storage.
+*FilesApi* | [**content**](docs/FilesApi.md#content) | **GET** /v1/files/{file_id}/content | Retrieve file content
+*FilesApi* | [**delete**](docs/FilesApi.md#delete) | **DELETE** /v1/files/{file_id} | Delete file
+*FilesApi* | [**retrieve**](docs/FilesApi.md#retrieve) | **GET** /v1/files/{file_id} | Get file
+*FilesApi* | [**create**](docs/FilesApi.md#create) | **POST** /v1/files | Upload file
+*FilesApi* | [**list**](docs/FilesApi.md#list) | **GET** /v1/files | List files
+*InferenceApi* | [**rerank**](docs/InferenceApi.md#rerank) | **POST** /v1alpha/inference/rerank | Rerank documents based on relevance to a query.
+*InputItemsApi* | [**list**](docs/InputItemsApi.md#list) | **GET** /v1/responses/{response_id}/input_items | List input items.
+*InspectApi* | [**health**](docs/InspectApi.md#health) | **GET** /v1/health | Get health status.
+*InspectApi* | [**version**](docs/InspectApi.md#version) | **GET** /v1/version | Get version.
+*InteractionsApi* | [**interaction_v1alpha_interactions_post**](docs/InteractionsApi.md#interaction_v1alpha_interactions_post) | **POST** /v1alpha/interactions | Create an interaction.
+*ItemsApi* | [**delete**](docs/ItemsApi.md#delete) | **DELETE** /v1/conversations/{conversation_id}/items/{item_id} | Delete an item.
+*ItemsApi* | [**get**](docs/ItemsApi.md#get) | **GET** /v1/conversations/{conversation_id}/items/{item_id} | Retrieve an item.
+*ItemsApi* | [**list**](docs/ItemsApi.md#list) | **GET** /v1/conversations/{conversation_id}/items | List items.
+*ItemsApi* | [**create**](docs/ItemsApi.md#create) | **POST** /v1/conversations/{conversation_id}/items | Create items.
+*MessagesApi* | [**list**](docs/MessagesApi.md#list) | **GET** /v1/chat/completions/{completion_id}/messages | List chat completion messages.
+*MessagesApi* | [**message_batch_results_v1_messages_batches_message_batch_id_results_get**](docs/MessagesApi.md#message_batch_results_v1_messages_batches_message_batch_id_results_get) | **GET** /v1/messages/batches/{message_batch_id}/results | Retrieve Message Batch results.
+*MessagesApi* | [**message_batch_v1_messages_batches_message_batch_id_cancel_post**](docs/MessagesApi.md#message_batch_v1_messages_batches_message_batch_id_cancel_post) | **POST** /v1/messages/batches/{message_batch_id}/cancel | Cancel a Message Batch.
+*MessagesApi* | [**message_batch_v1_messages_batches_message_batch_id_get**](docs/MessagesApi.md#message_batch_v1_messages_batches_message_batch_id_get) | **GET** /v1/messages/batches/{message_batch_id} | Retrieve a Message Batch.
+*MessagesApi* | [**message_batch_v1_messages_batches_post**](docs/MessagesApi.md#message_batch_v1_messages_batches_post) | **POST** /v1/messages/batches | Create a Message Batch.
+*MessagesApi* | [**message_batches_v1_messages_batches_get**](docs/MessagesApi.md#message_batches_v1_messages_batches_get) | **GET** /v1/messages/batches | List Message Batches.
+*MessagesApi* | [**message_tokens_v1_messages_count_tokens_post**](docs/MessagesApi.md#message_tokens_v1_messages_count_tokens_post) | **POST** /v1/messages/count_tokens | Count tokens in a message.
+*MessagesApi* | [**message_v1_messages_post**](docs/MessagesApi.md#message_v1_messages_post) | **POST** /v1/messages | Create a message.
+*ModelsApi* | [**retrieve**](docs/ModelsApi.md#retrieve) | **GET** /v1/models/{model_id} | Get a model by its identifier.
+*OpenaiApi* | [**list**](docs/OpenaiApi.md#list) | **GET** /v1/models | List models.
+*PromptsApi* | [**set_default_version**](docs/PromptsApi.md#set_default_version) | **PUT** /v1/prompts/{prompt_id}/set-default-version | Set prompt version.
+*PromptsApi* | [**create**](docs/PromptsApi.md#create) | **POST** /v1/prompts | Create a prompt.
+*PromptsApi* | [**delete**](docs/PromptsApi.md#delete) | **DELETE** /v1/prompts/{prompt_id} | Delete a prompt.
+*PromptsApi* | [**retrieve**](docs/PromptsApi.md#retrieve) | **GET** /v1/prompts/{prompt_id} | Get a prompt.
+*PromptsApi* | [**update**](docs/PromptsApi.md#update) | **PUT** /v1/prompts/{prompt_id} | Update a prompt.
+*PromptsApi* | [**list**](docs/PromptsApi.md#list) | **GET** /v1/prompts | List all prompts.
+*ProvidersApi* | [**retrieve**](docs/ProvidersApi.md#retrieve) | **GET** /v1/providers/{provider_id} | Get provider.
+*ProvidersApi* | [**list**](docs/ProvidersApi.md#list) | **GET** /v1/providers | List providers.
+*ResponsesApi* | [**compact**](docs/ResponsesApi.md#compact) | **POST** /v1/responses/compact | Compact a conversation. [alpha]
+*ResponsesApi* | [**create**](docs/ResponsesApi.md#create) | **POST** /v1/responses | Create a model response.
+*ResponsesApi* | [**openai_response_v1_responses_response_id_cancel_post**](docs/ResponsesApi.md#openai_response_v1_responses_response_id_cancel_post) | **POST** /v1/responses/{response_id}/cancel | Cancel a background response that is in progress.
+*ResponsesApi* | [**delete**](docs/ResponsesApi.md#delete) | **DELETE** /v1/responses/{response_id} | Delete a response.
+*ResponsesApi* | [**retrieve**](docs/ResponsesApi.md#retrieve) | **GET** /v1/responses/{response_id} | Get a model response.
+*ResponsesApi* | [**list**](docs/ResponsesApi.md#list) | **GET** /v1/responses | List all responses.
+*RoutesApi* | [**list**](docs/RoutesApi.md#list) | **GET** /v1/inspect/routes | List routes.
+*SkillsApi* | [**skill_content_v1alpha_skills_skill_id_content_get**](docs/SkillsApi.md#skill_content_v1alpha_skills_skill_id_content_get) | **GET** /v1alpha/skills/{skill_id}/content | Get skill content
+*SkillsApi* | [**skill_v1alpha_skills_post**](docs/SkillsApi.md#skill_v1alpha_skills_post) | **POST** /v1alpha/skills | Create skill
+*SkillsApi* | [**skill_v1alpha_skills_skill_id_delete**](docs/SkillsApi.md#skill_v1alpha_skills_skill_id_delete) | **DELETE** /v1alpha/skills/{skill_id} | Delete skill
+*SkillsApi* | [**skill_v1alpha_skills_skill_id_get**](docs/SkillsApi.md#skill_v1alpha_skills_skill_id_get) | **GET** /v1alpha/skills/{skill_id} | Get skill
+*SkillsApi* | [**skill_v1alpha_skills_skill_id_post**](docs/SkillsApi.md#skill_v1alpha_skills_skill_id_post) | **POST** /v1alpha/skills/{skill_id} | Update skill
+*SkillsApi* | [**skill_version_content_v1alpha_skills_skill_id_versions_version_content_get**](docs/SkillsApi.md#skill_version_content_v1alpha_skills_skill_id_versions_version_content_get) | **GET** /v1alpha/skills/{skill_id}/versions/{version}/content | Get skill version content
+*SkillsApi* | [**skill_version_v1alpha_skills_skill_id_versions_post**](docs/SkillsApi.md#skill_version_v1alpha_skills_skill_id_versions_post) | **POST** /v1alpha/skills/{skill_id}/versions | Create skill version
+*SkillsApi* | [**skill_version_v1alpha_skills_skill_id_versions_version_delete**](docs/SkillsApi.md#skill_version_v1alpha_skills_skill_id_versions_version_delete) | **DELETE** /v1alpha/skills/{skill_id}/versions/{version} | Delete skill version
+*SkillsApi* | [**skill_version_v1alpha_skills_skill_id_versions_version_get**](docs/SkillsApi.md#skill_version_v1alpha_skills_skill_id_versions_version_get) | **GET** /v1alpha/skills/{skill_id}/versions/{version} | Get skill version
+*SkillsApi* | [**skill_versions_v1alpha_skills_skill_id_versions_get**](docs/SkillsApi.md#skill_versions_v1alpha_skills_skill_id_versions_get) | **GET** /v1alpha/skills/{skill_id}/versions | List skill versions
+*SkillsApi* | [**skills_v1alpha_skills_get**](docs/SkillsApi.md#skills_v1alpha_skills_get) | **GET** /v1alpha/skills | List skills
+*ToolsApi* | [**tools_v1_admin_tools_get**](docs/ToolsApi.md#tools_v1_admin_tools_get) | **GET** /v1/admin/tools | List tools with optional tool group filter.
+*VectorIoApi* | [**insert**](docs/VectorIoApi.md#insert) | **POST** /v1/vector-io/insert | Insert embedded chunks into a vector database.
+*VectorIoApi* | [**query**](docs/VectorIoApi.md#query) | **POST** /v1/vector-io/query | Query chunks from a vector database.
+*VectorStoresApi* | [**create**](docs/VectorStoresApi.md#create) | **POST** /v1/vector_stores | Create a vector store (OpenAI-compatible).
+*VectorStoresApi* | [**delete**](docs/VectorStoresApi.md#delete) | **DELETE** /v1/vector_stores/{vector_store_id} | Delete a vector store (OpenAI-compatible).
+*VectorStoresApi* | [**list**](docs/VectorStoresApi.md#list) | **GET** /v1/vector_stores | List vector stores (OpenAI-compatible).
+*VectorStoresApi* | [**retrieve**](docs/VectorStoresApi.md#retrieve) | **GET** /v1/vector_stores/{vector_store_id} | Retrieve a vector store (OpenAI-compatible).
+*VectorStoresApi* | [**search**](docs/VectorStoresApi.md#search) | **POST** /v1/vector_stores/{vector_store_id}/search | Search a vector store (OpenAI-compatible).
+*VectorStoresApi* | [**update**](docs/VectorStoresApi.md#update) | **POST** /v1/vector_stores/{vector_store_id} | Update a vector store (OpenAI-compatible).
+*VectorStoresFilesApi* | [**create**](docs/VectorStoresFilesApi.md#create) | **POST** /v1/vector_stores/{vector_store_id}/files | Attach a file to a vector store (OpenAI-compatible).
+*VectorStoresFilesApi* | [**delete**](docs/VectorStoresFilesApi.md#delete) | **DELETE** /v1/vector_stores/{vector_store_id}/files/{file_id} | Delete a vector store file (OpenAI-compatible).
+*VectorStoresFilesApi* | [**list**](docs/VectorStoresFilesApi.md#list) | **GET** /v1/vector_stores/{vector_store_id}/files | List files in a vector store (OpenAI-compatible).
+*VectorStoresFilesApi* | [**content**](docs/VectorStoresFilesApi.md#content) | **GET** /v1/vector_stores/{vector_store_id}/files/{file_id}/content | Retrieve vector store file contents (OpenAI-compatible).
+*VectorStoresFilesApi* | [**retrieve**](docs/VectorStoresFilesApi.md#retrieve) | **GET** /v1/vector_stores/{vector_store_id}/files/{file_id} | Retrieve a vector store file (OpenAI-compatible).
+*VectorStoresFilesApi* | [**update**](docs/VectorStoresFilesApi.md#update) | **POST** /v1/vector_stores/{vector_store_id}/files/{file_id} | Update a vector store file (OpenAI-compatible).
+*VersionsApi* | [**list**](docs/VersionsApi.md#list) | **GET** /v1/prompts/{prompt_id}/versions | List prompt versions.
+
+
+## Documentation For Models
+
+ - [AddItemsRequest](docs/AddItemsRequest.md)
+ - [AllowedToolsConfig](docs/AllowedToolsConfig.md)
+ - [AllowedToolsFilter](docs/AllowedToolsFilter.md)
+ - [AnthropicBase64ImageSource](docs/AnthropicBase64ImageSource.md)
+ - [AnthropicBase64ImageSourceAnthropicURLImageSource](docs/AnthropicBase64ImageSourceAnthropicURLImageSource.md)
+ - [AnthropicBashTool](docs/AnthropicBashTool.md)
+ - [AnthropicCacheControl](docs/AnthropicCacheControl.md)
+ - [AnthropicCountTokensRequest](docs/AnthropicCountTokensRequest.md)
+ - [AnthropicCountTokensResponse](docs/AnthropicCountTokensResponse.md)
+ - [AnthropicCreateMessageRequest](docs/AnthropicCreateMessageRequest.md)
+ - [AnthropicCustomToolDef](docs/AnthropicCustomToolDef.md)
+ - [AnthropicCustomToolDef4Variants](docs/AnthropicCustomToolDef4Variants.md)
+ - [AnthropicImageBlock](docs/AnthropicImageBlock.md)
+ - [AnthropicListModelsResponse](docs/AnthropicListModelsResponse.md)
+ - [AnthropicMessage](docs/AnthropicMessage.md)
+ - [AnthropicMessageResponse](docs/AnthropicMessageResponse.md)
+ - [AnthropicModelInfo](docs/AnthropicModelInfo.md)
+ - [AnthropicRedactedThinkingBlock](docs/AnthropicRedactedThinkingBlock.md)
+ - [AnthropicTextBlock](docs/AnthropicTextBlock.md)
+ - [AnthropicTextBlock6Variants](docs/AnthropicTextBlock6Variants.md)
+ - [AnthropicTextBlock6Variants1](docs/AnthropicTextBlock6Variants1.md)
+ - [AnthropicTextBlockAnthropicImageBlock](docs/AnthropicTextBlockAnthropicImageBlock.md)
+ - [AnthropicTextEditorTool](docs/AnthropicTextEditorTool.md)
+ - [AnthropicThinkingBlock](docs/AnthropicThinkingBlock.md)
+ - [AnthropicThinkingConfig](docs/AnthropicThinkingConfig.md)
+ - [AnthropicToolResultBlockInput](docs/AnthropicToolResultBlockInput.md)
+ - [AnthropicToolResultBlockOutput](docs/AnthropicToolResultBlockOutput.md)
+ - [AnthropicToolUseBlock](docs/AnthropicToolUseBlock.md)
+ - [AnthropicURLImageSource](docs/AnthropicURLImageSource.md)
+ - [AnthropicUsage](docs/AnthropicUsage.md)
+ - [AnthropicWebSearchTool](docs/AnthropicWebSearchTool.md)
+ - [Api](docs/Api.md)
+ - [ApprovalFilter](docs/ApprovalFilter.md)
+ - [ArrayType](docs/ArrayType.md)
+ - [Batch](docs/Batch.md)
+ - [BatchError](docs/BatchError.md)
+ - [BatchRequestCounts](docs/BatchRequestCounts.md)
+ - [BatchUsage](docs/BatchUsage.md)
+ - [Bf16QuantizationConfig](docs/Bf16QuantizationConfig.md)
+ - [BooleanType](docs/BooleanType.md)
+ - [CancelBatchRequest](docs/CancelBatchRequest.md)
+ - [ChatCompletionInputType](docs/ChatCompletionInputType.md)
+ - [ChatCompletionMessage](docs/ChatCompletionMessage.md)
+ - [ChatCompletionMessageCustomToolCall](docs/ChatCompletionMessageCustomToolCall.md)
+ - [ChatCompletionMessageCustomToolCallCustom](docs/ChatCompletionMessageCustomToolCallCustom.md)
+ - [ChatCompletionMessageFunctionCall](docs/ChatCompletionMessageFunctionCall.md)
+ - [ChatCompletionMessageList](docs/ChatCompletionMessageList.md)
+ - [ChatCompletionMessageToolCall](docs/ChatCompletionMessageToolCall.md)
+ - [ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall](docs/ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall.md)
+ - [ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1](docs/ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1.md)
+ - [ChatCompletionMessageToolCallFunction](docs/ChatCompletionMessageToolCallFunction.md)
+ - [ChoiceDeltaToolCall](docs/ChoiceDeltaToolCall.md)
+ - [ChoiceDeltaToolCallFunction](docs/ChoiceDeltaToolCallFunction.md)
+ - [Chunk](docs/Chunk.md)
+ - [ChunkForDeletion](docs/ChunkForDeletion.md)
+ - [ChunkMetadata](docs/ChunkMetadata.md)
+ - [CompactResponseRequest](docs/CompactResponseRequest.md)
+ - [CompactResponseRequestInput](docs/CompactResponseRequestInput.md)
+ - [CompactResponseRequestModel](docs/CompactResponseRequestModel.md)
+ - [ComparisonFilter](docs/ComparisonFilter.md)
+ - [CompletionInputType](docs/CompletionInputType.md)
+ - [CompoundFilter](docs/CompoundFilter.md)
+ - [Connector](docs/Connector.md)
+ - [ConnectorInput](docs/ConnectorInput.md)
+ - [ConnectorType](docs/ConnectorType.md)
+ - [ContextManagement](docs/ContextManagement.md)
+ - [Conversation](docs/Conversation.md)
+ - [ConversationDeletedResource](docs/ConversationDeletedResource.md)
+ - [ConversationItem](docs/ConversationItem.md)
+ - [ConversationItemCreateRequest](docs/ConversationItemCreateRequest.md)
+ - [ConversationItemDeletedResource](docs/ConversationItemDeletedResource.md)
+ - [ConversationItemInclude](docs/ConversationItemInclude.md)
+ - [ConversationItemList](docs/ConversationItemList.md)
+ - [ConversationMessage](docs/ConversationMessage.md)
+ - [CreateBatchRequest](docs/CreateBatchRequest.md)
+ - [CreateConversationRequest](docs/CreateConversationRequest.md)
+ - [CreateMessageBatchRequest](docs/CreateMessageBatchRequest.md)
+ - [CreatePromptRequest](docs/CreatePromptRequest.md)
+ - [CreateResponseRequest](docs/CreateResponseRequest.md)
+ - [CustomToolConfig](docs/CustomToolConfig.md)
+ - [DeleteChunksRequest](docs/DeleteChunksRequest.md)
+ - [DeleteConversationRequest](docs/DeleteConversationRequest.md)
+ - [DeleteFileRequest](docs/DeleteFileRequest.md)
+ - [DeleteItemRequest](docs/DeleteItemRequest.md)
+ - [DeletePromptRequest](docs/DeletePromptRequest.md)
+ - [DialogType](docs/DialogType.md)
+ - [EmbeddedChunk](docs/EmbeddedChunk.md)
+ - [EmbeddedChunkInput](docs/EmbeddedChunkInput.md)
+ - [EmbeddedChunkOutput](docs/EmbeddedChunkOutput.md)
+ - [EmbeddingsResponse](docs/EmbeddingsResponse.md)
+ - [Error](docs/Error.md)
+ - [ErrorDetail](docs/ErrorDetail.md)
+ - [Errors](docs/Errors.md)
+ - [ExpiresAfter](docs/ExpiresAfter.md)
+ - [Fp8QuantizationConfig](docs/Fp8QuantizationConfig.md)
+ - [FunctionToolConfig](docs/FunctionToolConfig.md)
+ - [GetChatCompletionRequest](docs/GetChatCompletionRequest.md)
+ - [GetConnectorRequest](docs/GetConnectorRequest.md)
+ - [GetConnectorToolRequest](docs/GetConnectorToolRequest.md)
+ - [GetConversationRequest](docs/GetConversationRequest.md)
+ - [GetModelRequest](docs/GetModelRequest.md)
+ - [GetModelV1ModelsModelIdGet200Response](docs/GetModelV1ModelsModelIdGet200Response.md)
+ - [GetPromptRequest](docs/GetPromptRequest.md)
+ - [GoogleCreateInteractionRequest](docs/GoogleCreateInteractionRequest.md)
+ - [GoogleFunctionCallContent](docs/GoogleFunctionCallContent.md)
+ - [GoogleFunctionCallOutput](docs/GoogleFunctionCallOutput.md)
+ - [GoogleFunctionDeclaration](docs/GoogleFunctionDeclaration.md)
+ - [GoogleFunctionResponseContent](docs/GoogleFunctionResponseContent.md)
+ - [GoogleGenerationConfig](docs/GoogleGenerationConfig.md)
+ - [GoogleInputTurn](docs/GoogleInputTurn.md)
+ - [GoogleInteractionResponse](docs/GoogleInteractionResponse.md)
+ - [GoogleListModelsResponse](docs/GoogleListModelsResponse.md)
+ - [GoogleModelInfo](docs/GoogleModelInfo.md)
+ - [GoogleTextContent](docs/GoogleTextContent.md)
+ - [GoogleTextContentGoogleFunctionCallContentGoogleFunctionResponseContent](docs/GoogleTextContentGoogleFunctionCallContentGoogleFunctionResponseContent.md)
+ - [GoogleTextOutput](docs/GoogleTextOutput.md)
+ - [GoogleTextOutputGoogleFunctionCallOutputGoogleThoughtOutput](docs/GoogleTextOutputGoogleFunctionCallOutputGoogleThoughtOutput.md)
+ - [GoogleThoughtOutput](docs/GoogleThoughtOutput.md)
+ - [GoogleTool](docs/GoogleTool.md)
+ - [GoogleUsage](docs/GoogleUsage.md)
+ - [GrammarResponseFormat](docs/GrammarResponseFormat.md)
+ - [GreedySamplingStrategy](docs/GreedySamplingStrategy.md)
+ - [GreedySamplingStrategyTopPSamplingStrategyTopKSamplingStrategy](docs/GreedySamplingStrategyTopPSamplingStrategyTopKSamplingStrategy.md)
+ - [HealthInfo](docs/HealthInfo.md)
+ - [HealthStatus](docs/HealthStatus.md)
+ - [ImageContentItem](docs/ImageContentItem.md)
+ - [ImageContentItemInput](docs/ImageContentItemInput.md)
+ - [ImageContentItemInputTextContentItem](docs/ImageContentItemInputTextContentItem.md)
+ - [ImageContentItemOutput](docs/ImageContentItemOutput.md)
+ - [ImageContentItemOutputTextContentItem](docs/ImageContentItemOutputTextContentItem.md)
+ - [ImageContentItemTextContentItem](docs/ImageContentItemTextContentItem.md)
+ - [ImageDelta](docs/ImageDelta.md)
+ - [InlineProviderSpec](docs/InlineProviderSpec.md)
+ - [InputTokensDetails](docs/InputTokensDetails.md)
+ - [InsertChunksRequest](docs/InsertChunksRequest.md)
+ - [InspectProviderRequest](docs/InspectProviderRequest.md)
+ - [Int4QuantizationConfig](docs/Int4QuantizationConfig.md)
+ - [IntegerNumber](docs/IntegerNumber.md)
+ - [InterleavedContent](docs/InterleavedContent.md)
+ - [InterleavedContentItem](docs/InterleavedContentItem.md)
+ - [Job](docs/Job.md)
+ - [JobStatus](docs/JobStatus.md)
+ - [JsonSchemaResponseFormat](docs/JsonSchemaResponseFormat.md)
+ - [JsonType](docs/JsonType.md)
+ - [ListBatchesRequest](docs/ListBatchesRequest.md)
+ - [ListBatchesResponse](docs/ListBatchesResponse.md)
+ - [ListChatCompletionMessagesRequest](docs/ListChatCompletionMessagesRequest.md)
+ - [ListChatCompletionsRequest](docs/ListChatCompletionsRequest.md)
+ - [ListConnectorToolsRequest](docs/ListConnectorToolsRequest.md)
+ - [ListConnectorsResponse](docs/ListConnectorsResponse.md)
+ - [ListFilesRequest](docs/ListFilesRequest.md)
+ - [ListItemsRequest](docs/ListItemsRequest.md)
+ - [ListMessageBatchesResponse](docs/ListMessageBatchesResponse.md)
+ - [ListModelsResponse](docs/ListModelsResponse.md)
+ - [ListModelsV1ModelsGet200Response](docs/ListModelsV1ModelsGet200Response.md)
+ - [ListNumberString](docs/ListNumberString.md)
+ - [ListOpenAIChatCompletionResponse](docs/ListOpenAIChatCompletionResponse.md)
+ - [ListOpenAIFileResponse](docs/ListOpenAIFileResponse.md)
+ - [ListOpenAIResponseInputItem](docs/ListOpenAIResponseInputItem.md)
+ - [ListOpenAIResponseObject](docs/ListOpenAIResponseObject.md)
+ - [ListPromptVersionsRequest](docs/ListPromptVersionsRequest.md)
+ - [ListPromptsResponse](docs/ListPromptsResponse.md)
+ - [ListProvidersResponse](docs/ListProvidersResponse.md)
+ - [ListRoutesRequest](docs/ListRoutesRequest.md)
+ - [ListRoutesResponse](docs/ListRoutesResponse.md)
+ - [ListSkillVersionsRequest](docs/ListSkillVersionsRequest.md)
+ - [ListSkillVersionsResponse](docs/ListSkillVersionsResponse.md)
+ - [ListSkillsRequest](docs/ListSkillsRequest.md)
+ - [ListSkillsResponse](docs/ListSkillsResponse.md)
+ - [ListStringAllowedToolsFilter](docs/ListStringAllowedToolsFilter.md)
+ - [ListToolDefsResponse](docs/ListToolDefsResponse.md)
+ - [ListToolGroupsResponse](docs/ListToolGroupsResponse.md)
+ - [ListToolsRequest](docs/ListToolsRequest.md)
+ - [ListToolsResponse](docs/ListToolsResponse.md)
+ - [MCPListToolsTool](docs/MCPListToolsTool.md)
+ - [MessageBatch](docs/MessageBatch.md)
+ - [MessageBatchRequestCounts](docs/MessageBatchRequestCounts.md)
+ - [MessageBatchRequestParams](docs/MessageBatchRequestParams.md)
+ - [MetricInResponse](docs/MetricInResponse.md)
+ - [Model](docs/Model.md)
+ - [ModelType](docs/ModelType.md)
+ - [NumberType](docs/NumberType.md)
+ - [ObjectType](docs/ObjectType.md)
+ - [OpenAIAssistantMessageParam](docs/OpenAIAssistantMessageParam.md)
+ - [OpenAIAssistantMessageParamInput](docs/OpenAIAssistantMessageParamInput.md)
+ - [OpenAIAssistantMessageParamOutput](docs/OpenAIAssistantMessageParamOutput.md)
+ - [OpenAIAttachFileRequest](docs/OpenAIAttachFileRequest.md)
+ - [OpenAIChatCompletion](docs/OpenAIChatCompletion.md)
+ - [OpenAIChatCompletionChunk](docs/OpenAIChatCompletionChunk.md)
+ - [OpenAIChatCompletionContentPartImageParam](docs/OpenAIChatCompletionContentPartImageParam.md)
+ - [OpenAIChatCompletionContentPartParam](docs/OpenAIChatCompletionContentPartParam.md)
+ - [OpenAIChatCompletionContentPartTextParam](docs/OpenAIChatCompletionContentPartTextParam.md)
+ - [OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam](docs/OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam.md)
+ - [OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParamOpenAIFile](docs/OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParamOpenAIFile.md)
+ - [OpenAIChatCompletionCustomToolCallFunction](docs/OpenAIChatCompletionCustomToolCallFunction.md)
+ - [OpenAIChatCompletionRequestWithExtraBody](docs/OpenAIChatCompletionRequestWithExtraBody.md)
+ - [OpenAIChatCompletionResponseMessage](docs/OpenAIChatCompletionResponseMessage.md)
+ - [OpenAIChatCompletionToolCallFunction](docs/OpenAIChatCompletionToolCallFunction.md)
+ - [OpenAIChatCompletionToolChoice](docs/OpenAIChatCompletionToolChoice.md)
+ - [OpenAIChatCompletionToolChoiceAllowedTools](docs/OpenAIChatCompletionToolChoiceAllowedTools.md)
+ - [OpenAIChatCompletionToolChoiceCustomTool](docs/OpenAIChatCompletionToolChoiceCustomTool.md)
+ - [OpenAIChatCompletionToolChoiceFunctionTool](docs/OpenAIChatCompletionToolChoiceFunctionTool.md)
+ - [OpenAIChatCompletionUsage](docs/OpenAIChatCompletionUsage.md)
+ - [OpenAIChatCompletionUsageCompletionTokensDetails](docs/OpenAIChatCompletionUsageCompletionTokensDetails.md)
+ - [OpenAIChatCompletionUsagePromptTokensDetails](docs/OpenAIChatCompletionUsagePromptTokensDetails.md)
+ - [OpenAIChoice](docs/OpenAIChoice.md)
+ - [OpenAIChoiceDelta](docs/OpenAIChoiceDelta.md)
+ - [OpenAIChoiceLogprobs](docs/OpenAIChoiceLogprobs.md)
+ - [OpenAIChunkChoice](docs/OpenAIChunkChoice.md)
+ - [OpenAIChunkChoiceLogprobs](docs/OpenAIChunkChoiceLogprobs.md)
+ - [OpenAICompactedResponse](docs/OpenAICompactedResponse.md)
+ - [OpenAICompletion](docs/OpenAICompletion.md)
+ - [OpenAICompletionChoice](docs/OpenAICompletionChoice.md)
+ - [OpenAICompletionLogprobs](docs/OpenAICompletionLogprobs.md)
+ - [OpenAICompletionRequestWithExtraBody](docs/OpenAICompletionRequestWithExtraBody.md)
+ - [OpenAICompletionWithInputMessages](docs/OpenAICompletionWithInputMessages.md)
+ - [OpenAICreateVectorStoreFileBatchRequestWithExtraBody](docs/OpenAICreateVectorStoreFileBatchRequestWithExtraBody.md)
+ - [OpenAICreateVectorStoreRequestWithExtraBody](docs/OpenAICreateVectorStoreRequestWithExtraBody.md)
+ - [OpenAIDeleteResponseObject](docs/OpenAIDeleteResponseObject.md)
+ - [OpenAIDeveloperMessageParam](docs/OpenAIDeveloperMessageParam.md)
+ - [OpenAIEmbeddingData](docs/OpenAIEmbeddingData.md)
+ - [OpenAIEmbeddingUsage](docs/OpenAIEmbeddingUsage.md)
+ - [OpenAIEmbeddingsRequestWithExtraBody](docs/OpenAIEmbeddingsRequestWithExtraBody.md)
+ - [OpenAIEmbeddingsResponse](docs/OpenAIEmbeddingsResponse.md)
+ - [OpenAIFile](docs/OpenAIFile.md)
+ - [OpenAIFileDeleteResponse](docs/OpenAIFileDeleteResponse.md)
+ - [OpenAIFileFile](docs/OpenAIFileFile.md)
+ - [OpenAIFileObject](docs/OpenAIFileObject.md)
+ - [OpenAIFilePurpose](docs/OpenAIFilePurpose.md)
+ - [OpenAIFileUploadPurpose](docs/OpenAIFileUploadPurpose.md)
+ - [OpenAIFinishReason](docs/OpenAIFinishReason.md)
+ - [OpenAIImageURL](docs/OpenAIImageURL.md)
+ - [OpenAIJSONSchema](docs/OpenAIJSONSchema.md)
+ - [OpenAIListModelsResponse](docs/OpenAIListModelsResponse.md)
+ - [OpenAIMessageParam](docs/OpenAIMessageParam.md)
+ - [OpenAIModel](docs/OpenAIModel.md)
+ - [OpenAIResponseAnnotationCitation](docs/OpenAIResponseAnnotationCitation.md)
+ - [OpenAIResponseAnnotationContainerFileCitation](docs/OpenAIResponseAnnotationContainerFileCitation.md)
+ - [OpenAIResponseAnnotationFileCitation](docs/OpenAIResponseAnnotationFileCitation.md)
+ - [OpenAIResponseAnnotationFileCitation4Variants](docs/OpenAIResponseAnnotationFileCitation4Variants.md)
+ - [OpenAIResponseAnnotationFilePath](docs/OpenAIResponseAnnotationFilePath.md)
+ - [OpenAIResponseAnnotations](docs/OpenAIResponseAnnotations.md)
+ - [OpenAIResponseCompaction](docs/OpenAIResponseCompaction.md)
+ - [OpenAIResponseContentPart](docs/OpenAIResponseContentPart.md)
+ - [OpenAIResponseContentPartOutputText](docs/OpenAIResponseContentPartOutputText.md)
+ - [OpenAIResponseContentPartOutputTextOpenAIResponseContentPartRefusalOpenAIResponseContentPartReasoningText](docs/OpenAIResponseContentPartOutputTextOpenAIResponseContentPartRefusalOpenAIResponseContentPartReasoningText.md)
+ - [OpenAIResponseContentPartReasoningSummary](docs/OpenAIResponseContentPartReasoningSummary.md)
+ - [OpenAIResponseContentPartReasoningText](docs/OpenAIResponseContentPartReasoningText.md)
+ - [OpenAIResponseContentPartRefusal](docs/OpenAIResponseContentPartRefusal.md)
+ - [OpenAIResponseError](docs/OpenAIResponseError.md)
+ - [OpenAIResponseFormatJSONObject](docs/OpenAIResponseFormatJSONObject.md)
+ - [OpenAIResponseFormatJSONSchema](docs/OpenAIResponseFormatJSONSchema.md)
+ - [OpenAIResponseFormatParam](docs/OpenAIResponseFormatParam.md)
+ - [OpenAIResponseFormatText](docs/OpenAIResponseFormatText.md)
+ - [OpenAIResponseFormatTextOpenAIResponseFormatJSONSchemaOpenAIResponseFormatJSONObject](docs/OpenAIResponseFormatTextOpenAIResponseFormatJSONSchemaOpenAIResponseFormatJSONObject.md)
+ - [OpenAIResponseIncompleteDetails](docs/OpenAIResponseIncompleteDetails.md)
+ - [OpenAIResponseInput](docs/OpenAIResponseInput.md)
+ - [OpenAIResponseInputFunctionToolCallOutput](docs/OpenAIResponseInputFunctionToolCallOutput.md)
+ - [OpenAIResponseInputFunctionToolCallOutputOpenAIResponseMCPApprovalResponseOpenAIResponseCompaction](docs/OpenAIResponseInputFunctionToolCallOutputOpenAIResponseMCPApprovalResponseOpenAIResponseCompaction.md)
+ - [OpenAIResponseInputMessageContent](docs/OpenAIResponseInputMessageContent.md)
+ - [OpenAIResponseInputMessageContentFile](docs/OpenAIResponseInputMessageContentFile.md)
+ - [OpenAIResponseInputMessageContentImage](docs/OpenAIResponseInputMessageContentImage.md)
+ - [OpenAIResponseInputMessageContentText](docs/OpenAIResponseInputMessageContentText.md)
+ - [OpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFile](docs/OpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFile.md)
+ - [OpenAIResponseInputTool](docs/OpenAIResponseInputTool.md)
+ - [OpenAIResponseInputToolChoice](docs/OpenAIResponseInputToolChoice.md)
+ - [OpenAIResponseInputToolChoiceAllowedTools](docs/OpenAIResponseInputToolChoiceAllowedTools.md)
+ - [OpenAIResponseInputToolChoiceAllowedTools6Variants](docs/OpenAIResponseInputToolChoiceAllowedTools6Variants.md)
+ - [OpenAIResponseInputToolChoiceCustomTool](docs/OpenAIResponseInputToolChoiceCustomTool.md)
+ - [OpenAIResponseInputToolChoiceFileSearch](docs/OpenAIResponseInputToolChoiceFileSearch.md)
+ - [OpenAIResponseInputToolChoiceFunctionTool](docs/OpenAIResponseInputToolChoiceFunctionTool.md)
+ - [OpenAIResponseInputToolChoiceMCPTool](docs/OpenAIResponseInputToolChoiceMCPTool.md)
+ - [OpenAIResponseInputToolChoiceMode](docs/OpenAIResponseInputToolChoiceMode.md)
+ - [OpenAIResponseInputToolChoiceMode1](docs/OpenAIResponseInputToolChoiceMode1.md)
+ - [OpenAIResponseInputToolChoiceMode2](docs/OpenAIResponseInputToolChoiceMode2.md)
+ - [OpenAIResponseInputToolChoiceWebSearch](docs/OpenAIResponseInputToolChoiceWebSearch.md)
+ - [OpenAIResponseInputToolFileSearch](docs/OpenAIResponseInputToolFileSearch.md)
+ - [OpenAIResponseInputToolFunction](docs/OpenAIResponseInputToolFunction.md)
+ - [OpenAIResponseInputToolMCP](docs/OpenAIResponseInputToolMCP.md)
+ - [OpenAIResponseInputToolWebSearch](docs/OpenAIResponseInputToolWebSearch.md)
+ - [OpenAIResponseInputToolWebSearch4Variants](docs/OpenAIResponseInputToolWebSearch4Variants.md)
+ - [OpenAIResponseInputToolWebSearch4Variants1](docs/OpenAIResponseInputToolWebSearch4Variants1.md)
+ - [OpenAIResponseMCPApprovalRequest](docs/OpenAIResponseMCPApprovalRequest.md)
+ - [OpenAIResponseMCPApprovalResponse](docs/OpenAIResponseMCPApprovalResponse.md)
+ - [OpenAIResponseMessage](docs/OpenAIResponseMessage.md)
+ - [OpenAIResponseMessage11Variants](docs/OpenAIResponseMessage11Variants.md)
+ - [OpenAIResponseMessage8Variants](docs/OpenAIResponseMessage8Variants.md)
+ - [OpenAIResponseMessageInput](docs/OpenAIResponseMessageInput.md)
+ - [OpenAIResponseMessageInput11Variants](docs/OpenAIResponseMessageInput11Variants.md)
+ - [OpenAIResponseMessageInput8Variants](docs/OpenAIResponseMessageInput8Variants.md)
+ - [OpenAIResponseMessageOutput](docs/OpenAIResponseMessageOutput.md)
+ - [OpenAIResponseMessageOutput11Variants](docs/OpenAIResponseMessageOutput11Variants.md)
+ - [OpenAIResponseMessageOutput8Variants](docs/OpenAIResponseMessageOutput8Variants.md)
+ - [OpenAIResponseMessageOutputUnion](docs/OpenAIResponseMessageOutputUnion.md)
+ - [OpenAIResponseObject](docs/OpenAIResponseObject.md)
+ - [OpenAIResponseObjectStream](docs/OpenAIResponseObjectStream.md)
+ - [OpenAIResponseObjectStreamError](docs/OpenAIResponseObjectStreamError.md)
+ - [OpenAIResponseObjectStreamResponseCompleted](docs/OpenAIResponseObjectStreamResponseCompleted.md)
+ - [OpenAIResponseObjectStreamResponseContentPartAdded](docs/OpenAIResponseObjectStreamResponseContentPartAdded.md)
+ - [OpenAIResponseObjectStreamResponseContentPartDone](docs/OpenAIResponseObjectStreamResponseContentPartDone.md)
+ - [OpenAIResponseObjectStreamResponseCreated](docs/OpenAIResponseObjectStreamResponseCreated.md)
+ - [OpenAIResponseObjectStreamResponseFailed](docs/OpenAIResponseObjectStreamResponseFailed.md)
+ - [OpenAIResponseObjectStreamResponseFileSearchCallCompleted](docs/OpenAIResponseObjectStreamResponseFileSearchCallCompleted.md)
+ - [OpenAIResponseObjectStreamResponseFileSearchCallInProgress](docs/OpenAIResponseObjectStreamResponseFileSearchCallInProgress.md)
+ - [OpenAIResponseObjectStreamResponseFileSearchCallSearching](docs/OpenAIResponseObjectStreamResponseFileSearchCallSearching.md)
+ - [OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta](docs/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta.md)
+ - [OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone](docs/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone.md)
+ - [OpenAIResponseObjectStreamResponseInProgress](docs/OpenAIResponseObjectStreamResponseInProgress.md)
+ - [OpenAIResponseObjectStreamResponseIncomplete](docs/OpenAIResponseObjectStreamResponseIncomplete.md)
+ - [OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta](docs/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta.md)
+ - [OpenAIResponseObjectStreamResponseMcpCallArgumentsDone](docs/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone.md)
+ - [OpenAIResponseObjectStreamResponseMcpCallCompleted](docs/OpenAIResponseObjectStreamResponseMcpCallCompleted.md)
+ - [OpenAIResponseObjectStreamResponseMcpCallFailed](docs/OpenAIResponseObjectStreamResponseMcpCallFailed.md)
+ - [OpenAIResponseObjectStreamResponseMcpCallInProgress](docs/OpenAIResponseObjectStreamResponseMcpCallInProgress.md)
+ - [OpenAIResponseObjectStreamResponseMcpListToolsCompleted](docs/OpenAIResponseObjectStreamResponseMcpListToolsCompleted.md)
+ - [OpenAIResponseObjectStreamResponseMcpListToolsFailed](docs/OpenAIResponseObjectStreamResponseMcpListToolsFailed.md)
+ - [OpenAIResponseObjectStreamResponseMcpListToolsInProgress](docs/OpenAIResponseObjectStreamResponseMcpListToolsInProgress.md)
+ - [OpenAIResponseObjectStreamResponseOutputItemAdded](docs/OpenAIResponseObjectStreamResponseOutputItemAdded.md)
+ - [OpenAIResponseObjectStreamResponseOutputItemDone](docs/OpenAIResponseObjectStreamResponseOutputItemDone.md)
+ - [OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded](docs/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded.md)
+ - [OpenAIResponseObjectStreamResponseOutputTextDelta](docs/OpenAIResponseObjectStreamResponseOutputTextDelta.md)
+ - [OpenAIResponseObjectStreamResponseOutputTextDone](docs/OpenAIResponseObjectStreamResponseOutputTextDone.md)
+ - [OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded](docs/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded.md)
+ - [OpenAIResponseObjectStreamResponseReasoningSummaryPartDone](docs/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone.md)
+ - [OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta](docs/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta.md)
+ - [OpenAIResponseObjectStreamResponseReasoningSummaryTextDone](docs/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone.md)
+ - [OpenAIResponseObjectStreamResponseReasoningTextDelta](docs/OpenAIResponseObjectStreamResponseReasoningTextDelta.md)
+ - [OpenAIResponseObjectStreamResponseReasoningTextDone](docs/OpenAIResponseObjectStreamResponseReasoningTextDone.md)
+ - [OpenAIResponseObjectStreamResponseRefusalDelta](docs/OpenAIResponseObjectStreamResponseRefusalDelta.md)
+ - [OpenAIResponseObjectStreamResponseRefusalDone](docs/OpenAIResponseObjectStreamResponseRefusalDone.md)
+ - [OpenAIResponseObjectStreamResponseWebSearchCallCompleted](docs/OpenAIResponseObjectStreamResponseWebSearchCallCompleted.md)
+ - [OpenAIResponseObjectStreamResponseWebSearchCallInProgress](docs/OpenAIResponseObjectStreamResponseWebSearchCallInProgress.md)
+ - [OpenAIResponseObjectStreamResponseWebSearchCallSearching](docs/OpenAIResponseObjectStreamResponseWebSearchCallSearching.md)
+ - [OpenAIResponseObjectWithInput](docs/OpenAIResponseObjectWithInput.md)
+ - [OpenAIResponseOutput](docs/OpenAIResponseOutput.md)
+ - [OpenAIResponseOutputItem](docs/OpenAIResponseOutputItem.md)
+ - [OpenAIResponseOutputMessageContent](docs/OpenAIResponseOutputMessageContent.md)
+ - [OpenAIResponseOutputMessageContentOutputText](docs/OpenAIResponseOutputMessageContentOutputText.md)
+ - [OpenAIResponseOutputMessageContentOutputTextInput](docs/OpenAIResponseOutputMessageContentOutputTextInput.md)
+ - [OpenAIResponseOutputMessageContentOutputTextInputOpenAIResponseContentPartRefusal](docs/OpenAIResponseOutputMessageContentOutputTextInputOpenAIResponseContentPartRefusal.md)
+ - [OpenAIResponseOutputMessageContentOutputTextOpenAIResponseContentPartRefusal](docs/OpenAIResponseOutputMessageContentOutputTextOpenAIResponseContentPartRefusal.md)
+ - [OpenAIResponseOutputMessageContentOutputTextOutput](docs/OpenAIResponseOutputMessageContentOutputTextOutput.md)
+ - [OpenAIResponseOutputMessageContentOutputTextOutputOpenAIResponseContentPartRefusal](docs/OpenAIResponseOutputMessageContentOutputTextOutputOpenAIResponseContentPartRefusal.md)
+ - [OpenAIResponseOutputMessageFileSearchToolCall](docs/OpenAIResponseOutputMessageFileSearchToolCall.md)
+ - [OpenAIResponseOutputMessageFileSearchToolCallResults](docs/OpenAIResponseOutputMessageFileSearchToolCallResults.md)
+ - [OpenAIResponseOutputMessageFunctionToolCall](docs/OpenAIResponseOutputMessageFunctionToolCall.md)
+ - [OpenAIResponseOutputMessageMCPCall](docs/OpenAIResponseOutputMessageMCPCall.md)
+ - [OpenAIResponseOutputMessageMCPListTools](docs/OpenAIResponseOutputMessageMCPListTools.md)
+ - [OpenAIResponseOutputMessageReasoningContent](docs/OpenAIResponseOutputMessageReasoningContent.md)
+ - [OpenAIResponseOutputMessageReasoningItem](docs/OpenAIResponseOutputMessageReasoningItem.md)
+ - [OpenAIResponseOutputMessageReasoningSummary](docs/OpenAIResponseOutputMessageReasoningSummary.md)
+ - [OpenAIResponseOutputMessageWebSearchToolCall](docs/OpenAIResponseOutputMessageWebSearchToolCall.md)
+ - [OpenAIResponseOutputMessageWebSearchToolCallInput](docs/OpenAIResponseOutputMessageWebSearchToolCallInput.md)
+ - [OpenAIResponseOutputMessageWebSearchToolCallOutput](docs/OpenAIResponseOutputMessageWebSearchToolCallOutput.md)
+ - [OpenAIResponsePrompt](docs/OpenAIResponsePrompt.md)
+ - [OpenAIResponseReasoning](docs/OpenAIResponseReasoning.md)
+ - [OpenAIResponseText](docs/OpenAIResponseText.md)
+ - [OpenAIResponseTextFormat](docs/OpenAIResponseTextFormat.md)
+ - [OpenAIResponseTool](docs/OpenAIResponseTool.md)
+ - [OpenAIResponseToolMCP](docs/OpenAIResponseToolMCP.md)
+ - [OpenAIResponseUsage](docs/OpenAIResponseUsage.md)
+ - [OpenAIResponseUsageInputTokensDetails](docs/OpenAIResponseUsageInputTokensDetails.md)
+ - [OpenAIResponseUsageOutputTokensDetails](docs/OpenAIResponseUsageOutputTokensDetails.md)
+ - [OpenAISearchVectorStoreRequest](docs/OpenAISearchVectorStoreRequest.md)
+ - [OpenAISystemMessageParam](docs/OpenAISystemMessageParam.md)
+ - [OpenAITokenLogProb](docs/OpenAITokenLogProb.md)
+ - [OpenAIToolMessageParam](docs/OpenAIToolMessageParam.md)
+ - [OpenAITopLogProb](docs/OpenAITopLogProb.md)
+ - [OpenAIUpdateVectorStoreFileRequest](docs/OpenAIUpdateVectorStoreFileRequest.md)
+ - [OpenAIUpdateVectorStoreRequest](docs/OpenAIUpdateVectorStoreRequest.md)
+ - [OpenAIUserMessageParam](docs/OpenAIUserMessageParam.md)
+ - [OpenAIUserMessageParamInput](docs/OpenAIUserMessageParamInput.md)
+ - [OpenAIUserMessageParamInput5Variants](docs/OpenAIUserMessageParamInput5Variants.md)
+ - [OpenAIUserMessageParamOutput](docs/OpenAIUserMessageParamOutput.md)
+ - [OpenAIUserMessageParamOutput5Variants](docs/OpenAIUserMessageParamOutput5Variants.md)
+ - [Order](docs/Order.md)
+ - [OutputTokensDetails](docs/OutputTokensDetails.md)
+ - [PaginatedResponse](docs/PaginatedResponse.md)
+ - [ParamType](docs/ParamType.md)
+ - [ProcessFileRequest](docs/ProcessFileRequest.md)
+ - [ProcessFileResponse](docs/ProcessFileResponse.md)
+ - [Prompt](docs/Prompt.md)
+ - [ProviderInfo](docs/ProviderInfo.md)
+ - [ProviderSpec](docs/ProviderSpec.md)
+ - [QueryChunksRequest](docs/QueryChunksRequest.md)
+ - [QueryChunksResponse](docs/QueryChunksResponse.md)
+ - [RegisterModelRequest](docs/RegisterModelRequest.md)
+ - [RemoteProviderSpec](docs/RemoteProviderSpec.md)
+ - [RerankData](docs/RerankData.md)
+ - [RerankRequest](docs/RerankRequest.md)
+ - [RerankResponse](docs/RerankResponse.md)
+ - [ResponseFormat](docs/ResponseFormat.md)
+ - [ResponseItemInclude](docs/ResponseItemInclude.md)
+ - [ResponseRetrieveItemV1ConversationsConversationIdItemsItemIdGet](docs/ResponseRetrieveItemV1ConversationsConversationIdItemsItemIdGet.md)
+ - [ResponseStreamOptions](docs/ResponseStreamOptions.md)
+ - [ResponseTruncation](docs/ResponseTruncation.md)
+ - [RetrieveBatchRequest](docs/RetrieveBatchRequest.md)
+ - [RetrieveFileContentRequest](docs/RetrieveFileContentRequest.md)
+ - [RetrieveFileRequest](docs/RetrieveFileRequest.md)
+ - [RetrieveItemRequest](docs/RetrieveItemRequest.md)
+ - [RouteInfo](docs/RouteInfo.md)
+ - [SamplingParams](docs/SamplingParams.md)
+ - [SamplingStrategy](docs/SamplingStrategy.md)
+ - [ScoreRequest](docs/ScoreRequest.md)
+ - [ScoringResult](docs/ScoringResult.md)
+ - [SearchRankingOptions](docs/SearchRankingOptions.md)
+ - [ServiceTier](docs/ServiceTier.md)
+ - [SetDefaultVersionBodyRequest](docs/SetDefaultVersionBodyRequest.md)
+ - [SetDefaultVersionRequest](docs/SetDefaultVersionRequest.md)
+ - [Skill](docs/Skill.md)
+ - [SkillDeleteResponse](docs/SkillDeleteResponse.md)
+ - [SkillUpdateRequest](docs/SkillUpdateRequest.md)
+ - [SkillVersion](docs/SkillVersion.md)
+ - [SkillVersionCreateRequest](docs/SkillVersionCreateRequest.md)
+ - [SkillVersionDeleteResponse](docs/SkillVersionDeleteResponse.md)
+ - [String4Variants](docs/String4Variants.md)
+ - [String4Variants1](docs/String4Variants1.md)
+ - [StringApprovalFilter](docs/StringApprovalFilter.md)
+ - [StringListAnthropicTextBlock](docs/StringListAnthropicTextBlock.md)
+ - [StringListAnthropicTextBlock1](docs/StringListAnthropicTextBlock1.md)
+ - [StringListAnthropicTextBlockAnthropicImageBlock](docs/StringListAnthropicTextBlockAnthropicImageBlock.md)
+ - [StringListGoogleInputTurn](docs/StringListGoogleInputTurn.md)
+ - [StringListGoogleTextContentGoogleFunctionCallContentGoogleFunctionResponseContent](docs/StringListGoogleTextContentGoogleFunctionCallContentGoogleFunctionResponseContent.md)
+ - [StringListImageContentItemInputTextContentItem](docs/StringListImageContentItemInputTextContentItem.md)
+ - [StringListImageContentItemInputTextContentItem1](docs/StringListImageContentItemInputTextContentItem1.md)
+ - [StringListImageContentItemOutputTextContentItem](docs/StringListImageContentItemOutputTextContentItem.md)
+ - [StringListImageContentItemTextContentItem](docs/StringListImageContentItemTextContentItem.md)
+ - [StringListImageContentItemTextContentItem1](docs/StringListImageContentItemTextContentItem1.md)
+ - [StringListImageContentItemTextContentItem2](docs/StringListImageContentItemTextContentItem2.md)
+ - [StringListImageContentItemTextContentItem3](docs/StringListImageContentItemTextContentItem3.md)
+ - [StringListImageContentItemTextContentItem4](docs/StringListImageContentItemTextContentItem4.md)
+ - [StringListImageContentItemTextContentItem5](docs/StringListImageContentItemTextContentItem5.md)
+ - [StringListOpenAIChatCompletionContentPartTextParam](docs/StringListOpenAIChatCompletionContentPartTextParam.md)
+ - [StringListOpenAIChatCompletionContentPartTextParam1](docs/StringListOpenAIChatCompletionContentPartTextParam1.md)
+ - [StringListOpenAIChatCompletionContentPartTextParam2](docs/StringListOpenAIChatCompletionContentPartTextParam2.md)
+ - [StringListOpenAIChatCompletionContentPartTextParam3](docs/StringListOpenAIChatCompletionContentPartTextParam3.md)
+ - [StringListOpenAIChatCompletionContentPartTextParam4](docs/StringListOpenAIChatCompletionContentPartTextParam4.md)
+ - [StringListOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParamOpenAIFile](docs/StringListOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParamOpenAIFile.md)
+ - [StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFile](docs/StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFile.md)
+ - [StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextInputOpenAIResponseContentPartRefusal](docs/StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextInputOpenAIResponseContentPartRefusal.md)
+ - [StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextOpenAIResponseContentPartRefusal](docs/StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextOpenAIResponseContentPartRefusal.md)
+ - [StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextOutputOpenAIResponseContentPartRefusal](docs/StringListOpenAIResponseInputMessageContentTextOpenAIResponseInputMessageContentImageOpenAIResponseInputMessageContentFileListOpenAIResponseOutputMessageContentOutputTextOutputOpenAIResponseContentPartRefusal.md)
+ - [StringListOpenAIResponseMessageUnionOpenAIResponseInputFunctionToolCallOutput](docs/StringListOpenAIResponseMessageUnionOpenAIResponseInputFunctionToolCallOutput.md)
+ - [StringListString](docs/StringListString.md)
+ - [StringListString1](docs/StringListString1.md)
+ - [StringListString2](docs/StringListString2.md)
+ - [StringNumberBoolean](docs/StringNumberBoolean.md)
+ - [StringNumberBoolean1](docs/StringNumberBoolean1.md)
+ - [StringObject](docs/StringObject.md)
+ - [StringObject1](docs/StringObject1.md)
+ - [StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam](docs/StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam.md)
+ - [StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam1](docs/StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam1.md)
+ - [StringType](docs/StringType.md)
+ - [SystemMessage](docs/SystemMessage.md)
+ - [TextContentItem](docs/TextContentItem.md)
+ - [TextDelta](docs/TextDelta.md)
+ - [TokenLogProbs](docs/TokenLogProbs.md)
+ - [ToolChoiceAny](docs/ToolChoiceAny.md)
+ - [ToolChoiceAuto](docs/ToolChoiceAuto.md)
+ - [ToolChoiceAuto4Variants](docs/ToolChoiceAuto4Variants.md)
+ - [ToolChoiceNone](docs/ToolChoiceNone.md)
+ - [ToolChoiceTool](docs/ToolChoiceTool.md)
+ - [ToolConfig](docs/ToolConfig.md)
+ - [ToolDef](docs/ToolDef.md)
+ - [ToolGroup](docs/ToolGroup.md)
+ - [ToolGroupInput](docs/ToolGroupInput.md)
+ - [ToolInvocationResult](docs/ToolInvocationResult.md)
+ - [ToolResponseMessage](docs/ToolResponseMessage.md)
+ - [TopKSamplingStrategy](docs/TopKSamplingStrategy.md)
+ - [TopPSamplingStrategy](docs/TopPSamplingStrategy.md)
+ - [URL](docs/URL.md)
+ - [URLOrData](docs/URLOrData.md)
+ - [UnionType](docs/UnionType.md)
+ - [UnregisterModelRequest](docs/UnregisterModelRequest.md)
+ - [UpdateConversationRequest](docs/UpdateConversationRequest.md)
+ - [UpdatePromptBodyRequest](docs/UpdatePromptBodyRequest.md)
+ - [UpdatePromptRequest](docs/UpdatePromptRequest.md)
+ - [UploadFileRequest](docs/UploadFileRequest.md)
+ - [UserMessage](docs/UserMessage.md)
+ - [VectorStoreChunkingStrategy](docs/VectorStoreChunkingStrategy.md)
+ - [VectorStoreChunkingStrategyAuto](docs/VectorStoreChunkingStrategyAuto.md)
+ - [VectorStoreChunkingStrategyAutoVectorStoreChunkingStrategyStaticVectorStoreChunkingStrategyContextual](docs/VectorStoreChunkingStrategyAutoVectorStoreChunkingStrategyStaticVectorStoreChunkingStrategyContextual.md)
+ - [VectorStoreChunkingStrategyAutoVectorStoreChunkingStrategyStaticVectorStoreChunkingStrategyContextual1](docs/VectorStoreChunkingStrategyAutoVectorStoreChunkingStrategyStaticVectorStoreChunkingStrategyContextual1.md)
+ - [VectorStoreChunkingStrategyContextual](docs/VectorStoreChunkingStrategyContextual.md)
+ - [VectorStoreChunkingStrategyContextualConfig](docs/VectorStoreChunkingStrategyContextualConfig.md)
+ - [VectorStoreChunkingStrategyStatic](docs/VectorStoreChunkingStrategyStatic.md)
+ - [VectorStoreChunkingStrategyStaticConfig](docs/VectorStoreChunkingStrategyStaticConfig.md)
+ - [VectorStoreContent](docs/VectorStoreContent.md)
+ - [VectorStoreCreateRequest](docs/VectorStoreCreateRequest.md)
+ - [VectorStoreDeleteResponse](docs/VectorStoreDeleteResponse.md)
+ - [VectorStoreExpirationAfter](docs/VectorStoreExpirationAfter.md)
+ - [VectorStoreFileBatchFileEntry](docs/VectorStoreFileBatchFileEntry.md)
+ - [VectorStoreFileBatchObject](docs/VectorStoreFileBatchObject.md)
+ - [VectorStoreFileContentResponse](docs/VectorStoreFileContentResponse.md)
+ - [VectorStoreFileCounts](docs/VectorStoreFileCounts.md)
+ - [VectorStoreFileDeleteResponse](docs/VectorStoreFileDeleteResponse.md)
+ - [VectorStoreFileLastError](docs/VectorStoreFileLastError.md)
+ - [VectorStoreFileObject](docs/VectorStoreFileObject.md)
+ - [VectorStoreFileStatus](docs/VectorStoreFileStatus.md)
+ - [VectorStoreFilesListInBatchResponse](docs/VectorStoreFilesListInBatchResponse.md)
+ - [VectorStoreListFilesResponse](docs/VectorStoreListFilesResponse.md)
+ - [VectorStoreListResponse](docs/VectorStoreListResponse.md)
+ - [VectorStoreModifyRequest](docs/VectorStoreModifyRequest.md)
+ - [VectorStoreObject](docs/VectorStoreObject.md)
+ - [VectorStoreSearchRequest](docs/VectorStoreSearchRequest.md)
+ - [VectorStoreSearchResponse](docs/VectorStoreSearchResponse.md)
+ - [VectorStoreSearchResponsePage](docs/VectorStoreSearchResponsePage.md)
+ - [VectorStoreStatus](docs/VectorStoreStatus.md)
+ - [VersionInfo](docs/VersionInfo.md)
+ - [WebSearchActionFind](docs/WebSearchActionFind.md)
+ - [WebSearchActionOpenPage](docs/WebSearchActionOpenPage.md)
+ - [WebSearchActionSearch](docs/WebSearchActionSearch.md)
+ - [WebSearchActionSearchWebSearchActionOpenPageWebSearchActionFind](docs/WebSearchActionSearchWebSearchActionOpenPageWebSearchActionFind.md)
+ - [WebSearchActionSearchWebSearchActionOpenPageWebSearchActionFind1](docs/WebSearchActionSearchWebSearchActionOpenPageWebSearchActionFind1.md)
+ - [WebSearchFilters](docs/WebSearchFilters.md)
+ - [WebSearchSource](docs/WebSearchSource.md)
+ - [WebSearchUserLocation](docs/WebSearchUserLocation.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+Endpoints do not require authorization.
+
+
+## Author
+
+
+