opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
74 stars 488 forks source link

[DOC] Document the request/response format required by neural search for data exchange facilitated by AI connectors #5699

Open dylan-tong-aws opened 11 months ago

dylan-tong-aws commented 11 months ago

What do you want to do?

Document the request/response format required by neural search for data exchange facilitated by AI connectors.

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

Document the request/response format required by neural search for data exchange facilitated by AI connectors.

Connectors that are designed for powering neural search will receive requests in a specific format. Neural search also requires a response in a specific format. Users need to know the format of the request and respond payload for various reasons like:

  1. If I'm an integrator and I'm building a connector blueprint, I need to know the format to implement the appropriate pre/post processing logic
  2. If I'm an application developer who wants to integrate a custom model via the Amazon SageMaker connector, I need to know the format so that I can write the appropriate pre/post processing logic in my model serving script.

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

hdhalter commented 11 months ago

@dylan-tong-aws - Can you please provide the format for the request/response?