Class ConverseRequest

Inheritance
object
ConverseRequest
Inherited Members
Namespace: Glitch9.AIDevKit.AmazonAws
Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll
Syntax
public sealed class ConverseRequest

Properties

| Edit this page View Source

AdditionalModelRequestFields

Optional. Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse and ConverseStream support in the inferenceConfig field. For more information, see Model parameters.

Declaration
[JsonProperty("additionalModelRequestFields")]
public JToken AdditionalModelRequestFields { get; set; }
Property Value
Type Description
JToken
| Edit this page View Source

AdditionalModelResponseFieldPaths

Optional. Additional model parameters field paths to return in the response. Converse and ConverseStream return the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

["/stop_sequence"]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force(IETF) documentation.

Converse and ConverseStream reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

Declaration
[JsonProperty("additionalModelResponseFieldPaths")]
public List<string> AdditionalModelResponseFieldPaths { get; set; }
Property Value
Type Description
List<string>
| Edit this page View Source

GuardrailConfig

Optional. Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

Declaration
[JsonProperty("guardrailConfig")]
public GuardrailConfiguration GuardrailConfig { get; set; }
Property Value
Type Description
GuardrailConfiguration
| Edit this page View Source

InferenceConfig

Optional. Inference parameters to pass to the model. Converse and ConverseStream support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Declaration
[JsonProperty("inferenceConfig")]
public InferenceConfiguration InferenceConfig { get; set; }
Property Value
Type Description
InferenceConfiguration
| Edit this page View Source

Messages

Optional. The messages that you want to send to the model.

Declaration
[JsonProperty("messages")]
public List<ConverseMessage> Messages { get; set; }
Property Value
Type Description
List<ConverseMessage>
| Edit this page View Source

Model

Declaration
[JsonIgnore]
public string Model { get; set; }
Property Value
Type Description
string
| Edit this page View Source

PerformanceConfig

Optional. Model performance settings for the request.

Declaration
[JsonProperty("performanceConfig")]
public PerformanceConfiguration PerformanceConfig { get; set; }
Property Value
Type Description
PerformanceConfiguration
| Edit this page View Source

PromptVariables

Optional. Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId field.

Declaration
[JsonProperty("promptVariables")]
public Dictionary<string, TextEnvelope> PromptVariables { get; set; }
Property Value
Type Description
Dictionary<string, TextEnvelope>
| Edit this page View Source

RawRequest

Declaration
[JsonIgnore]
public IGenerativeRequest RawRequest { get; set; }
Property Value
Type Description
IGenerativeRequest
| Edit this page View Source

RequestMetadata

Optional. Key-value pairs that you can use to filter invocation logs.

Declaration
[JsonProperty("requestMetadata")]
public ServerDictionary RequestMetadata { get; set; }
Property Value
Type Description
ServerDictionary
| Edit this page View Source

ServiceTier

Optional. Specifies the processing tier configuration used for serving the request.

Declaration
[JsonProperty("serviceTier")]
public BedrockServiceTier ServiceTier { get; set; }
Property Value
Type Description
BedrockServiceTier
Remarks

Valid Values: priority | default | flex

| Edit this page View Source

System

Optional. A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.

Declaration
[JsonProperty("system")]
public List<TextEnvelope> System { get; set; }
Property Value
Type Description
List<TextEnvelope>
| Edit this page View Source

ToolConfig

Optional. Configuration information for the tools that the model can use when generating a response.

Declaration
[JsonProperty("toolConfig")]
public ToolConfiguration ToolConfig { get; set; }
Property Value
Type Description
ToolConfiguration

Extension Methods