Merge remote-tracking branch 'refs/remotes/origin/main' into feat/openai-conv-api-msg

Author: rpanackal

.pipeline/checkstyle-suppressions.xml

@@ -10,6 +10,8 @@
   <suppress files="[/\\]core[/\\]model[/\\]" checks=".*"/>
   <suppress files="[/\\]openai[/\\]generated[/\\]model[/\\]" checks=".*"/>
   <suppress files="[/\\]orchestration[/\\]model[/\\]" checks=".*"/>
+  <suppress files="[/\\]grounding[/\\]api[/\\]" checks=".*"/>
+  <suppress files="[/\\]grounding[/\\]model[/\\]" checks=".*"/>
   <!-- Suppress TODOs -->
   <suppress files="OpenAiChatMessage.java" checks="TodoComment" lines="257,7" />
   <suppress files="ChatCompletionResponseMessage.java" checks="TodoComment" lines="53,34" />

.pipeline/spotbugs-exclusions.xml

@@ -5,6 +5,8 @@
       <Package name="com.sap.ai.sdk.core.client"/>
       <Package name="com.sap.ai.sdk.core.model"/>
       <Package name="com.sap.ai.sdk.orchestration.model"/>
+      <Package name="com.sap.ai.sdk.grounding.client"/>
+      <Package name="com.sap.ai.sdk.grounding.model"/>
     </Or>
   </Match>
 </FindBugsFilter>

README.md

@@ -136,6 +136,7 @@ For more detailed information and advanced usage, please refer to the following:
 - [<img src="sample-code/spring-app/src/main/resources/static/Open-AI-Logo.svg" width="16"/> OpenAI Chat Completion](docs/guides/OPENAI_CHAT_COMPLETION.md)
 - [<img src="https://spring.io/favicon-32x32.png" width="16"/> Spring AI Integration](docs/guides/SPRING_AI_INTEGRATION.md)
 - [🧰 AI Core Deployment](docs/guides/AI_CORE_DEPLOYMENT.md)
+- [<img src="sample-code/spring-app/src/main/resources/static/grounding.png" width="16"/> AI Core Grounding](docs/guides/GROUNDING.md)
 
 For updating versions, please refer to the [**Release Notes**](docs/release-notes/release-notes-0-to-14.md).
 
@@ -160,11 +161,20 @@ This opens up a wide range of possibilities to customize the connection, includi
 
 ```java
 var service = new AiCoreService();
-var service = service.withBaseDestination(
-        DefaultHttpDestination.fromDestination(service.getBaseDestination())
-          .header("my-header-key", "my-header-value")
-          .build()
-);
+var destination =
+    DefaultHttpDestination.fromDestination(service.getBaseDestination())
+        .header("my-header-key", "my-header-value")
+        .build();
+
+// AI Core client
+service = service.withBaseDestination(destination);
+DeploymentApi client = new DeploymentApi(service);
+
+// Orchestration client
+OrchestrationClient client = new OrchestrationClient(destination);
+
+// OpenAI client
+OpenAiClient client2 = OpenAiClient.withCustomDestination(destination);
 ```
 
 For more information, please refer to the [AI Core connectivity guide](./docs/guides/CONNECTING_TO_AICORE.md) and the [SAP Cloud SDK documentation](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations).

core/src/main/java/com/sap/ai/sdk/core/model/AiApiError.java

@@ -219,18 +219,38 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiApiError} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException("AiApiError has no field with name '" + name + "'.");
     }
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiApiError} instance including unrecognized
+   * properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (code != null) declaredFields.put("code", code);
+    if (message != null) declaredFields.put("message", message);
+    if (requestId != null) declaredFields.put("requestId", requestId);
+    if (target != null) declaredFields.put("target", target);
+    if (details != null) declaredFields.put("details", details);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiApiError} instance. If the map previously
    * contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiApiErrorWithId.java

@@ -117,18 +117,35 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiApiErrorWithId} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException("AiApiErrorWithId has no field with name '" + name + "'.");
     }
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiApiErrorWithId} instance including
+   * unrecognized properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (id != null) declaredFields.put("id", id);
+    if (error != null) declaredFields.put("error", error);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiApiErrorWithId} instance. If the map previously
    * contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiArtifact.java

