search

jina-ai / examples

Jina examples and demos to help you get started
https://docs.jina.ai
Apache License 2.0
455 stars 142 forks source link

Update examples to REST CRUD interface #447

Closed FionnD closed 3 years ago

FionnD commented 3 years ago

Maintenance

All our examples should be using the REST CRUD interface and not the /api/{mode}which is deprecated.

Acceptance Criteria This ticket is done when: All 13 examples on the example repo are working correctly and using the REST CRUD interface.

[Updated by Fionn Friday 30th April]

cristianmtr commented 3 years ago

The checklist for each of these would be:

See https://github.com/jina-ai/examples/pull/453 and https://github.com/jina-ai/examples/pull/452

nan-wang commented 3 years ago

The checklist for each of these would be:

  • update Jina to 1.1.0 (if not already at that version or higher)
  • modify flow yamls to enable REST API
  • add index_rest method that indexes docs using the /index REST API
  • add index_rest as CLI option to -t (via click options)
  • change README to point towards /search (NOT /api/search)

See #453 and #452

Good point. @rutujasurve94 Let's start to update the examples.

rutujasurve94 commented 3 years ago

I'm beginning work on this today onwards

cristianmtr commented 3 years ago

@rutujasurve94 make sure to add the PRs to this issue's parent comment and check it off

alexcg1 commented 3 years ago

I'm happy to take on pokedex since I'm looking at doing some work on it anyway

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/465 closes Advanced Vector Search

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/466 closes Cross Modal Search

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/470 solves Multires Lyrics

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/471 solves Object Search

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/473 solves Pokedex with Bit

rutujasurve94 commented 3 years ago

https://github.com/jina-ai/examples/pull/469 solves Fashion Example

nan-wang commented 3 years ago

@cristianmtr @FionnD I suggest we hold on progressing this ticket because it will introduce quite a lot of duplicated codes in all the examples. Basically, this will require that all the examples load the files, wrap them up to an HTTP request and send to different APIs. This will make the examples even harder to maintain. I see the motivation is to show how to use RESTful API to do CRUD in jina, but I suggest to show this in one example instead of copy-paste to every example.

FionnD commented 3 years ago

Hi @nan-wang

Make sense, let's close this issue so?