View a markdown version of this page

HarnessOpenAiModelConfig - Amazon Bedrock AgentCore Control Plane

HarnessOpenAiModelConfig

Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.

Contents

apiKeyArn

The ARN of your OpenAI API key on AgentCore Identity.

Type: String

Pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+

Required: Yes

modelId

The OpenAI model ID.

Type: String

Required: Yes

additionalParams

Provider-specific parameters passed through to the model provider unchanged.

Type: JSON value

Required: No

apiFormat

The API format to use when calling the OpenAI provider.

Type: String

Valid Values: chat_completions | responses

Required: No

maxTokens

The maximum number of tokens to allow in the generated response per model call.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

temperature

The temperature to set when calling the model.

Type: Float

Valid Range: Minimum value of 0.0. Maximum value of 2.0.

Required: No

topP

The topP set when calling the model.

Type: Float

Valid Range: Minimum value of 0.0. Maximum value of 1.0.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: