Skip to content

Get OAIAssistant

dfinke edited this page Apr 20, 2024 · 2 revisions

Get-OAIAssistant

SYNOPSIS

Retrieves OpenAI assistants.

SYNTAX

Get-OAIAssistant [[-Name] <Object>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-OAIAssistant function retrieves OpenAI assistants based on the specified criteria.

EXAMPLES

EXAMPLE 1

Get-OAIAssistant -Name "Weather Assistant"
Retrieves the assistant with the name "Weather Assistant".

EXAMPLE 2

Get-OAIAssistant -Raw
Retrieves the raw response of all assistants.

PARAMETERS

-Name

Specifies the name of the assistant to retrieve. If not provided, all assistants will be returned.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Raw

Indicates whether to return the raw response or the selected properties of the assistants.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

This function requires PowerShell version 7.4.0 or later. The Invoke-RestMethod switch -AllowInsecureRedirect is not available in earlier versions.

RELATED LINKS

https://platform.openai.com/docs/api-reference/assistants/listAssistants

Clone this wiki locally