## API Report File for "@azure/search-documents"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

// @public
export interface AIServices {
    apiKey?: string;
    uri: string;
}

// @public
export interface AzureBlobKnowledgeSourceParams extends KnowledgeSourceParams {
    kind: "azureBlob";
}

// @public
export interface CompletedSynchronizationState {
    endTime: Date;
    itemsSkipped: number;
    itemsUpdatesFailed: number;
    itemsUpdatesProcessed: number;
    startTime: Date;
}

// @public
export interface IndexedOneLakeKnowledgeSourceParams extends KnowledgeSourceParams {
    kind: "indexedOneLake";
}

// @public
export interface KnowledgeBaseActivityRecord {
    elapsedInMs?: number;
    error?: KnowledgeBaseErrorDetail;
    id: number;
    type: KnowledgeBaseActivityRecordType;
}

// @public
export type KnowledgeBaseActivityRecordType = string;

// @public
export type KnowledgeBaseActivityRecordUnion = KnowledgeBaseModelWebSummarizationActivityRecord | KnowledgeBaseAgenticReasoningActivityRecord | KnowledgeBaseActivityRecord;

// @public
export interface KnowledgeBaseAgenticReasoningActivityRecord extends KnowledgeBaseActivityRecord {
    reasoningTokens?: number;
    retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
    type: "agenticReasoning";
}

// @public
export interface KnowledgeBaseAzureBlobReference extends KnowledgeBaseReference {
    blobUrl?: string;
    type: "azureBlob";
}

// @public
export interface KnowledgeBaseErrorAdditionalInfo {
    readonly info?: Record<string, unknown>;
    readonly type?: string;
}

// @public
export interface KnowledgeBaseErrorDetail {
    readonly additionalInfo?: KnowledgeBaseErrorAdditionalInfo[];
    readonly code?: string;
    readonly details?: KnowledgeBaseErrorDetail[];
    readonly message?: string;
    readonly target?: string;
}

// @public
export interface KnowledgeBaseImageContent {
    url: string;
}

// @public
export interface KnowledgeBaseIndexedOneLakeReference extends KnowledgeBaseReference {
    docUrl?: string;
    type: "indexedOneLake";
}

// @public
export interface KnowledgeBaseMessage {
    content: KnowledgeBaseMessageContentUnion[];
    role?: string;
}

// @public
export interface KnowledgeBaseMessageContent {
    type: KnowledgeBaseMessageContentType;
}

// @public
export type KnowledgeBaseMessageContentType = string;

// @public
export type KnowledgeBaseMessageContentUnion = KnowledgeBaseMessageTextContent | KnowledgeBaseMessageImageContent | KnowledgeBaseMessageContent;

// @public
export interface KnowledgeBaseMessageImageContent extends KnowledgeBaseMessageContent {
    image: KnowledgeBaseImageContent;
    type: "image";
}

// @public
export interface KnowledgeBaseMessageTextContent extends KnowledgeBaseMessageContent {
    text: string;
    type: "text";
}

// @public
export interface KnowledgeBaseModelWebSummarizationActivityRecord extends KnowledgeBaseActivityRecord {
    inputTokensCount?: number;
    outputTokensCount?: number;
    type: "modelWebSummarization";
}

// @public
export interface KnowledgeBaseReference {
    activitySource: number;
    id: string;
    rerankerScore?: number;
    sourceData?: Record<string, unknown>;
    type: KnowledgeBaseReferenceType;
}

// @public
export type KnowledgeBaseReferenceType = string;

// @public
export type KnowledgeBaseReferenceUnion = KnowledgeBaseSearchIndexReference | KnowledgeBaseAzureBlobReference | KnowledgeBaseIndexedOneLakeReference | KnowledgeBaseWebReference | KnowledgeBaseReference;

// @public
export interface KnowledgeBaseRetrievalRequest {
    includeActivity?: boolean;
    intents?: KnowledgeRetrievalIntentUnion[];
    knowledgeSourceParams?: KnowledgeSourceParamsUnion[];
    maxOutputSizeInTokens?: number;
    maxRuntimeInSeconds?: number;
}

// @public
export interface KnowledgeBaseRetrievalResponse {
    activity?: KnowledgeBaseActivityRecordUnion[];
    references?: KnowledgeBaseReferenceUnion[];
    response?: KnowledgeBaseMessage[];
}

// @public
export interface KnowledgeBaseSearchIndexReference extends KnowledgeBaseReference {
    docKey?: string;
    type: "searchIndex";
}

// @public
export interface KnowledgeBaseWebReference extends KnowledgeBaseReference {
    title?: string;
    type: "web";
    url?: string;
}

// @public
export interface KnowledgeRetrievalIntent {
    type: KnowledgeRetrievalIntentType;
}

