make API stricter

Author: gary-huang

dd-trace-api/src/main/java/datadog/trace/api/llmobs/LLMObsSpan.java

@@ -2,50 +2,60 @@
 
 import java.util.List;
 import java.util.Map;
-import javax.annotation.Nullable;
 
 /** This interface represent an individual LLM Obs span. */
 public interface LLMObsSpan {
 
   /**
-   * Annotate spans with inputs, outputs, metadata, metrics, and tags.
+   * Annotate spans with inputs and outputs
    *
    * @param inputData The input data of the span in the form of a list, for example a list of input
    *     messages
    * @param outputData The output data of the span in the form of a list, for example a list of
    *     output messages
-   * @param metadata A map of JSON serializable key-value pairs that contains metadata information
-   *     relevant to the input or output operation described by the span
-   * @param metrics A map of JSON serializable keys and numeric values that users can add as metrics
-   *     relevant to the operation described by the span (input_tokens, output_tokens, total_tokens,
-   *     etc.).
-   * @param tags An map of JSON serializable key-value pairs that users can add as tags regarding
-   *     the span’s context (session, environment, system, versioning, etc.).
    */
-  void annotate(
-      @Nullable List<Map<String, Object>> inputData,
-      @Nullable List<Map<String, Object>> outputData,
-      @Nullable Map<String, Object> metadata,
-      @Nullable Map<String, Number> metrics,
-      @Nullable Map<String, Object> tags);
+  void annotateIO(List<Map<String, Object>> inputData, List<Map<String, Object>> outputData);
+
 
   /**
-   * Annotate spans with inputs, outputs, metadata, metrics, and tags.
+   * Annotate spans with inputs and outputs
    *
    * @param inputData The input data of the span in the form of a string
    * @param outputData The output data of the span in the form of a string
+   */
+  void annotateIO(String inputData, String outputData);
+
+  /**
+   * Annotate spans with metadata
+   *
    * @param metadata A map of JSON serializable key-value pairs that contains metadata information
    *     relevant to the input or output operation described by the span
+   */
+  void setMetadata(Map<String, Object> metadata);
+
+  /**
+   * Annotate spans with metrics
+   *
    * @param metrics A map of JSON serializable keys and numeric values that users can add as metrics
    *     relevant to the operation described by the span (input_tokens, output_tokens, total_tokens,
    *     etc.).
+   */
+  void setMetrics(Map<String, Number> metrics);
+
+  /**
+   * Annotate spans with tags
+   *
    * @param tags An map of JSON serializable key-value pairs that users can add as tags regarding
    *     the span’s context (session, environment, system, versioning, etc.).
    */
-  void annotate(
-      @Nullable String inputData,
-      @Nullable String outputData,
-      @Nullable Map<String, Object> metadata,
-      @Nullable Map<String, Number> metrics,
-      @Nullable Map<String, Object> tags);
+  void setTags(Map<String, Object> tags);
+
+  /**
+   * Annotate spans with a single tag key value pair as a tag regarding
+   *    the span’s context (session, environment, system, versioning, etc.).
+   *
+   * @param key the key of the tag
+   * @param value the value of the tag
+   */
+  void setTag(String key, String value);
 }