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

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

SearchOverGroupsData

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchOverGroupsData.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_FILTERS`
`static String`	`SERIALIZED_NAME_GET_COLLISIONS`
`static String`	`SERIALIZED_NAME_GROUP_SIZE`
`static String`	`SERIALIZED_NAME_HIGHLIGHT_DELIMITERS`
`static String`	`SERIALIZED_NAME_HIGHLIGHT_RESULTS`
`static String`	`SERIALIZED_NAME_PAGE`
`static String`	`SERIALIZED_NAME_PAGE_SIZE`
`static String`	`SERIALIZED_NAME_QUERY`
`static String`	`SERIALIZED_NAME_SCORE_THRESHOLD`
`static String`	`SERIALIZED_NAME_SEARCH_TYPE`

Constructor Summary

Constructors
Constructor Description

SearchOverGroupsData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SearchOverGroupsData`	`addHighlightDelimitersItem(String highlightDelimitersItem)`
`boolean`	`equals(Object o)`
`SearchOverGroupsData`	`filters(ChunkFilter filters)`
`static SearchOverGroupsData`	`fromJson(String jsonString)`	Create an instance of SearchOverGroupsData given an JSON string
`SearchOverGroupsData`	`getCollisions(Boolean getCollisions)`
`@Valid ChunkFilter`	`getFilters()`	Get filters
`Boolean`	`getGetCollisions()`	Set get_collisions to true to get the collisions for each chunk.
`@Min(0L) Integer`	`getGroupSize()`	Get groupSize minimum: 0
`List<String>`	`getHighlightDelimiters()`	Set highlight_delimiters to a list of strings to use as delimiters for highlighting.
`Boolean`	`getHighlightResults()`	Set highlight_results to true to highlight the results.
`@Min(0L) Long`	`getPage()`	Page of chunks to fetch.
`@Min(0L) Integer`	`getPageSize()`	Page size is the number of chunks to fetch.
`@NotNull String`	`getQuery()`	Query is the search query.
`Float`	`getScoreThreshold()`	Set score_threshold to a float to filter out chunks with a score below the threshold.
`@NotNull String`	`getSearchType()`	Can be either \"semantic\", \"fulltext\", or \"hybrid\".
`SearchOverGroupsData`	`groupSize(Integer groupSize)`
`int`	`hashCode()`
`SearchOverGroupsData`	`highlightDelimiters(List<String> highlightDelimiters)`
`SearchOverGroupsData`	`highlightResults(Boolean highlightResults)`
`SearchOverGroupsData`	`page(Long page)`
`SearchOverGroupsData`	`pageSize(Integer pageSize)`
`SearchOverGroupsData`	`query(String query)`
`SearchOverGroupsData`	`scoreThreshold(Float scoreThreshold)`
`SearchOverGroupsData`	`searchType(String searchType)`
`void`	`setFilters(ChunkFilter filters)`
`void`	`setGetCollisions(Boolean getCollisions)`
`void`	`setGroupSize(Integer groupSize)`
`void`	`setHighlightDelimiters(List<String> highlightDelimiters)`
`void`	`setHighlightResults(Boolean highlightResults)`
`void`	`setPage(Long page)`
`void`	`setPageSize(Integer pageSize)`
`void`	`setQuery(String query)`
`void`	`setScoreThreshold(Float scoreThreshold)`
`void`	`setSearchType(String searchType)`
`String`	`toJson()`	Convert an instance of SearchOverGroupsData 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_FILTERS
```
public static final String SERIALIZED_NAME_FILTERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GET_COLLISIONS
```
public static final String SERIALIZED_NAME_GET_COLLISIONS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GROUP_SIZE
```
public static final String SERIALIZED_NAME_GROUP_SIZE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HIGHLIGHT_DELIMITERS
```
public static final String SERIALIZED_NAME_HIGHLIGHT_DELIMITERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HIGHLIGHT_RESULTS
```
public static final String SERIALIZED_NAME_HIGHLIGHT_RESULTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAGE
```
public static final String SERIALIZED_NAME_PAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAGE_SIZE
```
public static final String SERIALIZED_NAME_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_QUERY
```
public static final String SERIALIZED_NAME_QUERY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SCORE_THRESHOLD
```
public static final String SERIALIZED_NAME_SCORE_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEARCH_TYPE
```
public static final String SERIALIZED_NAME_SEARCH_TYPE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - SearchOverGroupsData
```
public SearchOverGroupsData()
```
- Method Detail
  - filters
```
public SearchOverGroupsData filters(ChunkFilter filters)
```
  - getFilters
```
@Nullable
@Valid
public @Valid ChunkFilter getFilters()
```
    Get filters
    
    Returns:
    
    filters
  - setFilters
```
public void setFilters(ChunkFilter filters)
```
  - getCollisions
