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

Could you please make this more descriptive? #728

Closed
tyler-suard-parker opened this issue Nov 20, 2023 · 6 comments · Fixed by #795
Closed

Could you please make this more descriptive? #728

tyler-suard-parker opened this issue Nov 20, 2023 · 6 comments · Fixed by #795
Labels
rag retrieve-augmented generative agents

Comments

@tyler-suard-parker
Copy link
Contributor

query_texts (List[str]): the query texts.

Variable name: query_texts
Variable description: the query texts

Yes, I understand that, but what do you mean by query texts? Is this a list of strings that are going to be used to query documents? If so then why do we have a search string?

@rickyloynd-microsoft
Copy link
Contributor

@thinkall fyi

@rickyloynd-microsoft rickyloynd-microsoft added the rag retrieve-augmented generative agents label Nov 21, 2023
@thinkall
Copy link
Collaborator

@tyler-suard-parker thanks for asking, it’s a list of strings, query_texts (List[str]): the query texts. says List[str]. Does it make sense to you?

@tyler-suard-parker
Copy link
Contributor Author

Sorry, still no. I understand it is a list of strings, but what is the purpose of the query_texts argument?

@thinkall
Copy link
Collaborator

It contains the text used for retrieving documents from the database.

@tyler-suard-parker
Copy link
Contributor Author

@thinkall Thank you. How is that different from the search string?

@thinkall
Copy link
Collaborator

@thinkall Thank you. How is that different from the search string?

Thank you @tyler-suard-parker , I get your point. This is not a user-oriented function, if you come to this file from here, search_string (str): only docs containing this string will be retrieved. you may not be so confused.

I'll make a PR to improve the doc_string. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rag retrieve-augmented generative agents
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants