AI Portal

​

Availability

​

Purpose

• Unified User Experience: Offer a cohesive interface for accessing all AI capabilities configured within Tyk AI Studio.
• Self-Service Access: Enable users to independently access and utilize AI features without administrator intervention.
• Contextual Documentation: Provide integrated documentation and guidance for available AI services.
• Account Management: Allow users to manage their own profile settings and view usage information.
• Secure Access Control: Enforce permissions based on teams and organizational policies.

​

Key Features

• Chat Interface: Access to all Chat Experiences the user has permission to use, with a clean, intuitive UI for conversational interactions.
• Resource Catalogues: Browse and subscribe to available LLMs, Data Sources, and Tools through dedicated catalogue interfaces.
• Application Management: Create and manage Apps that integrate LLMs, tools, and data sources for API access.
• Documentation Hub: Integrated documentation for available AI services, tools, and data sources.
• User Profile Management: Self-service capabilities for updating profile information and preferences.
• History & Favorites: Access to past chat sessions and ability to bookmark favorite conversations.
• Responsive Design: Optimized for both desktop and mobile devices for consistent access across platforms.
• Customizable Themes: Support for light/dark mode and potentially organization-specific branding.
• Notifications: System alerts and updates relevant to the user’s AI interactions.

​

Using the AI Portal

1. Authentication: Users log in using their credentials (username/password, SSO, or other configured authentication methods).
2. Home Dashboard: Upon login, users see a dashboard with available Chat Experiences and recent activity.
3. Resource Discovery: Users can browse catalogues of available LLMs, Data Sources, and Tools to which they have access.
4. Application Creation: Users can create Apps by selecting and subscribing to the LLMs, tools, and data sources they need.
5. Chat Selection: Users can select from available Chat Experiences to start or continue conversations.
6. Documentation Access: Users can browse integrated documentation to learn about available capabilities.
7. Profile Management: Users can update their profile settings, preferences, and view usage statistics.

​

Configuration (Admin)

• Portal Branding: Customize logos, colors, and themes to match organizational branding.
• Available Features: Enable or disable specific portal features (chat, documentation, etc.).
• Authentication Methods: Configure login options (local accounts, SSO integration, etc.).
• Default Settings: Set system-wide defaults for user experiences.
• Access Control: Manage which teams can access the portal and specific features within it.
• Custom Content: Add organization-specific documentation, welcome messages, or announcements.

​

API Access

• Authentication API: /api/v1/auth/... endpoints for managing user sessions.
• Chat API: /api/v1/chat/... endpoints for programmatic access to chat functionality.
• User Profile API: /api/v1/users/... endpoints for managing user information.
• Datasource API: /datasource/{dsSlug} endpoints for querying configured data sources, generating embeddings, and metadata filtering.

​

Datasource API

​

Text Search

• Endpoint: POST /datasource/{dsSlug}
• Authentication: Bearer token required
• Request Format:
  Copy

  Ask AI

  {
    "query": "your search query here",
    "n": 5  // optional, number of results to return (default: 3)
  }
  
• Response Format:
  Copy

  Ask AI

  {
    "documents": [
      {
        "PageContent": "text content of the document chunk",
        "Metadata": {
          "source": "filename.pdf",
          "page": 42
        },
        "Score": 0.92
      }
    ]
  }
  

​

Vector Search

• Endpoint: POST /datasource/{dsSlug}/vector
• Authentication: Bearer token required
• Request Format:
  Copy

  Ask AI

  {
    "embedding": [0.1, 0.2, 0.3, ...],
    "n": 10,                    // optional, max results (default: 10)
    "similarity_threshold": 0.7  // optional, minimum score filter (default: 0.0)
  }
  
• Response Format:
  Copy

  Ask AI

  {
    "documents": [
      {
        "PageContent": "text content of the document chunk",
        "Metadata": {
          "source": "filename.pdf",
          "page": 42
        },
        "Score": 0.92
      }
    ]
  }
  

​

Metadata Query

• Endpoint: POST /datasource/{dsSlug}/metadata
• Authentication: Bearer token required
• Request Format:
  Copy

  Ask AI

  {
    "filter": {
      "source": "filename.pdf",
      "category": "technical"
    },
    "filter_mode": "AND",  // optional, "AND" or "OR" (default: "AND")
    "limit": 10,           // optional, max results (default: 10, max: 100)
    "offset": 0            // optional, pagination offset (default: 0)
  }
  
• Response Format:
  Copy

  Ask AI

  {
    "documents": [
      {
        "PageContent": "text content of the document chunk",
        "Metadata": {
          "source": "filename.pdf",
          "category": "technical"
        },
        "Score": 0.0
      }
    ],
    "total_count": 42
  }
  

​

Generate Embeddings

• Endpoint: POST /datasource/{dsSlug}/embeddings
• Authentication: Bearer token required
• Request Format:
  Copy

  Ask AI

  {
    "texts": ["first text chunk", "second text chunk"]  // max 100 items
  }
  
• Response Format:
  Copy

  Ask AI

  {
    "vectors": [
      [0.1, 0.2, 0.3, ...],
      [0.4, 0.5, 0.6, ...]
    ]
  }