Updated to include NewsAPI

Author: djthorpe

cmd/agent/main.go

@@ -12,6 +12,8 @@ import (
 	client "github.com/mutablelogic/go-client"
 	llm "github.com/mutablelogic/go-llm"
 	agent "github.com/mutablelogic/go-llm/pkg/agent"
+	"github.com/mutablelogic/go-llm/pkg/newsapi"
+	"github.com/mutablelogic/go-llm/pkg/tool"
 )
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -26,6 +28,9 @@ type Globals struct {
 	Ollama    `embed:"" help:"Ollama configuration"`
 	Anthropic `embed:"" help:"Anthropic configuration"`
 
+	// Tools
+	NewsAPI `embed:"" help:"NewsAPI configuration"`
+
 	// Context
 	ctx   context.Context
 	agent llm.Agent
@@ -40,6 +45,10 @@ type Anthropic struct {
 	AnthropicKey string `env:"ANTHROPIC_API_KEY" help:"Anthropic API Key"`
 }
 
+type NewsAPI struct {
+	NewsKey string `env:"NEWSAPI_KEY" help:"News API Key"`
+}
+
 type CLI struct {
 	Globals
 
@@ -93,6 +102,20 @@ func main() {
 		opts = append(opts, agent.WithAnthropic(cli.AnthropicKey, clientopts...))
 	}
 
+	// Make a toolkit
+	toolkit := tool.NewToolKit()
+	opts = append(opts, agent.WithToolKit(toolkit))
+
+	// NewsAPI
+	if cli.NewsKey != "" {
+		if client, err := newsapi.New(cli.NewsKey, clientopts...); err != nil {
+			cmd.FatalIfErrorf(err)
+		} else if err := client.RegisterWithToolKit(toolkit); err != nil {
+			cmd.FatalIfErrorf(err)
+		}
+	}
+
+	// Create the agent
 	agent, err := agent.New(opts...)
 	cmd.FatalIfErrorf(err)
 	cli.Globals.agent = agent

pkg/newsapi/README.md

@@ -0,0 +1,8 @@
+# NewsAPI Client
+
+This package provides a client for the NewsAPI API, which is used to interact with the NewsAPI service.
+
+References:
+
+- API https://newsapi.org/docs
+- Package https://pkg.go.dev/github.com/mutablelogic/go-llm/pkg/newsapi

pkg/newsapi/agent.go

@@ -0,0 +1,188 @@
+package newsapi
+
+import (
+	"context"
+
+	// Packages
+	llm "github.com/mutablelogic/go-llm"
+)
+
+///////////////////////////////////////////////////////////////////////////////
+// TYPES
+
+type headlines struct {
+	*Client `json:"-"`
+}
+
+var _ llm.Tool = (*headlines)(nil)
+
+///////////////////////////////////////////////////////////////////////////////
+// HEADLINES
+
+func (headlines) Name() string {
+	return "current_headlines"
+}
+
+func (headlines) Description() string {
+	return "Return the current news headlines"
+}
+
+func (headlines *headlines) Run(ctx context.Context) (any, error) {
+	response, err := headlines.Headlines(OptCategory("general"), OptLimit(5))
+	if err != nil {
+		return nil, err
+	}
+	return map[string]any{
+		"type":      "text",
+		"headlines": response,
+	}, nil
+}
+
+/*
+// Return all the agent tools for the weatherapi
+func (c *Client) Tools() []agent.Tool {
+	return []agent.Tool{
+		&tool{
+			name:        "current_headlines",
+			description: "Return the current news headlines",
+			run:         c.agentCurrentHeadlines,
+		}, &tool{
+			name:        "current_headlines_country",
+			description: "Return the current news headlines for a country",
+			run:         c.agentCountryHeadlines,
+			params: []agent.ToolParameter{
+				{
+					Name:        "countrycode",
+					Description: "The two-letter country code to return headlines for",
+					Required:    true,
+				},
+			},
+		}, &tool{
+			name:        "current_headlines_category",
+			description: "Return the current news headlines for a business, entertainment, health, science, sports or technology",
+			run:         c.agentCategoryHeadlines,
+			params: []agent.ToolParameter{
+				{
+					Name:        "category",
+					Description: "business, entertainment, health, science, sports, technology",
+					Required:    true,
+				},
+			},
+		}, &tool{
+			name:        "search_news",
+			description: "Return the news headlines with a search query",
+			run:         c.agentSearchNews,
+			params: []agent.ToolParameter{
+				{
+					Name:        "query",
+					Description: "A phrase used to search for news headlines",
+					Required:    true,
+				},
+			},
+		},
+	}
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// PRIVATE METHODS - TOOL
+
+func (*tool) Provider() string {
+	return "newsapi"
+}
+
+func (t *tool) Name() string {
+	return t.name
+}
+
+func (t *tool) Description() string {
+	return t.description
+}
+
+func (t *tool) Params() []agent.ToolParameter {
+	return t.params
+}
+
+func (t *tool) Run(ctx context.Context, call *agent.ToolCall) (*agent.ToolResult, error) {
+	return t.run(ctx, call)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// PRIVATE METHODS - TOOL
+
+// Return the current general headlines
+func (c *Client) agentCurrentHeadlines(_ context.Context, call *agent.ToolCall) (*agent.ToolResult, error) {
+	response, err := c.Headlines(OptCategory("general"), OptLimit(5))
+	if err != nil {
+		return nil, err
+	}
+	return &agent.ToolResult{
+		Id: call.Id,
+		Result: map[string]any{
+			"type":      "text",
+			"headlines": response,
+		},
+	}, nil
+}
+
+// Return the headlines for a specific country
+func (c *Client) agentCountryHeadlines(_ context.Context, call *agent.ToolCall) (*agent.ToolResult, error) {
+	country, err := call.String("countrycode")
+	if err != nil {
+		return nil, err
+	}
+	country = strings.ToLower(country)
+	response, err := c.Headlines(OptCountry(country), OptLimit(5))
+	if err != nil {
+		return nil, err
+	}
+	return &agent.ToolResult{
+		Id: call.Id,
+		Result: map[string]any{
+			"type":      "text",
+			"country":   country,
+			"headlines": response,
+		},
+	}, nil
+}
+
+// Return the headlines for a specific category
+func (c *Client) agentCategoryHeadlines(_ context.Context, call *agent.ToolCall) (*agent.ToolResult, error) {
+	category, err := call.String("category")
+	if err != nil {
+		return nil, err
+	}
+	category = strings.ToLower(category)
+	response, err := c.Headlines(OptCategory(category), OptLimit(5))
+	if err != nil {
+		return nil, err
+	}
+	return &agent.ToolResult{
+		Id: call.Id,
+		Result: map[string]any{
+			"type":      "text",
+			"category":  category,
+			"headlines": response,
+		},
+	}, nil
+}
+
+// Return the headlines for a specific query
+func (c *Client) agentSearchNews(_ context.Context, call *agent.ToolCall) (*agent.ToolResult, error) {
+	query, err := call.String("query")
+	if err != nil {
+		return nil, err
+	}
+	response, err := c.Articles(OptQuery(query), OptLimit(5))
+	if err != nil {
+		return nil, err
+	}
+	return &agent.ToolResult{
+		Id: call.Id,
+		Result: map[string]any{
+			"type":      "text",
+			"query":     query,
+			"headlines": response,
+		},
+	}, nil
+}
+*/

pkg/newsapi/articles.go

@@ -0,0 +1,82 @@
+package newsapi
+
+import (
+	"time"
+
+	// Packages
+	"github.com/mutablelogic/go-client"
+
+	// Namespace imports
+	. "github.com/djthorpe/go-errors"
+)
+
+///////////////////////////////////////////////////////////////////////////////
+// TYPES
+
+type Article struct {
+	Source      Source    `json:"source"`
+	Title       string    `json:"title"`
+	Author      string    `json:"author,omitempty"`
+	Description string    `json:"description,omitempty"`
+	Url         string    `json:"url,omitempty"`
+	ImageUrl    string    `json:"urlToImage,omitempty"`
+	PublishedAt time.Time `json:"publishedAt,omitempty"`
+	Content     string    `json:"content,omitempty"`
+}
+
+type respArticles struct {
+	Status       string    `json:"status"`
+	Code         string    `json:"code,omitempty"`
+	Message      string    `json:"message,omitempty"`
+	TotalResults int       `json:"totalResults"`
+	Articles     []Article `json:"articles"`
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// PUBLIC METHODS
+
+// Returns headlines
+func (c *Client) Headlines(opt ...Opt) ([]Article, error) {
+	var response respArticles
+	var query opts
+
+	// Add options
+	for _, opt := range opt {
+		if err := opt(&query); err != nil {
+			return nil, err
+		}
+	}
+
+	// Request -> Response
+	if err := c.Do(nil, &response, client.OptPath("top-headlines"), client.OptQuery(query.Values())); err != nil {
+		return nil, err
+	} else if response.Status != "ok" {
+		return nil, ErrBadParameter.Withf("%s: %s", response.Code, response.Message)
+	}
+
+	// Return success
+	return response.Articles, nil
+}
+
+// Returns articles
+func (c *Client) Articles(opt ...Opt) ([]Article, error) {
+	var response respArticles
+	var query opts
+
+	// Add options
+	for _, opt := range opt {
+		if err := opt(&query); err != nil {
+			return nil, err
+		}
+	}
+
+	// Request -> Response
+	if err := c.Do(nil, &response, client.OptPath("everything"), client.OptQuery(query.Values())); err != nil {
+		return nil, err
+	} else if response.Status != "ok" {
+		return nil, ErrBadParameter.Withf("%s: %s", response.Code, response.Message)
+	}
+
+	// Return success
+	return response.Articles, nil
+}

pkg/newsapi/articles_test.go

@@ -0,0 +1,38 @@
+package newsapi_test
+
+import (
+	"encoding/json"
+	"os"
+	"testing"
+
+	// Packages
+	opts "github.com/mutablelogic/go-client"
+	newsapi "github.com/mutablelogic/go-llm/pkg/newsapi"
+	assert "github.com/stretchr/testify/assert"
+)
+
+func Test_articles_001(t *testing.T) {
+	assert := assert.New(t)
+	client, err := newsapi.New(GetApiKey(t), opts.OptTrace(os.Stderr, true))
+	assert.NoError(err)
+
+	articles, err := client.Headlines(newsapi.OptQuery("google"))
+	assert.NoError(err)
+	assert.NotNil(articles)
+
+	body, _ := json.MarshalIndent(articles, "", "  ")
+	t.Log(string(body))
+}
+
+func Test_articles_002(t *testing.T) {
+	assert := assert.New(t)
+	client, err := newsapi.New(GetApiKey(t), opts.OptTrace(os.Stderr, true))
+	assert.NoError(err)
+
+	articles, err := client.Articles(newsapi.OptQuery("google"), newsapi.OptLimit(1))
+	assert.NoError(err)
+	assert.NotNil(articles)
+
+	body, _ := json.MarshalIndent(articles, "", "  ")
+	t.Log(string(body))
+}