KnowledgeBaseWebReference Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0

public final class KnowledgeBaseWebReference
extends KnowledgeBaseReference

Represents a web document reference.

Method Summary

Modifier and Type Method and Description
static KnowledgeBaseWebReference fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseWebReference from the JsonReader.
String getTitle()

Get the title property: The title of the web document.
KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.
String getUrl()

Get the url property: The url the reference data originated from.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from KnowledgeBaseReference

fromJson getActivitySource getId getRerankerScore getSourceData getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static KnowledgeBaseWebReference fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseWebReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeBaseWebReference if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getTitle

public String getTitle()

Get the title property: The title of the web document.

Returns:

the title value.

getType

public KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.

Overrides:

KnowledgeBaseWebReference.getType()

Returns:

the type value.

getUrl

public String getUrl()

Get the url property: The url the reference data originated from.

Returns:

the url value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KnowledgeBaseWebReference.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to