/
VectorSearchField.cs
48 lines (42 loc) · 2.24 KB
/
VectorSearchField.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
using System;
namespace Azure.Search.Documents.Indexes.Models
{
/// <summary>
/// A searchable vector field of type "Collection(<see cref="SearchFieldDataType.Single"/>)".
/// </summary>
public class VectorSearchField : SearchFieldTemplate
{
/// <summary>
/// Initializes a new instance of the <see cref="SimpleField"/> class.
/// </summary>
/// <param name="name">The name of the field, which must be unique within the index or parent field.</param>
/// <param name="vectorSearchDimensions">The dimensionality of the vector field.</param>
/// <param name="vectorSearchProfileName">The name of the vector search profile that specifies the algorithm to use when searching the vector field.</param>
/// <exception cref="ArgumentException"><paramref name="name"/> is an empty string.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is null.</exception>
public VectorSearchField(string name, int vectorSearchDimensions, string vectorSearchProfileName) : base(name, SearchFieldDataType.Collection(SearchFieldDataType.Single))
{
VectorSearchDimensions = vectorSearchDimensions;
VectorSearchProfileName = vectorSearchProfileName;
}
/// <summary> The dimensionality of the vector field. </summary>
public int VectorSearchDimensions { get; set; }
/// <summary> The name of the vector search profile that specifies the algorithm to use when searching the vector field. </summary>
public string VectorSearchProfileName { get; set; }
/// <summary>
/// Gets or sets whether the field is returned in search results. The default is false.
/// </summary>
public bool IsHidden { get; set; }
/// <inheritdoc/>
private protected override void Save(SearchField field)
{
// Vector fields are required to be searchable
field.IsSearchable = true;
field.IsHidden = IsHidden;
field.VectorSearchDimensions = VectorSearchDimensions;
field.VectorSearchProfileName = VectorSearchProfileName;
}
}
}