Test OAIAssistantId

Test-OAIAssistantId

SYNOPSIS

Tests whether an OpenAI Assistant ID exists.

SYNTAX

Test-OAIAssistantId [[-AssistantId] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Test-OAIAssistantId function checks whether an OpenAI Assistant ID exists by querying the Get-OAIAssistantItem cmdlet.

EXAMPLES

EXAMPLE 1

Test-OAIAssistantId -AssistantId "12345678"
Checks whether the Assistant ID "12345678" exists.

PARAMETERS

-AssistantId

The Assistant ID to be tested.

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

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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

None. You cannot pipe objects to this function.

OUTPUTS

System.Boolean

Returns $true if the Assistant ID exists, otherwise returns $false.

NOTES

RELATED LINKS