Azure-Samples / Azure-Samples/rag-data-openai-python-promptflow

Document required Python 3.11.9 version

Ouverte
#31 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
290
Forks
152
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

> Please provide us with the following information:
> ---------------------------------------------------------------

### This issue is for a: (mark with an `x`)
```
- [x] bug report -> please search issues before submitting
- [ ] feature request
- [x] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)
```

### Minimal steps to reproduce
> I had the newest version Python 3.12 installed on my machine and build the example.
Building runs fine (pip etc) but running the example fails with obscure errors.
I found out that the "az" tool seems not to be supported with Python 3.12

So I searched the docs from the rag-data-openai-python-promptflow example, and found hints about Python 3.10
However this did not run either..."az" gave a kind of error message that 3.11.9 is needed.

Finally I installed Python 3.11.9 and the example can be build and run successfully.
I would recommend to add this information into the docs as it can save some frustration.
I now noticed that the Windows AppStore has also Python 3.11.9 as default (which can avoid the problem if you install from there) but there are also other installation ways or OS, so giving a hint that Python 3.11.9 is required would be fine.

There are also ways to enforce the python version technically (e.g. via pipenv) but this would be a separate discussion.

### Any log messages given by the failure
> I can add the error messages with Python 3.12 and Python 3.10 if you need them

### Expected/desired behavior
> I would like the required Python version 3.11.9 to be documented clearly.

### OS and Version?
> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
Windows
### Versions
>10

### Mention any other details that might be useful

> ---------------------------------------------------------------
> Thanks! We'll be in touch soon.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par localiser la documentation de l’exemple rag-data-openai-python-promptflow et vérifiez comment ses exigences Python sont actuellement décrites. Mettez à jour les instructions de configuration concernées afin d’indiquer que la version requise de Python est 3.11.9, puis vérifiez que les instructions documentées sont claires pour Windows et les autres environnements pris en charge.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.