Add-ContainerFile.md

external help file	Module Name	online version	schema
PSOpenAI-help.xml	PSOpenAI	https://github.com/mkht/PSOpenAI/blob/main/Docs/Add-ContainerFile.md	2.0.0

Add-ContainerFile

SYNOPSIS

Copy files to a container.

SYNTAX

Add-ContainerFile
    [-ContainerId] <String>
    [-File] <Object[]>
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <SecureString>]
    [-Organization <String>]
    [<CommonParameters>]

DESCRIPTION

Attach one or more files to a container.
You can send either local file , or uploaded files with file ID.

EXAMPLES

Example 1

PS C:\> Add-ContainerFile -ContainerId 'cont_abc123' -File 'file-abc123'

Attach a file with ID file-abc123 to the container with ID cont_abc123.

Example 2

PS C:\> Add-ContainerFile -ContainerId 'cont_abc123' -File 'C:\data\sample.pdf'

Upload and attach a local file to the container with ID cont_abc123.

PARAMETERS

-ContainerId

The ID of the container to which the file(s) will be attached.

Type: String
Aliases: Container, container_id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName, ByValue)

-File

The file(s) to attach.
Accepts file IDs (as strings), file paths, or FileInfo objects.

Type: Object[]
Aliases: FileId
Required: True
Position: 1
Accept pipeline input: True (ByPropertyName, ByValue)

-TimeoutSec

Specifies 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: 0

-MaxRetryCount

Number 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 retried.

Type: Int32
Required: False
Position: Named
Default value: 0

-ApiBase

Specifies an API endpoint URL such as: 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/v1

-ApiKey

Specifies API key for authentication.
The type of data should be [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: Named

-Organization

Specifies Organization ID 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: Named

INPUTS

OUTPUTS

PSCustomObject

NOTES

RELATED LINKS

https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/create