update documentation for rpt-1.5 - #682
vladimir-a-sap wants to merge 5 commits into
Conversation
|
|
||
| Please find more examples in [the sample application](https://github.com/SAP/ai-sdk-java/tree/main/sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/RptService.java). | ||
|
|
||
| ## Migration from RPT-1 version |
There was a problem hiding this comment.
[req] As far as I now understand how it works based on Clemens message
this is the same web service code on server-side and the API is equivalent except for the two added optional parameters...
Some spec changes could be applicable for all models. So I wouldn't say migration from old model, but rather some compatibility note from the last spec version (if any, then also caused by the server side, and should not differ between models unless requests are handled completely different based on model names). So the new spec should be backward compatible and also describe the old model usage.
| - review your usage of `PredictRequestPayload`, add either `rows` or `columns` if both are missing depending on your | ||
| use case (one of them is now required) | ||
| - in case you use custom destinations (e.g. `RptClient.forDestination` with a configured URL) check your | ||
| configuration if you need to adjust it to account for the API base path change (from `/v1` prefix to `/`) |
There was a problem hiding this comment.
[q] Is this verified? I wonder if /v1 was needed before?
There was a problem hiding this comment.
[a] Yes, according to the spec file, base path has been changed. You can see the change in spec here - https://github.com/SAP/ai-sdk-java/pull/976/changes#diff-7a0efec3184502bb0d701aa412121d49b3e82eebedb732a9c59b356a1f4d955c
There was a problem hiding this comment.
I know the spec has been changed. But the spec path might be an internal path. Using the actual deployment url, /v1 might be invisible.
Jonas-Isr
left a comment
Jonas-Isr
left a comment
There was a problem hiding this comment.
LGTM besides very small fix (and Zhongpins comments)
| - review your usage of `PredictRequestPayload`, add either `rows` or `columns` if both are missing depending on your | ||
| use case (one of them is now required) | ||
| - in case you use custom destinations (e.g. `RptClient.forDestination` with a configured URL) check your | ||
| configuration if you need to adjust it to account for the API base path change (from `/v1` prefix to `/`) |
There was a problem hiding this comment.
(Minor)
| - review your usage of `PredictRequestPayload`, add either `rows` or `columns` if both are missing depending on your | |
| use case (one of them is now required) | |
| - in case you use custom destinations (e.g. `RptClient.forDestination` with a configured URL) check your | |
| configuration if you need to adjust it to account for the API base path change (from `/v1` prefix to `/`) | |
| - Review your usage of `PredictRequestPayload`, add either `rows` or `columns` if both are missing depending on your | |
| use case (one of them is now required). | |
| - In case you use custom destinations (e.g. `RptClient.forDestination` with a configured URL) check your | |
| configuration if you need to adjust it to account for the API base path change (from `/v1` prefix to `/`) |
|
Replacement PR |
4 participants
updated documentation related to java-sdk rpt-1.5 support
implementation pr - SAP/ai-sdk-java#976