Commit Graph

26 Commits

Author SHA1 Message Date
Anush
8b4bc59650 docs: Reference api.qdrant.tech in README.md instead (#854)
* doc: New API reference

* docs: New reference index.rst

* Apply suggestions from code review

Co-authored-by: George <george.panchuk@qdrant.tech>

---------

Co-authored-by: George <george.panchuk@qdrant.tech>
2024-11-15 15:11:01 +01:00
Hossam Hagag
c92a0432f3 Refactor recreate collection (#719)
* deprecated recreate_collection from tests

* checked if collection exists before deletion

* reverted deletion of recreate_collection

* added missing collection_exsits before deletion

* nit if condition

* fix type hint in local_collection

* removed run mypy on async client generator

* added checks for create_collection if exists

* nit change collection name

* add else to create_collection

* nit

* nit

* refactoring: remove redundant checks

* fix: do not test collection_exists through itself

* refactoring: remove redundant collection exists checks

* fix: remove redundant collection exists checks

* refactoring: remove redundant collection checks

* refactoring: remove redundant collection existence check in test sparse search

* refactoring: remove redundant checks in test_updates

* refactoring: remove redundant checks

* fix: remove redundant checks

* refactoring: remove redundant checks

* refactoring: remove redundant imports

* new: add recreate collection test

---------

Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>
2024-08-09 23:33:31 +02:00
George
9a9fb0c1a4 chore: remove qdrant_openapi_client directory (#731)
* chore: remove qdrant_openapi_client directory

* fix: remove qdrant_openapi_client from pyproject.toml

* chore: finish deletion
2024-08-09 21:26:05 +02:00
Anush
efc203ad8a docs: Removed recreate_collection quickstart.ipynb (#698) 2024-07-25 12:07:21 +02:00
Rishab Mallick
c30f6b11e4 docs: typo fix of extra word in quickstart 2024-03-06 14:43:29 +05:30
Nicolas Oulianov
5e564e6702 Adds missing import in documentation example (#464) 2024-02-03 13:32:44 +01:00
Nirant
fe0ce68585 Remove upload collection example and update (#366)
index.rst
2023-11-02 13:43:04 +05:30
Nirant
76c3168f4d Add New API to Docs (#361)
* * chore(.gitignore): add docs/source/examples/*/*/* to ignore list

* * feat(docs): add new modules and subpackages to qdrant_client documentation

* * docs(qdrant_client): update QdrantClient documentation to include information about async versions

* * docs(index.rst): update link to complete client API docs

* * chore(pyproject.toml): remove unused dependencies from dev group
* feat(pyproject.toml): add dependencies for documentation group

* * chore(pyproject.toml): update ipython dependency version to 8
* fix(pyproject.toml): fix typo in Pygments dependency version

* * chore(generate_docs_netlify.sh): remove unnecessary pip installations and fix newline at end of file

* * docs(index.rst): update Qdrant Client Documentation title to include [Python]
* docs(index.rst): update Qdrant Client Documentation description to include vector search engine
* docs(index.rst): update recreate_collection code example to include vectors_config parameter

* * docs(index.rst): add code samples for async client support

* * chore(conf.py): exclude grpc and tests directories from documentation build

* * docs(index.rst): fix title of Qdrant Python Client Documentation
* docs(index.rst): remove unnecessary link to test file in async mode section
* docs(index.rst): add missing classes to API Reference section

* * chore(conf.py): exclude local directory from documentation generation

* * docs(quickstart.ipynb): update section title from "Points, Upsert and Search without `fastembed`" to "Qdrant without `fastembed`"

* * chore(conf.py): exclude tests from documentation by updating exclude_patterns
2023-11-01 20:14:32 +05:30
Nirant
ef49b6f1e6 Rewrite Docstrings + Change Netlify build to branch from Pip (#359)
* * chore(qdrant_client.py): update ordering parameter description

* * fix(qdrant_client.py): fix docstring formatting and add missing type hints in the update_point method

* * chore(async_qdrant_client.py): update docstring for `upsert` method

* * chore(qdrant_client.py): reformat and clarify ordering parameter description

* * chore(async_qdrant_client.py): update method signatures and add missing docstring for `insert` and `update` methods
* chore(qdrant_client.py): update method signatures and add missing docstring for `insert` and `update` methods

* *chore(qdrant_client.py): fix indentation errors

* *chore(async_qdrant_client.py): fix indentation errors

* * chore(.gitignore): add ignore rules for local_cache and db directories in docs/source/examples

* * chore(generate_docs_netlify.sh): add Pygments package as a dependency for generating docs

* * chore(conf.py): add IPython.sphinxext.ipython_console_highlighting to the list of extensions

* * chore(generate_docs_netlify.sh): add ipython package to the dependencies

* * chore(generate_docs_netlify.sh): update pip install command to install project in editable mode

* * chore(generate_docs_netlify.sh): update script to use poetry for dependency management

* * chore(generate_docs_netlify.sh): add export PATH command to include /opt/buildhome/.local/bin in the PATH

* * chore(async_qdrant_client.py, qdrant_client.py): update documentation for scroll

* * chore(async_qdrant_client.py): update consistency parameter docs
* chore(qdrant_client.py): update consistency parameter docs

* * chore(qdrant_client): fix priority indentation in docstrings

* * docs(index.rst): update reference link for DataTypes aka Models to Models
2023-10-31 19:24:14 +05:30
Nirant
b8ea4fbe62 Add Executable Quickstart Example (#352)
* * chore(docs): add nbsphinx extension to Sphinx configuration
* chore(pyproject.toml): add nbsphinx package to project dependencies

* * docs(source/examples/install.rst): delete install.rst file
* docs(source/examples/quickstart.ipynb): create quickstart.ipynb file
* docs(source/index.rst): update examples section to include quickstart.ipynb

* * attempt(generate_docs.sh): add pandoc installation step

* * chore(generate_docs_netlify.sh): add installation of pandoc package

* * chore(generate_docs.sh): comment out the installation of pandoc
* chore(generate_docs_netlify.sh): comment out the installation of pandoc

* * chore(generate_docs_netlify.sh): add nbsphinx package installation
* chore(generate_docs_netlify.sh): install pandoc using apt-get

* * chore(generate_docs_netlify.sh): change installation command for pandoc from 'sudo apt-get install' to 'apt-get install'

* * chore(generate_docs.sh): add pandoc installation and configuration

* * chore(generate_docs.sh): remove unused code and comments
* feat(generate_docs_netlify.sh): add pandoc installation and configuration

* * chore(generate_docs_netlify.sh): update script to install pandoc using brew
* chore(generate_docs_netlify.sh): update script to install qdrant-client using pip

* * docs(index.rst): update API references in the documentation

* * docs(source/index.rst): remove append_payload and limit parameters from code examples

* * fix(docs): fix incorrect argument name in code example

* * fix(quickstart.ipynb): add limit parameter to the queries

* * fix(docs): update comments in code examples for clarity and consistency

* * docs(index.rst): remove unnecessary API references and sections

* * docs(index.rst): add highlighted classes section with relevant classes

* * fix(generate_docs.sh): install pandoc using apt-get before running sphinx-apidoc

* * docs(index.rst): update root `toctree` directive
2023-10-26 20:17:00 +05:30
NirantK
d9eb9bb9a7 * docs: add installation and getting started example to index.rst
* docs: create install.rst file for installation and getting started example
2023-10-24 18:42:18 +05:30
NirantK
0617222848 * docs(index.rst): add new API reference section with selected API modules
* docs(index.rst): add new section for complete client API documentation
2023-10-24 18:16:37 +05:30
NirantK
b317aa6eb8 * docs(index.rst): add qdrant_client.http.models to API reference 2023-10-24 18:00:15 +05:30
NirantK
9757b70f0e * docs(index.rst): remove unnecessary import statement for qdrant_client.qdrant_client.http.models 2023-10-24 17:58:56 +05:30
NirantK
93d96f63f8 * docs(index.rst): fix missing closing parenthesis in print statement
* docs(index.rst): remove unnecessary lines from indices and tables section
2023-10-24 17:54:46 +05:30
NirantK
c81bce5e80 * docs(README.md): update Python Client API Documentation link
* chore(docs): remove deleted api-icon.png image
2023-10-19 17:16:25 +05:30
NirantK
dbb786497c * chore(README.md): add link to API documentation
* feat(docs/images): add API icon image
2023-10-19 17:12:35 +05:30
Prashanth Rao
0d8cc12b18 Change top kwarg to limit as per code (#233) 2023-08-21 11:24:15 +02:00
George
0fffa1abd4 Pydantic v2 (#214)
* new: update autogenerated code

* fix: fix config conversions

* new: add pydantic compat

* new: add types to pydantic_compat

* new: update dependencies

* new: use pydantic compat functions

* new: add pydantic v2 field check

* fix typing

* fix typing

---------

Co-authored-by: generall <andrey@vasnetsov.com>
2023-07-16 01:23:21 +02:00
Andrey Vasnetsov
fd3d997c64 update url 2023-03-30 21:57:16 +02:00
Andrey Vasnetsov
0e88c48854 wip: universal entry point (#142)
* wip: universal entry point

* init entry points

* fix types

* fix types

* fix types

* fix types

* rename qdrant_impl to _client

* upd readme

* big picture

* fix wording
2023-03-30 21:40:28 +02:00
George
bdae392066 new: add pre-commit (#126)
* new: add pre-commit

* new: exclude auto-generated files

* new: increase black line length

* fix: fix exclude pattern

* remove default version

* apply black

---------

Co-authored-by: Andrey Vasnetsov <andrey@vasnetsov.com>
2023-03-01 21:19:46 +04:00
Kacper Łukawski
f6a50d4325 Add the same example of inserting points into the docs 2023-01-19 09:29:57 +01:00
Andrey Vasnetsov
95d75375c2 upd logo 2022-06-21 16:56:16 +02:00
Andrey Vasnetsov
7204275931 gRPC search (#41)
* allow using grpc for search

* add docs

* assert + docs fix
2022-05-23 14:12:17 +02:00
trean
334ee2d510 qdrant-sphinx-theme for documentation (#34)
* qdrant-sphinx-theme for documentation

* generated docs

* docs fixes

Co-authored-by: Andrey Vasnetsov <andrey@vasnetsov.com>
2022-04-12 22:19:42 +02:00