Package version:

Interface BaseKnowledgeBaseRetrievalActivityRecord

Represents a retrieval activity record.

interface BaseKnowledgeBaseRetrievalActivityRecord {
    count?: number;
    elapsedMs?: number;
    error?: KnowledgeBaseErrorDetail;
    id: number;
    knowledgeSourceName?: string;
    queryTime?: any;
    type:
        | "azureBlob"
        | "KnowledgeBaseRetrievalActivityRecord"
        | "searchIndex"
        | "indexedSharePoint"
        | "indexedOneLake"
        | "web"
        | "remoteSharePoint";
}

Hierarchy (view full)

Properties

count? elapsedMs? error? id knowledgeSourceName? queryTime? type

Properties

Optionalcount

count?: number

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

OptionalelapsedMs

elapsedMs?: number

The elapsed time in milliseconds for the retrieval activity.

Optionalerror

error?: KnowledgeBaseErrorDetail

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

id

id: number

The ID of the activity record.

OptionalknowledgeSourceName

knowledgeSourceName?: string

The knowledge source for the retrieval activity.

OptionalqueryTime

queryTime?: any

The query time for this retrieval activity.

type

type:
    | "azureBlob"
    | "KnowledgeBaseRetrievalActivityRecord"
    | "searchIndex"
    | "indexedSharePoint"
    | "indexedOneLake"
    | "web"
    | "remoteSharePoint"

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility