Class HarnessOpenAiModelConfig

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.HarnessOpenAiModelConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HarnessOpenAiModelConfig.Builder,HarnessOpenAiModelConfig>
@Generated("software.amazon.awssdk:codegen") public final class HarnessOpenAiModelConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HarnessOpenAiModelConfig.Builder,HarnessOpenAiModelConfig>

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

See Also:

  • Method Details

    • modelId

      public final String modelId()

      The OpenAI model ID.

      Returns:
      The OpenAI model ID.

    • apiKeyArn

      public final String apiKeyArn()

      The ARN of your OpenAI API key on AgentCore Identity.

      Returns:
      The ARN of your OpenAI API key on AgentCore Identity.

    • maxTokens

      public final Integer maxTokens()

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

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

    • temperature

      public final Float temperature()

      The temperature to set when calling the model.

      Returns:
      The temperature to set when calling the model.

    • topP

      public final Float topP()

      The topP set when calling the model.

      Returns:
      The topP set when calling the model.

    • toBuilder

      public HarnessOpenAiModelConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HarnessOpenAiModelConfig.Builder,HarnessOpenAiModelConfig>
      Returns:
      a builder for type T

    • builder

      public static HarnessOpenAiModelConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HarnessOpenAiModelConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.