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

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

SearchWithinGroupData

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchWithinGroupData.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_DATE_BIAS`
`static String`	`SERIALIZED_NAME_FILTERS`
`static String`	`SERIALIZED_NAME_GROUP_ID`
`static String`	`SERIALIZED_NAME_GROUP_TRACKING_ID`
`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`
`static String`	`SERIALIZED_NAME_USE_WEIGHTS`

Constructor Summary

Constructors
Constructor Description

SearchWithinGroupData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SearchWithinGroupData`	`addHighlightDelimitersItem(String highlightDelimitersItem)`
`SearchWithinGroupData`	`dateBias(Boolean dateBias)`
`boolean`	`equals(Object o)`
`SearchWithinGroupData`	`filters(ChunkFilter filters)`
`static SearchWithinGroupData`	`fromJson(String jsonString)`	Create an instance of SearchWithinGroupData given an JSON string
`Boolean`	`getDateBias()`	Set date_bias to true to bias search results towards more recent chunks.
`@Valid ChunkFilter`	`getFilters()`	Get filters
`@Valid UUID`	`getGroupId()`	Group specifies the group to search within.
`String`	`getGroupTrackingId()`	Group_tracking_id specifies the group to search within by tracking id.
`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()`	The page of chunks to fetch.
`@Min(0L) Long`	`getPageSize()`	The page size is the number of chunks to fetch.
`@NotNull String`	`getQuery()`	The 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()`	Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\".
`Boolean`	`getUseWeights()`	Set use_weights to true to use the weights of the chunks in the result set in order to sort them.
`SearchWithinGroupData`	`groupId(UUID groupId)`
`SearchWithinGroupData`	`groupTrackingId(String groupTrackingId)`
`int`	`hashCode()`
`SearchWithinGroupData`	`highlightDelimiters(List<String> highlightDelimiters)`
`SearchWithinGroupData`	`highlightResults(Boolean highlightResults)`
`SearchWithinGroupData`	`page(Long page)`
`SearchWithinGroupData`	`pageSize(Long pageSize)`
`SearchWithinGroupData`	`query(String query)`
`SearchWithinGroupData`	`scoreThreshold(Float scoreThreshold)`
`SearchWithinGroupData`	`searchType(String searchType)`
`void`	`setDateBias(Boolean dateBias)`
`void`	`setFilters(ChunkFilter filters)`
`void`	`setGroupId(UUID groupId)`
`void`	`setGroupTrackingId(String groupTrackingId)`
`void`	`setHighlightDelimiters(List<String> highlightDelimiters)`
`void`	`setHighlightResults(Boolean highlightResults)`
`void`	`setPage(Long page)`
`void`	`setPageSize(Long pageSize)`
`void`	`setQuery(String query)`
`void`	`setScoreThreshold(Float scoreThreshold)`
`void`	`setSearchType(String searchType)`
`void`	`setUseWeights(Boolean useWeights)`
`String`	`toJson()`	Convert an instance of SearchWithinGroupData to an JSON string
`String`	`toString()`
`SearchWithinGroupData`	`useWeights(Boolean useWeights)`
`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_DATE_BIAS
```
public static final String SERIALIZED_NAME_DATE_BIAS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILTERS
```
public static final String SERIALIZED_NAME_FILTERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GROUP_ID
```
public static final String SERIALIZED_NAME_GROUP_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GROUP_TRACKING_ID
```
public static final String SERIALIZED_NAME_GROUP_TRACKING_ID
```
    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
  - SERIALIZED_NAME_USE_WEIGHTS
```
public static final String SERIALIZED_NAME_USE_WEIGHTS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - SearchWithinGroupData
```
public SearchWithinGroupData()
```
- Method Detail
  - dateBias
```
public SearchWithinGroupData dateBias(Boolean dateBias)
```
  - getDateBias
```
@Nullable
public Boolean getDateBias()
```
    Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.
    
    Returns:
    
    dateBias
  - setDateBias
```
public void setDateBias(Boolean dateBias)
```
  - filters
```
public SearchWithinGroupData filters(ChunkFilter filters)
```
  - getFilters
```
@Nullable
@Valid
public @Valid ChunkFilter getFilters()
```
    Get filters
    
    Returns:
    
    filters
  - setFilters
```
public void setFilters(ChunkFilter filters)
```
  - groupId
```
public SearchWithinGroupData groupId(UUID groupId)
```
  - getGroupId
```
@Nullable
@Valid
public @Valid UUID getGroupId()
```
    Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group.
    
    Returns:
    
    groupId
  - setGroupId
```
public void setGroupId(UUID groupId)
```
  - groupTrackingId
```
public SearchWithinGroupData groupTrackingId(String groupTrackingId)
```
  - getGroupTrackingId
```
@Nullable
public String getGroupTrackingId()
```
    Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used.
    
    Returns:
    
    groupTrackingId
  - setGroupTrackingId
```
public void setGroupTrackingId(String groupTrackingId)
```
  - highlightDelimiters
```
public SearchWithinGroupData highlightDelimiters(List<String> highlightDelimiters)
```
  - addHighlightDelimitersItem
```
public SearchWithinGroupData 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 SearchWithinGroupData 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 SearchWithinGroupData page(Long page)
```
  - getPage
```
@Nullable
@Min(0L)
public @Min(0L) Long getPage()
```
    The 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 SearchWithinGroupData pageSize(Long pageSize)
```
  - getPageSize
```
@Nullable
@Min(0L)
public @Min(0L) Long getPageSize()
```
    The 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(Long pageSize)
```
  - query
```
public SearchWithinGroupData query(String query)
```
  - getQuery
```
@Nonnull
@NotNull
public @NotNull String getQuery()
```
    The 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 SearchWithinGroupData 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 SearchWithinGroupData searchType(String searchType)
```
  - getSearchType
```
@Nonnull
@NotNull
public @NotNull String getSearchType()
```
    Search_type 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)
```
  - useWeights
```
public SearchWithinGroupData useWeights(Boolean useWeights)
```
  - getUseWeights
```
@Nullable
public Boolean getUseWeights()
```
    Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.
    
    Returns:
    
    useWeights
  - setUseWeights
```
public void setUseWeights(Boolean useWeights)
```
  - 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 SearchWithinGroupData
  - fromJson
```
public static SearchWithinGroupData fromJson(String jsonString)
                                      throws IOException
```
    Create an instance of SearchWithinGroupData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SearchWithinGroupData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to SearchWithinGroupData
  - toJson
```
public String toJson()
```
    Convert an instance of SearchWithinGroupData to an JSON string
    
    Returns:
    
    JSON string

Class SearchWithinGroupData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_DATE_BIAS

SERIALIZED_NAME_FILTERS

SERIALIZED_NAME_GROUP_ID

SERIALIZED_NAME_GROUP_TRACKING_ID

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

SERIALIZED_NAME_USE_WEIGHTS

openapiFields

openapiRequiredFields

Constructor Detail

SearchWithinGroupData

Method Detail

dateBias

getDateBias

setDateBias

filters

getFilters

setFilters

groupId

getGroupId

setGroupId

groupTrackingId

getGroupTrackingId

setGroupTrackingId

highlightDelimiters

addHighlightDelimitersItem

getHighlightDelimiters

setHighlightDelimiters

highlightResults

getHighlightResults

setHighlightResults

page

getPage

setPage

pageSize

getPageSize

setPageSize

query

getQuery

setQuery

scoreThreshold

getScoreThreshold

setScoreThreshold

searchType

getSearchType

setSearchType

useWeights

getUseWeights

setUseWeights

equals

hashCode

toString

validateJsonElement

fromJson

toJson