ComparisonFilter Class

Definition

Namespace:: Azure.AI.AgentServer.Responses.Models

Assembly:: Azure.AI.AgentServer.Responses.dll

Package:: Azure.AI.AgentServer.Responses v1.0.0-beta.3

Source:: ComparisonFilter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Comparison Filter.

public class ComparisonFilter : System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ComparisonFilter>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ComparisonFilter>

type ComparisonFilter = class
    interface IJsonModel<ComparisonFilter>
    interface IPersistableModel<ComparisonFilter>

Public Class ComparisonFilter
Implements IJsonModel(Of ComparisonFilter), IPersistableModel(Of ComparisonFilter)

Inheritance: Object
ComparisonFilter

Implements: IJsonModel<ComparisonFilter> IPersistableModel<ComparisonFilter> IPersistableModel<T>

Constructors

Name	Description
ComparisonFilter(ComparisonFilterType, String, BinaryData)	Initializes a new instance of ComparisonFilter.

Properties

Name Description

Name	Description
Key	The key to compare against the value.
Type	Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. `eq`: equals `ne`: not equal `gt`: greater than `gte`: greater than or equal `lt`: less than `lte`: less than or equal `in`: in `nin`: not in
Value	The value to compare against the attribute key; supports string, number, or boolean types. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types: String. Double. Boolean. IList<T> where `T` is of type BinaryData. </remarks> Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Key

The key to compare against the value.

Type

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

`eq`: equals
`ne`: not equal
`gt`: greater than
`gte`: greater than or equal
`lt`: less than
`lte`: less than or equal
`in`: in
`nin`: not in

Value

The value to compare against the attribute key; supports string, number, or boolean types.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

String.
Double.
Boolean.
IList<T> where T is of type BinaryData.

</remarks>

Examples:

BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<ComparisonFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ComparisonFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ComparisonFilter>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ComparisonFilter>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ComparisonFilter>.Write(ModelReaderWriterOptions)

Applies to

Feedback

Was this page helpful?