quick start connectors

Connecteurs de démarrage rapide

---

Table des matières

• Table des matières
• Aperçu
  • Caractéristiques
• Commencer
• Contributif

Aperçu

Le framework Build-your-Own-Own-Connector de Cohere vous permet d'intégrer la commande de Cohere's Command LLM via le point de terminaison de l'API de chat à tout datastore / logiciel qui contient des informations texte et a un point de terminaison de recherche correspondant exposé dans son API. Cela permet au modèle de commande de générer des réponses aux requêtes utilisateur qui sont fondées sur des informations propriétaires.

Quelques exemples des cas d'utilisation que vous pouvez activer avec ce cadre:

• Question / réponse générique autour de grands documents d'entreprise internes
• Connaissances travaillant avec un sous-ensemble spécifique de connaissances internes
• Résumé et recherche internes des communications
• Recherche utilisant des fournisseurs d'informations externes, permettant aux chercheurs et aux écrivains d'explorer les informations des tiers

Ce référentiel open source contient du code qui vous permettra de commencer à vous intégrer à certaines des datast les plus populaires. Il existe également un connecteur de modèle vide que vous pouvez développer pour utiliser n'importe quelle source de données. Notez que les différentes bandes de données peuvent avoir différentes exigences ou limitations qui doivent être traitées afin d'obtenir des réponses de bonne qualité. Bien qu'une partie du code QuickStart ait été améliorée pour répondre à certaines de ces limitations, d'autres ne fournissent que les bases de l'intégration, et vous devrez les développer davantage pour s'adapter à votre cas d'utilisation spécifique et aux limitations sous-jacentes de type de données.

Veuillez en savoir plus sur notre cadre Connecteurs ici: https://docs.cohere.com/docs/connectors

Commencer

Ce projet nécessite Python 3.11+ et la poésie au minimum. Chaque connecteur utilise la poésie pour créer un environnement virtuel spécifique à ce connecteur et pour installer toutes les dépendances requises pour exécuter un serveur local.

Pour les versions de production, vous pouvez éventuellement créer et déployer à l'aide de Docker. Lors de la création d'une image Docker, vous pouvez utiliser le Dockerfile dans le répertoire du projet racine et spécifier l'argument de la création app . Par exemple:

docker build . -t gdrive:1 --build-arg app=gdrive

Développement

Pour le développement, reportez-vous au ReadMe d'un connecteur. Généralement, il existe un fichier .env qui doit être créé dans ce sous-répertoire, basé sur un .env-template . Les variables d'environnement ici définissent le plus souvent les valeurs d'autorisation telles que les clés d'API, les informations d'identification et modifient également la façon dont la recherche de ce connecteur se comporte.

Après avoir configuré le .env , vous pourrez utiliser CLI de poetry pour démarrer un serveur local.

Pré-engager

Il est recommandé d'utiliser les pré-comité définis qui mettra automatiquement à peluchez vos fichiers. Vous pouvez exécuter une pip install pre-commit

et

pre-commit install dans le dossier racine. Maintenant, vous avant de commettre vos fichiers sera automatiquement liné. Actuellement, le pré-engagement fonctionnera noir (épinglé au 24.1.1).

Intégrer avec Cohere

Tous les connecteurs de ce référentiel ont été adaptés pour s'intégrer à l'API de chat de Cohere pour rendre la création d'un chatbot fondé rapidement et facile.

L'API de Cohere exige que les connecteurs renvoient les documents en tant que tableau d'objets JSON. Chaque document doit être un objet avec des touches de chaîne et des valeurs de chaîne contenant toutes les informations pertinentes sur le document (par exemple, title , url , etc.). Pour les meilleurs résultats, le plus grand contenu texte doit être stocké dans la clé text .

Par exemple, un connecteur qui renvoie des documents sur la politique de dépenses de l'entreprise peut renvoyer ce qui suit:

[
  {
    "title" : " Company Travel Policy " ,
    "text" : " Flights, Hotels and Meals can be expensed using this new tool... " ,
    "url" : " https://drive.google.com/file/d/id1 " ,
    "created_at" : " 2023-11-25T20:09:31Z "
  },
  {
    "title" : " 2024 Expenses Policy " ,
    "text" : " The list of recommended hotels are... " ,
    "url" : " https://drive.google.com/file/d/id2 " ,
    "created_at" : " 2023-12-04T16:52:12Z "
  }
]

L'API de chat de Cohere interrogera le connecteur et utilisera ces documents pour générer des réponses avec des citations directes.

Contributif

Les contributions sont ce qui stimule une communauté open source, toutes les contributions apportées sont grandement appréciées. Pour spécifique. Pour commencer, consultez notre documentation.