Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions src/Weaviate.Client.Tests/Unit/TestVectorizers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -413,4 +413,87 @@ public void Test_Multi2VecGoogleGemini_Serializes_AudioFields_WeightedFields()
Assert.Contains("\"textFields\"", json);
Assert.Contains("\"videoFields\"", json);
}

/// <summary>
/// Tests that Text2VecDigitalOcean serializes baseURL and model correctly under the
/// <c>text2vec-digitalocean</c> module key.
/// </summary>
[Fact]
[System.Diagnostics.CodeAnalysis.SuppressMessage(
"Performance",
"CA1869:Cache and reuse 'JsonSerializerOptions' instances",
Justification = "<Pending>"
)]
public void Test_Text2VecDigitalOcean_Serializes_BaseURL_And_Model()
{
// Arrange
var vc = Configure.Vector(
"default",
v =>
v.Text2VecDigitalOcean(
model: "qwen3-embedding-0.6b",
baseURL: "https://inference.do-ai.run",
vectorizeCollectionName: false
)
);

// Act
var dto = vc.Vectorizer?.ToDto() ?? default;
var json = JsonSerializer.Serialize(
dto,
new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
WriteIndented = false,
}
);

// Assert
Assert.Contains("\"text2vec-digitalocean\"", json);
Assert.Contains("\"baseURL\":\"https://inference.do-ai.run\"", json);
Assert.Contains("\"model\":\"qwen3-embedding-0.6b\"", json);
Assert.Contains("\"vectorizeClassName\":false", json);
}

/// <summary>
/// Tests that Text2VecDigitalOcean omits unset optional fields so the server can apply
/// its defaults (no <c>baseURL</c>). <c>model</c> is required by the factory so it is
/// always present.
/// </summary>
[Fact]
[System.Diagnostics.CodeAnalysis.SuppressMessage(
"Performance",
"CA1869:Cache and reuse 'JsonSerializerOptions' instances",
Justification = "<Pending>"
)]
public void Test_Text2VecDigitalOcean_Omits_Unset_BaseURL()
{
// Arrange
var vc = Configure.Vector(
"default",
v => v.Text2VecDigitalOcean(model: "qwen3-embedding-0.6b")
);

// Act
var dto = vc.Vectorizer?.ToDto() ?? default;
var json = JsonSerializer.Serialize(
dto,
new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
DefaultIgnoreCondition = System
.Text
.Json
.Serialization
.JsonIgnoreCondition
.WhenWritingNull,
WriteIndented = false,
}
);

// Assert
Assert.Contains("\"text2vec-digitalocean\"", json);
Assert.Contains("\"model\":\"qwen3-embedding-0.6b\"", json);
Assert.DoesNotContain("\"baseURL\"", json);
}
}
21 changes: 21 additions & 0 deletions src/Weaviate.Client/Configure/VectorizerFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -750,6 +750,27 @@ public VectorizerConfig Text2VecMistral(
VectorizeCollectionName = vectorizeCollectionName,
};

/// <summary>
/// Creates a configuration for the <c>text2vec-digitalocean</c> vectorizer.
/// See the <a href="https://weaviate.io/developers/weaviate/model-providers/digitalocean/embeddings">documentation</a>
/// for detailed usage.
/// </summary>
/// <param name="model">The model to use, e.g. <c>qwen3-embedding-0.6b</c>. Required by the server.</param>
/// <param name="baseURL">The base URL where API requests should go. Defaults to <c>null</c>, which uses the server-defined default of <c>https://inference.do-ai.run</c>.</param>
/// <param name="vectorizeCollectionName">Whether to vectorize the collection name.</param>
/// <returns>The vectorizer config</returns>
public VectorizerConfig Text2VecDigitalOcean(
string model,
string? baseURL = null,
bool? vectorizeCollectionName = null
) =>
new Text2VecDigitalOcean
{
BaseURL = baseURL,
Model = model,
VectorizeCollectionName = vectorizeCollectionName,
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't we get rid of this parameter? 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not officially. It's in pretty much every vectorizer config, also in Java and Typescript.

Python is the only client that has definitely removed it by making it no-op.

};

/// <summary>
/// Texts the 2 vec model 2 vec using the specified inference url
/// </summary>
Expand Down
33 changes: 33 additions & 0 deletions src/Weaviate.Client/Models/Vectorizer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1064,6 +1064,39 @@ internal Text2VecMistral() { }
public bool? VectorizeCollectionName { get; set; } = null;
}

/// <summary>
/// The configuration for text vectorization using the DigitalOcean module.
/// See the <a href="https://weaviate.io/developers/weaviate/model-providers/digitalocean/embeddings">documentation</a>
/// for detailed usage.
/// </summary>
[Vectorizer("text2vec-digitalocean")]
public record Text2VecDigitalOcean : VectorizerConfig
{
/// <summary>
/// Initializes a new instance of the <see cref="Text2VecDigitalOcean"/> class
/// </summary>
[JsonConstructor]
internal Text2VecDigitalOcean() { }

/// <summary>
/// Gets or sets the base URL where API requests should go.
/// Defaults to <c>null</c>, which uses the server-defined default of <c>https://inference.do-ai.run</c>.
/// </summary>
[JsonPropertyName("baseURL")]
public string? BaseURL { get; set; } = null;

/// <summary>
/// Gets or sets the model to use, e.g. <c>qwen3-embedding-0.6b</c>. Required by the server.
/// </summary>
public string? Model { get; set; } = null;

/// <summary>
/// Gets or sets the value of the vectorize collection name
/// </summary>
[JsonPropertyName("vectorizeClassName")]
public bool? VectorizeCollectionName { get; set; } = null;
}

/// <summary>
/// The configuration for text vectorization using the Model2Vec module.
/// See the documentation for detailed usage.
Expand Down
19 changes: 19 additions & 0 deletions src/Weaviate.Client/PublicAPI.Unshipped.txt
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
#nullable enable
override sealed Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Equals(Weaviate.Client.Models.VectorizerConfig? other) -> bool
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.<Clone>$() -> Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean!
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.EqualityContract.get -> System.Type!
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Equals(object? obj) -> bool
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.GetHashCode() -> int
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.PrintMembers(System.Text.StringBuilder! builder) -> bool
override Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.ToString() -> string!
static Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.operator !=(Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean? left, Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean? right) -> bool
static Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.operator ==(Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean? left, Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean? right) -> bool
virtual Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Equals(Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean? other) -> bool
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.BaseURL.get -> string?
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.BaseURL.set -> void
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Model.get -> string?
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Model.set -> void
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.Text2VecDigitalOcean(Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean! original) -> void
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.VectorizeCollectionName.get -> bool?
Weaviate.Client.Models.Vectorizer.Text2VecDigitalOcean.VectorizeCollectionName.set -> void
Weaviate.Client.VectorizerFactory.Text2VecDigitalOcean(string! model, string? baseURL = null, bool? vectorizeCollectionName = null) -> Weaviate.Client.Models.VectorizerConfig!
Loading