Update docs of DeepsetCloudDocumentStore #2460
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tstadel
requested changes
Apr 26, 2022
There was a problem hiding this comment.
DEFAULT_API_ENDPOINT in haystack/document_stores/deepsetcloud.py can be safely removed. Instead please adjust DEFAULT_API_ENDPOINT in haystack/utils/deepsetcloud.py. This is the one that acts as default if neither the api_key param nor the env variable has been set.
The remaining parts look good to me :-)
| @@ -9,7 +9,7 @@ | |||
| from haystack.utils import DeepsetCloud | |||
|
|
|||
|
|
|||
| DEFAULT_API_ENDPOINT = f"DC_API_PLACEHOLDER/v1" # TODO | |||
| DEFAULT_API_ENDPOINT = "https://api.cloud.deepset.ai/api/v1" | |||
There was a problem hiding this comment.
Looks like this is superfluous. The actual DEFAULT_API_ENDPOINT has moved to haystack/utils/deepsetcloud.py. There it makes sense to adjust it. But this one can be safely removed.
Co-authored-by: tstadel <60758086+tstadel@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes:
Updating a few doc strings of the DeepsetCloudDocumentStore
@tstadel not sure about the usage of "DEFAULT_API_ENDPOINT". Where is this one actually used? Does it make sense to update it to the actual endpoint now?
Status (please check what you already did):