Skip to content

[doc issue] Streaming documentation only for orchestration v1 endpoint #56

@sap-mtietje

Description

@sap-mtietje

Issue description

The documentation for enabling streaming on the v2/completion endpoint seems to reference the v1 request body schema instead of the v2 format.

In the docs, the example body for streaming is shown as:

{
  "orchestration_config": {
    "stream": true,
    "module_configurations": {
      ...
    },
    "input_params": {
      ...
    }
  }
}

This matches the v1 schema, where orchestration_config.stream accepted a boolean.

However, the v2 schema looks like this:

{
  "config": {
    "modules": {
      "prompt_templating": {
        "prompt": {
          "template": [
            ...
          ]
        },
        "model": {
          ...
        }
      }
    }
  },
  "placeholder_values": {
    ...
  }
}

Adding "stream": true under config yields:

400 - Request Body: True is not of type 'object' - 'config.stream'

Using "stream": {} is accepted, but no streaming response is returned

I would like to know how streaming can be enabled for the v2/completion endpoint

Feedback Type (Optional)

None

Page Title on SAP Help Portal (prefilled)

Streaming

Page URL on SAP Help Portal (prefilled)

https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/streaming?locale=en-US

Metadata

Metadata

Labels

contributionValuable Contributiontype/content-gapsSomething essential is missing in the documentation.ua-reviewUnder review by the UA team.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions