Skip to content

Fix TextExpansionQuery definition #7864

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
Jul 31, 2023
Merged

Fix TextExpansionQuery definition #7864

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
200 changes: 145 additions & 55 deletions src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,30 +27,108 @@

namespace Elastic.Clients.Elasticsearch.QueryDsl;

internal sealed partial class TextExpansionQueryConverter : JsonConverter<TextExpansionQuery>
{
public override TextExpansionQuery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
if (reader.TokenType != JsonTokenType.StartObject)
throw new JsonException("Unexpected JSON detected.");
reader.Read();
var fieldName = reader.GetString();
reader.Read();
var variant = new TextExpansionQuery(fieldName);
while (reader.Read() && reader.TokenType != JsonTokenType.EndObject)
{
if (reader.TokenType == JsonTokenType.PropertyName)
{
var property = reader.GetString();
if (property == "_name")
{
variant.QueryName = JsonSerializer.Deserialize<string?>(ref reader, options);
continue;
}

if (property == "boost")
{
variant.Boost = JsonSerializer.Deserialize<float?>(ref reader, options);
continue;
}

if (property == "model_id")
{
variant.ModelId = JsonSerializer.Deserialize<string>(ref reader, options);
continue;
}

if (property == "model_text")
{
variant.ModelText = JsonSerializer.Deserialize<string>(ref reader, options);
continue;
}
}
}

reader.Read();
return variant;
}

public override void Write(Utf8JsonWriter writer, TextExpansionQuery value, JsonSerializerOptions options)
{
if (value.Field is null)
throw new JsonException("Unable to serialize TextExpansionQuery because the `Field` property is not set. Field name queries must include a valid field name.");
if (options.TryGetClientSettings(out var settings))
{
writer.WriteStartObject();
writer.WritePropertyName(settings.Inferrer.Field(value.Field));
writer.WriteStartObject();
if (!string.IsNullOrEmpty(value.QueryName))
{
writer.WritePropertyName("_name");
writer.WriteStringValue(value.QueryName);
}

if (value.Boost.HasValue)
{
writer.WritePropertyName("boost");
writer.WriteNumberValue(value.Boost.Value);
}

writer.WritePropertyName("model_id");
writer.WriteStringValue(value.ModelId);
writer.WritePropertyName("model_text");
writer.WriteStringValue(value.ModelText);
writer.WriteEndObject();
writer.WriteEndObject();
return;
}

throw new JsonException("Unable to retrieve client settings required to infer field.");
}
}

