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.

Sign up for GitHub

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

Jump to bottom

Add conversation search documentation #5018

Merged
merged 15 commits into from
Sep 19, 2023
Merged

Add conversation search documentation #5018

merged 15 commits into from
Sep 19, 2023

Conversation

Naarcha-AWS
Copy link
Collaborator

Resolves #4943

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@Naarcha-AWS Naarcha-AWS added release-notes PR: Include this PR in the automated release notes experimental v2.10.0 labels Sep 13, 2023
@Naarcha-AWS Naarcha-AWS added this to the v2.10 milestone Sep 13, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this Sep 13, 2023
@Naarcha-AWS
Copy link
Collaborator Author

@HenryL27: I've added the conversation memory section and I'm working the RAG Pipeline section. While I'm working on the RAG section, mind taking a look at what we have so far to make sure I didn't miss anything?

@Naarcha-AWS
Start RAG section
44af75e 
Signed-off-by: Naarcha-AWS <[email protected]>
HenryL27
HenryL27 reviewed Sep 13, 2023
View reviewed changes
Copy link
Contributor

@HenryL27 HenryL27 left a comment

Choose a reason for hiding this comment

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

Lookin good! A couple of nits that are probably my own typos, sorry about that. Some of the indentation looks funny here but that probably goes away when rendering, right

_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
@hdhalter hdhalter added the 3 - Tech review PR: Tech review in progress label Sep 14, 2023
@Naarcha-AWS
Copy link
Collaborator Author

@HenryL27: RAG steps are ready for your review.

HenryL27
HenryL27 reviewed Sep 15, 2023
View reviewed changes
Copy link
Contributor

@HenryL27 HenryL27 left a comment

Choose a reason for hiding this comment

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

thanks @Naarcha-AWS, looking good. Just one more section I forgot to give you on security; sorry about that. Also @austintlee if you have time could you take a look?

_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
cwillum
cwillum approved these changes Sep 18, 2023
View reviewed changes
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

In addition to requests for changes from the dev, my suggestions are here. Looks good.

_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits September 18, 2023 14:21
@Naarcha-AWS @cwillum
Apply suggestions from code review
3d8a3f7 
Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Apply suggestions from code review
860e6ac 
Signed-off-by: Naarcha-AWS <[email protected]>
natebower
natebower reviewed Sep 19, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated
:--- | :--- | :---
`llm_question` | Yes | The question the LLM must answer.
`llm_model` | No | Overrides the original model set in the connection in cases where you want to use a different model. For example, using GPT 4 instead of GPT 3.5. This option is required if a default model is not set during pipeline creation.
`coversation_id` | No | Integrates conversation memory into your RAG pipeline by adding the 10 most recent conversations into the context of search query to the LLM.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like either "a" or "the" should precede "search query".

_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
_ml-commons-plugin/conversational-search.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS added the 5 - Editorial review PR: Editorial review in progress label Sep 19, 2023
@hdhalter hdhalter removed the 3 - Tech review PR: Tech review in progress label Sep 19, 2023
Naarcha-AWS and others added 2 commits September 19, 2023 16:47
@Naarcha-AWS @natebower
Apply suggestions from code review
c14f010 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS @natebower
Update _ml-commons-plugin/conversational-search.md
7545401 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit d5d7849 into main Sep 19, 2023
3 checks passed
@Naarcha-AWS Naarcha-AWS deleted the conversational-search branch September 19, 2023 21:48
vagimeli pushed a commit that referenced this pull request Sep 19, 2023
@Naarcha-AWS @cwillum
@natebower @vagimeli
Add conversation search documentation (#5018)
e465d63 
* Add conversation search documentation

Signed-off-by: Naarcha-AWS <[email protected]>

* Add delete response

Signed-off-by: Naarcha-AWS <[email protected]>

* Start RAG section

Signed-off-by: Naarcha-AWS <[email protected]>

* Add additional technical feedback.

Signed-off-by: Naarcha-AWS <[email protected]>

* Add RAG steps

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update conversational-search.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/conversational-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
vagimeli added a commit that referenced this pull request Sep 19, 2023
@vagimeli
Revert "Add conversation search documentation (#5018)"
f7e3060 
This reverts commit e465d63.
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
@Naarcha-AWS @cwillum
@natebower @harshavamsi
Add conversation search documentation (opensearch-project#5018)
26a01c7 
* Add conversation search documentation

Signed-off-by: Naarcha-AWS <[email protected]>

* Add delete response

Signed-off-by: Naarcha-AWS <[email protected]>

* Start RAG section

Signed-off-by: Naarcha-AWS <[email protected]>

* Add additional technical feedback.

Signed-off-by: Naarcha-AWS <[email protected]>

* Add RAG steps

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update conversational-search.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/conversational-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
@Naarcha-AWS @cwillum
@natebower @vagimeli
Add conversation search documentation (#5018)
3226949 
* Add conversation search documentation

Signed-off-by: Naarcha-AWS <[email protected]>

* Add delete response

Signed-off-by: Naarcha-AWS <[email protected]>

* Start RAG section

Signed-off-by: Naarcha-AWS <[email protected]>

* Add additional technical feedback.

Signed-off-by: Naarcha-AWS <[email protected]>

* Add RAG steps

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update conversational-search.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/conversational-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower left review comments

@HenryL27 HenryL27 HenryL27 left review comments

@cwillum cwillum cwillum approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@ananzh ananzh Awaiting requested review from ananzh

@seanneumann seanneumann Awaiting requested review from seanneumann

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress experimental release-notes PR: Include this PR in the automated release notes v2.10.0
Projects
None yet
Milestone
v2.10
Development

Successfully merging this pull request may close these issues.

[DOC] Add conversation search feature
5 participants
@Naarcha-AWS @HenryL27 @natebower @cwillum @hdhalter