Connection String to Google AI

Define a connection string to Google AI

1. Name
   Enter a name for this connection string.

2. Identifier (optional)
   Enter an identifier for this connection string.
   Learn more about the identifier in the connection string identifier section.

3. Connector
   Select Google AI from the dropdown menu.

4. AI Version (optional)

   • Select the Google AI API version to use.
   • If not specified, V1_Beta is used. Learn more in API versions explained.

5. API key
   Enter the API key used to authenticate requests to Google's AI services.

6. Model
   Select or enter the Google AI text embedding model to use.

7. Dimensions (optional)

   • Specify the number of dimensions for the output embeddings.
   • If not specified, the model's default dimensionality is used.

8. Max concurrent query batches: (optional)

   • When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches.
   • This parameter defines the maximum number of these batches that can be processed concurrently.
     You can set a default value using the Ai.Embeddings.MaxConcurrentBatches configuration key.

9. Click Test Connection to confirm the connection string is set up correctly.

10. Click Save to store the connection string or Cancel to discard changes.

using (var store = new DocumentStore())
{
    // Define the connection string to Google AI
    var connectionString = new AiConnectionString
    {
        // Connection string name & identifier
        Name = "ConnectionStringToGoogleAI", 
        Identifier = "identifier-to-the-connection-string", // optional
        
        // Google AI connection settings
        GoogleSettings = new GoogleSettings(
            apiKey: "your-api-key",
            model: "text-embedding-004",
            aiVersion: GoogleAIVersion.V1)
    };
    
    // Optionally, override the default maximum number of query embedding batches
    // that can be processed concurrently 
    connectionString.GoogleSettings.EmbeddingsMaxConcurrentBatches = 10;
    
    // Deploy the connection string to the server
    var operation = new PutConnectionStringOperation<AiConnectionString>(connectionString);
    var putConnectionStringResult = store.Maintenance.Send(operation);
}

public class AiConnectionString
{
    public string Name { get; set; }
    public string Identifier { get; set; }
    public GoogleSettings GoogleSettings { get; set; }
}

public class GoogleSettings : AbstractAiSettings
{
    public string ApiKey { get; set; }
    public string Model { get; set; }
    public GoogleAIVersion? AiVersion { get; set; }
    public int? Dimensions { get; set; }
}

public enum GoogleAIVersion
{
    V1, // Represents the "v1" version of the Google AI API
    V1_Beta // Represents the "v1beta" version of the Google AI API
}

public class AbstractAiSettings
{
    public int? EmbeddingsMaxConcurrentBatches { get; set; }
}