```
public SearchOverGroupsData getCollisions(Boolean getCollisions)
```
  - getGetCollisions
```
@Nullable
public Boolean getGetCollisions()
```
    Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.
    
    Returns:
    
    getCollisions
  - setGetCollisions
```
public void setGetCollisions(Boolean getCollisions)
```
  - groupSize
```
public SearchOverGroupsData groupSize(Integer groupSize)
```
  - getGroupSize
```
@Nullable
@Min(0L)
public @Min(0L) Integer getGroupSize()
```
    Get groupSize minimum: 0
    
    Returns:
    
    groupSize
  - setGroupSize
```
public void setGroupSize(Integer groupSize)
```
  - highlightDelimiters
```
public SearchOverGroupsData highlightDelimiters(List<String> highlightDelimiters)
```
  - addHighlightDelimitersItem
```
public SearchOverGroupsData addHighlightDelimitersItem(String highlightDelimitersItem)
```
  - getHighlightDelimiters
```
@Nullable
public List<String> getHighlightDelimiters()
```
    Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
    
    Returns:
    
    highlightDelimiters
  - setHighlightDelimiters
```
public void setHighlightDelimiters(List<String> highlightDelimiters)
```
  - highlightResults
```
public SearchOverGroupsData highlightResults(Boolean highlightResults)
```
  - getHighlightResults
```
@Nullable
public Boolean getHighlightResults()
```
    Set highlight_results to true to highlight the results. If not specified, this defaults to true.
    
    Returns:
    
    highlightResults
  - setHighlightResults
```
public void setHighlightResults(Boolean highlightResults)
```
  - page
```
public SearchOverGroupsData page(Long page)
```
  - getPage
```
@Nullable
@Min(0L)
public @Min(0L) Long getPage()
```
    Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. minimum: 0
    
    Returns:
    
    page
  - setPage
```
public void setPage(Long page)
```
  - pageSize
```
public SearchOverGroupsData pageSize(Integer pageSize)
```
  - getPageSize
```
@Nullable
@Min(0L)
public @Min(0L) Integer getPageSize()
```
    Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. minimum: 0
    
    Returns:
    
    pageSize
  - setPageSize
```
public void setPageSize(Integer pageSize)
```
  - query
```
public SearchOverGroupsData query(String query)
```
  - getQuery
```
@Nonnull
@NotNull
public @NotNull String getQuery()
```
    Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.
    
    Returns:
    
    query
  - setQuery
```
public void setQuery(String query)
```
  - scoreThreshold
```
public SearchOverGroupsData scoreThreshold(Float scoreThreshold)
```
  - getScoreThreshold
```
@Nullable
public Float getScoreThreshold()
```
    Set score_threshold to a float to filter out chunks with a score below the threshold.
    
    Returns:
    
    scoreThreshold
  - setScoreThreshold
```
public void setScoreThreshold(Float scoreThreshold)
```
  - searchType
```
public SearchOverGroupsData searchType(String searchType)
```
  - getSearchType
```
@Nonnull
@NotNull
public @NotNull String getSearchType()
```
    Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE.
    
    Returns:
    
    searchType
  - setSearchType
```
public void setSearchType(String searchType)
```
  - 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 SearchOverGroupsData
  - fromJson
```
public static SearchOverGroupsData fromJson(String jsonString)
                                     throws IOException
```
    Create an instance of SearchOverGroupsData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SearchOverGroupsData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to SearchOverGroupsData
  - toJson
```
public String toJson()
```
    Convert an instance of SearchOverGroupsData to an JSON string
    
    Returns:
    
    JSON string

Class SearchOverGroupsData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_FILTERS

SERIALIZED_NAME_GET_COLLISIONS

SERIALIZED_NAME_GROUP_SIZE

SERIALIZED_NAME_HIGHLIGHT_DELIMITERS

SERIALIZED_NAME_HIGHLIGHT_RESULTS

SERIALIZED_NAME_PAGE

SERIALIZED_NAME_PAGE_SIZE

SERIALIZED_NAME_QUERY

SERIALIZED_NAME_SCORE_THRESHOLD

SERIALIZED_NAME_SEARCH_TYPE

openapiFields

openapiRequiredFields

Constructor Detail

SearchOverGroupsData

Method Detail

filters

getFilters

setFilters

getCollisions

getGetCollisions

setGetCollisions

groupSize

getGroupSize

setGroupSize

highlightDelimiters

addHighlightDelimitersItem

getHighlightDelimiters

setHighlightDelimiters

highlightResults

getHighlightResults

setHighlightResults

page

getPage

setPage

pageSize

getPageSize

setPageSize

query

getQuery

setQuery

scoreThreshold

getScoreThreshold

setScoreThreshold

searchType

getSearchType

setSearchType

equals

hashCode

toString

validateJsonElement

fromJson

toJson