Show / Hide Table of Contents

Struct ChatDocumentFilterReason

Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.AI.OpenAI.dll
Syntax
[OpenAI.CodeGenType("AzureChatMessageContextAllRetrievedDocumentsFilterReason")]
public struct ChatDocumentFilterReason : IEquatable<Azure.AI.OpenAI.Chat.ChatDocumentFilterReason>

Constructors

ChatDocumentFilterReason(String)

Initializes a new instance of ChatDocumentFilterReason.

Declaration
public ChatDocumentFilterReason (string value);
Parameters
System.String value

The value.

Exceptions
System.ArgumentNullException

value is null.

Properties

Rerank

Gets the Rerank.

Declaration
public static Azure.AI.OpenAI.Chat.ChatDocumentFilterReason Rerank { get; }
Property Value
ChatDocumentFilterReason

Score

Gets the Score.

Declaration
public static Azure.AI.OpenAI.Chat.ChatDocumentFilterReason Score { get; }
Property Value
ChatDocumentFilterReason

Methods

Equals(ChatDocumentFilterReason)

Declaration
public bool Equals (Azure.AI.OpenAI.Chat.ChatDocumentFilterReason other);
Parameters
ChatDocumentFilterReason other

The instance to compare.

Returns
System.Boolean

Equals(Object)

Declaration
[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);
Parameters
System.Object obj

The object to compare.

Returns
System.Boolean

GetHashCode()

Returns the hash code for this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();
Returns
System.Int32

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

Declaration
public override string ToString ();
Returns
System.String

The fully qualified type name.

Operators

Equality(ChatDocumentFilterReason, ChatDocumentFilterReason)

Determines if two ChatDocumentFilterReason values are the same.

Declaration
public static bool operator == (Azure.AI.OpenAI.Chat.ChatDocumentFilterReason left, Azure.AI.OpenAI.Chat.ChatDocumentFilterReason right);
Parameters
ChatDocumentFilterReason left

The left value to compare.

ChatDocumentFilterReason right

The right value to compare.

Returns
System.Boolean

Implicit(String to ChatDocumentFilterReason)

Converts a string to a ChatDocumentFilterReason.

Declaration
public static implicit operator Azure.AI.OpenAI.Chat.ChatDocumentFilterReason (string value);
Parameters
System.String value

The value.

Returns
ChatDocumentFilterReason

Inequality(ChatDocumentFilterReason, ChatDocumentFilterReason)

Determines if two ChatDocumentFilterReason values are not the same.

Declaration
public static bool operator != (Azure.AI.OpenAI.Chat.ChatDocumentFilterReason left, Azure.AI.OpenAI.Chat.ChatDocumentFilterReason right);
Parameters
ChatDocumentFilterReason left

The left value to compare.

ChatDocumentFilterReason right

The right value to compare.

Returns
System.Boolean

Back to top Azure SDK for .NET