Invoke-AmazonTextModel¶

SYNOPSIS¶

Sends message(s) to an Amazon Titan model on the Amazon Bedrock platform and retrieves the response.

SYNTAX¶

Standard¶

Invoke-AmazonTextModel -Message <String> -ModelID <String> [-ReturnFullObject] [-PromptOnly]
 [-NoContextPersist] [-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>]

PreCraftedMessages¶

Invoke-AmazonTextModel -CustomConversation <String> -ModelID <String> [-ReturnFullObject] [-PromptOnly]
 [-NoContextPersist] [-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 Amazon Titan model on the Amazon Bedrock platform and returns the model's response. By default, a conversation prompt style is used and the conversation context history is persisted to maintain a continuous interaction with the model. You can disable this by using the NoContextPersist parameter. Alternatively, you can use the PromptOnly parameter to have a less conversational response. 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.

EXAMPLES¶

EXAMPLE 1¶

Invoke-AmazonTextModel -Message 'Explain zero-point energy.' -ModelID amazon.titan-text-lite-v1 -Credential $awsCredential -Region 'us-west-2'

Sends a text message to the on-demand Amazon Titan model in the specified AWS region and returns the response.

EXAMPLE 2¶

Invoke-AmazonTextModel -Message 'Explain zero-point energy.' -ModelID amazon.titan-text-lite-v1 -ProfileName default -Region 'us-west-2' -ReturnFullObject

Sends a text message to the on-demand Amazon Titan model in the specified AWS region and returns the full response object.

EXAMPLE 3¶

Invoke-AmazonTextModel -Message 'Explain zero-point energy.' -ModelID amazon.titan-text-lite-v1 -ProfileName default -Region 'us-west-2' -NoContextPersist

Sends a text message to the on-demand Amazon Titan model in the specified AWS region without persisting the conversation context history. This is useful for one-off interactions.

EXAMPLE 4¶

Invoke-AmazonTextModel -Message 'Explain zero-point energy.' -ModelID amazon.titan-text-lite-v1 -ProfileName default -Region 'us-west-2' -PromptOnly

Sends a text message to the on-demand Amazon Titan model in the specified AWS region with a less conversational response. No conversation context history is persisted.

EXAMPLE 5¶

$customConversation = @'
User: How are you?
Bot: I am doing well, thank you. How can I help you today?
User: Tell me about Klingon culture.
Bot: Worf is the son of Mogh.
User: No, don't tell me about Worf. Tell me about Klingon culture.
'@
Invoke-AmazonTextModel -CustomConversation $customConversation -ModelID amazon.titan-text-lite-v1 -ProfileName default -Region 'us-west-2'

Sends a custom conversation to the on-demand Amazon Titan model in the specified AWS region and returns the response.

EXAMPLE 6¶

$invokeAmazonTextModelSplat = @{
    Message          = 'Explain zero-point energy.'
    ModelID          = 'amazon.titan-text-lite-v1'
    Temperature      = 0.5
    MaxTokens        = 256
    Credential       = $credential
    Region           = 'us-west-2'
    ReturnFullObject = $true
}
Invoke-AmazonTextModel @invokeAmazonTextModelSplat

Sends a text message to the on-demand Amazon Titan model in the specified AWS region with a temperature of 0.5 and a maximum of 256 tokens generated. The full response object is returned.

PARAMETERS¶

-Message¶

The message to be sent to the model.

Type: String
Parameter Sets: Standard
Aliases:

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

-CustomConversation¶

A properly formatted string that represents a custom conversation.

Type: String
Parameter Sets: PreCraftedMessages
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

-PromptOnly¶

When specified, the model will have a less conversational response. It will also 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

-NoContextPersist¶

Do not persist the conversation context history. If this parameter is specified, you will not be able to have a continuous conversation with the model. Has no effect if -PromptOnly is specified.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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. Defaults to 1.0. Ranges from 0.0 to 1.0. Use a lower value to decrease randomness in responses.

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/

https://www.pwshbedrock.dev/en/latest/Invoke-AmazonTextModel/

https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-titan-text.html