Feature/allow backwards compat

[emrgnt-cmplxty]

Important

Reintroduce and deprecate completion field in RAGResponse for backwards compatibility, updating rag() function accordingly.

• Models:
  • In RAGResponse class, comment out generated_answer field and reintroduce completion field with deprecation notice in responses.py.
• Services:
  • Update rag() function in retrieval_service.py to use completion field in RAGResponse instead of generated_answer.

^{This description was created by for 22adf3c. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 22adf3c in 1 minute and 2 seconds

More details

• Looked at 52 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 4 drafted comments based on config settings.

1. py/core/main/services/retrieval_service.py:598

• Draft comment:
  The RAGResponse is constructed with a 'generated_answer' field, but this field is now commented out in the model. This may cause a validation error. Use only the 'completion' field or update the model to accept both names for backwards compatibility.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

2. py/shared/api/models/retrieval/responses.py:109

• Draft comment:
  The generated_answer field is commented out in favor of a new 'completion' field. Also, the JSON schema example still references 'generated_answer'. Update the schema example to reflect the new field for consistency.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

3. py/core/main/services/retrieval_service.py:600

• Draft comment:
  Adding the parameter 'completion' now in the RAGResponse constructor. Make sure that downstream clients and documentation match the new field name, as this replaces the previously named 'generated_answer'.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
  This comment is asking the author to ensure that downstream clients and documentation match the new field name. This is a request for confirmation and not a specific code suggestion or test request. It violates the rule against asking the author to ensure behavior is intended or to double-check things.

4. py/shared/api/models/retrieval/responses.py:107

• Draft comment:
  The 'generated_answer' field and its alias property 'completion' were removed in favor of a sole 'completion' field marked as deprecated. This appears to reverse the original intent (which instructed to use 'generated_answer' instead). Also, the JSON schema example still shows 'generated_answer'. Please clarify which field should be canonical and update both the deprecation notice and schema example accordingly.
• Reason this comment was not posted:
  Marked as duplicate.

Workflow ID: wflow_i9DrFSuywzACKRGk

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.