33import com .google .common .annotations .Beta ;
44import com .sap .ai .sdk .grounding .model .DataRepositories ;
55import com .sap .ai .sdk .grounding .model .DataRepository ;
6- import com .sap .ai .sdk .grounding .model .RetievalSearchResults ;
7- import com .sap .ai .sdk .grounding .model .RetrievalSearchInput ;
6+ import com .sap .ai .sdk .grounding .model .SearchInput ;
7+ import com .sap .ai .sdk .grounding .model .SearchResults ;
88import com .sap .cloud .sdk .cloudplatform .connectivity .Destination ;
99import com .sap .cloud .sdk .services .openapi .apiclient .ApiClient ;
1010import com .sap .cloud .sdk .services .openapi .core .AbstractOpenApiService ;
2424import org .springframework .web .util .UriComponentsBuilder ;
2525
2626/**
27- * Document Grounding Pipeline API in version 0.1.0.
27+ * Grounding in version 0.1.0.
2828 *
29- * <p>SAP AI Core - API Specification AI Data Management api's
29+ * <p>Grounding is a service designed to handle data-related tasks, such as grounding and retrieval,
30+ * using vector databases. It provides specialized data retrieval through these databases, grounding
31+ * the retrieval process with your own external and context-relevant data. Grounding combines
32+ * generative AI capabilities with the ability to use real-time, precise data to improve
33+ * decision-making and business operations for specific AI-driven business solutions.
3034 */
3135public class RetrievalApi extends AbstractOpenApiService {
3236 /**
33- * Instantiates this API class to invoke operations on the Document Grounding Pipeline API .
37+ * Instantiates this API class to invoke operations on the Grounding.
3438 *
3539 * @param httpDestination The destination that API should be used with
3640 */
@@ -39,8 +43,8 @@ public RetrievalApi(@Nonnull final Destination httpDestination) {
3943 }
4044
4145 /**
42- * Instantiates this API class to invoke operations on the Document Grounding Pipeline API based
43- * on a given {@link ApiClient}.
46+ * Instantiates this API class to invoke operations on the Grounding based on a given {@link
47+ * ApiClient}.
4448 *
4549 * @param apiClient ApiClient to invoke the API on
4650 */
@@ -52,13 +56,13 @@ public RetrievalApi(@Nonnull final ApiClient apiClient) {
5256 /**
5357 * List all DataRepository objects.
5458 *
55- * <p>List all DataRepository objects.
59+ * <p>List all Data Repositories
5660 *
5761 * <p><b>200</b> - Successful Response
5862 *
5963 * <p><b>400</b> - The specification of the resource was incorrect
6064 *
61- * @param aiResourceGroup (required) The value for the parameter aiResourceGroup
65+ * @param aiResourceGroup (required) Resource Group ID
6266 * @param $top (optional) Number of results to display
6367 * @param $skip (optional) Number of results to be skipped from the ordered list of results
6468 * @param $count (optional) When the $count field is set to false, the response contains a count
@@ -124,13 +128,13 @@ public DataRepositories getDataRepositories(
124128 /**
125129 * List all DataRepository objects.
126130 *
127- * <p>List all DataRepository objects.
131+ * <p>List all Data Repositories
128132 *
129133 * <p><b>200</b> - Successful Response
130134 *
131135 * <p><b>400</b> - The specification of the resource was incorrect
132136 *
133- * @param aiResourceGroup The value for the parameter aiResourceGroup
137+ * @param aiResourceGroup Resource Group ID
134138 * @return DataRepositories
135139 * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
136140 */
@@ -143,7 +147,7 @@ public DataRepositories getDataRepositories(@Nonnull final String aiResourceGrou
143147 /**
144148 * List single DataRepository object.
145149 *
146- * <p>List single DataRepository object.
150+ * <p>List data repository by id
147151 *
148152 * <p><b>200</b> - Successful Response
149153 *
@@ -153,8 +157,8 @@ public DataRepositories getDataRepositories(@Nonnull final String aiResourceGrou
153157 *
154158 * <p><b>404</b> - The specification of the resource was incorrect
155159 *
156- * @param aiResourceGroup The value for the parameter aiResourceGroup
157- * @param repositoryId The value for the parameter repositoryId
160+ * @param aiResourceGroup Resource Group ID
161+ * @param repositoryId Repository ID
158162 * @return DataRepository
159163 * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
160164 */
@@ -216,7 +220,7 @@ public DataRepository getDataRepositoryById(
216220 }
217221
218222 /**
219- * Retrieve relevant content given a query string.
223+ * Retrieve relevant content
220224 *
221225 * <p>Retrieve relevant content given a query string.
222226 *
@@ -226,28 +230,27 @@ public DataRepository getDataRepositoryById(
226230 *
227231 * <p><b>422</b> - There are validation issues with the data.
228232 *
229- * @param aiResourceGroup The value for the parameter aiResourceGroup
230- * @param retrievalSearchInput The value for the parameter retrievalSearchInput
231- * @return RetievalSearchResults
233+ * @param aiResourceGroup Resource Group ID
234+ * @param searchInput The value for the parameter searchInput
235+ * @return SearchResults
232236 * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
233237 */
234238 @ Nonnull
235- public RetievalSearchResults search (
236- @ Nonnull final String aiResourceGroup ,
237- @ Nonnull final RetrievalSearchInput retrievalSearchInput )
239+ public SearchResults search (
240+ @ Nonnull final String aiResourceGroup , @ Nonnull final SearchInput searchInput )
238241 throws OpenApiRequestException {
239- final Object localVarPostBody = retrievalSearchInput ;
242+ final Object localVarPostBody = searchInput ;
240243
241244 // verify the required parameter 'aiResourceGroup' is set
242245 if (aiResourceGroup == null ) {
243246 throw new OpenApiRequestException (
244247 "Missing the required parameter 'aiResourceGroup' when calling search" );
245248 }
246249
247- // verify the required parameter 'retrievalSearchInput ' is set
248- if (retrievalSearchInput == null ) {
250+ // verify the required parameter 'searchInput ' is set
251+ if (searchInput == null ) {
249252 throw new OpenApiRequestException (
250- "Missing the required parameter 'retrievalSearchInput ' when calling retrievalV1RetrievalEndpointsSearch" );
253+ "Missing the required parameter 'searchInput ' when calling retrievalV1RetrievalEndpointsSearch" );
251254 }
252255
253256 final String localVarPath =
@@ -269,8 +272,8 @@ public RetievalSearchResults search(
269272
270273 final String [] localVarAuthNames = new String [] {};
271274
272- final ParameterizedTypeReference <RetievalSearchResults > localVarReturnType =
273- new ParameterizedTypeReference <RetievalSearchResults >() {};
275+ final ParameterizedTypeReference <SearchResults > localVarReturnType =
276+ new ParameterizedTypeReference <SearchResults >() {};
274277 return apiClient .invokeAPI (
275278 localVarPath ,
276279 HttpMethod .POST ,
0 commit comments