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

[DOC] ext objects are also supported in queries #6968

Open
3 tasks
smacrakis opened this issue Apr 17, 2024 · 3 comments
Open
3 tasks

[DOC] ext objects are also supported in queries #6968

smacrakis opened this issue Apr 17, 2024 · 3 comments
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR.

Comments

@smacrakis
Copy link
Contributor

smacrakis commented Apr 17, 2024

What do you want to do?

  • [X ] Request a change to existing documentation

This page says that "plugin authors can add an ext object to the search response", but @reta says that queries can also have an ext section.

Also, the doc for the Rerank processor includes an ext in a search query.

I would be happy to edit this myself, but I don't know the rules around ext objects.

  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@hdhalter
Copy link
Collaborator

@gaobinlong , @heemin32 - Is this something you can help with?

@gaobinlong
Copy link
Contributor

By diving deep into the ext object, I found it's defined in OpenSearch-core, that makes the search request could be extended by the plugins, plugins can subclass SeachExtBuilder to add their own ext section. Now we have RerankSearchExitBuilder implemented in neural-search plugin, and the type of ext is just a map, so I think we can give an example of the rerank ext object in the documentation of the search api.

@hdhalter hdhalter added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Apr 24, 2024
@hdhalter
Copy link
Collaborator

By diving deep into the ext object, I found it's defined in OpenSearch-core, that makes the search request could be extended by the plugins, plugins can subclass SeachExtBuilder to add their own ext section. Now we have RerankSearchExitBuilder implemented in neural-search plugin, and the type of ext is just a map, so I think we can give an example of the rerank ext object in the documentation of the search api.

Who would be able to provide that example?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR.
Projects
None yet
Development

No branches or pull requests

3 participants