@@ -546,18 +546,45 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiArtifact} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException("AiArtifact has no field with name '" + name + "'.");
     }
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiArtifact} instance including unrecognized
+   * properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (labels != null) declaredFields.put("labels", labels);
+    if (name != null) declaredFields.put("name", name);
+    if (kind != null) declaredFields.put("kind", kind);
+    if (url != null) declaredFields.put("url", url);
+    if (description != null) declaredFields.put("description", description);
+    if (id != null) declaredFields.put("id", id);
+    if (scenarioId != null) declaredFields.put("scenarioId", scenarioId);
+    if (configurationId != null) declaredFields.put("configurationId", configurationId);
+    if (executionId != null) declaredFields.put("executionId", executionId);
+    if (createdAt != null) declaredFields.put("createdAt", createdAt);
+    if (modifiedAt != null) declaredFields.put("modifiedAt", modifiedAt);
+    if (scenario != null) declaredFields.put("scenario", scenario);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiArtifact} instance. If the map previously
    * contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiArtifactArgumentBinding.java

@@ -118,11 +118,13 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiArtifactArgumentBinding} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException(
@@ -131,6 +133,21 @@ public Object getCustomField(@Nonnull final String name) throws NoSuchElementExc
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiArtifactArgumentBinding} instance including
+   * unrecognized properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (key != null) declaredFields.put("key", key);
+    if (artifactId != null) declaredFields.put("artifactId", artifactId);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiArtifactArgumentBinding} instance. If the map
    * previously contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiArtifactCreationResponse.java

@@ -153,11 +153,13 @@ public Set<String> getCustomFieldNames() {
    * Get the value of an unrecognizable property of this {@link AiArtifactCreationResponse}
    * instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException(
@@ -166,6 +168,22 @@ public Object getCustomField(@Nonnull final String name) throws NoSuchElementExc
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiArtifactCreationResponse} instance including
+   * unrecognized properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (id != null) declaredFields.put("id", id);
+    if (message != null) declaredFields.put("message", message);
+    if (url != null) declaredFields.put("url", url);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiArtifactCreationResponse} instance. If the map
    * previously contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiArtifactList.java

@@ -135,18 +135,35 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiArtifactList} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException("AiArtifactList has no field with name '" + name + "'.");
     }
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiArtifactList} instance including unrecognized
+   * properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (count != null) declaredFields.put("count", count);
+    if (resources != null) declaredFields.put("resources", resources);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiArtifactList} instance. If the map previously
    * contained a mapping for the key, the old value is replaced by the specified value.

core/src/main/java/com/sap/ai/sdk/core/model/AiArtifactPostData.java

@@ -341,18 +341,39 @@ public Set<String> getCustomFieldNames() {
   /**
    * Get the value of an unrecognizable property of this {@link AiArtifactPostData} instance.
    *
+   * @deprecated Use {@link #toMap()} instead.
    * @param name The name of the property
    * @return The value of the property
    * @throws NoSuchElementException If no property with the given name could be found.
    */
   @Nullable
+  @Deprecated
   public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
     if (!cloudSdkCustomFields.containsKey(name)) {
       throw new NoSuchElementException("AiArtifactPostData has no field with name '" + name + "'.");
     }
     return cloudSdkCustomFields.get(name);
   }
 
+  /**
+   * Get the value of all properties of this {@link AiArtifactPostData} instance including
+   * unrecognized properties.
+   *
+   * @return The map of all properties
+   */
+  @JsonIgnore
+  @Nonnull
+  public Map<String, Object> toMap() {
+    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
+    if (labels != null) declaredFields.put("labels", labels);
+    if (name != null) declaredFields.put("name", name);
+    if (kind != null) declaredFields.put("kind", kind);
+    if (url != null) declaredFields.put("url", url);
+    if (description != null) declaredFields.put("description", description);
+    if (scenarioId != null) declaredFields.put("scenarioId", scenarioId);
+    return declaredFields;
+  }
+
   /**
    * Set an unrecognizable property of this {@link AiArtifactPostData} instance. If the map
    * previously contained a mapping for the key, the old value is replaced by the specified value.