Skip to content
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.

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

Refactor Add_documents API #535

Merged
merged 19 commits into from
Jul 14, 2023
Merged

Refactor Add_documents API #535

merged 19 commits into from
Jul 14, 2023

Conversation

wanliAlex
Copy link
Collaborator

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    we move the query parameters non_tensor_fields, use_existing_tensors, image_download_headers, model_auth, mappings to the request body.

  • What is the current behavior? (You can also link to an open issue here)
    non_tensor_fields, use_existing_tensors, image_download_headers, model_auth, mappings are query parameters

  • What is the new behavior (if this is a feature change)?
    they are now moved to the query body as nonTensorFields, useExistingTensors, imageDownloadHeaders, modelAuth, mappings

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    yes.
    for py-marqo users, they need to upgrade the py-marqo version
    for bash curl users, they need to change their requests

marqo will still support old APIs recently but my remove them in the near future.

  • Have unit tests been run against this PR? (Has there also been any additional testing?)
    running

  • Related Python client changes (link commit/PR here)
    working on

  • Related documentation changes (link commit/PR here)
    finished

  • Other information:

  • Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added / updated (for bug fixes / features)

@wanliAlex wanliAlex temporarily deployed to marqo-test-suite July 11, 2023 08:22 — with GitHub Actions Inactive
@wanliAlex wanliAlex temporarily deployed to marqo-test-suite July 12, 2023 02:02 — with GitHub Actions Inactive
Copy link
Collaborator

@farshidz farshidz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed I suggest avoiding old and new in names so that we can easily remove the deprecated API in the future

src/marqo/tensor_search/web/api_utils.py Outdated Show resolved Hide resolved
src/marqo/tensor_search/web/api_utils.py Outdated Show resolved Hide resolved
src/marqo/tensor_search/models/add_docs_objects.py Outdated Show resolved Hide resolved
src/marqo/tensor_search/models/add_docs_objects.py Outdated Show resolved Hide resolved
@farshidz farshidz merged commit e8d078c into mainline Jul 14, 2023
@farshidz farshidz deleted the li/add_docs_api branch July 14, 2023 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants