Class ToolConfiguration

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

Configuration settings for a tool used by AI Agents.

See Also:

  • Method Details

    • toolName

      public final String toolName()

      The name of the tool.

      Returns:
      The name of the tool.

    • toolType

      public final ToolType toolType()

      The type of the tool.

      If the service returns an enum value that is not available in the current SDK version, toolType will return ToolType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from toolTypeAsString().

      Returns:
      The type of the tool.
      See Also:

    • toolTypeAsString

      public final String toolTypeAsString()

      The type of the tool.

      If the service returns an enum value that is not available in the current SDK version, toolType will return ToolType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from toolTypeAsString().

      Returns:
      The type of the tool.
      See Also:

    • title

      public final String title()

      The title of the tool configuration.

      Returns:
      The title of the tool configuration.

    • toolId

      public final String toolId()

      The identifier of the tool, for example toolName from Model Context Provider server.

      Returns:
      The identifier of the tool, for example toolName from Model Context Provider server.

    • description

      public final String description()

      The description of the tool configuration.

      Returns:
      The description of the tool configuration.

    • instruction

      public final ToolInstruction instruction()

      Instructions for using the tool.

      Returns:
      Instructions for using the tool.

    • hasOverrideInputValues

      public final boolean hasOverrideInputValues()
      For responses, this returns true if the service returned a value for the OverrideInputValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • overrideInputValues

      public final List<ToolOverrideInputValue> overrideInputValues()

      Override input values for the tool configuration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOverrideInputValues() method.

      Returns:
      Override input values for the tool configuration.

    • hasOutputFilters

      public final boolean hasOutputFilters()
      For responses, this returns true if the service returned a value for the OutputFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • outputFilters

      public final List<ToolOutputFilter> outputFilters()

      Output filters applies to the tool result.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputFilters() method.

      Returns:
      Output filters applies to the tool result.

    • inputSchema

      public final Document inputSchema()

      The input schema for the tool configuration.

      Returns:
      The input schema for the tool configuration.

    • outputSchema

      public final Document outputSchema()

      The output schema for the tool configuration.

      Returns:
      The output schema for the tool configuration.

    • annotations

      public final Annotation annotations()

      Annotations for the tool configuration.

      Returns:
      Annotations for the tool configuration.

    • userInteractionConfiguration

      public final UserInteractionConfiguration userInteractionConfiguration()

      Configuration for user interaction with the tool.

      Returns:
      Configuration for user interaction with the tool.

    • toBuilder

      public ToolConfiguration.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<ToolConfiguration.Builder,ToolConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ToolConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ToolConfiguration.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.