-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
SemanticErrorMode.cs
51 lines (42 loc) · 2.66 KB
/
SemanticErrorMode.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> Allows the user to choose whether a semantic call should fail completely, or to return partial results. </summary>
public readonly partial struct SemanticErrorMode : IEquatable<SemanticErrorMode>
{
private readonly string _value;
/// <summary> Initializes a new instance of <see cref="SemanticErrorMode"/>. </summary>
/// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
public SemanticErrorMode(string value)
{
_value = value ?? throw new ArgumentNullException(nameof(value));
}
private const string PartialValue = "partial";
private const string FailValue = "fail";
/// <summary> If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. </summary>
public static SemanticErrorMode Partial { get; } = new SemanticErrorMode(PartialValue);
/// <summary> If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error. </summary>
public static SemanticErrorMode Fail { get; } = new SemanticErrorMode(FailValue);
/// <summary> Determines if two <see cref="SemanticErrorMode"/> values are the same. </summary>
public static bool operator ==(SemanticErrorMode left, SemanticErrorMode right) => left.Equals(right);
/// <summary> Determines if two <see cref="SemanticErrorMode"/> values are not the same. </summary>
public static bool operator !=(SemanticErrorMode left, SemanticErrorMode right) => !left.Equals(right);
/// <summary> Converts a string to a <see cref="SemanticErrorMode"/>. </summary>
public static implicit operator SemanticErrorMode(string value) => new SemanticErrorMode(value);
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object obj) => obj is SemanticErrorMode other && Equals(other);
/// <inheritdoc />
public bool Equals(SemanticErrorMode 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;
}
}