aboutsummaryrefslogtreecommitdiffstats
path: root/client
diff options
context:
space:
mode:
authorKristian Aune <kraune@verizonmedia.com>2023-09-20 15:48:55 +0200
committerKristian Aune <kraune@verizonmedia.com>2023-09-20 15:48:55 +0200
commit09a2a7c21a1ca82a4ca56a449283217fedf8125b (patch)
tree6d442e73905068c18f86f64a658d33b59b26cda2 /client
parent16050559773b552387bc702aa15c24ab30ece982 (diff)
link + html cleanup
Diffstat (limited to 'client')
-rw-r--r--client/README.md50
1 files changed, 25 insertions, 25 deletions
diff --git a/client/README.md b/client/README.md
index 8403e02a485..82fa32bb2d5 100644
--- a/client/README.md
+++ b/client/README.md
@@ -3,60 +3,60 @@
![Vespa logo](https://vespa.ai/assets/vespa-logo-color.png)
# Vespa clients
-This part of the Vespa repository got Vespa client implementations for operations like
-* deploy
-* read/write
-* query
-<!-- ToDo: illustration -->
+This part of the Vespa repository got Vespa client implementations for operations like
+- deploy
+- read/write
+- query
+<!-- ToDo: illustration -->
## Vespa CLI
+
The Vespa command-line tool, see the [README](go/README.md).
Use the Vespa CLI to deploy, feed and query a Vespa application,
for local, self-hosted or [Vespa Cloud](https://cloud.vespa.ai/) instances.
-
-
## pyvespa
-[pyvespa](https://pyvespa.readthedocs.io/) provides a python API to Vespa -
+
+[pyvespa](https://pyvespa.readthedocs.io/en/latest/) provides a python API to Vespa -
use it to create, modify, deploy and interact with running Vespa instances.
The main pyvespa goal is to allow for faster prototyping
and to facilitate Machine Learning experiments for Vespa applications.
-
-
## Vespa FE (fixme: better name and description here)
-This is a [work-in-progress javascript app](js/app) for querying a Vespa application.
-
+This is a [work-in-progress javascript app](js/app) for querying a Vespa application.
-----
+---
## Misc
<!-- ToDo: move this / demote this somehow -->
+
### vespa_query_dsl
+
This lib is used for composing Vespa
[YQL queries](https://docs.vespa.ai/en/reference/query-language-reference.html).
For usage, refer to the [QTest.java](src/test/java/ai/vespa/client/dsl/QTest.java) unit test.
ToDos:
+
- [ ] support `predicate` (https://docs.vespa.ai/en/predicate-fields.html)
- [ ] support methods for checking positive/negative conditions for specific field
-- [X] support order by annotation
-- [X] support order by
-- [X] support sub operators in contains (sameElement, phrase, near, onear, equiv)
-- [X] support group syntax
-- [X] support `nonEmpty`
-- [X] support `dotProduct`
-- [X] support `weightedSet`
-- [X] support `wand`
-- [X] support `weakAnd`
+- [x] support order by annotation
+- [x] support order by
+- [x] support sub operators in contains (sameElement, phrase, near, onear, equiv)
+- [x] support group syntax
+- [x] support `nonEmpty`
+- [x] support `dotProduct`
+- [x] support `weightedSet`
+- [x] support `wand`
+- [x] support `weakAnd`
- [x] support `userInput`
- [x] support `rank`
- [x] support filter annotation
-- [X] unit tests
-- [X] support other annotations
-- [X] handle edge cases (e.g. `Q.b("test").contains("a").build()`)
+- [x] unit tests
+- [x] support other annotations
+- [x] handle edge cases (e.g. `Q.b("test").contains("a").build()`)