java.lang.Object
- org.openapitools.client.model.UpdateChunkByTrackingIdData

@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 UpdateChunkByTrackingIdData
extends Object

UpdateChunkByTrackingIdData

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UpdateChunkByTrackingIdData.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CHUNK_HTML`
`static String`	`SERIALIZED_NAME_GROUP_IDS`
`static String`	`SERIALIZED_NAME_GROUP_TRACKING_IDS`
`static String`	`SERIALIZED_NAME_LINK`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_TIME_STAMP`
`static String`	`SERIALIZED_NAME_TRACKING_ID`
`static String`	`SERIALIZED_NAME_WEIGHT`

Constructor Summary

Constructors
Constructor Description

UpdateChunkByTrackingIdData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`UpdateChunkByTrackingIdData`	`addGroupIdsItem(UUID groupIdsItem)`
`UpdateChunkByTrackingIdData`	`addGroupTrackingIdsItem(String groupTrackingIdsItem)`
`UpdateChunkByTrackingIdData`	`chunkHtml(String chunkHtml)`
`boolean`	`equals(Object o)`
`static UpdateChunkByTrackingIdData`	`fromJson(String jsonString)`	Create an instance of UpdateChunkByTrackingIdData given an JSON string
`String`	`getChunkHtml()`	HTML content of the chunk you want to update.
`@Valid List<UUID>`	`getGroupIds()`	Group ids are the ids of the groups that the chunk should be placed into.
`List<String>`	`getGroupTrackingIds()`	Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into.
`String`	`getLink()`	Link of the chunk you want to update.
`Object`	`getMetadata()`	The metadata is a JSON object which can be used to filter chunks.
`String`	`getTimeStamp()`	Time_stamp should be an ISO 8601 combined date and time without timezone.
`@NotNull String`	`getTrackingId()`	Tracking_id of the chunk you want to update.
`Double`	`getWeight()`	Weight is a float which can be used to bias search results.
`UpdateChunkByTrackingIdData`	`groupIds(List<UUID> groupIds)`
`UpdateChunkByTrackingIdData`	`groupTrackingIds(List<String> groupTrackingIds)`
`int`	`hashCode()`
`UpdateChunkByTrackingIdData`	`link(String link)`
`UpdateChunkByTrackingIdData`	`metadata(Object metadata)`
`void`	`setChunkHtml(String chunkHtml)`
`void`	`setGroupIds(List<UUID> groupIds)`
`void`	`setGroupTrackingIds(List<String> groupTrackingIds)`
`void`	`setLink(String link)`
`void`	`setMetadata(Object metadata)`
`void`	`setTimeStamp(String timeStamp)`
`void`	`setTrackingId(String trackingId)`
`void`	`setWeight(Double weight)`
`UpdateChunkByTrackingIdData`	`timeStamp(String timeStamp)`
`String`	`toJson()`	Convert an instance of UpdateChunkByTrackingIdData to an JSON string
`String`	`toString()`
`UpdateChunkByTrackingIdData`	`trackingId(String trackingId)`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found
`UpdateChunkByTrackingIdData`	`weight(Double weight)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CHUNK_HTML
```
public static final String SERIALIZED_NAME_CHUNK_HTML
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GROUP_IDS
```
public static final String SERIALIZED_NAME_GROUP_IDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GROUP_TRACKING_IDS
```
public static final String SERIALIZED_NAME_GROUP_TRACKING_IDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LINK
```
public static final String SERIALIZED_NAME_LINK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_METADATA
```
public static final String SERIALIZED_NAME_METADATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TIME_STAMP
```
public static final String SERIALIZED_NAME_TIME_STAMP
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRACKING_ID
```
public static final String SERIALIZED_NAME_TRACKING_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEIGHT
```
public static final String SERIALIZED_NAME_WEIGHT
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - UpdateChunkByTrackingIdData
```
public UpdateChunkByTrackingIdData()
```
- Method Detail
  - chunkHtml
```
public UpdateChunkByTrackingIdData chunkHtml(String chunkHtml)
```
  - 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)
```
  - groupIds
```
public UpdateChunkByTrackingIdData groupIds(List<UUID> groupIds)
```
  - addGroupIdsItem
```
public UpdateChunkByTrackingIdData 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 update a chunk and add it to a group or multiple groups in one request.
    
    Returns:
    
    groupIds
  - setGroupIds
```
public void setGroupIds(List<UUID> groupIds)
```
  - groupTrackingIds
```
public UpdateChunkByTrackingIdData groupTrackingIds(List<String> groupTrackingIds)
```
  - addGroupTrackingIdsItem
```
public UpdateChunkByTrackingIdData 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)
```
  - link
```
public UpdateChunkByTrackingIdData link(String link)
```
  - 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)
```
  - metadata
```
public UpdateChunkByTrackingIdData metadata(Object metadata)
```
  - 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)
```
  - timeStamp
```
public UpdateChunkByTrackingIdData timeStamp(String timeStamp)
```
  - 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)
```
  - trackingId
```
public UpdateChunkByTrackingIdData trackingId(String trackingId)
```
  - getTrackingId
```
@Nonnull
@NotNull
public @NotNull 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)
```
  - weight
```
public UpdateChunkByTrackingIdData weight(Double weight)
```
  - 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)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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 UpdateChunkByTrackingIdData
  - fromJson
```
public static UpdateChunkByTrackingIdData fromJson(String jsonString)
                                            throws IOException
```
    Create an instance of UpdateChunkByTrackingIdData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of UpdateChunkByTrackingIdData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to UpdateChunkByTrackingIdData
  - toJson
```
public String toJson()
```
    Convert an instance of UpdateChunkByTrackingIdData to an JSON string
    
    Returns:
    
    JSON string

Class UpdateChunkByTrackingIdData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CHUNK_HTML

SERIALIZED_NAME_GROUP_IDS

SERIALIZED_NAME_GROUP_TRACKING_IDS

SERIALIZED_NAME_LINK

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_TIME_STAMP

SERIALIZED_NAME_TRACKING_ID

SERIALIZED_NAME_WEIGHT

openapiFields

openapiRequiredFields

Constructor Detail

UpdateChunkByTrackingIdData

Method Detail

chunkHtml

getChunkHtml

setChunkHtml

groupIds

addGroupIdsItem

getGroupIds

setGroupIds

groupTrackingIds

addGroupTrackingIdsItem

getGroupTrackingIds

setGroupTrackingIds

link

getLink

setLink

metadata

getMetadata

setMetadata

timeStamp

getTimeStamp

setTimeStamp

trackingId

getTrackingId

setTrackingId

weight

getWeight

setWeight

equals

hashCode

toString

validateJsonElement

fromJson

toJson