Invoke-MistralAIChatModel¶
SYNOPSIS¶
Sends message(s) to the Mistral AI chat model on the Amazon Bedrock platform and retrieves the response.
SYNTAX¶
CombinedSet¶
Invoke-MistralAIChatModel -Message <String> [-MediaPath <String[]>] -SystemPrompt <String> -ModelID <String>
[-ReturnFullObject] [-NoContextPersist] [-Tools <PSObject[]>] [-ToolChoice <String>] [-MaxTokens <Int32>]
[-Temperature <Single>] [-TopP <Single>] [-AccessKey <String>] [-Credential <AWSCredentials>]
[-EndpointUrl <String>] [-NetworkCredential <PSCredential>] [-ProfileLocation <String>]
[-ProfileName <String>] [-Region <Object>] [-SecretKey <String>] [-SessionToken <String>]
[<CommonParameters>]
MessageSet¶
Invoke-MistralAIChatModel -Message <String> [-MediaPath <String[]>] -ModelID <String> [-ReturnFullObject]
[-NoContextPersist] [-Tools <PSObject[]>] [-ToolChoice <String>] [-MaxTokens <Int32>] [-Temperature <Single>]
[-TopP <Single>] [-AccessKey <String>] [-Credential <AWSCredentials>] [-EndpointUrl <String>]
[-NetworkCredential <PSCredential>] [-ProfileLocation <String>] [-ProfileName <String>] [-Region <Object>]
[-SecretKey <String>] [-SessionToken <String>] [<CommonParameters>]
SystemPromptSet¶
Invoke-MistralAIChatModel -SystemPrompt <String> -ModelID <String> [-ReturnFullObject] [-NoContextPersist]
[-Tools <PSObject[]>] [-ToolChoice <String>] [-MaxTokens <Int32>] [-Temperature <Single>] [-TopP <Single>]
[-AccessKey <String>] [-Credential <AWSCredentials>] [-EndpointUrl <String>]
[-NetworkCredential <PSCredential>] [-ProfileLocation <String>] [-ProfileName <String>] [-Region <Object>]
[-SecretKey <String>] [-SessionToken <String>] [<CommonParameters>]
ToolsResultsSet¶
Invoke-MistralAIChatModel -ToolsResults <PSObject[]> -ModelID <String> [-ReturnFullObject] [-NoContextPersist]
[-Tools <PSObject[]>] [-ToolChoice <String>] [-MaxTokens <Int32>] [-Temperature <Single>] [-TopP <Single>]
[-AccessKey <String>] [-Credential <AWSCredentials>] [-EndpointUrl <String>]
[-NetworkCredential <PSCredential>] [-ProfileLocation <String>] [-ProfileName <String>] [-Region <Object>]
[-SecretKey <String>] [-SessionToken <String>] [<CommonParameters>]
DESCRIPTION¶
Sends a message to an Mistral AI chat model on the Amazon Bedrock platform and returns the model's response. By default, the conversation context history is persisted to maintain a continuous interaction with the model. You can disable this by using the NoContextPersist parameter. Additionally, the cmdlet estimates the cost of model usage based on the provided input and output tokens and adds the estimate to the models tally information. This model supports Function Calling, which allows the Mistral model to connect to external tools. You can provide Tools and ToolChoice parameters to enable this feature. If you are providing Tools to enable Function Calling, it is recommended that you use the ReturnFullObject parameter to capture the full response object. See the pwshBedrock documentation for more information on Function Calling and the Mistral AI chat model.
EXAMPLES¶
EXAMPLE 1¶
Invoke-MistralAIChatModel -Message 'Explain zero-point energy.' -ModelID 'mistral.mistral-large-2407-v1:0' -Credential $awsCredential -Region 'us-west-2'
Sends a chat message to the on-demand Mistral AI chat model in the specified AWS region and returns the response.
EXAMPLE 2¶
Invoke-MistralAIChatModel -Message 'Explain zero-point energy.' -ModelID 'mistral.mistral-large-2407-v1:0' -Credential $awsCredential -Region 'us-west-2' -ReturnFullObject
Sends a chat message to the on-demand Mistral AI chat model in the specified AWS region and returns the full response object.
EXAMPLE 3¶
$invokeMistralAIChatModelSplat = @{
Message = 'What can you tell me about this picture? Is it referencing something?'
MediaPath = 'C:\images\tanagra.jpg'
ModelID = 'mistral.pixtral-large-2502-v1:0'
Credential = $awsCredential
Region = 'us-west-2'
}
Invoke-MistralAIChatModel @invokeMistralAIChatModelSplat
Sends a chat message to the on-demand Mistral AI chat model in the specified AWS region with a media file.
EXAMPLE 4¶
$invokeMistralAIChatModelSplat = @{
SystemPrompt = 'You are a Star Trek trivia expert.'
Message = 'How much does Lt. Commander Data weigh?'
Tools = $starTrekTriviaFunctionTool
ToolChoice = 'auto'
ReturnFullObject = $true
ModelID = 'mistral.mistral-large-2407-v1:0'
ReturnFullObject = $true
Credential = $awsCredential
Region = 'us-west-2'
}
$result = Invoke-MistralAIChatModel @invokeMistralAIChatModelSplat
Sends a chat message to the on-demand Mistral AI chat model in the specified AWS region with a system prompt and tool function call.
EXAMPLE 5¶
$invokeMistralAIChatModelSplat = @{
ToolsResults = $starTrekTriviaFunctionResults
ModelID = 'mistral.mistral-large-2407-v1:0'
ReturnFullObject = $true
Credential = $awsCredential
Region = 'us-west-2'
}
$result = Invoke-MistralAIChatModel @invokeMistralAIChatModelSplat
Sends a chat message to the on-demand Mistral AI chat model in the specified AWS region with tool results from a previous chat turn.
PARAMETERS¶
-Message¶
The message to be sent to the model.
Type: String
Parameter Sets: CombinedSet, MessageSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MediaPath¶
File path to local media file. Only supported by image-capable models.
Type: String[]
Parameter Sets: CombinedSet, MessageSet
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SystemPrompt¶
Sets the behavior and context for the model in the conversation.
Type: String
Parameter Sets: CombinedSet, SystemPromptSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ToolsResults¶
A list of results from invoking tools recommended by the model in the previous chat turn.
Type: PSObject[]
Parameter Sets: ToolsResultsSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ModelID¶
The unique identifier of the model.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReturnFullObject¶
Specify if you want the full object returned instead of just the message reply.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-NoContextPersist¶
Do not persist the conversation context history.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Tools¶
Definitions of tools that the model may use.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ToolChoice¶
Specifies how functions are called. If set to none the model won't call a function and will generate a message instead. If set to auto the model can choose to either generate a message or call a function. If set to any the model is forced to call a function.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxTokens¶
The maximum number of tokens to generate before stopping.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 8192
Accept pipeline input: False
Accept wildcard characters: False
-Temperature¶
The amount of randomness injected into the response.
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-TopP¶
Use a lower value to ignore less probable options and decrease the diversity of responses.
Type: Single
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-AccessKey¶
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential¶
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Type: AWSCredentials
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EndpointUrl¶
The endpoint to make the call against. Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NetworkCredential¶
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProfileLocation¶
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory).aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProfileName¶
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region¶
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SecretKey¶
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SessionToken¶
The session token if the access and secret keys are temporary session-based credentials.
Type: String
Parameter Sets: (All)
Aliases:
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, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS¶
OUTPUTS¶
System.String¶
or¶
System.Management.Automation.PSCustomObject¶
NOTES¶
Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/
- For a full tools example, see the advanced documentation on the pwshBedrock website.
This was incredibly hard to make.
RELATED LINKS¶
https://www.pwshbedrock.dev/en/latest/Invoke-MistralAIChatModel/
https://www.pwshbedrock.dev/en/latest/pwshBedrock-Advanced/
https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-mistral-chat-completion.html