-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
QueryAnswerType.cs
51 lines (42 loc) · 3 KB
/
QueryAnswerType.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
49
50
51
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System;
using System.ComponentModel;
namespace Azure.Search.Documents.Models
{
/// <summary> This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. </summary>
public readonly partial struct QueryAnswerType : IEquatable<QueryAnswerType>
{
private readonly string _value;
/// <summary> Initializes a new instance of <see cref="QueryAnswerType"/>. </summary>
/// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
public QueryAnswerType(string value)
{
_value = value ?? throw new ArgumentNullException(nameof(value));
}
private const string NoneValue = "none";
private const string ExtractiveValue = "extractive";
/// <summary> Do not return answers for the query. </summary>
public static QueryAnswerType None { get; } = new QueryAnswerType(NoneValue);
/// <summary> Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. </summary>
public static QueryAnswerType Extractive { get; } = new QueryAnswerType(ExtractiveValue);
/// <summary> Determines if two <see cref="QueryAnswerType"/> values are the same. </summary>
public static bool operator ==(QueryAnswerType left, QueryAnswerType right) => left.Equals(right);
/// <summary> Determines if two <see cref="QueryAnswerType"/> values are not the same. </summary>
public static bool operator !=(QueryAnswerType left, QueryAnswerType right) => !left.Equals(right);
/// <summary> Converts a string to a <see cref="QueryAnswerType"/>. </summary>
public static implicit operator QueryAnswerType(string value) => new QueryAnswerType(value);
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object obj) => obj is QueryAnswerType other && Equals(other);
/// <inheritdoc />
public bool Equals(QueryAnswerType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode() => _value?.GetHashCode() ?? 0;
/// <inheritdoc />
public override string ToString() => _value;
}
}