Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add session data export endpoint documentation #594

Merged
merged 3 commits into from
Dec 20, 2024

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Dec 19, 2024

Session Data Export Documentation

Changes

  • Added documentation for session data export endpoints
  • Clarified authentication requirements (API key only)
  • Provided example code for making requests
  • Maintained existing documentation structure

Testing

  • Documentation renders correctly
  • Examples are clear and accurate
  • No references to JWT tokens or get_session_jwt()
  • Maintained backward compatibility

Link to Devin run: https://app.devin.ai/sessions/ad7c503faf0142f69a5cb28ae2abe0cf

- Add get_session_jwt() documentation in sdk-reference.mdx
- Add Session Authentication section in sessions.mdx
- Document JWT token retrieval process

Co-Authored-By: Alex Reibman <meta.alex.r@gmail.com>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Add "(aside)" to your comment to have me ignore it.

Copy link

Walkthrough

This update enhances the SDK documentation by introducing a new section on Session Authentication in the sessions.mdx file. It explains how to retrieve a JWT token for session-specific API requests using the get_session_jwt() function. Additionally, the sdk-reference.mdx file now includes detailed documentation of the get_session_jwt() function, covering its parameters and return values. These improvements aim to provide developers with clearer guidance on session authentication processes.

Changes

File(s) Summary
docs/v1/concepts/sessions.mdx Introduced "Session Authentication" section detailing JWT token retrieval for session-specific API requests using agentops.get_session_jwt().
docs/v1/usage/sdk-reference.mdx Added comprehensive documentation for get_session_jwt(), including parameters and return values, to assist developers in session JWT token retrieval.

🔗 Related PRs

Instructions

Emoji Descriptions:

  • ⚠️ Potential Issue - May require further investigation.
  • 🔒 Security Vulnerability - Fix to ensure system safety.
  • 💻 Code Improvement - Suggestions to enhance code quality.
  • 🔨 Refactor Suggestion - Recommendations for restructuring code.
  • ℹ️ Others - General comments and information.

Interact with the Bot:

  • Send a message or request using the format:
    @bot + *your message*
Example: @bot Can you suggest improvements for this code?
  • Help the Bot learn by providing feedback on its responses.
    @bot + *feedback*
Example: @bot Do not comment on `save_auth` function !

Execute a command using the format:

@bot + */command*

Example: @bot /updateCommit

Available Commands:

  • /updateCommit ✨: Apply the suggested changes and commit them (or Click on the Github Action button to apply the changes !)
  • /updateGuideline 🛠️: Modify an existing guideline.
  • /addGuideline ➕: Introduce a new guideline.

Tips for Using @bot Effectively:

  • Specific Queries: For the best results, be specific with your requests.
    🔍 Example: @bot summarize the changes in this PR.
  • Focused Discussions: Tag @bot directly on specific code lines or files for detailed feedback.
    📑 Example: @bot review this line of code.
  • Managing Reviews: Use review comments for targeted discussions on code snippets, and PR comments for broader queries about the entire PR.
    💬 Example: @bot comment on the entire PR.

Need More Help?

📚 Visit our documentation for detailed guides on using Entelligence.AI.
🌐 Join our community to connect with others, request features, and share feedback.
🔔 Follow us for updates on new features and improvements.

Co-Authored-By: Alex Reibman <meta.alex.r@gmail.com>
@devin-ai-integration devin-ai-integration bot changed the title docs: improve JWT token retrieval documentation docs: add session data export endpoint documentation Dec 19, 2024
Co-Authored-By: Alex Reibman <meta.alex.r@gmail.com>
@areibman areibman merged commit f844e0a into main Dec 20, 2024
1 check passed
@areibman areibman deleted the devin/1734576700-jwt-docs branch December 20, 2024 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant