Skip to content

Commit c1eb898

Browse files
committed
Add usage
1 parent 6fecca9 commit c1eb898

1 file changed

Lines changed: 36 additions & 6 deletions

File tree

README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,45 @@ composer require gorse/php-gorse
1616

1717
## Usage
1818

19-
Insert feedback and get recommendations:
19+
Create a Gorse client:
2020

2121
```php
2222
$client = new Gorse("http://127.0.0.1:8088/", "api_key");
23+
```
24+
25+
Insert users:
26+
27+
```php
28+
$user = new User("100", ["gender" => "M", "age" => "25"], "my_comment");
29+
$rowsAffected = $client->insertUser($user);
30+
```
31+
32+
Insert items:
33+
34+
```php
35+
$item = new Item(
36+
"2000",
37+
true,
38+
["embedding" => [0.1, 0.2, 0.3]],
39+
["Comedy", "Animation"],
40+
"2022-11-20T13:55:27Z",
41+
"Minions (2015)"
42+
);
43+
$rowsAffected = $client->insertItem($item);
44+
```
2345

24-
$rowsAffected = $client->insertFeedback([
25-
new Feedback("read", "10", "3", "2022-11-20T13:55:27Z"),
26-
new Feedback("read", "10", "4", "2022-11-20T13:55:27Z"),
27-
]);
46+
Insert feedback:
2847

29-
$client->getRecommend('10');
48+
```php
49+
$feedback = [
50+
new Feedback("read", "100", "2000", 1.0, "2022-11-20T13:55:27Z"),
51+
new Feedback("read", "100", "2001", 1.0, "2022-11-20T13:55:27Z"),
52+
];
53+
$rowsAffected = $client->insertFeedback($feedback);
54+
```
55+
56+
Get recommendations:
57+
58+
```php
59+
$items = $client->getRecommend('100', 10);
3060
```

0 commit comments

Comments
 (0)