OpenAIClientExtensions.AsIHostedFileClient Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| AsIHostedFileClient(OpenAIFileClient) |
Gets an IHostedFileClient for use with this OpenAIFileClient. |
| AsIHostedFileClient(OpenAIClient) |
Gets an IHostedFileClient for use with this OpenAIClient. |
| AsIHostedFileClient(ContainerClient, String) |
Gets an IHostedFileClient for use with this ContainerClient. |
AsIHostedFileClient(OpenAIFileClient)
- Source:
- OpenAIClientExtensions.cs
Gets an IHostedFileClient for use with this OpenAIFileClient.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::AI::IHostedFileClient ^ AsIHostedFileClient(OpenAI::Files::OpenAIFileClient ^ fileClient);[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.Files.OpenAIFileClient fileClient);public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.Files.OpenAIFileClient fileClient);[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
static member AsIHostedFileClient : OpenAI.Files.OpenAIFileClient -> Microsoft.Extensions.AI.IHostedFileClientstatic member AsIHostedFileClient : OpenAI.Files.OpenAIFileClient -> Microsoft.Extensions.AI.IHostedFileClient<Extension()>
Public Function AsIHostedFileClient (fileClient As OpenAIFileClient) As IHostedFileClientParameters
- fileClient
- OpenAIFileClient
The client.
Returns
An IHostedFileClient that can be used to manage files via the OpenAIFileClient.
- Attributes
Exceptions
fileClient is null.
Remarks
The returned IHostedFileClient supports only the standard Files API. Operations requiring container access (via Scope) will throw InvalidOperationException. To access container files, use AsIHostedFileClient(ContainerClient, String) or AsIHostedFileClient(OpenAIClient).
Applies to
AsIHostedFileClient(OpenAIClient)
- Source:
- OpenAIClientExtensions.cs
Gets an IHostedFileClient for use with this OpenAIClient.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::AI::IHostedFileClient ^ AsIHostedFileClient(OpenAI::OpenAIClient ^ openAIClient);[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.OpenAIClient openAIClient);public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.OpenAIClient openAIClient);[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
static member AsIHostedFileClient : OpenAI.OpenAIClient -> Microsoft.Extensions.AI.IHostedFileClientstatic member AsIHostedFileClient : OpenAI.OpenAIClient -> Microsoft.Extensions.AI.IHostedFileClient<Extension()>
Public Function AsIHostedFileClient (openAIClient As OpenAIClient) As IHostedFileClientParameters
- openAIClient
- OpenAIClient
The client.
Returns
An IHostedFileClient that can be used to manage files via the OpenAIClient.
- Attributes
Exceptions
openAIClient is null.
Remarks
The returned IHostedFileClient supports both the standard Files API and container files (used for code interpreter outputs). To download a container file, specify the container ID in the Scope property.
Applies to
AsIHostedFileClient(ContainerClient, String)
- Source:
- OpenAIClientExtensions.cs
Gets an IHostedFileClient for use with this ContainerClient.
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.Containers.ContainerClient containerClient, string? defaultScope = default);public static Microsoft.Extensions.AI.IHostedFileClient AsIHostedFileClient(this OpenAI.Containers.ContainerClient containerClient, string? defaultScope = default);[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
static member AsIHostedFileClient : OpenAI.Containers.ContainerClient * string -> Microsoft.Extensions.AI.IHostedFileClientstatic member AsIHostedFileClient : OpenAI.Containers.ContainerClient * string -> Microsoft.Extensions.AI.IHostedFileClient<Extension()>
Public Function AsIHostedFileClient (containerClient As ContainerClient, Optional defaultScope As String = Nothing) As IHostedFileClientParameters
- containerClient
- ContainerClient
The client.
- defaultScope
- String
The default container ID for operations. If not specified, a container ID must be
provided via the Scope property on per-call options.
Returns
An IHostedFileClient that can be used to manage files within containers via the ContainerClient.
- Attributes
Exceptions
containerClient is null.
