Skip to content

docs: fix library search example and add missing search options #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philwinder wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix library search example and add missing search options #549

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d870a09
docs: fix Go HTTP client example and add REPORTING_LOG_TIME_INTERVAL …
Apr 22, 2026
af03a5f
docs: fix library search example and add missing search options
Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ results, err := client.Search.Query(ctx, "create a deployment",
service.WithLimit(10),
)

for _, snippet := range results.Snippets() {
fmt.Println(snippet.Path(), snippet.Name())
for _, result := range results.Enrichments() {
fmt.Println(result.Subtype(), result.Content())
}
```

Expand Down Expand Up @@ -238,6 +238,9 @@ for _, snippet := range results.Snippets() {
| `WithLanguages(langs...)` | Filter by programming languages |
| `WithRepositories(ids...)` | Filter by repository IDs |
| `WithMinScore(score)` | Minimum score threshold |
| `WithEnrichmentTypes(types...)` | Filter results to specific enrichment types |
| `WithSnippets(include)` | Include code snippets in results |
| `WithDocuments(include)` | Include enrichment documents in results |

### Go HTTP client

Expand All @@ -253,12 +256,16 @@ import koditclient "github.com/helixml/kodit/clients/go"
client, err := koditclient.NewClient("https://kodit.example.com")

// List repositories
resp, err := client.GetApiV1Repositories(ctx)
resp, err := client.GetRepositories(ctx, nil)

// Search
resp, err := client.PostApiV1SearchMulti(ctx, koditclient.PostApiV1SearchMultiJSONRequestBody{
TextQuery: "create a deployment",
TopK: 10,
text := "create a deployment"
resp, err := client.PostSearch(ctx, koditclient.PostSearchJSONRequestBody{
Data: &koditclient.DtoSearchData{
Attributes: &koditclient.DtoSearchAttributes{
Text: &text,
},
},
})
```

Expand Down Expand Up @@ -418,6 +425,7 @@ kodit serve --env-file .env
| `SEARCH_LIMIT` | `10` | Default search result limit |
| `DISABLE_TELEMETRY` | `false` | Disable anonymous usage telemetry |
| `HTTP_CACHE_DIR` | (empty) | Directory for caching HTTP POST responses to disk; avoids repeated API calls during development |
| `REPORTING_LOG_TIME_INTERVAL` | `5` | Progress reporting interval in seconds |

### Embedding Provider

Expand Down
Loading