Package org.openapitools.client.model

Class ChunkData

  • @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 ChunkData
extends Object
    ChunkData

    • Constructor Detail

      • ChunkData

        public ChunkData()

    • Method Detail

      • getChunkHtml

        @Nullable
public String getChunkHtml()
        HTML content of the chunk. 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.
        Returns:
        chunkHtml

      • setChunkHtml

        public void setChunkHtml​(String chunkHtml)

      • addChunkVectorItem

        public ChunkData addChunkVectorItem​(Float chunkVectorItem)

      • getChunkVector

        @Nullable
public List<Float> getChunkVector()
        Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding.
        Returns:
        chunkVector

      • setChunkVector

        public void setChunkVector​(List<Float> chunkVector)

      • getFileId

        @Nullable
@Valid
public @Valid UUID getFileId()
        File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks.
        Returns:
        fileId

      • setFileId

        public void setFileId​(UUID fileId)

      • addGroupIdsItem

        public ChunkData addGroupIdsItem​(UUID groupIdsItem)

      • 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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response.
        Returns:
        groupIds

      • setGroupIds

        public void setGroupIds​(List<UUID> groupIds)

      • addGroupTrackingIdsItem

        public ChunkData 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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response.
        Returns:
        groupTrackingIds

      • setGroupTrackingIds

        public void setGroupTrackingIds​(List<String> groupTrackingIds)

      • getLink

        @Nullable
public String getLink()
        Link to the chunk. 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.
        Returns:
        link

      • setLink

        public void setLink​(String link)

      • getMetadata

        @Nullable
public Object getMetadata()
        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.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Object metadata)

      • getSplitAvg

        @Nullable
public Boolean getSplitAvg()
        Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false.
        Returns:
        splitAvg

      • setSplitAvg

        public void setSplitAvg​(Boolean splitAvg)

      • getTagSet

        @Nullable
public List<String> getTagSet()
        Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them.
        Returns:
        tagSet

      • setTagSet

        public void setTagSet​(List<String> tagSet)

      • 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.
        Returns:
        timeStamp

      • setTimeStamp

        public void setTimeStamp​(String timeStamp)

      • getTrackingId

        @Nullable
public String getTrackingId()
        Tracking_id is a string which can be used to identify a chunk. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
        Returns:
        trackingId

      • setTrackingId

        public void setTrackingId​(String trackingId)

      • upsertByTrackingId

        public ChunkData upsertByTrackingId​(Boolean upsertByTrackingId)

      • getUpsertByTrackingId

        @Nullable
public Boolean getUpsertByTrackingId()
        Upsert when a chunk with the same tracking_id exists. By default this is false, and the request will fail if a chunk with the same tracking_id exists. If this is true, the chunk will be updated if a chunk with the same tracking_id exists.
        Returns:
        upsertByTrackingId

      • setUpsertByTrackingId

        public void setUpsertByTrackingId​(Boolean upsertByTrackingId)

      • 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.
        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 ChunkData

      • fromJson

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

      • toJson

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