Ce guide explique comment récupérer la liste des documents téléchargés dans Paradigm à l'aide du client Python OpenAI. Assurez-vous que le client Python OpenAI soit configuré conformément au guide de configuration initiale.
Instructions étape par étape
Étape 1 : Installer la bibliothèque requise
Assurez-vous que la bibliothèque OpenAI est installée. Sinon, installez-la en utilisant pip :
pip install --upgrade openai
Étape 2 : configurer le client OpenAI
Configurez votre client OpenAI avec la clé API et définissez l'URL de base sur l'API Paradigm :
from openai import OpenAI as OpenAICompatibleClient
import os
# Récupérez la clé API à partir de la variable d'environnement
api_key = os.getenv("PARADIGM_API_KEY")
# Notre URL de base API
base_url = "https://paradigm.lighton.ai/api/v2"
# Configurer le client compatible OpenAI
client = OpenAICompatibleClient (api_key=api_key, base_url=base_url)
Étape 3 : Récupérer la liste paginée des documents
Pour récupérer tous les documents, utilisez la méthode files.list() méthode de l’objet python OpenAi:
response = client.files.list()
Étape 4 : Manipuler la réponse
La méthode renverra un objet SyncPage contenant la liste paginée des documents et des informations complémentaires, tels que décrits ci-dessous :
Attributs de SyncPage:
data: Liste d'objetsFileObjectobject: valeur constante fixée à"list"next: url à appeler pour obtenir le contenu de la page suivante si elle existeprevious: url à appeler pour récupérer le contenu de la page précédente si elle existecount: nombre total de fichiers disponibles à travers toutes les pages
Gérez cette réponse selon les besoins dans votre application.
# Exemple de code pour imprimer toutes les informations du document
for document in response.data:
print(document)
Gérer la pagination
Le nombre de documents par page est actuellement fixé à 20 et ne peut pas être modifié par l'utilisateur final.
Pour obtenir les documents d'une page spécifique, vous pouvez ajouter les informations via le paramètre extra_query de la méthode files.list(), comme indiqué ci-dessous :
# Exemple de code demandant le contenu de la deuxième page
response = client.files.list(
extra_query={"page": 2}
)
Filtrer les documents par type d'espace
Un document peut se trouver dans l'un de ces trois types d'espace :
- Espace privé (private): les documents de cet espace ne sont accessibles qu'à l'utilisateur
- Espace entreprise (company): les documents présents dans cet espace sont accessibles à chaque membre de l'entreprise
- Espace de travail (workspace): les documents de ce type d'espace sont accessibles aux membres de l'espace de travail donné, qui est une sous-sélection des membres de l'entreprise.
Pour filtrer les documents, vous pouvez ajouter les paramètres suivants :
# Exemple code filtrant les documents sur l'espace privé et l'espace de travail n°2
response = client.files.list(
extra_query={
"company_scope" : False,
"private_scope" : True,
"workspace_scope": [2],
}
)
Par défaut, tous les documents sont inclus dans la réponse, modifiez les arguments afin de réduire le nombre de fichiers renvoyés.
Conclusion
Vous avez appris à récupérer avec succès une liste paginée de documents téléchargés à partir de Paradigm en utilisant la méthode spécifiée. A ajuster le numéro de page avec le paramètre extra_query ainsi que modifier la portée de vos documents renvoyés avec les 3 arguments : private_scope, company_scope et workspace_scope