Package org.openapitools.client.model

Class UpdateChunkData

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T12:34:27.506198300-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class UpdateChunkData
extends Object
    UpdateChunkData

    • Constructor Detail

      • UpdateChunkData

        public UpdateChunkData()

    • Method Detail

      • getChunkHtml

        @Nullable
public String getChunkHtml()
        HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.
        Returns:
        chunkHtml

      • setChunkHtml

        public void setChunkHtml​(String chunkHtml)

      • getChunkId

        @Nullable
@Valid
public @Valid UUID getChunkId()
        Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.
        Returns:
        chunkId

      • setChunkId

        public void setChunkId​(UUID chunkId)

      • getGroupIds

        @Nullable
@Valid
public @Valid List<UUID> getGroupIds()
        Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
        Returns:
        groupIds

      • setGroupIds

        public void setGroupIds​(List<UUID> groupIds)

      • addGroupTrackingIdsItem

        public UpdateChunkData addGroupTrackingIdsItem​(String groupTrackingIdsItem)

      • getGroupTrackingIds

        @Nullable
public List<String> getGroupTrackingIds()
        Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
        Returns:
        groupTrackingIds

      • setGroupTrackingIds

        public void setGroupTrackingIds​(List<String> groupTrackingIds)

      • getLink

        @Nullable
public String getLink()
        Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used.
        Returns:
        link

      • setLink

        public void setLink​(String link)

      • getMetadata

        @Nullable
public Object getMetadata()
        The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Object metadata)

      • getTimeStamp

        @Nullable
public String getTimeStamp()
        Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.
        Returns:
        timeStamp

      • setTimeStamp

        public void setTimeStamp​(String timeStamp)

      • getTrackingId

        @Nullable
public String getTrackingId()
        Tracking_id of the chunk you want to update. This is required to match an existing chunk.
        Returns:
        trackingId

      • setTrackingId

        public void setTrackingId​(String trackingId)

      • getWeight

        @Nullable
public Double getWeight()
        Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. If no weight is provided, the existing weight will be used.
        Returns:
        weight

      • setWeight

        public void setWeight​(Double weight)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to UpdateChunkData

      • fromJson

        public static UpdateChunkData fromJson​(String jsonString)
                                throws IOException
        Create an instance of UpdateChunkData given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of UpdateChunkData
        Throws:
        IOException - if the JSON string is invalid with respect to UpdateChunkData

      • toJson

        public String toJson()
        Convert an instance of UpdateChunkData to an JSON string
        Returns:
        JSON string