Class KnowledgeBaseWebActivityRecord

java.lang.Object

com.azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord

com.azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalActivityRecord

com.azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityRecord

All Implemented Interfaces:

com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>

public final class KnowledgeBaseWebActivityRecord
extends KnowledgeBaseRetrievalActivityRecord

Represents a web retrieval activity record.

Constructor Summary

Constructors

Constructor	Description
KnowledgeBaseWebActivityRecord(int id)	Creates an instance of KnowledgeBaseWebActivityRecord class.

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseWebActivityRecord	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of KnowledgeBaseWebActivityRecord from the JsonReader.
String	getType()	Get the type property: The type of the activity record.
KnowledgeBaseWebActivityArguments	getWebArguments()	Get the webArguments property: The web arguments for the retrieval activity.
KnowledgeBaseWebActivityRecord	setCount(Integer count)	Set the count property: The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
KnowledgeBaseWebActivityRecord	setElapsedMs(Integer elapsedMs)	Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
KnowledgeBaseWebActivityRecord	setError(KnowledgeBaseErrorDetail error)	Set the error property: The error detail explaining why the operation failed.
KnowledgeBaseWebActivityRecord	setKnowledgeSourceName(String knowledgeSourceName)	Set the knowledgeSourceName property: The knowledge source for the retrieval activity.
KnowledgeBaseWebActivityRecord	setQueryTime(OffsetDateTime queryTime)	Set the queryTime property: The query time for this retrieval activity.
KnowledgeBaseWebActivityRecord	setWebArguments(KnowledgeBaseWebActivityArguments webArguments)	Set the webArguments property: The web arguments for the retrieval activity.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class KnowledgeBaseRetrievalActivityRecord

getCount, getKnowledgeSourceName, getQueryTime

Methods inherited from class KnowledgeBaseActivityRecord

getElapsedMs, getError, getId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

KnowledgeBaseWebActivityRecord

public KnowledgeBaseWebActivityRecord(int id)

Creates an instance of KnowledgeBaseWebActivityRecord class.

Parameters:

id - the id value to set.

Method Details

getType

public String getType()

Get the type property: The type of the activity record.

Overrides:

getType in class KnowledgeBaseRetrievalActivityRecord

Returns:

the type value.

getWebArguments

public KnowledgeBaseWebActivityArguments getWebArguments()

Get the webArguments property: The web arguments for the retrieval activity.

Returns:

the webArguments value.

setWebArguments

public KnowledgeBaseWebActivityRecord setWebArguments(KnowledgeBaseWebActivityArguments webArguments)

Set the webArguments property: The web arguments for the retrieval activity.

Parameters:

webArguments - the webArguments value to set.

Returns:

the KnowledgeBaseWebActivityRecord object itself.

setKnowledgeSourceName

public KnowledgeBaseWebActivityRecord setKnowledgeSourceName(String knowledgeSourceName)

Set the knowledgeSourceName property: The knowledge source for the retrieval activity.

Overrides:

setKnowledgeSourceName in class KnowledgeBaseRetrievalActivityRecord

Parameters:

knowledgeSourceName - the knowledgeSourceName value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setQueryTime

public KnowledgeBaseWebActivityRecord setQueryTime(OffsetDateTime queryTime)

Set the queryTime property: The query time for this retrieval activity.

Overrides:

setQueryTime in class KnowledgeBaseRetrievalActivityRecord

Parameters:

queryTime - the queryTime value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setCount

public KnowledgeBaseWebActivityRecord setCount(Integer count)

Set the count property: The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.

Overrides:

setCount in class KnowledgeBaseRetrievalActivityRecord

Parameters:

count - the count value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setElapsedMs

public KnowledgeBaseWebActivityRecord setElapsedMs(Integer elapsedMs)

Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.

Overrides:

setElapsedMs in class KnowledgeBaseRetrievalActivityRecord

Parameters:

elapsedMs - the elapsedMs value to set.

Returns:

the KnowledgeBaseActivityRecord object itself.

setError

public KnowledgeBaseWebActivityRecord setError(KnowledgeBaseErrorDetail error)

Set the error property: The error detail explaining why the operation failed. This property is only included when the activity does not succeed.

Overrides:

setError in class KnowledgeBaseRetrievalActivityRecord

Parameters:

error - the error value to set.

Returns:

the KnowledgeBaseActivityRecord object itself.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>

Overrides:

toJson in class KnowledgeBaseRetrievalActivityRecord

Throws:

IOException

fromJson

public static KnowledgeBaseWebActivityRecord fromJson(com.azure.json.JsonReader jsonReader)
                                               throws IOException

Reads an instance of KnowledgeBaseWebActivityRecord from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

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

IOException - If an error occurs while reading the KnowledgeBaseWebActivityRecord.