updated Readme #29
Merged
updated Readme #29
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
ofermend
reviewed
Dec 6, 2024
| * Querying the corpora | ||
| ```python | ||
| from vectara import SearchCorporaParameters, Vectara | ||
| client = Vectara( |
There was a problem hiding this comment.
Perhaps explain here that you should use either the API Key or the OAUth ID/secret, but not both at the same time? on first read, that may be confusing to users.
ofermend
reviewed
Dec 6, 2024
README.md
Outdated
| ) | ||
| ``` | ||
|
|
||
| * Starting the chat session |
ofermend
reviewed
Dec 6, 2024
| ) | ||
|
|
||
| response = session.chat(query="Tell me about machine learning.") | ||
| print(response.answer) |
There was a problem hiding this comment.
Here please show how someone does a subsequent chat. i.e. using the returned Chat session for a new turn
|
@ofermend please have a look again. |
ofermend
reviewed
Dec 10, 2024
README.md
Outdated
| ```python | ||
| from vectara import SearchCorporaParameters, Vectara | ||
| client = Vectara( | ||
| api_key="YOUR_API_KEY", # Use this for API key-based authentication |
There was a problem hiding this comment.
This is better but not ideal still. My recommendation is:
- Have a section about "create a client" that just shows the client=Vectara() piece, and shows it in two different ways (not a single call with "OR" comment - that can be confusing).
- Then show query (i.e. setup search params, generation params, and the query). But please add some parameters there as an example. IT needs to be a good example where someone can copy/paste and get good results. You can then suggest they can look at docs for more details and options.
- Chat example.
ofermend
reviewed
Dec 10, 2024
README.md
Outdated
| chat_params = ChatParameters(store=True) | ||
|
|
||
| session = client.create_chat_session( | ||
| search=search_params, |
There was a problem hiding this comment.
shouldn't this be search=search and generation=generation? (search_params is not defined).
Please make these real examples and test them to validate.
ofermend
approved these changes
Dec 11, 2024
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.
No description provided.