// @public
export type KnowledgeRetrievalIntentType = string;

// @public
export type KnowledgeRetrievalIntentUnion = KnowledgeRetrievalSemanticIntent | KnowledgeRetrievalIntent;

// @public
export interface KnowledgeRetrievalMinimalReasoningEffort extends KnowledgeRetrievalReasoningEffort {
    kind: "minimal";
}

// @public
export interface KnowledgeRetrievalReasoningEffort {
    kind: KnowledgeRetrievalReasoningEffortKind;
}

// @public
export type KnowledgeRetrievalReasoningEffortKind = string;

// @public
export type KnowledgeRetrievalReasoningEffortUnion = KnowledgeRetrievalMinimalReasoningEffort | KnowledgeRetrievalReasoningEffort;

// @public
export interface KnowledgeRetrievalSemanticIntent extends KnowledgeRetrievalIntent {
    search: string;
    type: "semantic";
}

// @public
export interface KnowledgeSourceAzureOpenAIVectorizer extends KnowledgeSourceVectorizer {
    azureOpenAIParameters?: AzureOpenAIVectorizerParameters;
    kind: "azureOpenAI";
}

// @public
export interface KnowledgeSourceIngestionParameters {
    aiServices?: AIServices;
    chatCompletionModel?: KnowledgeBaseModelUnion;
    contentExtractionMode?: KnowledgeSourceContentExtractionMode;
    disableImageVerbalization?: boolean;
    embeddingModel?: KnowledgeSourceVectorizerUnion;
    identity?: SearchIndexerDataIdentityUnion;
    ingestionSchedule?: IndexingSchedule;
}

// @public
export interface KnowledgeSourceParams {
    includeReferences?: boolean;
    includeReferenceSourceData?: boolean;
    kind: KnowledgeSourceKind;
    knowledgeSourceName: string;
    rerankerThreshold?: number;
}

// @public
export type KnowledgeSourceParamsUnion = SearchIndexKnowledgeSourceParams | AzureBlobKnowledgeSourceParams | IndexedOneLakeKnowledgeSourceParams | WebKnowledgeSourceParams | KnowledgeSourceParams;

// @public
export interface KnowledgeSourceStatistics {
    averageItemsProcessedPerSynchronization: number;
    averageSynchronizationDuration: string;
    totalSynchronizations: number;
}

// @public
export interface KnowledgeSourceStatus {
    currentSynchronizationState?: SynchronizationState;
    kind?: KnowledgeSourceKind;
    lastSynchronizationState?: CompletedSynchronizationState;
    statistics?: KnowledgeSourceStatistics;
    synchronizationInterval?: string;
    synchronizationStatus: KnowledgeSourceSynchronizationStatus;
}

// @public
export interface KnowledgeSourceSynchronizationError {
    details?: string;
    docId?: string;
    documentationLink?: string;
    errorMessage: string;
    name?: string;
    statusCode?: number;
}

// @public
export interface KnowledgeSourceVectorizer {
    kind: VectorSearchVectorizerKind;
}

// @public
export type KnowledgeSourceVectorizerUnion = KnowledgeSourceAzureOpenAIVectorizer | KnowledgeSourceVectorizer;

// @public
export enum KnownKnowledgeBaseActivityRecordType {
    AgenticReasoning = "agenticReasoning",
    AzureBlob = "azureBlob",
    IndexedOneLake = "indexedOneLake",
    ModelWebSummarization = "modelWebSummarization",
    SearchIndex = "searchIndex",
    Web = "web"
}

// @public
export enum KnownKnowledgeBaseMessageContentType {
    Image = "image",
    Text = "text"
}

// @public
export enum KnownKnowledgeBaseReferenceType {
    AzureBlob = "azureBlob",
    IndexedOneLake = "indexedOneLake",
    SearchIndex = "searchIndex",
    Web = "web"
}

// @public
export enum KnownKnowledgeRetrievalIntentType {
    Semantic = "semantic"
}

// @public
export enum KnownKnowledgeRetrievalReasoningEffortKind {
    Minimal = "minimal"
}

// @public
export interface SearchIndexKnowledgeSourceParams extends KnowledgeSourceParams {
    filterAddOn?: string;
    kind: "searchIndex";
}

// @public
export interface SynchronizationState {
    errors?: KnowledgeSourceSynchronizationError[];
    itemsSkipped: number;
    itemsUpdatesFailed: number;
    itemsUpdatesProcessed: number;
    startTime: Date;
}

// @public
export interface WebKnowledgeSourceParams extends KnowledgeSourceParams {
    count?: number;
    freshness?: string;
    kind: "web";
    language?: string;
    market?: string;
}

// (No @packageDocumentation comment for this package)

```