-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
42 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,42 @@ | ||
# gorse-go | ||
Go SDK for gorse recommender system | ||
|
||
# ToDO | ||
- TestStrategy needs to be implemented -> Deployment Docker Compose from GORSE.IO | ||
Go SDK for Gorse recommender system. | ||
|
||
> ⚠️⚠️⚠️ This SDK is unstable currently. APIs might be changed in later versions. | ||
## Install | ||
|
||
```bash | ||
go get github.com/gorse-io/gorse-go | ||
``` | ||
|
||
## Usage | ||
|
||
```go | ||
import client "github.com/gorse-io/gorse-go" | ||
|
||
gorse := client.NewGorseClient("http://127.0.0.1:8087", "api_key") | ||
|
||
gorse.InsertFeedback([]client.Feedback{ | ||
{FeedbackType: "star", UserId: "bob", ItemId: "vuejs:vue", Timestamp: "2022-02-24"}, | ||
{FeedbackType: "star", UserId: "bob", ItemId: "d3:d3", Timestamp: "2022-02-25"}, | ||
{FeedbackType: "star", UserId: "bob", ItemId: "dogfalo:materialize", Timestamp: "2022-02-26"}, | ||
{FeedbackType: "star", UserId: "bob", ItemId: "mozilla:pdf.js", Timestamp: "2022-02-27"}, | ||
{FeedbackType: "star", UserId: "bob", ItemId: "moment:moment", Timestamp: "2022-02-28"}, | ||
}) | ||
|
||
gorse.GetRecommend("bob", "", 10) | ||
``` | ||
|
||
## Test | ||
|
||
|
||
In the root directory of Gorse source: | ||
|
||
```bash | ||
# Setup Gorse | ||
docker compose up -d | ||
|
||
# Test | ||
go test . | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters