Get OAIFileItem

Get-OAIFileItem

SYNOPSIS

Retrieves information about a file from the OpenAI API.

SYNTAX

Get-OAIFileItem [-FileId] <Object> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-OAIFileItem function retrieves information about a file from the OpenAI API by providing the file ID.

EXAMPLES

EXAMPLE 1

Get-OAIFileItem -FileId "abc123"
Retrieves information about the file with the ID "abc123" from the OpenAI API.

PARAMETERS

-FileId

The ID of the file to retrieve information for.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://beta.openai.com/docs/api-reference/files/retrieve