APIEndpointAsset model

chirps/asset/admin.py

@@ -4,6 +4,7 @@
 from polymorphic.admin import PolymorphicChildModelAdmin, PolymorphicParentModelAdmin
 
 from .models import BaseAsset
+from .providers.api_endpoint import APIEndpointAsset
 from .providers.mantium import MantiumAsset
 from .providers.pinecone import PineconeAsset
 from .providers.redis import RedisAsset
@@ -33,6 +34,13 @@ class RedisAssetAdmin(PolymorphicChildModelAdmin):
     base_model = RedisAsset
 
 
+class APIEndpointAssetAdmin(PolymorphicChildModelAdmin):
+    """Admin class for the APIEndpoint model."""
+
+    base_model = APIEndpointAsset
+
+
 admin.site.register(RedisAsset)
 admin.site.register(MantiumAsset)
 admin.site.register(PineconeAsset)
+admin.site.register(APIEndpointAsset)

chirps/asset/forms.py

@@ -1,10 +1,12 @@
 """Forms for rendering and validating the asset models."""
 from asset.models import BaseAsset
+from asset.widgets import KeyValueWidget
 from django import forms
 from django.forms import ModelForm
 from django.urls import reverse_lazy
 from embedding.models import Embedding
 
+from .providers.api_endpoint import APIEndpointAsset
 from .providers.mantium import MantiumAsset
 from .providers.pinecone import PineconeAsset
 from .providers.redis import RedisAsset
@@ -164,10 +166,39 @@ def __init__(self, *args, **kwargs):
         )
 
 
+class APIEndpointAssetForm(ModelForm):
+    """Form for the APIEndpointAsset model."""
+
+    class Meta:
+        """Django Meta options for the APIEndpointAssetForm."""
+
+        model = APIEndpointAsset
+        fields = [
+            'name',
+            'url',
+            'authentication_method',
+            'api_key',
+            'headers',
+            'body',
+        ]
+
+        widgets = {
+            'name': forms.TextInput(attrs={'class': 'form-control', 'placeholder': 'Enter a name for the asset'}),
+            'url': forms.URLInput(attrs={'class': 'form-control', 'placeholder': 'URL'}),
+            'authentication_method': forms.Select(
+                choices=[('Basic', 'Basic'), ('Bearer', 'Bearer')], attrs={'class': 'form-control'}
+            ),
+            'api_key': forms.TextInput(attrs={'class': 'form-control', 'placeholder': 'API Key'}),
+            'headers': KeyValueWidget(attrs={'class': 'form-control'}),
+            'body': KeyValueWidget(attrs={'class': 'form-control'}),
+        }
+
+
 assets = [
     {'form': RedisAssetForm, 'model': RedisAsset},
     {'form': MantiumAssetForm, 'model': MantiumAsset},
     {'form': PineconeAssetForm, 'model': PineconeAsset},
+    {'form': APIEndpointAssetForm, 'model': APIEndpointAsset},
 ]
 
 

chirps/asset/migrations/0003_apiendpointasset.py

@@ -0,0 +1,50 @@
+# Generated by Django 4.2.3 on 2023-08-21 13:22
+
+import django.db.models.deletion
+import fernet_fields.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('asset', '0002_alter_pineconeasset_api_key'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='APIEndpointAsset',
+            fields=[
+                (
+                    'baseasset_ptr',
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to='asset.baseasset',
+                    ),
+                ),
+                ('url', models.URLField(max_length=2048)),
+                (
+                    'authentication_method',
+                    models.CharField(
+                        choices=[('Basic', 'Basic'), ('Bearer', 'Bearer')],
+                        default='Bearer',
+                        max_length=10,
+                    ),
+                ),
+                ('api_key', fernet_fields.fields.EncryptedCharField(max_length=256)),
+                ('headers', models.JSONField(blank=True, null=True)),
+                (
+                    'body',
+                    models.JSONField(blank=True, default={'data': '%query%'}, null=True),
+                ),
+            ],
+            options={
+                'abstract': False,
+                'base_manager_name': 'objects',
+            },
+            bases=('asset.baseasset',),
+        ),
+    ]

chirps/asset/providers/api_endpoint.py

