Skip to content

Get-OpenAIFile.md

Latest commit

 

History

History
186 lines (148 loc) · 4.08 KB

Get-OpenAIFile.md

File metadata and controls

186 lines (148 loc) · 4.08 KB
external help file PSOpenAI-help.xml
Module Name PSOpenAI
online version https://github.com/mkht/PSOpenAI/blob/main/Docs/Get-OpenAIFile.md
schema 2.0.0

Get-OpenAIFile

SYNOPSIS

Retrieves information about files stored in OpenAI, allowing for listing and retrieving specific files.

SYNTAX

Get

Get-OpenAIFile
    [-FileId] <String>
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <SecureString>]
    [-Organization <String>]
    [<CommonParameters>]

List

Get-OpenAIFile
    [-Purpose <String>]
    [-All]
    [-Limit <Int32>]
    [-Order <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <SecureString>]
    [-Organization <String>]
    [<CommonParameters>]

DESCRIPTION

Retrieves information about files stored in OpenAI, allowing for listing and retrieving specific files.

EXAMPLES

Example 1

PS C:\> Get-OpenAIFile -FileId "file-abc123"

This command retrieves a file with the specified ID from OpenAI.

Example 2

PS C:\> Get-OpenAIFile -Purpose "assistants" -All

Lists all files where the purpose attribute is assistants.

PARAMETERS

-FileId

Specifies the ID of the file to be retrieved.

Type: String
Parameter Sets: Get
Aliases: Id, file_id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName, ByValue)

-Purpose

Only return files with the given purpose.

Type: String
Parameter Sets: List
Required: False
Position: Named

-Limit

A limit on the number of objects to be returned. Limit can range between 1 and 10000, and the default is 10000.

Type: Int32
Parameter Sets: List
Required: False
Position: Named
Default value: 10000

-All

When this switch is specified, all objects will be retrieved.

Type: SwitchParameter
Parameter Sets: List
Required: False
Position: Named

-Order

Sort order by the created timestamp of the objects. asc for ascending order and desc for descending order. The default is desc

Type: String
Parameter Sets: List
Accepted values: asc, desc
Required: False
Position: Named
Default value: desc

-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 performed.

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

-ApiBase

Specifies 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/v1

-ApiKey

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

-Organization

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

INPUTS

OUTPUTS

PSCustomObject

NOTES

RELATED LINKS

https://developers.openai.com/api/reference/resources/files/methods/list/ https://developers.openai.com/api/reference/resources/files/methods/retrieve/