Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
import com.google.common.annotations.Beta;
import com.sap.ai.sdk.grounding.model.DataRepositories;
import com.sap.ai.sdk.grounding.model.DataRepository;
import com.sap.ai.sdk.grounding.model.RetievalSearchResults;
import com.sap.ai.sdk.grounding.model.RetrievalSearchInput;
import com.sap.ai.sdk.grounding.model.SearchInput;
import com.sap.ai.sdk.grounding.model.SearchResults;
import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService;
Expand All @@ -24,13 +24,17 @@
import org.springframework.web.util.UriComponentsBuilder;

/**
* Document Grounding Pipeline API in version 0.1.0.
* Grounding in version 0.1.0.
*
* <p>SAP AI Core - API Specification AI Data Management api's
* <p>Grounding is a service designed to handle data-related tasks, such as grounding and retrieval,
* using vector databases. It provides specialized data retrieval through these databases, grounding
* the retrieval process with your own external and context-relevant data. Grounding combines
* generative AI capabilities with the ability to use real-time, precise data to improve
* decision-making and business operations for specific AI-driven business solutions.
*/
public class RetrievalApi extends AbstractOpenApiService {
/**
* Instantiates this API class to invoke operations on the Document Grounding Pipeline API.
* Instantiates this API class to invoke operations on the Grounding.
*
* @param httpDestination The destination that API should be used with
*/
Expand All @@ -39,8 +43,8 @@ public RetrievalApi(@Nonnull final Destination httpDestination) {
}

/**
* Instantiates this API class to invoke operations on the Document Grounding Pipeline API based
* on a given {@link ApiClient}.
* Instantiates this API class to invoke operations on the Grounding based on a given {@link
* ApiClient}.
*
* @param apiClient ApiClient to invoke the API on
*/
Expand All @@ -52,13 +56,13 @@ public RetrievalApi(@Nonnull final ApiClient apiClient) {
/**
* List all DataRepository objects.
*
* <p>List all DataRepository objects.
* <p>List all Data Repositories
*
* <p><b>200</b> - Successful Response
*
* <p><b>400</b> - The specification of the resource was incorrect
*
* @param aiResourceGroup (required) The value for the parameter aiResourceGroup
* @param aiResourceGroup (required) Resource Group ID
* @param $top (optional) Number of results to display
* @param $skip (optional) Number of results to be skipped from the ordered list of results
* @param $count (optional) When the $count field is set to false, the response contains a count
Expand Down Expand Up @@ -124,13 +128,13 @@ public DataRepositories getDataRepositories(
/**
* List all DataRepository objects.
*
* <p>List all DataRepository objects.
* <p>List all Data Repositories
*
* <p><b>200</b> - Successful Response
*
* <p><b>400</b> - The specification of the resource was incorrect
*
* @param aiResourceGroup The value for the parameter aiResourceGroup
* @param aiResourceGroup Resource Group ID
* @return DataRepositories
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -143,7 +147,7 @@ public DataRepositories getDataRepositories(@Nonnull final String aiResourceGrou
/**
* List single DataRepository object.
*
* <p>List single DataRepository object.
* <p>List data repository by id
*
* <p><b>200</b> - Successful Response
*
Expand All @@ -153,8 +157,8 @@ public DataRepositories getDataRepositories(@Nonnull final String aiResourceGrou
*
* <p><b>404</b> - The specification of the resource was incorrect
*
* @param aiResourceGroup The value for the parameter aiResourceGroup
* @param repositoryId The value for the parameter repositoryId
* @param aiResourceGroup Resource Group ID
* @param repositoryId Repository ID
* @return DataRepository
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand Down Expand Up @@ -216,7 +220,7 @@ public DataRepository getDataRepositoryById(
}

/**
* Retrieve relevant content given a query string.
* Retrieve relevant content
*
* <p>Retrieve relevant content given a query string.
*
Expand All @@ -226,28 +230,27 @@ public DataRepository getDataRepositoryById(
*
* <p><b>422</b> - There are validation issues with the data.
*
* @param aiResourceGroup The value for the parameter aiResourceGroup
* @param retrievalSearchInput The value for the parameter retrievalSearchInput
* @return RetievalSearchResults
* @param aiResourceGroup Resource Group ID
* @param searchInput The value for the parameter searchInput
* @return SearchResults
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public RetievalSearchResults search(
@Nonnull final String aiResourceGroup,
@Nonnull final RetrievalSearchInput retrievalSearchInput)
public SearchResults search(
@Nonnull final String aiResourceGroup, @Nonnull final SearchInput searchInput)
throws OpenApiRequestException {
final Object localVarPostBody = retrievalSearchInput;
final Object localVarPostBody = searchInput;

// verify the required parameter 'aiResourceGroup' is set
if (aiResourceGroup == null) {
throw new OpenApiRequestException(
"Missing the required parameter 'aiResourceGroup' when calling search");
}

// verify the required parameter 'retrievalSearchInput' is set
if (retrievalSearchInput == null) {
// verify the required parameter 'searchInput' is set
if (searchInput == null) {
throw new OpenApiRequestException(
"Missing the required parameter 'retrievalSearchInput' when calling retrievalV1RetrievalEndpointsSearch");
"Missing the required parameter 'searchInput' when calling retrievalV1RetrievalEndpointsSearch");
}

final String localVarPath =
Expand All @@ -269,8 +272,8 @@ public RetievalSearchResults search(

final String[] localVarAuthNames = new String[] {};

final ParameterizedTypeReference<RetievalSearchResults> localVarReturnType =
new ParameterizedTypeReference<RetievalSearchResults>() {};
final ParameterizedTypeReference<SearchResults> localVarReturnType =
new ParameterizedTypeReference<SearchResults>() {};
return apiClient.invokeAPI(
localVarPath,
HttpMethod.POST,
Expand Down
Loading
Loading