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

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

UploadFileData

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UploadFileData.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_BASE64_FILE`
`static String`	`SERIALIZED_NAME_CREATE_CHUNKS`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_FILE_MIME_TYPE`
`static String`	`SERIALIZED_NAME_FILE_NAME`
`static String`	`SERIALIZED_NAME_LINK`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_TAG_SET`
`static String`	`SERIALIZED_NAME_TIME_STAMP`

Constructor Summary

Constructors
Constructor Description

UploadFileData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`UploadFileData`	`addTagSetItem(String tagSetItem)`
`UploadFileData`	`base64File(String base64File)`
`UploadFileData`	`createChunks(Boolean createChunks)`
`UploadFileData`	`description(String description)`
`boolean`	`equals(Object o)`
`UploadFileData`	`fileMimeType(String fileMimeType)`
`UploadFileData`	`fileName(String fileName)`
`static UploadFileData`	`fromJson(String jsonString)`	Create an instance of UploadFileData given an JSON string
`@NotNull String`	`getBase64File()`	Base64 encoded file.
`Boolean`	`getCreateChunks()`	Create chunks is a boolean which determines whether or not to create chunks from the file.
`String`	`getDescription()`	Description is an optional convience field so you do not have to remember what the file contains or is about.
`@NotNull String`	`getFileMimeType()`	MIME type of the file being uploaded.
`@NotNull String`	`getFileName()`	Name of the file being uploaded, including the extension.
`String`	`getLink()`	Link to the file.
`Object`	`getMetadata()`	Metadata is a JSON object which can be used to filter chunks.
`List<String>`	`getTagSet()`	Tag set is a comma separated list of tags which will be passed down to the chunks made from the file.
`String`	`getTimeStamp()`	Time stamp should be an ISO 8601 combined date and time without timezone.
`int`	`hashCode()`
`UploadFileData`	`link(String link)`
`UploadFileData`	`metadata(Object metadata)`
`void`	`setBase64File(String base64File)`
`void`	`setCreateChunks(Boolean createChunks)`
`void`	`setDescription(String description)`
`void`	`setFileMimeType(String fileMimeType)`
`void`	`setFileName(String fileName)`
`void`	`setLink(String link)`
`void`	`setMetadata(Object metadata)`
`void`	`setTagSet(List<String> tagSet)`
`void`	`setTimeStamp(String timeStamp)`
`UploadFileData`	`tagSet(List<String> tagSet)`
`UploadFileData`	`timeStamp(String timeStamp)`
`String`	`toJson()`	Convert an instance of UploadFileData to an JSON string
`String`	`toString()`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found

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

- Field Detail
  - SERIALIZED_NAME_BASE64_FILE
```
public static final String SERIALIZED_NAME_BASE64_FILE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_CHUNKS
```
public static final String SERIALIZED_NAME_CREATE_CHUNKS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILE_MIME_TYPE
```
public static final String SERIALIZED_NAME_FILE_MIME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILE_NAME
```
public static final String SERIALIZED_NAME_FILE_NAME
```
    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_TAG_SET
```
public static final String SERIALIZED_NAME_TAG_SET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TIME_STAMP
```
public static final String SERIALIZED_NAME_TIME_STAMP
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - UploadFileData
```
public UploadFileData()
```
- Method Detail
  - base64File
```
public UploadFileData base64File(String base64File)
```
  - getBase64File
```
@Nonnull
@NotNull
public @NotNull String getBase64File()
```
    Base64 encoded file. Convert + to -, / to _, and remove the ending = if present. This is the standard base64url encoding.
    
    Returns:
    
    base64File
  - setBase64File
```
public void setBase64File(String base64File)
```
  - createChunks
```
public UploadFileData createChunks(Boolean createChunks)
```
  - getCreateChunks
```
@Nullable
public Boolean getCreateChunks()
```
    Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users.
    
    Returns:
    
    createChunks
  - setCreateChunks
```
public void setCreateChunks(Boolean createChunks)
```
  - description
```
public UploadFileData description(String description)
```
  - getDescription
```
@Nullable
public String getDescription()
```
    Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - fileMimeType
```
public UploadFileData fileMimeType(String fileMimeType)
```
  - getFileMimeType
```
@Nonnull
@NotNull
public @NotNull String getFileMimeType()
```
    MIME type of the file being uploaded.
    
    Returns:
    
    fileMimeType
  - setFileMimeType
```
public void setFileMimeType(String fileMimeType)
```
  - fileName
```
public UploadFileData fileName(String fileName)
```
  - getFileName
```
@Nonnull
@NotNull
public @NotNull String getFileName()
```
    Name of the file being uploaded, including the extension.
    
    Returns:
    
    fileName
  - setFileName
```
public void setFileName(String fileName)
```
  - link
```
public UploadFileData link(String link)
```
  - getLink
```
@Nullable
public String getLink()
```
    Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.
    
    Returns:
    
    link
  - setLink
```
public void setLink(String link)
```
  - metadata
```
public UploadFileData metadata(Object metadata)
```
  - 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. Will be passed down to the file's chunks.
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(Object metadata)
```
  - tagSet
```
public UploadFileData tagSet(List<String> tagSet)
```
  - addTagSetItem
```
public UploadFileData addTagSetItem(String tagSetItem)
```
  - getTagSet
```
@Nullable
public List<String> getTagSet()
```
    Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them.
    
    Returns:
    
    tagSet
  - setTagSet
```
public void setTagSet(List<String> tagSet)
```
  - timeStamp
```
public UploadFileData timeStamp(String timeStamp)
```
  - getTimeStamp
```
@Nullable
public String getTimeStamp()
```
    Time stamp should be an ISO 8601 combined date and time without timezone. Time_stamp is used for time window filtering and recency-biasing search results. Will be passed down to the file's chunks.
    
    Returns:
    
    timeStamp
  - setTimeStamp
```
public void setTimeStamp(String timeStamp)
```
  - 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 UploadFileData
  - fromJson
```
public static UploadFileData fromJson(String jsonString)
                               throws IOException
```
    Create an instance of UploadFileData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of UploadFileData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to UploadFileData
  - toJson
```
public String toJson()
```
    Convert an instance of UploadFileData to an JSON string
    
    Returns:
    
    JSON string

Class UploadFileData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_BASE64_FILE

SERIALIZED_NAME_CREATE_CHUNKS

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_FILE_MIME_TYPE

SERIALIZED_NAME_FILE_NAME

SERIALIZED_NAME_LINK

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_TAG_SET

SERIALIZED_NAME_TIME_STAMP

openapiFields

openapiRequiredFields

Constructor Detail

UploadFileData

Method Detail

base64File

getBase64File

setBase64File

createChunks

getCreateChunks

setCreateChunks

description

getDescription

setDescription

fileMimeType

getFileMimeType

setFileMimeType

fileName

getFileName

setFileName

link

getLink

setLink

metadata

getMetadata

setMetadata

tagSet

addTagSetItem

getTagSet

setTagSet

timeStamp

getTimeStamp

setTimeStamp

equals

hashCode

toString

validateJsonElement

fromJson

toJson