SearchIndexKnowledgeSourceFilterHint Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.2

Source:

SearchIndexKnowledgeSourceFilterHint.cs

A hint that identifies a field and representative values the query planner can use when constructing a filter.

public class SearchIndexKnowledgeSourceFilterHint : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceFilterHint>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceFilterHint>

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

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

Inheritance

Object

SearchIndexKnowledgeSourceFilterHint

Implements

IJsonModel<SearchIndexKnowledgeSourceFilterHint> IPersistableModel<SearchIndexKnowledgeSourceFilterHint> IPersistableModel<T>

Constructors

Name	Description
SearchIndexKnowledgeSourceFilterHint(String, IEnumerable<String>)	Initializes a new instance of SearchIndexKnowledgeSourceFilterHint.

Properties

Name	Description
Field	The name of the filterable search index field.
FieldValues	Representative values for the field.
FilterInstructions	Natural-language instructions that explain when and how to filter on the field.

Methods

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

Explicit Interface Implementations

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