feat: adds online evals changes for go sdk (#12)

# Add Evaluation Functionality and Improve Documentation

### TL;DR

Added evaluation functionality to the logging package and improved documentation with package overview comments.

### What changed?

- Added new `evaluate.go` file with evaluation functionality through the `evaluateContainer` type
- Added `Evaluate()` methods to Session, Trace, Generation, and Retrieval entities
- Added accessor methods to CommitLog (GetEntity, GetEntityID, GetAction, GetData)
- Added package documentation to the Anthropic logging module
- Created a MockWriter implementation for testing
- Added utility function `removeDuplicateStrings()` to handle duplicate evaluators

### How to test?

Test the new evaluation functionality with:

```go
// Initialize client and logger as usual
logger, _ := client.GetLogger(&logging.LoggerConfig{Id: "your-log-repo-id"})

// Create a trace and evaluate it
trace := logger.CreateTrace(&logging.TraceConfig{})
err := trace.Evaluate().WithEvaluators([]string{"evaluator1", "evaluator2"})

// Or evaluate with variables
variables := map[string]string{"key1": "value1", "key2": "value2"}
err = trace.Evaluate().WithVariablesAndEvaluators(variables, []string{"evaluator1"})

// Check for errors
if err != nil {
    // handle error
}
```

### Why make this change?

This change enables evaluation capabilities for different entities in the logging package, allowing users to evaluate Traces, Sessions, Generations, and Retrievals using Maxim's evaluators. The improved documentation provides better context for developers using the package, and the new MockWriter facilitates more comprehensive testing.

Author: akshaydeo

logging/anthropic.go

@@ -6,6 +6,7 @@ import (
 	"time"
 )
 
+// ParseAnthropicResult parses a JSON response from Anthropic's API and returns a MaximLLMResult.
 func ParseAnthropicResult(jsonData []byte) (*MaximLLMResult, error) {
 	var anthropicResp struct {
 		ID      string `json:"id"`

logging/base.go

@@ -13,6 +13,7 @@ const (
 	ProviderBedrock   = "aws"
 )
 
+// baseConfig is the configuration for a base entity.
 type baseConfig struct {
 	Id       string                 `json:"id"`
 	SpanId   *string                `json:"spanId,omitempty"`
@@ -21,6 +22,7 @@ type baseConfig struct {
 	Tags     *map[string]string     `json:"tags,omitempty"`
 }
 
+// base is the base entity for all entities.
 type base struct {
 	entity         Entity
 	id             string
@@ -32,6 +34,7 @@ type base struct {
 	writer         *writer
 }
 
+// sanitizeMetadata sanitizes the metadata for a base entity.
 func sanitizeMetadata(metadata map[string]interface{}) map[string]string {
 	sanitizedMetadata := make(map[string]string)
 	for key, value := range metadata {
@@ -48,6 +51,7 @@ func sanitizeMetadata(metadata map[string]interface{}) map[string]string {
 	return sanitizedMetadata
 }
 
+// newBase creates a new base entity.
 func newBase(e Entity, id string, c *baseConfig, w *writer) *base {
 	return &base{
 		entity:         e,
@@ -60,14 +64,17 @@ func newBase(e Entity, id string, c *baseConfig, w *writer) *base {
 	}
 }
 
+// commit commits a new commit log to the writer.
 func (b *base) commit(action string, data interface{}) {
 	b.writer.commit(newCommitLog(b.entity, b.id, action, data))
 }
 
+// Id returns the id of the base entity.
 func (b *base) Id() string {
 	return b.id
 }
 
+// AddTag adds a tag to the base entity.
 func (b *base) AddTag(key, value string) {
 	if b.tags == nil {
 		b.tags = &map[string]string{}
@@ -78,20 +85,23 @@ func (b *base) AddTag(key, value string) {
 	})
 }
 
+// AddMetadata adds metadata to the base entity.
 func (b *base) AddMetadata(metadata map[string]interface{}) {
 	sanitizedMetadata := sanitizeMetadata(metadata)
 	b.commit("update", map[string]interface{}{
 		"metadata": sanitizedMetadata,
 	})
 }
 
+// End ends the base entity.
 func (b *base) End() {
 	b.endTimestamp = utcNowPtr()
 	b.commit("end", map[string]interface{}{
 		"endTimestamp": b.endTimestamp,
 	})
 }
 
+// data returns the data of the base entity.
 func (b *base) data() map[string]interface{} {
 	data := map[string]interface{}{
 		"startTimestamp": b.startTimestamp,
@@ -113,6 +123,7 @@ func (b *base) data() map[string]interface{} {
 
 // Static methods
 
+// addTag adds a tag to the base entity.
 func addTag(w *writer, entity Entity, id, key, value string) {
 	w.commit(newCommitLog(entity, id, "update", map[string]interface{}{
 		"tags": map[string]string{
@@ -121,6 +132,7 @@ func addTag(w *writer, entity Entity, id, key, value string) {
 	}))
 }
 
+// addEvent adds an event to the base entity.
 func addEvent(w *writer, entity Entity, entityId, eId, event string, tags *map[string]string) {
 	eventData := map[string]interface{}{
 		"id":        eId,
@@ -133,10 +145,12 @@ func addEvent(w *writer, entity Entity, entityId, eId, event string, tags *map[s
 	w.commit(newCommitLog(entity, entityId, "add-event", eventData))
 }
 
+// addFeedback adds feedback to the base entity.
 func addFeedback(w *writer, entity Entity, id string, feedback *Feedback) {
 	w.commit(newCommitLog(entity, id, "add-feedback", feedback))
 }
 
+// end ends the base entity.
 func end(w *writer, entity Entity, id string) {
 	w.commit(newCommitLog(entity, id, "end", map[string]interface{}{
 		"endTimestamp": utcNow(),

logging/commitLog.go

@@ -27,7 +27,7 @@ type CommitLog struct {
 	data     interface{}
 }
 
-// NewCommitLog creates a new CommitLog instance
+// newCommitLog creates a new CommitLog instance (internal use)
 func newCommitLog(entity Entity, entityID, action string, data interface{}) *CommitLog {
 	return &CommitLog{
 		entity:   entity,
@@ -52,3 +52,23 @@ func (cl *CommitLog) Serialize() string {
 	}
 	return fmt.Sprintf("%s{id=%s,action=%s,data=%s}", cl.entity, cl.entityID, cl.action, string(dataJSON))
 }
+
+// GetEntity returns the entity type of the commit log
+func (cl *CommitLog) GetEntity() Entity {
+	return cl.entity
+}
+
+// GetEntityID returns the entity ID of the commit log
+func (cl *CommitLog) GetEntityID() string {
+	return cl.entityID
+}
+
+// GetAction returns the action of the commit log
+func (cl *CommitLog) GetAction() string {
+	return cl.action
+}
+
+// GetData returns the data of the commit log
+func (cl *CommitLog) GetData() interface{} {
+	return cl.data
+}

logging/errors.go

@@ -0,0 +1,6 @@
+package logging
+
+import "errors"
+
+var ErrNoEvaluators = errors.New("at least one evaluator is required")
+var ErrNoVariables = errors.New("at least one variable is required")

logging/evaluate.go

@@ -0,0 +1,43 @@
+package logging
+
+type evaluateContainer struct {
+	entity Entity
+	id     string
+	writer *writer
+}
+
+func newEvaluateContainer(entity Entity, id string, writer *writer) *evaluateContainer {
+	return &evaluateContainer{
+		entity: entity,
+		id:     id,
+		writer: writer,
+	}
+}
+
+func (ec *evaluateContainer) WithVariablesAndEvaluators(variables map[string]string, evaluators []string) error {
+	if len(evaluators) == 0 {
+		return ErrNoEvaluators
+	}
+	// Make sure there are no duplicates in the evaluators
+	evaluators = removeDuplicateStrings(evaluators)
+	ec.writer.commit(newCommitLog(ec.entity, ec.id, "evaluate", map[string]interface{}{
+		"with":       "variables",
+		"variables":  variables,
+		"evaluators": evaluators,
+		"timestamp":  utcNow(),
+	}))
+	return nil
+}
+
+func (ec *evaluateContainer) WithEvaluators(evaluators []string) error {
+	if len(evaluators) == 0 {
+		return ErrNoEvaluators
+	}
+	evaluators = removeDuplicateStrings(evaluators)
+	ec.writer.commit(newCommitLog(ec.entity, ec.id, "evaluate", map[string]interface{}{
+		"with":       "evaluators",
+		"evaluators": evaluators,
+		"timestamp":  utcNow(),
+	}))
+	return nil
+}

logging/generation.go

@@ -238,6 +238,10 @@ func (g *Generation) SetMaximPromptID(pId string) {
 	})
 }
 
+func (g *Generation) Evaluate() *evaluateContainer {
+	return newEvaluateContainer(EntityGeneration, g.Id(), g.writer)
+}
+
 func (g *Generation) SetResult(r interface{}) {
 	var finalResult *MaximLLMResult
 	var err error