docs: improve code documentation for structs and methods

- Add detailed comments for `Usage` struct explaining token usage details
- Add detailed comments for `Response` struct explaining the structure of an OpenAI API response
- Add detailed comments for `Generative` interface explaining its methods
- Update comments for `Completion` method to clarify its functionality
- Update comments for `GetSummaryPrefix` method to clarify its functionality

Signed-off-by: appleboy <[email protected]>

Author: appleboy

core/openai.go

@@ -6,21 +6,32 @@ import (
 	"github.com/sashabaranov/go-openai"
 )
 
+// Usage represents the token usage details for an OpenAI API request.
+// It includes the number of tokens used for the prompt, the completion,
+// and the total tokens used. Additionally, it may include detailed
+// information about the completion tokens.
 type Usage struct {
 	PromptTokens            int
 	CompletionTokens        int
 	TotalTokens             int
 	CompletionTokensDetails *openai.CompletionTokensDetails
 }
 
+// Response represents the structure of a response from the OpenAI API.
+// It contains the content of the response and the usage information.
 type Response struct {
 	Content string
 	Usage   Usage
 }
 
+// Generative defines an interface for generative AI operations.
+// It includes methods for creating completions and obtaining summary prefixes.
 type Generative interface {
-	// CreateCompletion is an API call to create a completion.
+	// Completion generates a completion based on the provided content.
+	// It takes a context and a string as input and returns a Response pointer and an error.
 	Completion(ctx context.Context, content string) (resp *Response, err error)
-	// GetSummaryPrefix is an API call to get a summary prefix using function call.
+
+	// GetSummaryPrefix generates a summary prefix based on the provided content.
+	// It takes a context and a string as input and returns a Response pointer and an error.
 	GetSummaryPrefix(ctx context.Context, content string) (resp *Response, err error)
 }