@@ -0,0 +1,54 @@
+"""Logic for interfacing with an API Endpoint Asset."""
+from logging import getLogger
+
+from asset.models import BaseAsset, PingResult, SearchResult
+from django.db import models
+from fernet_fields import EncryptedCharField
+
+logger = getLogger(__name__)
+
+
+class APIEndpointAsset(BaseAsset):
+    """Implementation of an API Endpoint asset."""
+
+    url = models.URLField(max_length=2048, blank=False, null=False)
+    authentication_method = models.CharField(
+        max_length=10, choices=[('Basic', 'Basic'), ('Bearer', 'Bearer')], default='Bearer'
+    )
+    api_key = EncryptedCharField(max_length=256, editable=True)
+    headers = models.JSONField(blank=True, null=True)
+    body = models.JSONField(blank=True, null=True, default={'data': '%query%'})
+
+    # Name of the file in the ./asset/static/ directory to use as a logo
+    html_logo = 'asset/api-endpoint-logo.svg'
+    html_name = 'API Endpoint'
+    html_description = 'Generic API Endpoint Asset'
+
+    HAS_PING = True
+
+    @property
+    def decrypted_api_key(self):
+        """Return the decrypted API key."""
+        if self.api_key is not None:
+            try:
+                decrypted_value = self.api_key
+                masked_value = decrypted_value[:4] + '*' * (len(decrypted_value) - 4)
+                return masked_value
+            except UnicodeDecodeError:
+                return 'Error: Decryption failed'
+        return None
+
+    def search(self, query: str, max_results: int) -> list[SearchResult]:
+        """Search the API Endpoint asset with the specified query."""
+        raise NotImplementedError('The search method is not implemented for this asset.')
+
+    def test_connection(self) -> PingResult:
+        """Ensure that the API Endpoint asset can be connected to."""
+        raise NotImplementedError('The test_connection method is not implemented for this asset.')
+
+    def displayable_attributes(self):
+        """Display a subset of the model's attributes"""
+        return [
+            {'label': 'URL', 'value': self.url},
+            {'label': 'Authentication Method', 'value': self.authentication_method},
+        ]

chirps/asset/providers/mantium.py

@@ -34,3 +34,7 @@ def search(self, query: str, max_results: int) -> list[SearchResult]:
         documents = [SearchResult(data=doc['content']) for doc in results['documents']]
         logger.debug('Mantium asset search complete', extra={'id': self.id})
         return documents
+
+    def displayable_attributes(self):
+        """Display a subset of the model's attributes"""
+        return [{'label': 'Application ID', 'value': self.app_id}]

chirps/asset/providers/pinecone.py

@@ -21,7 +21,7 @@ class PineconeAsset(BaseAsset):
     embedding_model_service = models.CharField(max_length=256, default='OpenAI')
 
     # Name of the file in the ./asset/static/ directory to use as a logo
-    html_logo = 'asset/pinecone-logo.png'
+    html_logo = 'asset/pinecone-logo.svg'
     html_name = 'Pinecone'
     html_description = 'Pinecone Vector Database'
 
@@ -67,3 +67,12 @@ def test_connection(self) -> PingResult:
         except pinecone_lib.core.client.exceptions.UnauthorizedException as err:
             logger.error('Pinecone connection test failed', extra={'error': err.body})
             return PingResult(success=False, error=err.body)
+
+    def displayable_attributes(self):
+        """Display a subset of the model's attributes"""
+        return [
+            {'label': 'API Key', 'value': self.decrypted_api_key},
+            {'label': 'Environment', 'value': self.environment},
+            {'label': 'Index Name', 'value': self.index_name},
+            {'label': 'Project Name', 'value': self.project_name},
+        ]

chirps/asset/providers/redis.py

@@ -26,7 +26,7 @@ class RedisAsset(BaseAsset):
     embedding_model_service = models.CharField(max_length=256, default='OpenAI')
 
     # Name of the file in the ./asset/static/ directory to use as a logo
-    html_logo = 'asset/redis-logo.png'
+    html_logo = 'asset/redis-logo.svg'
     html_name = 'Redis'
     html_description = 'Redis Vector Database'
 
@@ -106,3 +106,12 @@ def test_connection(self) -> PingResult:
         except exceptions.ConnectionError as err:
             client.close()
             return PingResult(success=False, error=str(err))
+
+    def displayable_attributes(self):
+        """Display a subset of the model's attributes"""
+        return [
+            {'label': 'Host', 'value': self.host},
+            {'label': 'Port', 'value': self.port},
+            {'label': 'Database Name', 'value': self.database_name},
+            {'label': 'Username', 'value': self.username},
+        ]