Generative AI Hub SDK

Note

This project is under active development.

• Introduction
  • Installation
  • Configuration
    • Environment variables
    • Configuration files
  • Usage
    • Prerequisite
    • Examples
  • Supported Models
    • LLM Models
    • Text Embedding Models
    • Notes on model usage
  • Package dependencies
• Examples
  • Native Client Integrations
    • Completions
      • OpenAI
      • Google Vertex AI
      • Amazon
    • Embeddings
      • OpenAI
      • Amazon
  • Langchain Integration
    • Harmonized Model Initialization
    • LLM
    • Chat model
    • Embeddings
  • Using New Models in Gen AI Hub Before They Are Added to SDK
  • Streaming
    • Native SDKs
      • OpenAI - ChatGPT
      • Google - Gemini
      • Anthropic - Claude
      • Amazon - Titan
    • Langchain
  • Prompt Registry
    • Prerequisite
      • Provide the credentials to authenticate the client and establish a connection with the Prompt Registry API.
      • Step 0: Initialize Client
        • Initialize the client to interact with the Prompt Registry.
      • Step 1: Create Prompt Templates
        • Define the Prompt Template configuration and post to Prompt Registry.
      • Step 2: Retrieve Prompt Templates
        • Retrieve the Prompt Template by ID.
      • Step 3: Modify the Prompt Template
        • We will add an input variable to the existing Prompt Template.
      • Step 4: Prompt Template History
        • Retrieve the history of Prompt Templates by id.
      • Step 5: Fill Prompt Template
        • Fill the variables in the Prompt Template.
  • Orchestration Service
    • Prerequisite
    • Authentication
    • Basic Orchestration Pipeline
      • Step 1: Define the Template and Default Input Values
        • Referencing Templates in the Prompt Registry
        • Overview of response_format Parameter Options
      • Step 2: Define the LLM
      • Step 3: Create the Orchestration Configuration
      • Step 4: Run the Orchestration Request
    • Understanding Deployment Resolution
      • Default Behavior
      • Direct Deployment Specification
      • Config-Based Specification
    • Optional Modules
      • Data Masking
        • Masking Types
        • Configuration Options
      • Content Filtering
    • Streaming
    • Advanced Examples
      • Translation Service
      • Chatbot with Memory
      • Sentiment Analysis with Few Shot Learning
    • Async Support
  • Document Grounding
    • Prerequisites
    • Configuration of the Grounding Module
      • Create the configuration
        • Grounding configuration for searching SAP Help via elastic search
        • Grounding configuration for searching a custom data repository
        • One can also show the retrieved context from the grounding module, which is added to the prompt for improving the response.
        • Data Masking of the retrieved context
• Release Notes
  • 4.10.2
    • Features
  • 4.4.3
    • Features
  • 4.3.1
    • Features
    • Bugfixes
  • 4.1.1
    • Features
    • Bugfixes
  • 4.0.0
    • Breaking Changes
    • Features
  • 3.8.0
    • Features
  • 3.2.6
    • Features
    • Bugfixes
  • 3.1.1
    • Features
  • 3.1.0
    • Breaking Changes
    • Features