Skip to content

Add Similarity to KnnQuery #7956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2023
Merged

Add Similarity to KnnQuery #7956

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 38 additions & 0 deletions src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnQuery.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ public sealed partial class KnnQuery
/// </summary>
[JsonInclude, JsonPropertyName("query_vector_builder")]
public Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilder { get; set; }

/// <summary>
/// <para>The minimum similarity for a vector to be considered a match</para>
/// </summary>
[JsonInclude, JsonPropertyName("similarity")]
public float? Similarity { get; set; }
}

public sealed partial class KnnQueryDescriptor<TDocument> : SerializableDescriptor<KnnQueryDescriptor<TDocument>>
Expand All @@ -92,6 +98,7 @@ public KnnQueryDescriptor() : base()
private Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilderValue { get; set; }
private QueryVectorBuilderDescriptor QueryVectorBuilderDescriptor { get; set; }
private Action<QueryVectorBuilderDescriptor> QueryVectorBuilderDescriptorAction { get; set; }
private float? SimilarityValue { get; set; }

/// <summary>
/// <para>Filters for the kNN search query</para>
Expand Down Expand Up @@ -213,6 +220,15 @@ public KnnQueryDescriptor<TDocument> QueryVectorBuilder(Action<QueryVectorBuilde
return Self;
}

/// <summary>
/// <para>The minimum similarity for a vector to be considered a match</para>
/// </summary>
public KnnQueryDescriptor<TDocument> Similarity(float? similarity)
{
SimilarityValue = similarity;
return Self;
}

protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings)
{
writer.WriteStartObject();
Expand Down Expand Up @@ -279,6 +295,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
JsonSerializer.Serialize(writer, QueryVectorBuilderValue, options);
}

if (SimilarityValue.HasValue)
{
writer.WritePropertyName("similarity");
writer.WriteNumberValue(SimilarityValue.Value);
}

writer.WriteEndObject();
}
}
Expand All @@ -303,6 +325,7 @@ public KnnQueryDescriptor() : base()
private Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilderValue { get; set; }
private QueryVectorBuilderDescriptor QueryVectorBuilderDescriptor { get; set; }
private Action<QueryVectorBuilderDescriptor> QueryVectorBuilderDescriptorAction { get; set; }
private float? SimilarityValue { get; set; }

/// <summary>
/// <para>Filters for the kNN search query</para>
Expand Down Expand Up @@ -433,6 +456,15 @@ public KnnQueryDescriptor QueryVectorBuilder(Action<QueryVectorBuilderDescriptor
return Self;
}

/// <summary>
/// <para>The minimum similarity for a vector to be considered a match</para>
/// </summary>
public KnnQueryDescriptor Similarity(float? similarity)
{
SimilarityValue = similarity;
return Self;
}

protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings)
{
writer.WriteStartObject();
Expand Down Expand Up @@ -499,6 +531,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
JsonSerializer.Serialize(writer, QueryVectorBuilderValue, options);
}

if (SimilarityValue.HasValue)
{
writer.WritePropertyName("similarity");
writer.WriteNumberValue(SimilarityValue.Value);
}

writer.WriteEndObject();
}
}