Package com.sap.ai.sdk.prompt.registry.model

Class ImageContent

java.lang.Object
com.sap.ai.sdk.prompt.registry.model.ImageContent
All Implemented Interfaces:
MultiChatContent
public class ImageContent extends Object implements MultiChatContent
ImageContent

  • Constructor Details

    • ImageContent

      protected ImageContent()
      Default constructor for ImageContent.

  • Method Details

    • type

      @Nonnull public ImageContent type(@Nonnull ImageContent.TypeEnum type)
      Set the type of this ImageContent instance and return the same instance.
      Parameters:
      type - The type of this ImageContent
      Returns:
      The same instance of this ImageContent class

    • getType

      @Nonnull public ImageContent.TypeEnum getType()
      Get type
      Returns:
      type The type of this ImageContent instance.

    • setType

      public void setType(@Nonnull ImageContent.TypeEnum type)
      Set the type of this ImageContent instance.
      Parameters:
      type - The type of this ImageContent

    • imageUrl

      @Nonnull public ImageContent imageUrl(@Nonnull ImageContentImageUrl imageUrl)
      Set the imageUrl of this ImageContent instance and return the same instance.
      Parameters:
      imageUrl - The imageUrl of this ImageContent
      Returns:
      The same instance of this ImageContent class

    • getImageUrl

      @Nonnull public ImageContentImageUrl getImageUrl()
      Get imageUrl
      Returns:
      imageUrl The imageUrl of this ImageContent instance.

    • setImageUrl

      public void setImageUrl(@Nonnull ImageContentImageUrl imageUrl)
      Set the imageUrl of this ImageContent instance.
      Parameters:
      imageUrl - The imageUrl of this ImageContent

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the ImageContent.
      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 ImageContent 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 ImageContent 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 ImageContent 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 ImageContent.Builder create()
      Create a type-safe, fluent-api builder object to construct a new ImageContent instance with all required arguments.