KnowledgeBaseWebReference Class

Definition

Namespace:
Azure.Search.Documents.KnowledgeBases.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
KnowledgeBaseWebReference.cs
Source:
KnowledgeBaseWebReference.cs

Represents a web document reference.

public class KnowledgeBaseWebReference : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseWebReference>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseWebReference>
type KnowledgeBaseWebReference = class
    inherit KnowledgeBaseReference
    interface IJsonModel<KnowledgeBaseWebReference>
    interface IPersistableModel<KnowledgeBaseWebReference>
Public Class KnowledgeBaseWebReference
Inherits KnowledgeBaseReference
Implements IJsonModel(Of KnowledgeBaseWebReference), IPersistableModel(Of KnowledgeBaseWebReference)
Inheritance
Object
KnowledgeBaseReference
KnowledgeBaseWebReference
Implements
IJsonModel<KnowledgeBaseWebReference> IPersistableModel<KnowledgeBaseWebReference> IPersistableModel<T>

Properties

Name Description
ActivitySource

The source activity ID for the reference.

(Inherited from KnowledgeBaseReference)
Id

The ID of the reference.

(Inherited from KnowledgeBaseReference)
RerankerScore

The reranker score for the document reference.

(Inherited from KnowledgeBaseReference)
SourceData

The source data for the reference.

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

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

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" }.

(Inherited from KnowledgeBaseReference)
Title

The title of the web document.
Url

The url the reference data originated from.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeBaseReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from KnowledgeBaseReference)
IJsonModel<KnowledgeBaseReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeBaseReference)
IJsonModel<KnowledgeBaseWebReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KnowledgeBaseWebReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<KnowledgeBaseReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseWebReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<KnowledgeBaseWebReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KnowledgeBaseWebReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to