SessionsPythonPlugin.DownloadFileAsync(String, String) Method

Definition

Namespace:: Microsoft.SemanticKernel.Plugins.Core.CodeInterpreter

Assembly:: Microsoft.SemanticKernel.Plugins.Core.dll

Package:: Microsoft.SemanticKernel.Plugins.Core v1.45.0-alpha

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.

Downloads a file from the current Session ID.

[Microsoft.SemanticKernel.KernelFunction]
public System.Threading.Tasks.Task<byte[]> DownloadFileAsync(string remoteFilePath, string? localFilePath = default);

[<Microsoft.SemanticKernel.KernelFunction>]
member this.DownloadFileAsync : string * string -> System.Threading.Tasks.Task<byte[]>

Public Function DownloadFileAsync (remoteFilePath As String, Optional localFilePath As String = Nothing) As Task(Of Byte())

Parameters

remoteFilePath: String

The path to download the file from, relative to /mnt/data.

localFilePath: String

The path to save the downloaded file to. If not provided won't save it in the disk.

Returns

Task<Byte[]>

The data of the downloaded file as byte array.

Attributes: KernelFunctionAttribute

Applies to