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

Python: Update User-Agent to align with other SK languages #6827

Closed
moonbox3 opened this issue Jun 19, 2024 · 0 comments · Fixed by #6824
Closed

Python: Update User-Agent to align with other SK languages #6827

moonbox3 opened this issue Jun 19, 2024 · 0 comments · Fixed by #6824
Assignees
Labels
python Pull requests for the Python Semantic Kernel

Comments

@moonbox3
Copy link
Contributor

moonbox3 commented Jun 19, 2024

Describe the bug
Updates to the User-Agent are required so that we can align with all three SK languages. Examples:

User agent

  • semantic-kernel-csharp/1.1.1 [existing user agent]
  • semantic-kernel-java/1.1.1 [existing user agent]
  • semantic-kernel-python/1.1.1 [existing user agent]

semantic-kernel-version header

  • csharp/1.1.1
  • java/1.1.1
  • python/1.1.1
@moonbox3 moonbox3 added the bug Something isn't working label Jun 19, 2024
@markwallace-microsoft markwallace-microsoft added .NET Issue or Pull requests regarding .NET code java Issue or PR regarding Java code python Pull requests for the Python Semantic Kernel triage labels Jun 19, 2024
@github-actions github-actions bot changed the title Python: Update User-Agent to align with 3 SK languages Java: Python: Update User-Agent to align with 3 SK languages Jun 19, 2024
@github-actions github-actions bot changed the title Java: Python: Update User-Agent to align with 3 SK languages .Net: Python: Update User-Agent to align with 3 SK languages Jun 19, 2024
@moonbox3 moonbox3 removed bug Something isn't working .NET Issue or Pull requests regarding .NET code java Issue or PR regarding Java code triage labels Jun 19, 2024
@moonbox3 moonbox3 changed the title .Net: Python: Update User-Agent to align with 3 SK languages Python: Update User-Agent to align with 3 SK languages Jun 19, 2024
@moonbox3 moonbox3 self-assigned this Jun 19, 2024
@moonbox3 moonbox3 changed the title Python: Update User-Agent to align with 3 SK languages Python: Update User-Agent to align with other SK languages Jun 19, 2024
github-merge-queue bot pushed a commit that referenced this issue Jun 20, 2024
### Motivation and Context

Updates to the User-Agent are required so that we can align with all
three SK languages. Examples:

User agent
- semantic-kernel-csharp/1.1.1 [existing user agent]
- semantic-kernel-java/1.1.1 [existing user agent]
- semantic-kernel-python/1.1.1 [existing user agent]

semantic-kernel-version header
- csharp/1.1.1 
- java/1.1.1
- python/1.1.1

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

Updates to the user agent to reflect the desired changes/standardization
across all SK languages. Adding unit tests.
- Closes #6827 
- Moves the `USER_AGENT` const from its previous home in the openai
const file to a more generic const file.
- Updates unit tests to be able to run properly when a valid `.env` file
exists in the current working directory. The unit tests patch the env
vars and our current implementation of Pydantic Settings loads the
`.env` file if not specified.

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
@github-project-automation github-project-automation bot moved this to Sprint: Done in Semantic Kernel Jun 20, 2024
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this issue Aug 25, 2024
### Motivation and Context

Updates to the User-Agent are required so that we can align with all
three SK languages. Examples:

User agent
- semantic-kernel-csharp/1.1.1 [existing user agent]
- semantic-kernel-java/1.1.1 [existing user agent]
- semantic-kernel-python/1.1.1 [existing user agent]

semantic-kernel-version header
- csharp/1.1.1 
- java/1.1.1
- python/1.1.1

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

Updates to the user agent to reflect the desired changes/standardization
across all SK languages. Adding unit tests.
- Closes microsoft#6827 
- Moves the `USER_AGENT` const from its previous home in the openai
const file to a more generic const file.
- Updates unit tests to be able to run properly when a valid `.env` file
exists in the current working directory. The unit tests patch the env
vars and our current implementation of Pydantic Settings loads the
`.env` file if not specified.

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Pull requests for the Python Semantic Kernel
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants