Class: Aws::BedrockAgentCore::Types::HarnessOpenAiModelConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:api_base]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_params ⇒ Hash, ...

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

Returns:

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


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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 iteration.

Returns:

  • (Integer) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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) 


5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 5024

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