Interface SessionMetadataShape.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SessionMetadataShape.Builder,SessionMetadataShape>, SdkBuilder<SessionMetadataShape.Builder,SessionMetadataShape>, SdkPojo
Enclosing class:
SessionMetadataShape
@Mutable @NotThreadSafe public static interface SessionMetadataShape.Builder extends SdkPojo, CopyableBuilder<SessionMetadataShape.Builder,SessionMetadataShape>

  • Method Details

    • sessionId

      SessionMetadataShape.Builder sessionId(String sessionId)

      The unique identifier of the session this metadata applies to.

      Parameters:
      sessionId - The unique identifier of the session this metadata applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • testScenarioId

      SessionMetadataShape.Builder testScenarioId(String testScenarioId)

      An optional test scenario identifier for categorizing and tracking evaluation results.

      Parameters:
      testScenarioId - An optional test scenario identifier for categorizing and tracking evaluation results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groundTruth

      SessionMetadataShape.Builder groundTruth(GroundTruthSource groundTruth)

      The ground truth data for this session, including expected responses and assertions.

      Parameters:
      groundTruth - The ground truth data for this session, including expected responses and assertions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groundTruth

      default SessionMetadataShape.Builder groundTruth(Consumer<GroundTruthSource.Builder> groundTruth)

      The ground truth data for this session, including expected responses and assertions.

      This is a convenience method that creates an instance of the GroundTruthSource.Builder avoiding the need to create one manually via GroundTruthSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groundTruth(GroundTruthSource).

      Parameters:
      groundTruth - a consumer that will call methods on GroundTruthSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      SessionMetadataShape.Builder metadata(Map<String,String> metadata)

      Additional key-value metadata associated with this session.

      Parameters:
      metadata - Additional key-value metadata associated with this session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.