Package org.openapitools.client.api

Class ChunkGroupApi

  • public class ChunkGroupApi
extends Object

    • Constructor Detail

      • ChunkGroupApi

        public ChunkGroupApi()

      • ChunkGroupApi

        public ChunkGroupApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(String customBaseUrl)

      • addChunkToGroupCall

        public okhttp3.Call addChunkToGroupCall​(String trDataset,
                                        UUID groupId,
                                        AddChunkToGroupData addChunkToGroupData,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for addChunkToGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroup

        public void addChunkToGroup​(String trDataset,
                            UUID groupId,
                            AddChunkToGroupData addChunkToGroupData)
                     throws ApiException
        Add Chunk to Group Add Chunk to Group Route to add a chunk to a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupWithHttpInfo

        public ApiResponse<Void> addChunkToGroupWithHttpInfo​(@NotNull
                                                     @NotNull String trDataset,
                                                     @NotNull
                                                     @NotNull UUID groupId,
                                                     @NotNull
                                                     @NotNull AddChunkToGroupData addChunkToGroupData)
                                              throws ApiException
        Add Chunk to Group Add Chunk to Group Route to add a chunk to a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupAsync

        public okhttp3.Call addChunkToGroupAsync​(String trDataset,
                                         UUID groupId,
                                         AddChunkToGroupData addChunkToGroupData,
                                         ApiCallback<Void> _callback)
                                  throws ApiException
        Add Chunk to Group (asynchronously) Add Chunk to Group Route to add a chunk to a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupByTrackingIdCall

        public okhttp3.Call addChunkToGroupByTrackingIdCall​(String trDataset,
                                                    String trackingId,
                                                    AddChunkToGroupData addChunkToGroupData,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for addChunkToGroupByTrackingId
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupByTrackingId

        public void addChunkToGroupByTrackingId​(String trDataset,
                                        String trackingId,
                                        AddChunkToGroupData addChunkToGroupData)
                                 throws ApiException
        Add Chunk to Group by Tracking ID Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupByTrackingIdWithHttpInfo

        public ApiResponse<Void> addChunkToGroupByTrackingIdWithHttpInfo​(@NotNull
                                                                 @NotNull String trDataset,
                                                                 @NotNull
                                                                 @NotNull String trackingId,
                                                                 @NotNull
                                                                 @NotNull AddChunkToGroupData addChunkToGroupData)
                                                          throws ApiException
        Add Chunk to Group by Tracking ID Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • addChunkToGroupByTrackingIdAsync

        public okhttp3.Call addChunkToGroupByTrackingIdAsync​(String trDataset,
                                                     String trackingId,
                                                     AddChunkToGroupData addChunkToGroupData,
                                                     ApiCallback<Void> _callback)
                                              throws ApiException
        Add Chunk to Group by Tracking ID (asynchronously) Add Chunk to Group by Tracking ID Route to add a chunk to a group by tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Id of the group to add the chunk to as a bookmark (required)
        addChunkToGroupData - JSON request payload to add a chunk to a group (bookmark it) (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was added to the group (bookmark'ed). -
        400 Service error relating to getting the groups that the chunk is in. -

      • createChunkGroupCall

        public okhttp3.Call createChunkGroupCall​(String trDataset,
                                         CreateChunkGroupData createChunkGroupData,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for createChunkGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Returns the created chunkGroup -
        400 Service error relating to creating the chunkGroup -

      • createChunkGroup

        public ChunkGroup createChunkGroup​(String trDataset,
                                   CreateChunkGroupData createChunkGroupData)
                            throws ApiException
        Create Chunk Group Create Chunk Group Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        Returns:
        ChunkGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Returns the created chunkGroup -
        400 Service error relating to creating the chunkGroup -

      • createChunkGroupWithHttpInfo

        public ApiResponse<ChunkGroup> createChunkGroupWithHttpInfo​(@NotNull
                                                            @NotNull String trDataset,
                                                            @NotNull
                                                            @NotNull CreateChunkGroupData createChunkGroupData)
                                                     throws ApiException
        Create Chunk Group Create Chunk Group Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        Returns:
        ApiResponse<ChunkGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Returns the created chunkGroup -
        400 Service error relating to creating the chunkGroup -

      • createChunkGroupAsync

        public okhttp3.Call createChunkGroupAsync​(String trDataset,
                                          CreateChunkGroupData createChunkGroupData,
                                          ApiCallback<ChunkGroup> _callback)
                                   throws ApiException
        Create Chunk Group (asynchronously) Create Chunk Group Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Returns the created chunkGroup -
        400 Service error relating to creating the chunkGroup -

      • deleteChunkGroupCall

        public okhttp3.Call deleteChunkGroupCall​(String trDataset,
                                         UUID groupId,
                                         Boolean deleteChunks,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for deleteChunkGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        deleteChunks - Delete the chunks within the group (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteChunkGroup

        public void deleteChunkGroup​(String trDataset,
                             UUID groupId,
                             Boolean deleteChunks)
                      throws ApiException
        Delete Group Delete Group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        deleteChunks - Delete the chunks within the group (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteChunkGroupWithHttpInfo

        public ApiResponse<Void> deleteChunkGroupWithHttpInfo​(@NotNull
                                                      @NotNull String trDataset,
                                                      @NotNull
                                                      @NotNull UUID groupId,
                                                      @NotNull
                                                      @NotNull Boolean deleteChunks)
                                               throws ApiException
        Delete Group Delete Group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        deleteChunks - Delete the chunks within the group (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteChunkGroupAsync

        public okhttp3.Call deleteChunkGroupAsync​(String trDataset,
                                          UUID groupId,
                                          Boolean deleteChunks,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Delete Group (asynchronously) Delete Group This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        deleteChunks - Delete the chunks within the group (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteGroupByTrackingIdCall

        public okhttp3.Call deleteGroupByTrackingIdCall​(String trDataset,
                                                String trackingId,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for deleteGroupByTrackingId
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to delete (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteGroupByTrackingId

        public void deleteGroupByTrackingId​(String trDataset,
                                    String trackingId)
                             throws ApiException
        Delete Group by Tracking ID Delete Group by Tracking ID Delete a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to delete (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteGroupByTrackingIdWithHttpInfo

        public ApiResponse<Void> deleteGroupByTrackingIdWithHttpInfo​(@NotNull
                                                             @NotNull String trDataset,
                                                             @NotNull
                                                             @NotNull String trackingId)
                                                      throws ApiException
        Delete Group by Tracking ID Delete Group by Tracking ID Delete a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to delete (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • deleteGroupByTrackingIdAsync

        public okhttp3.Call deleteGroupByTrackingIdAsync​(String trDataset,
                                                 String trackingId,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException
        Delete Group by Tracking ID (asynchronously) Delete Group by Tracking ID Delete a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to delete (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was deleted -
        400 Service error relating to deleting the chunkGroup -

      • getChunkGroupCall

        public okhttp3.Call getChunkGroupCall​(String trDataset,
                                      UUID groupId,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getChunkGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getChunkGroup

        public ChunkGroup getChunkGroup​(String trDataset,
                                UUID groupId)
                         throws ApiException
        Get Group Get Group Fetch the group with the given id. get_group
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        Returns:
        ChunkGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getChunkGroupWithHttpInfo

        public ApiResponse<ChunkGroup> getChunkGroupWithHttpInfo​(@NotNull
                                                         @NotNull String trDataset,
                                                         @NotNull
                                                         @NotNull UUID groupId)
                                                  throws ApiException
        Get Group Get Group Fetch the group with the given id. get_group
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        Returns:
        ApiResponse<ChunkGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getChunkGroupAsync

        public okhttp3.Call getChunkGroupAsync​(String trDataset,
                                       UUID groupId,
                                       ApiCallback<ChunkGroup> _callback)
                                throws ApiException
        Get Group (asynchronously) Get Group Fetch the group with the given id. get_group
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getChunksInGroupCall

        public okhttp3.Call getChunksInGroupCall​(String trDataset,
                                         UUID groupId,
                                         Long page,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getChunksInGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        page - The page of chunks to get from the group (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroup

        public BookmarkData getChunksInGroup​(String trDataset,
                                     UUID groupId,
                                     Long page)
                              throws ApiException
        Get Chunks in Group Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        page - The page of chunks to get from the group (required)
        Returns:
        BookmarkData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupWithHttpInfo

        public ApiResponse<BookmarkData> getChunksInGroupWithHttpInfo​(@NotNull
                                                              @NotNull String trDataset,
                                                              @NotNull
                                                              @NotNull UUID groupId,
                                                              @NotNull @Min(0L)
                                                              @NotNull @Min(0L) Long page)
                                                       throws ApiException
        Get Chunks in Group Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        page - The page of chunks to get from the group (required)
        Returns:
        ApiResponse<BookmarkData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupAsync

        public okhttp3.Call getChunksInGroupAsync​(String trDataset,
                                          UUID groupId,
                                          Long page,
                                          ApiCallback<BookmarkData> _callback)
                                   throws ApiException
        Get Chunks in Group (asynchronously) Get Chunks in Group Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group you want to fetch. (required)
        page - The page of chunks to get from the group (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupByTrackingIdCall

        public okhttp3.Call getChunksInGroupByTrackingIdCall​(String trDataset,
                                                     String groupTrackingId,
                                                     Long page,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for getChunksInGroupByTrackingId
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupTrackingId - The id of the group to get the chunks from (required)
        page - The page of chunks to get from the group (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupByTrackingId

        public BookmarkData getChunksInGroupByTrackingId​(String trDataset,
                                                 String groupTrackingId,
                                                 Long page)
                                          throws ApiException
        Get Chunks in Group by Tracking ID Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupTrackingId - The id of the group to get the chunks from (required)
        page - The page of chunks to get from the group (required)
        Returns:
        BookmarkData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupByTrackingIdWithHttpInfo

        public ApiResponse<BookmarkData> getChunksInGroupByTrackingIdWithHttpInfo​(@NotNull
                                                                          @NotNull String trDataset,
                                                                          @NotNull
                                                                          @NotNull String groupTrackingId,
                                                                          @NotNull @Min(0L)
                                                                          @NotNull @Min(0L) Long page)
                                                                   throws ApiException
        Get Chunks in Group by Tracking ID Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupTrackingId - The id of the group to get the chunks from (required)
        page - The page of chunks to get from the group (required)
        Returns:
        ApiResponse<BookmarkData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getChunksInGroupByTrackingIdAsync

        public okhttp3.Call getChunksInGroupByTrackingIdAsync​(String trDataset,
                                                      String groupTrackingId,
                                                      Long page,
                                                      ApiCallback<BookmarkData> _callback)
                                               throws ApiException
        Get Chunks in Group by Tracking ID (asynchronously) Get Chunks in Group by Tracking ID Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupTrackingId - The id of the group to get the chunks from (required)
        page - The page of chunks to get from the group (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Chunks present within the specified group -
        400 Service error relating to getting the groups that the chunk is in -

      • getGroupByTrackingIdCall

        public okhttp3.Call getGroupByTrackingIdCall​(String trDataset,
                                             String trackingId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getGroupByTrackingId
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - The tracking id of the group to fetch. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getGroupByTrackingId

        public ChunkGroup getGroupByTrackingId​(String trDataset,
                                       String trackingId)
                                throws ApiException
        Get Group by Tracking ID Get Group by Tracking ID Fetch the group with the given tracking id. get_group_by_tracking_id
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - The tracking id of the group to fetch. (required)
        Returns:
        ChunkGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getGroupByTrackingIdWithHttpInfo

        public ApiResponse<ChunkGroup> getGroupByTrackingIdWithHttpInfo​(@NotNull
                                                                @NotNull String trDataset,
                                                                @NotNull
                                                                @NotNull String trackingId)
                                                         throws ApiException
        Get Group by Tracking ID Get Group by Tracking ID Fetch the group with the given tracking id. get_group_by_tracking_id
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - The tracking id of the group to fetch. (required)
        Returns:
        ApiResponse<ChunkGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getGroupByTrackingIdAsync

        public okhttp3.Call getGroupByTrackingIdAsync​(String trDataset,
                                              String trackingId,
                                              ApiCallback<ChunkGroup> _callback)
                                       throws ApiException
        Get Group by Tracking ID (asynchronously) Get Group by Tracking ID Fetch the group with the given tracking id. get_group_by_tracking_id
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - The tracking id of the group to fetch. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the group with the given tracking id -
        400 Service error relating to getting the group with the given tracking id -

      • getGroupsChunkIsInCall

        public okhttp3.Call getGroupsChunkIsInCall​(String trDataset,
                                           GetGroupsForChunksData getGroupsForChunksData,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getGroupsChunkIsIn
        Parameters:
        trDataset - The dataset id to use for the request (required)
        getGroupsForChunksData - JSON request payload to get the groups that a chunk is in (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups that the chunk is in -
        400 Service error relating to getting the groups that the chunk is in -

      • getGroupsChunkIsIn

        public List<BookmarkGroupResult> getGroupsChunkIsIn​(String trDataset,
                                                    GetGroupsForChunksData getGroupsForChunksData)
                                             throws ApiException
        Get Groups for Chunks Get Groups for Chunks Route to get the groups that a chunk is in.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        getGroupsForChunksData - JSON request payload to get the groups that a chunk is in (required)
        Returns:
        List<BookmarkGroupResult>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups that the chunk is in -
        400 Service error relating to getting the groups that the chunk is in -

      • getGroupsChunkIsInWithHttpInfo

        public ApiResponse<List<BookmarkGroupResult>> getGroupsChunkIsInWithHttpInfo​(@NotNull
                                                                             @NotNull String trDataset,
                                                                             @NotNull
                                                                             @NotNull GetGroupsForChunksData getGroupsForChunksData)
                                                                      throws ApiException
        Get Groups for Chunks Get Groups for Chunks Route to get the groups that a chunk is in.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        getGroupsForChunksData - JSON request payload to get the groups that a chunk is in (required)
        Returns:
        ApiResponse<List<BookmarkGroupResult>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups that the chunk is in -
        400 Service error relating to getting the groups that the chunk is in -

      • getGroupsChunkIsInAsync

        public okhttp3.Call getGroupsChunkIsInAsync​(String trDataset,
                                            GetGroupsForChunksData getGroupsForChunksData,
                                            ApiCallback<List<BookmarkGroupResult>> _callback)
                                     throws ApiException
        Get Groups for Chunks (asynchronously) Get Groups for Chunks Route to get the groups that a chunk is in.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        getGroupsForChunksData - JSON request payload to get the groups that a chunk is in (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups that the chunk is in -
        400 Service error relating to getting the groups that the chunk is in -

      • getRecommendedGroupsCall

        public okhttp3.Call getRecommendedGroupsCall​(String trDataset,
                                             ReccomendGroupChunksRequest reccomendGroupChunksRequest,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getRecommendedGroups
        Parameters:
        trDataset - The dataset id to use for the request (required)
        reccomendGroupChunksRequest - JSON request payload to get recommendations of chunks similar to the chunks in the request (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON response payload containing chunks with scores which are similar to those in the request body -
        400 Service error relating to to getting similar chunks -

      • getRecommendedGroups

        public List<GroupScoreChunkDTO> getRecommendedGroups​(String trDataset,
                                                     ReccomendGroupChunksRequest reccomendGroupChunksRequest)
                                              throws ApiException
        Get Recommended Groups Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        reccomendGroupChunksRequest - JSON request payload to get recommendations of chunks similar to the chunks in the request (required)
        Returns:
        List<GroupScoreChunkDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON response payload containing chunks with scores which are similar to those in the request body -
        400 Service error relating to to getting similar chunks -

      • getRecommendedGroupsWithHttpInfo

        public ApiResponse<List<GroupScoreChunkDTO>> getRecommendedGroupsWithHttpInfo​(@NotNull
                                                                              @NotNull String trDataset,
                                                                              @NotNull
                                                                              @NotNull ReccomendGroupChunksRequest reccomendGroupChunksRequest)
                                                                       throws ApiException
        Get Recommended Groups Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        reccomendGroupChunksRequest - JSON request payload to get recommendations of chunks similar to the chunks in the request (required)
        Returns:
        ApiResponse<List<GroupScoreChunkDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON response payload containing chunks with scores which are similar to those in the request body -
        400 Service error relating to to getting similar chunks -

      • getRecommendedGroupsAsync

        public okhttp3.Call getRecommendedGroupsAsync​(String trDataset,
                                              ReccomendGroupChunksRequest reccomendGroupChunksRequest,
                                              ApiCallback<List<GroupScoreChunkDTO>> _callback)
                                       throws ApiException
        Get Recommended Groups (asynchronously) Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        reccomendGroupChunksRequest - JSON request payload to get recommendations of chunks similar to the chunks in the request (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON response payload containing chunks with scores which are similar to those in the request body -
        400 Service error relating to to getting similar chunks -

      • getSpecificDatasetChunkGroupsCall

        public okhttp3.Call getSpecificDatasetChunkGroupsCall​(String trDataset,
                                                      UUID datasetId,
                                                      Long page,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for getSpecificDatasetChunkGroups
        Parameters:
        trDataset - The dataset id to use for the request (required)
        datasetId - The id of the dataset to fetch groups for. (required)
        page - The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups created by the given dataset -
        400 Service error relating to getting the groups created by the given dataset -

      • getSpecificDatasetChunkGroups

        public GroupData getSpecificDatasetChunkGroups​(String trDataset,
                                               UUID datasetId,
                                               Long page)
                                        throws ApiException
        Get Groups for Dataset Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        datasetId - The id of the dataset to fetch groups for. (required)
        page - The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon. (required)
        Returns:
        GroupData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups created by the given dataset -
        400 Service error relating to getting the groups created by the given dataset -

      • getSpecificDatasetChunkGroupsWithHttpInfo

        public ApiResponse<GroupData> getSpecificDatasetChunkGroupsWithHttpInfo​(@NotNull
                                                                        @NotNull String trDataset,
                                                                        @NotNull
                                                                        @NotNull UUID datasetId,
                                                                        @NotNull
                                                                        @NotNull Long page)
                                                                 throws ApiException
        Get Groups for Dataset Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        datasetId - The id of the dataset to fetch groups for. (required)
        page - The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon. (required)
        Returns:
        ApiResponse<GroupData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups created by the given dataset -
        400 Service error relating to getting the groups created by the given dataset -

      • getSpecificDatasetChunkGroupsAsync

        public okhttp3.Call getSpecificDatasetChunkGroupsAsync​(String trDataset,
                                                       UUID datasetId,
                                                       Long page,
                                                       ApiCallback<GroupData> _callback)
                                                throws ApiException
        Get Groups for Dataset (asynchronously) Get Groups for Dataset Fetch the groups which belong to a dataset specified by its id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        datasetId - The id of the dataset to fetch groups for. (required)
        page - The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the groups created by the given dataset -
        400 Service error relating to getting the groups created by the given dataset -

      • removeChunkFromGroupCall

        public okhttp3.Call removeChunkFromGroupCall​(String trDataset,
                                             UUID groupId,
                                             CreateChunkGroupData createChunkGroupData,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for removeChunkFromGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to remove the bookmark'ed chunk from (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was removed to the group -
        400 Service error relating to removing the chunk from the group -

      • removeChunkFromGroup

        public void removeChunkFromGroup​(String trDataset,
                                 UUID groupId,
                                 CreateChunkGroupData createChunkGroupData)
                          throws ApiException
        Remove Chunk from Group Remove Chunk from Group Route to remove a chunk from a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to remove the bookmark'ed chunk from (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was removed to the group -
        400 Service error relating to removing the chunk from the group -

      • removeChunkFromGroupWithHttpInfo

        public ApiResponse<Void> removeChunkFromGroupWithHttpInfo​(@NotNull
                                                          @NotNull String trDataset,
                                                          @NotNull
                                                          @NotNull UUID groupId,
                                                          @NotNull
                                                          @NotNull CreateChunkGroupData createChunkGroupData)
                                                   throws ApiException
        Remove Chunk from Group Remove Chunk from Group Route to remove a chunk from a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to remove the bookmark'ed chunk from (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was removed to the group -
        400 Service error relating to removing the chunk from the group -

      • removeChunkFromGroupAsync

        public okhttp3.Call removeChunkFromGroupAsync​(String trDataset,
                                              UUID groupId,
                                              CreateChunkGroupData createChunkGroupData,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Remove Chunk from Group (asynchronously) Remove Chunk from Group Route to remove a chunk from a group.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        groupId - Id of the group to remove the bookmark'ed chunk from (required)
        createChunkGroupData - JSON request payload to cretea a chunkGroup (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunk was removed to the group -
        400 Service error relating to removing the chunk from the group -

      • searchOverGroupsCall

        public okhttp3.Call searchOverGroupsCall​(SearchOverGroupsData searchOverGroupsData,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for searchOverGroups
        Parameters:
        searchOverGroupsData - JSON request payload to semantically search over groups (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchOverGroups

        public SearchOverGroupsResponseBody searchOverGroups​(SearchOverGroupsData searchOverGroupsData)
                                              throws ApiException
        Search Over Groups Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
        Parameters:
        searchOverGroupsData - JSON request payload to semantically search over groups (required)
        Returns:
        SearchOverGroupsResponseBody
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchOverGroupsWithHttpInfo

        public ApiResponse<SearchOverGroupsResponseBody> searchOverGroupsWithHttpInfo​(@NotNull
                                                                              @NotNull SearchOverGroupsData searchOverGroupsData)
                                                                       throws ApiException
        Search Over Groups Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
        Parameters:
        searchOverGroupsData - JSON request payload to semantically search over groups (required)
        Returns:
        ApiResponse<SearchOverGroupsResponseBody>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchOverGroupsAsync

        public okhttp3.Call searchOverGroupsAsync​(SearchOverGroupsData searchOverGroupsData,
                                          ApiCallback<SearchOverGroupsResponseBody> _callback)
                                   throws ApiException
        Search Over Groups (asynchronously) Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
        Parameters:
        searchOverGroupsData - JSON request payload to semantically search over groups (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchWithinGroupCall

        public okhttp3.Call searchWithinGroupCall​(String trDataset,
                                          SearchWithinGroupData searchWithinGroupData,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for searchWithinGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        searchWithinGroupData - JSON request payload to semantically search a group (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchWithinGroup

        public SearchGroupsResult searchWithinGroup​(String trDataset,
                                            SearchWithinGroupData searchWithinGroupData)
                                     throws ApiException
        Search Within Group Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        searchWithinGroupData - JSON request payload to semantically search a group (required)
        Returns:
        SearchGroupsResult
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchWithinGroupWithHttpInfo

        public ApiResponse<SearchGroupsResult> searchWithinGroupWithHttpInfo​(@NotNull
                                                                     @NotNull String trDataset,
                                                                     @NotNull
                                                                     @NotNull SearchWithinGroupData searchWithinGroupData)
                                                              throws ApiException
        Search Within Group Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        searchWithinGroupData - JSON request payload to semantically search a group (required)
        Returns:
        ApiResponse<SearchGroupsResult>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • searchWithinGroupAsync

        public okhttp3.Call searchWithinGroupAsync​(String trDataset,
                                           SearchWithinGroupData searchWithinGroupData,
                                           ApiCallback<SearchGroupsResult> _callback)
                                    throws ApiException
        Search Within Group (asynchronously) Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        searchWithinGroupData - JSON request payload to semantically search a group (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Group chunks which are similar to the embedding vector of the search query -
        400 Service error relating to getting the groups that the chunk is in -

      • updateChunkGroupCall

        public okhttp3.Call updateChunkGroupCall​(String trDataset,
                                         UpdateChunkGroupData updateChunkGroupData,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for updateChunkGroup
        Parameters:
        trDataset - The dataset id to use for the request (required)
        updateChunkGroupData - JSON request payload to update a chunkGroup (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateChunkGroup

        public void updateChunkGroup​(String trDataset,
                             UpdateChunkGroupData updateChunkGroupData)
                      throws ApiException
        Update Group Update Group Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        updateChunkGroupData - JSON request payload to update a chunkGroup (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateChunkGroupWithHttpInfo

        public ApiResponse<Void> updateChunkGroupWithHttpInfo​(@NotNull
                                                      @NotNull String trDataset,
                                                      @NotNull
                                                      @NotNull UpdateChunkGroupData updateChunkGroupData)
                                               throws ApiException
        Update Group Update Group Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        updateChunkGroupData - JSON request payload to update a chunkGroup (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateChunkGroupAsync

        public okhttp3.Call updateChunkGroupAsync​(String trDataset,
                                          UpdateChunkGroupData updateChunkGroupData,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Update Group (asynchronously) Update Group Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        updateChunkGroupData - JSON request payload to update a chunkGroup (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateGroupByTrackingIdCall

        public okhttp3.Call updateGroupByTrackingIdCall​(String trDataset,
                                                UUID trackingId,
                                                UpdateGroupByTrackingIDData updateGroupByTrackingIDData,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for updateGroupByTrackingId
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to update (required)
        updateGroupByTrackingIDData - JSON request payload to update a chunkGroup (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateGroupByTrackingId

        public void updateGroupByTrackingId​(String trDataset,
                                    UUID trackingId,
                                    UpdateGroupByTrackingIDData updateGroupByTrackingIDData)
                             throws ApiException
        Update Group by Tracking ID Update Group by Tracking ID Update a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to update (required)
        updateGroupByTrackingIDData - JSON request payload to update a chunkGroup (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateGroupByTrackingIdWithHttpInfo

        public ApiResponse<Void> updateGroupByTrackingIdWithHttpInfo​(@NotNull
                                                             @NotNull String trDataset,
                                                             @NotNull
                                                             @NotNull UUID trackingId,
                                                             @NotNull
                                                             @NotNull UpdateGroupByTrackingIDData updateGroupByTrackingIDData)
                                                      throws ApiException
        Update Group by Tracking ID Update Group by Tracking ID Update a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to update (required)
        updateGroupByTrackingIDData - JSON request payload to update a chunkGroup (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -

      • updateGroupByTrackingIdAsync

        public okhttp3.Call updateGroupByTrackingIdAsync​(String trDataset,
                                                 UUID trackingId,
                                                 UpdateGroupByTrackingIDData updateGroupByTrackingIDData,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException
        Update Group by Tracking ID (asynchronously) Update Group by Tracking ID Update a chunk_group with the given tracking id.
        Parameters:
        trDataset - The dataset id to use for the request (required)
        trackingId - Tracking id of the chunk_group to update (required)
        updateGroupByTrackingIDData - JSON request payload to update a chunkGroup (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 Confirmation that the chunkGroup was updated -
        400 Service error relating to updating the chunkGroup -