feat: update python sdk docs #272
Conversation
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested.
- Reviewed the entire pull request up to b73f799
- Looked at
5450lines of code in56files - Took 5 minutes and 21 seconds to review
More info
- Skipped
0files when reviewing. - Skipped posting
1additional comments because they didn't meet confidence threshold of50%.
1. docs/python-sdk-docs/julep/api/client.md:126:
- Assessed confidence :
100% - Grade:
0% - Comment:
The PR adds new metadata fields to the API methods, but it does not seem to include changes to the actual implementation of these methods to handle these new fields. Please ensure that these new fields are properly handled in the implementation. - Reasoning:
The PR is adding new metadata fields to the API methods. However, the PR does not include any changes to the actual implementation of these methods to handle the new metadata fields. This could potentially lead to issues if these fields are not properly handled in the implementation.
Workflow ID: wflow_ICzUQRJzWywwQqzi
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. We'll respond in a few minutes. Learn more here.
| @@ -134,25 +137,27 @@ async def chat( | |||
|
|
|||
| ### AsyncJulepApi().create_agent | |||
|
|
|||
| [Show source in client.py:1651](../../../../../../julep/api/client.py#L1651) | |||
| [Show source in client.py:2109](../../../../../../julep/api/client.py#L2109) | |||
|
|
|||
| Create a new agent | |||
|
|
|||
| #### Arguments | |||
|
|
|||
There was a problem hiding this comment.
The type of the 'instructions' parameter in the 'create_agent' method has been changed to 'List[str]' but the description still refers to 'List[Instruction]'. Please update the description to match the new type.
| @@ -134,25 +137,27 @@ | |||
|
|
|||
| ### AsyncJulepApi().create_agent | |||
|
|
|||
| [Show source in client.py:1651](../../../../../../julep/api/client.py#L1651) | |||
| [Show source in client.py:2109](../../../../../../julep/api/client.py#L2109) | |||
|
|
|||
| Create a new agent | |||
There was a problem hiding this comment.
The type of the 'instructions' parameter has been changed to 'List[str]'. Please update the description to reflect this change.
| Create a new agent | |
| - `-` *instructions* - typing.Optional[typing.List[str]]. List of instruction strings for the agent |
There was a problem hiding this comment.
❌ Changes requested.
- Performed an incremental review on 8941e8d
- Looked at
60lines of code in1files - Took 1 minute and 35 seconds to review
More info
- Skipped
0files when reviewing. - Skipped posting
0additional comments because they didn't meet confidence threshold of50%.
Workflow ID: wflow_21iFMffc6pRwHssK
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. We'll respond in a few minutes. Learn more here.
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-python@v5 |
There was a problem hiding this comment.
The 'actions/setup-python' action is used with version 'v5', which is not a valid release. The latest release of 'actions/setup-python' is 'v3'. Please update the version.
| - uses: actions/setup-python@v5 | |
| - uses: actions/setup-python@v3 |
There was a problem hiding this comment.
👍 Looks good to me!
- Performed an incremental review on 7fc7dd3
- Looked at
40lines of code in1files - Took 1 minute and 44 seconds to review
More info
- Skipped
0files when reviewing. - Skipped posting
1additional comments because they didn't meet confidence threshold of50%.
1. /docs/sdks/python-sdk-docs/client-1.md:137:
- Assessed confidence :
50% - Comment:
The type of the 'instructions' parameter in the 'create_agent' and 'update_agent' methods has been updated from 'Instruction' to 'str'. Please ensure that this change is consistent with the rest of the codebase and doesn't break anything. - Reasoning:
The PR author has updated the type of the 'instructions' parameter in the 'create_agent' and 'update_agent' methods from 'Instruction' to 'str'. This change is reflected in both the async and non-async versions of these methods. This change seems to be in line with the PR description and there doesn't seem to be any issues with it. However, I would need to check the rest of the codebase to ensure that this change doesn't break anything.
Workflow ID: wflow_5ujokCM6o7JioR4y
Not what you expected? You can customize the content of the reviews using rules. Learn more here.
Summary:
This PR updates the Python SDK documentation and modifies the GitHub workflow to generate Python SDK documentation, reflecting changes in API client, types, managers, and OpenAI patch.
Key points:
julep/api/client.mdto reflect changes in the API client.julep/api/types/index.mdto include new types and modifications to existing ones.julep/managers/agent.md,julep/managers/session.md, andjulep/managers/user.mdto reflect changes in the respective managers.julep/utils/openai_patch.mdto reflect changes in the OpenAI patch..github/workflows/generate-docs.ymlto include steps for generating Python SDK documentation.Generated with ❤️ by ellipsis.dev