Class: Aws::BedrockAgentCoreControl::Types::HarnessOpenAiModelConfig

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::HarnessOpenAiModelConfig

Defined in:

gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:api_base]

Instance Attribute Summary

• #additional_params ⇒ Hash, ...

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

• #api_base ⇒ String

  Optional custom endpoint URL for an OpenAI-compatible endpoint.

• #api_format ⇒ String

  The API format to use when calling the OpenAI provider.

• #api_key_arn ⇒ String

  The ARN of your OpenAI API key on AgentCore Identity.

• #max_tokens ⇒ Integer

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

• #model_id ⇒ String

  The OpenAI model ID.

• #temperature ⇒ Float

  The temperature to set when calling the model.

• #top_p ⇒ Float

  The topP set when calling the model.

Instance Attribute Details

#additional_params ⇒ Hash, ...

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

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#api_base ⇒ String

Optional custom endpoint URL for an OpenAI-compatible endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#api_format ⇒ String

The API format to use when calling the OpenAI provider.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#api_key_arn ⇒ String

The ARN of your OpenAI API key on AgentCore Identity.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#max_tokens ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#model_id ⇒ String

The OpenAI model ID.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#temperature ⇒ Float

The temperature to set when calling the model.

Returns:

• (Float)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end

#top_p ⇒ Float

The topP set when calling the model.

Returns:

• (Float)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 12467

class HarnessOpenAiModelConfig < Struct.new(
  :model_id,
  :api_key_arn,
  :api_base,
  :max_tokens,
  :temperature,
  :top_p,
  :api_format,
  :additional_params)
  SENSITIVE = [:api_base]
  include Aws::Structure
end