Package com.sap.ai.sdk.orchestration.model

Class ToolCallChunk

java.lang.Object
com.sap.ai.sdk.orchestration.model.ToolCallChunk
public class ToolCallChunk extends Object
ToolCallChunk

  • Constructor Details

    • ToolCallChunk

      protected ToolCallChunk()
      Default constructor for ToolCallChunk.

  • Method Details

    • index

      @Nonnull public ToolCallChunk index(@Nonnull Integer index)
      Set the index of this ToolCallChunk instance and return the same instance.
      Parameters:
      index - The index of this ToolCallChunk
      Returns:
      The same instance of this ToolCallChunk class

    • getIndex

      @Nonnull public Integer getIndex()
      Get index
      Returns:
      index The index of this ToolCallChunk instance.

    • setIndex

      public void setIndex(@Nonnull Integer index)
      Set the index of this ToolCallChunk instance.
      Parameters:
      index - The index of this ToolCallChunk

    • id

      @Nonnull public ToolCallChunk id(@Nullable String id)
      Set the id of this ToolCallChunk instance and return the same instance.
      Parameters:
      id - The ID of the tool call.
      Returns:
      The same instance of this ToolCallChunk class

    • getId

      @Nonnull public String getId()
      The ID of the tool call.
      Returns:
      id The id of this ToolCallChunk instance.

    • setId

      public void setId(@Nullable String id)
      Set the id of this ToolCallChunk instance.
      Parameters:
      id - The ID of the tool call.

    • type

      @Nonnull public ToolCallChunk type(@Nullable ToolCallChunk.TypeEnum type)
      Set the type of this ToolCallChunk instance and return the same instance.
      Parameters:
      type - The type of the tool. Currently, only `function` is supported.
      Returns:
      The same instance of this ToolCallChunk class

    • getType

      @Nonnull public ToolCallChunk.TypeEnum getType()
      The type of the tool. Currently, only `function` is supported.
      Returns:
      type The type of this ToolCallChunk instance.

    • setType

      public void setType(@Nullable ToolCallChunk.TypeEnum type)
      Set the type of this ToolCallChunk instance.
      Parameters:
      type - The type of the tool. Currently, only `function` is supported.

    • function

      @Nonnull public ToolCallChunk function(@Nullable ToolCallChunkFunction function)
      Set the function of this ToolCallChunk instance and return the same instance.
      Parameters:
      function - The function of this ToolCallChunk
      Returns:
      The same instance of this ToolCallChunk class

    • getFunction

      @Nonnull public ToolCallChunkFunction getFunction()
      Get function
      Returns:
      function The function of this ToolCallChunk instance.

    • setFunction

      public void setFunction(@Nullable ToolCallChunkFunction function)
      Set the function of this ToolCallChunk instance.
      Parameters:
      function - The function of this ToolCallChunk

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the ToolCallChunk.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this ToolCallChunk instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this ToolCallChunk instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this ToolCallChunk instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static ToolCallChunk.Builder create()
      Create a type-safe, fluent-api builder object to construct a new ToolCallChunk instance with all required arguments.