| external help file | PSOpenAI-help.xml |
|---|---|
| Module Name | PSOpenAI |
| online version | https://github.com/mkht/PSOpenAI/blob/main/Docs/New-Container.md |
| schema | 2.0.0 |
Create Container.
New-Container
[-Name] <String>
[-ExpiresAfterMinutes <UInt32>]
[-ExpiresAfterAnchor <String>]
[-FileId <String[]>]
[-MemoryLimit <String>]
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Create a new Container for CodeInterpreter tools.
PS C:\> New-Container -Name "My Container"Creates a new container with the name "My Container".
PS C:\> New-Container -Name "My Container" -FileId ('file-abc123', 'file-def456')Creates a new container with the name "My Container" and copies two files to the container.
Name of the container to create.
Type: String
Required: True
Position: 0Container expiration time in minutes.
Type: UInt32
Required: False
Position: NamedTime anchor for the expiration time. Currently only 'last_active_at' is supported.
Type: String
Required: False
Position: Named
Default value: last_active_atIDs of files to copy to the container.
Type: String[]
Aliases: file_ids
Required: False
Position: NamedOptional memory limit for the container. Defaults to 1g. Supported values are 1g, 4g, 16g, and 64g.
Type: String
Aliases: memory_limit
Required: False
Position: NamedSpecifies how long the request can be pending before it times out.
The default value is 0 (infinite).
Type: Int32
Required: False
Position: Named
Default value: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Namedhttps://developers.openai.com/api/reference/resources/containers/methods/create/