Skip to content

Update OAIAssistant

dfinke edited this page Apr 20, 2024 · 2 revisions

Update-OAIAssistant

SYNOPSIS

Updates an OpenAI Assistant.

SYNTAX

Update-OAIAssistant [[-Id] <Object>] [[-Model] <Object>] [[-Name] <Object>] [[-Description] <Object>]
 [[-Instructions] <Object>] [[-Tools] <Object>] [[-FileIds] <Object>] [[-Metadata] <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function updates an OpenAI Assistant with the specified parameters.

EXAMPLES

EXAMPLE 1

Update-OAIAssistant -Id "assistant123" -Model "gpt-3.5-turbo" -Name "My Assistant" -Description "This is my assistant" -Instructions "Use this assistant to perform various tasks" -Tools "PowerShell", "Visual Studio Code" -FileIds "file1", "file2" -Metadata @{ "key1" = "value1"; "key2" = "value2" }

PARAMETERS

-Id

The ID of the OpenAI Assistant to update.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Model

The model to use for the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Name

The name of the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Description

The description of the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Instructions

The instructions for using the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Tools

The tools required for using the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

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

-FileIds

The IDs of the files associated with the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases: file_ids

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

-Metadata

The metadata for the OpenAI Assistant.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
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://platform.openai.com/docs/api-reference/assistants/modifyAssistant

Clone this wiki locally