Class LocalShellAction

Namespace

OpenAI.Responses

Assembly

OpenAI-DotNet.dll

public sealed class LocalShellAction

Inheritance

object

LocalShellAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LocalShellAction()

public LocalShellAction()

LocalShellAction(IEnumerable<string>, IReadOnlyDictionary<string, string>, int?, string, string)

public LocalShellAction(IEnumerable<string> command, IReadOnlyDictionary<string, string> environment = null, int? timeoutMilliseconds = null, string user = null, string workingDirectory = null)

Parameters

command IEnumerable<string>

environment IReadOnlyDictionary<string, string>

timeoutMilliseconds int?

user string

workingDirectory string

LocalShellAction(string, IReadOnlyDictionary<string, string>, int?, string, string)

public LocalShellAction(string command, IReadOnlyDictionary<string, string> environment = null, int? timeoutMilliseconds = null, string user = null, string workingDirectory = null)

Parameters

command string

environment IReadOnlyDictionary<string, string>

timeoutMilliseconds int?

user string

workingDirectory string

Properties

Command

The command to run.

[JsonInclude]
[JsonPropertyName("command")]
public IReadOnlyList<string> Command { get; }

Property Value

IReadOnlyList<string>

Environment

Environment variables to set for the command.

[JsonInclude]
[JsonPropertyName("env")]
public IReadOnlyDictionary<string, string> Environment { get; }

Property Value

IReadOnlyDictionary<string, string>

TimeoutMilliseconds

Optional timeout in milliseconds for the command.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("timeout_ms")]
public int? TimeoutMilliseconds { get; }

Property Value

int?

Type

[JsonInclude]
[JsonPropertyName("type")]
public string Type { get; }

Property Value

string

User

Optional user to run the command as.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
[JsonPropertyName("user")]
public string User { get; }

Property Value

string

WorkingDirectory

Optional working directory to run the command in.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
[JsonPropertyName("working_directory")]
public string WorkingDirectory { get; }

Property Value

string