[JsonConverter(typeof(TextExpansionQueryConverter))]
public sealed partial class TextExpansionQuery : SearchQuery
{
[JsonInclude, JsonPropertyName("_name")]
public TextExpansionQuery(Field field)
{
if (field is null)
throw new ArgumentNullException(nameof(field));
Field = field;
}

public string? QueryName { get; set; }
[JsonInclude, JsonPropertyName("boost")]
public float? Boost { get; set; }

/// <summary>
/// <para>The text expansion NLP model to use</para>
/// </summary>
[JsonInclude, JsonPropertyName("model_id")]
public string ModelId { get; set; }

/// <summary>
/// <para>The query text</para>
/// </summary>
[JsonInclude, JsonPropertyName("model_text")]
public string ModelText { get; set; }

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// </summary>
[JsonInclude, JsonPropertyName("value")]
public Elastic.Clients.Elasticsearch.Field Value { get; set; }
public Elastic.Clients.Elasticsearch.Field Field { get; set; }

public static implicit operator Query(TextExpansionQuery textExpansionQuery) => QueryDsl.Query.TextExpansion(textExpansionQuery);

Expand All @@ -61,15 +139,29 @@ public sealed partial class TextExpansionQueryDescriptor<TDocument> : Serializab
{
internal TextExpansionQueryDescriptor(Action<TextExpansionQueryDescriptor<TDocument>> configure) => configure.Invoke(this);

public TextExpansionQueryDescriptor() : base()
internal TextExpansionQueryDescriptor() : base()
{
}

public TextExpansionQueryDescriptor(Field field)
{
if (field is null)
throw new ArgumentNullException(nameof(field));
FieldValue = field;
}

public TextExpansionQueryDescriptor(Expression<Func<TDocument, object>> field)
{
if (field is null)
throw new ArgumentNullException(nameof(field));
FieldValue = field;
}

private string? QueryNameValue { get; set; }
private float? BoostValue { get; set; }
private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; }
private string ModelIdValue { get; set; }
private string ModelTextValue { get; set; }
private Elastic.Clients.Elasticsearch.Field ValueValue { get; set; }

public TextExpansionQueryDescriptor<TDocument> QueryName(string? queryName)
{
Expand All @@ -83,44 +175,42 @@ public TextExpansionQueryDescriptor<TDocument> Boost(float? boost)
return Self;
}

/// <summary>
/// <para>The text expansion NLP model to use</para>
/// </summary>
public TextExpansionQueryDescriptor<TDocument> ModelId(string modelId)
public TextExpansionQueryDescriptor<TDocument> Field(Elastic.Clients.Elasticsearch.Field field)
{
ModelIdValue = modelId;
FieldValue = field;
return Self;
}

/// <summary>
/// <para>The query text</para>
/// </summary>
public TextExpansionQueryDescriptor<TDocument> ModelText(string modelText)
public TextExpansionQueryDescriptor<TDocument> Field<TValue>(Expression<Func<TDocument, TValue>> field)
{
ModelTextValue = modelText;
FieldValue = field;
return Self;
}

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// <para>The text expansion NLP model to use</para>
/// </summary>
public TextExpansionQueryDescriptor<TDocument> Value(Elastic.Clients.Elasticsearch.Field value)
public TextExpansionQueryDescriptor<TDocument> ModelId(string modelId)
{
ValueValue = value;
ModelIdValue = modelId;
return Self;
}

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// <para>The query text</para>
/// </summary>
public TextExpansionQueryDescriptor<TDocument> Value<TValue>(Expression<Func<TDocument, TValue>> value)
public TextExpansionQueryDescriptor<TDocument> ModelText(string modelText)
{
ValueValue = value;
ModelTextValue = modelText;
return Self;
}

protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings)
{
if (FieldValue is null)
throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument.");
writer.WriteStartObject();
writer.WritePropertyName(settings.Inferrer.Field(FieldValue));
writer.WriteStartObject();
if (!string.IsNullOrEmpty(QueryNameValue))
{
Expand All @@ -138,8 +228,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
writer.WriteStringValue(ModelIdValue);
writer.WritePropertyName("model_text");
writer.WriteStringValue(ModelTextValue);
writer.WritePropertyName("value");
JsonSerializer.Serialize(writer, ValueValue, options);
writer.WriteEndObject();
writer.WriteEndObject();
}
}
Expand All @@ -148,15 +237,22 @@ public sealed partial class TextExpansionQueryDescriptor : SerializableDescripto
{
internal TextExpansionQueryDescriptor(Action<TextExpansionQueryDescriptor> configure) => configure.Invoke(this);

public TextExpansionQueryDescriptor() : base()
internal TextExpansionQueryDescriptor() : base()
{
}

public TextExpansionQueryDescriptor(Field field)
{
if (field is null)
throw new ArgumentNullException(nameof(field));
FieldValue = field;
}

private string? QueryNameValue { get; set; }
private float? BoostValue { get; set; }
private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; }
private string ModelIdValue { get; set; }
private string ModelTextValue { get; set; }
private Elastic.Clients.Elasticsearch.Field ValueValue { get; set; }

public TextExpansionQueryDescriptor QueryName(string? queryName)
{
Expand All @@ -170,53 +266,48 @@ public TextExpansionQueryDescriptor Boost(float? boost)
return Self;
}

/// <summary>
/// <para>The text expansion NLP model to use</para>
/// </summary>
public TextExpansionQueryDescriptor ModelId(string modelId)
public TextExpansionQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field)
{
ModelIdValue = modelId;
FieldValue = field;
return Self;
}

/// <summary>
/// <para>The query text</para>
/// </summary>
public TextExpansionQueryDescriptor ModelText(string modelText)
public TextExpansionQueryDescriptor Field<TDocument, TValue>(Expression<Func<TDocument, TValue>> field)
{
ModelTextValue = modelText;
FieldValue = field;
return Self;
}

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// </summary>
public TextExpansionQueryDescriptor Value(Elastic.Clients.Elasticsearch.Field value)
public TextExpansionQueryDescriptor Field<TDocument>(Expression<Func<TDocument, object>> field)
{
ValueValue = value;
FieldValue = field;
return Self;
}

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// <para>The text expansion NLP model to use</para>
/// </summary>
public TextExpansionQueryDescriptor Value<TDocument, TValue>(Expression<Func<TDocument, TValue>> value)
public TextExpansionQueryDescriptor ModelId(string modelId)
{
ValueValue = value;
ModelIdValue = modelId;
return Self;
}

/// <summary>
/// <para>The name of the rank features field to search against</para>
/// <para>The query text</para>
/// </summary>
public TextExpansionQueryDescriptor Value<TDocument>(Expression<Func<TDocument, object>> value)
public TextExpansionQueryDescriptor ModelText(string modelText)
{
ValueValue = value;
ModelTextValue = modelText;
return Self;
}

protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings)
{
if (FieldValue is null)
throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument.");
writer.WriteStartObject();
writer.WritePropertyName(settings.Inferrer.Field(FieldValue));
writer.WriteStartObject();
if (!string.IsNullOrEmpty(QueryNameValue))
{
Expand All @@ -234,8 +325,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
writer.WriteStringValue(ModelIdValue);
writer.WritePropertyName("model_text");
writer.WriteStringValue(ModelTextValue);
writer.WritePropertyName("value");
JsonSerializer.Serialize(writer, ValueValue, options);
writer.WriteEndObject();
writer.WriteEndObject();
}
}