feat: [DevOps] Update grounding specification (#489)

* Update grounding based on main

* temp fix

* fixed

* fixed

* final

* Update grounding based on main

* Address unfixed API change

* Fix missing final

* finito

* release notes

---------

Co-authored-by: I538344 <[email protected]>
Co-authored-by: Alexander Dümont <[email protected]>

Author: 3 people

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/client/PipelinesApi.java

@@ -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.RetrievalSearchResults;
 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;
@@ -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
    */
@@ -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
    */
@@ -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
@@ -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
    */
@@ -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
    *
@@ -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
    */
@@ -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.
    *
@@ -226,13 +230,13 @@ public DataRepository getDataRepositoryById(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
+   * @param aiResourceGroup Resource Group ID
    * @param retrievalSearchInput The value for the parameter retrievalSearchInput
-   * @return RetievalSearchResults
+   * @return RetrievalSearchResults
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
   @Nonnull
-  public RetievalSearchResults search(
+  public RetrievalSearchResults search(
       @Nonnull final String aiResourceGroup,
       @Nonnull final RetrievalSearchInput retrievalSearchInput)
       throws OpenApiRequestException {
@@ -269,8 +273,8 @@ public RetievalSearchResults search(
 
     final String[] localVarAuthNames = new String[] {};
 
-    final ParameterizedTypeReference<RetievalSearchResults> localVarReturnType =
-        new ParameterizedTypeReference<RetievalSearchResults>() {};
+    final ParameterizedTypeReference<RetrievalSearchResults> localVarReturnType =
+        new ParameterizedTypeReference<RetrievalSearchResults>() {};
     return apiClient.invokeAPI(
         localVarPath,
         HttpMethod.POST,

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/client/RetrievalApi.java

@@ -33,13 +33,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 VectorApi 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
    */
@@ -48,8 +52,8 @@ public VectorApi(@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
    */
@@ -70,7 +74,7 @@ public VectorApi(@Nonnull final ApiClient apiClient) {
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
+   * @param aiResourceGroup Resource Group ID
    * @param collectionRequest The value for the parameter collectionRequest
    * @return An OpenApiResponse containing the status code of the HttpResponse.
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
@@ -142,8 +146,8 @@ public OpenApiResponse createCollection(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
    * @param documentCreateRequest The value for the parameter documentCreateRequest
    * @return DocumentsListResponse
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
@@ -227,8 +231,8 @@ public DocumentsListResponse createDocuments(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
    * @return An OpenApiResponse containing the status code of the HttpResponse.
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -303,9 +307,9 @@ public OpenApiResponse deleteCollectionById(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
-   * @param documentId The value for the parameter documentId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
+   * @param documentId Document ID
    * @return An OpenApiResponse containing the status code of the HttpResponse.
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -385,7 +389,7 @@ public OpenApiResponse deleteDocumentById(
    *
    * <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
@@ -457,7 +461,7 @@ public CollectionsListResponse getAllCollections(
    *
    * <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 CollectionsListResponse
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -480,8 +484,8 @@ public CollectionsListResponse getAllCollections(@Nonnull final String aiResourc
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup (required) The value for the parameter aiResourceGroup
-   * @param collectionId (required) The value for the parameter collectionId
+   * @param aiResourceGroup (required) Resource Group ID
+   * @param collectionId (required) Collection 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
@@ -569,8 +573,8 @@ public Documents getAllDocuments(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
    * @return Documents
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -594,8 +598,8 @@ public Documents getAllDocuments(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
    * @return Collection
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -669,8 +673,8 @@ public Collection getCollectionById(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param id The value for the parameter id
+   * @param aiResourceGroup Resource Group ID
+   * @param id Collection ID
    * @return VectorV1VectorEndpointsGetCollectionCreationStatus200Response
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -746,8 +750,8 @@ public VectorV1VectorEndpointsGetCollectionCreationStatus200Response getCollecti
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param id The value for the parameter id
+   * @param aiResourceGroup Resource Group ID
+   * @param id Collection ID
    * @return VectorV1VectorEndpointsGetCollectionDeletionStatus200Response
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -823,9 +827,9 @@ public VectorV1VectorEndpointsGetCollectionDeletionStatus200Response getCollecti
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
-   * @param documentId The value for the parameter documentId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
+   * @param documentId Document ID
    * @return DocumentResponse
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
    */
@@ -898,7 +902,7 @@ public DocumentResponse getDocumentById(
   /**
    * Search chunk by vector
    *
-   * <p>Search chunk by vector
+   * <p>Search chunks
    *
    * <p><b>200</b> - Successful Response
    *
@@ -908,7 +912,7 @@ public DocumentResponse getDocumentById(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
+   * @param aiResourceGroup Resource Group ID
    * @param textSearchRequest The value for the parameter textSearchRequest
    * @return SearchResults
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API
@@ -928,7 +932,7 @@ public SearchResults search(
     // verify the required parameter 'textSearchRequest' is set
     if (textSearchRequest == null) {
       throw new OpenApiRequestException(
-          "Missing the required parameter 'textSearchRequest' when calling vectorV1VectorEndpointsSearch");
+          "Missing the required parameter 'textSearchRequest' when calling vectorV1VectorEndpointsSearchChunk");
     }
 
     final String localVarPath =
@@ -978,8 +982,8 @@ public SearchResults search(
    *
    * <p><b>422</b> - There are validation issues with the data.
    *
-   * @param aiResourceGroup The value for the parameter aiResourceGroup
-   * @param collectionId The value for the parameter collectionId
+   * @param aiResourceGroup Resource Group ID
+   * @param collectionId Collection ID
    * @param documentUpdateRequest The value for the parameter documentUpdateRequest
    * @return DocumentsListResponse
    * @throws OpenApiRequestException if an error occurs while attempting to invoke the API

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/client/VectorApi.java

@@ -1,6 +1,6 @@
 /*
- * Document Grounding Pipeline API
- * SAP AI Core - API Specification AI Data Management api's
+ * Grounding
+ * 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.
  *
  *
  *

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/model/ApiError.java

@@ -1,6 +1,6 @@
 /*
- * Document Grounding Pipeline API
- * SAP AI Core - API Specification AI Data Management api's
+ * Grounding
+ * 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.
  *
  *
  *