@azure/search-documents/dist/esm/models/azure/search/documents/knowledgeBases/models.js

Azure client library to use AI Search for node.js and browser.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import { searchIndexerDataIdentityUnionSerializer, searchIndexerDataIdentityUnionDeserializer, azureOpenAIVectorizerParametersSerializer, azureOpenAIVectorizerParametersDeserializer, knowledgeBaseModelUnionSerializer, knowledgeBaseModelUnionDeserializer, indexingScheduleSerializer, indexingScheduleDeserializer, } from "../indexes/models.js";
export function knowledgeSourceIngestionParametersSerializer(item) {
    return {
        identity: !item["identity"]
            ? item["identity"]
            : searchIndexerDataIdentityUnionSerializer(item["identity"]),
        embeddingModel: !item["embeddingModel"]
            ? item["embeddingModel"]
            : knowledgeSourceVectorizerUnionSerializer(item["embeddingModel"]),
        chatCompletionModel: !item["chatCompletionModel"]
            ? item["chatCompletionModel"]
            : knowledgeBaseModelUnionSerializer(item["chatCompletionModel"]),
        disableImageVerbalization: item["disableImageVerbalization"],
        ingestionSchedule: !item["ingestionSchedule"]
            ? item["ingestionSchedule"]
            : indexingScheduleSerializer(item["ingestionSchedule"]),
        contentExtractionMode: item["contentExtractionMode"],
        aiServices: !item["aiServices"] ? item["aiServices"] : aiServicesSerializer(item["aiServices"]),
    };
}
export function knowledgeSourceIngestionParametersDeserializer(item) {
    return {
        identity: !item["identity"]
            ? item["identity"]
            : searchIndexerDataIdentityUnionDeserializer(item["identity"]),
        embeddingModel: !item["embeddingModel"]
            ? item["embeddingModel"]
            : knowledgeSourceVectorizerUnionDeserializer(item["embeddingModel"]),
        chatCompletionModel: !item["chatCompletionModel"]
            ? item["chatCompletionModel"]
            : knowledgeBaseModelUnionDeserializer(item["chatCompletionModel"]),
        disableImageVerbalization: item["disableImageVerbalization"],
        ingestionSchedule: !item["ingestionSchedule"]
            ? item["ingestionSchedule"]
            : indexingScheduleDeserializer(item["ingestionSchedule"]),
        contentExtractionMode: item["contentExtractionMode"],
        aiServices: !item["aiServices"]
            ? item["aiServices"]
            : aiServicesDeserializer(item["aiServices"]),
    };
}
export function knowledgeSourceVectorizerSerializer(item) {
    return { kind: item["kind"] };
}
export function knowledgeSourceVectorizerDeserializer(item) {
    return {
        kind: item["kind"],
    };
}
export function knowledgeSourceVectorizerUnionSerializer(item) {
    switch (item.kind) {
        case "azureOpenAI":
            return knowledgeSourceAzureOpenAIVectorizerSerializer(item);
        default:
            return knowledgeSourceVectorizerSerializer(item);
    }
}
export function knowledgeSourceVectorizerUnionDeserializer(item) {
    switch (item["kind"]) {
        case "azureOpenAI":
            return knowledgeSourceAzureOpenAIVectorizerDeserializer(item);
        default:
            return knowledgeSourceVectorizerDeserializer(item);
    }
}
export function knowledgeSourceAzureOpenAIVectorizerSerializer(item) {
    return {
        kind: item["kind"],
        azureOpenAIParameters: !item["azureOpenAIParameters"]
            ? item["azureOpenAIParameters"]
            : azureOpenAIVectorizerParametersSerializer(item["azureOpenAIParameters"]),
    };
}
export function knowledgeSourceAzureOpenAIVectorizerDeserializer(item) {
    return {
        kind: item["kind"],
        azureOpenAIParameters: !item["azureOpenAIParameters"]
            ? item["azureOpenAIParameters"]
            : azureOpenAIVectorizerParametersDeserializer(item["azureOpenAIParameters"]),
    };
}
export function aiServicesSerializer(item) {
    return { uri: item["uri"], apiKey: item["apiKey"] };
}
export function aiServicesDeserializer(item) {
    return {
        uri: item["uri"],
        apiKey: item["apiKey"],
    };
}
export function knowledgeSourceStatusSerializer(item) {
    return {
        kind: item["kind"],
        synchronizationStatus: item["synchronizationStatus"],
        synchronizationInterval: item["synchronizationInterval"],
        currentSynchronizationState: !item["currentSynchronizationState"]
            ? item["currentSynchronizationState"]
            : synchronizationStateSerializer(item["currentSynchronizationState"]),
        lastSynchronizationState: !item["lastSynchronizationState"]
            ? item["lastSynchronizationState"]
            : completedSynchronizationStateSerializer(item["lastSynchronizationState"]),
        statistics: !item["statistics"]
            ? item["statistics"]
            : knowledgeSourceStatisticsSerializer(item["statistics"]),
    };
}
export function knowledgeSourceStatusDeserializer(item) {
    return {
        kind: item["kind"],
        synchronizationStatus: item["synchronizationStatus"],
        synchronizationInterval: item["synchronizationInterval"],
        currentSynchronizationState: !item["currentSynchronizationState"]
            ? item["currentSynchronizationState"]
            : synchronizationStateDeserializer(item["currentSynchronizationState"]),
        lastSynchronizationState: !item["lastSynchronizationState"]
            ? item["lastSynchronizationState"]
            : completedSynchronizationStateDeserializer(item["lastSynchronizationState"]),
        statistics: !item["statistics"]
            ? item["statistics"]
            : knowledgeSourceStatisticsDeserializer(item["statistics"]),
    };
}
export function synchronizationStateSerializer(item) {
    return {
        startTime: item["startTime"].toISOString(),
        itemsUpdatesProcessed: item["itemsUpdatesProcessed"],
        itemsUpdatesFailed: item["itemsUpdatesFailed"],
        itemsSkipped: item["itemsSkipped"],
        errors: !item["errors"]
            ? item["errors"]
            : knowledgeSourceSynchronizationErrorArraySerializer(item["errors"]),
    };
}
export function synchronizationStateDeserializer(item) {
    return {
        startTime: new Date(item["startTime"]),
        itemsUpdatesProcessed: item["itemsUpdatesProcessed"],
        itemsUpdatesFailed: item["itemsUpdatesFailed"],
        itemsSkipped: item["itemsSkipped"],
        errors: !item["errors"]
            ? item["errors"]
            : knowledgeSourceSynchronizationErrorArrayDeserializer(item["errors"]),
    };
}
export function knowledgeSourceSynchronizationErrorArraySerializer(result) {
    return result.map((item) => {
        return knowledgeSourceSynchronizationErrorSerializer(item);
    });
}
export function knowledgeSourceSynchronizationErrorArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeSourceSynchronizationErrorDeserializer(item);
    });
}
export function knowledgeSourceSynchronizationErrorSerializer(item) {
    return {
        docId: item["docId"],
        statusCode: item["statusCode"],
        name: item["name"],
        errorMessage: item["errorMessage"],
        details: item["details"],
        documentationLink: item["documentationLink"],
    };
}
export function knowledgeSourceSynchronizationErrorDeserializer(item) {
    return {
        docId: item["docId"],
        statusCode: item["statusCode"],
        name: item["name"],
        errorMessage: item["errorMessage"],
        details: item["details"],
        documentationLink: item["documentationLink"],
    };
}
export function completedSynchronizationStateSerializer(item) {
    return {
        startTime: item["startTime"].toISOString(),
        endTime: item["endTime"].toISOString(),
        itemsUpdatesProcessed: item["itemsUpdatesProcessed"],
        itemsUpdatesFailed: item["itemsUpdatesFailed"],
        itemsSkipped: item["itemsSkipped"],
    };
}
export function completedSynchronizationStateDeserializer(item) {
    return {
        startTime: new Date(item["startTime"]),
        endTime: new Date(item["endTime"]),
        itemsUpdatesProcessed: item["itemsUpdatesProcessed"],
        itemsUpdatesFailed: item["itemsUpdatesFailed"],
        itemsSkipped: item["itemsSkipped"],
    };
}
export function knowledgeSourceStatisticsSerializer(item) {
    return {
        totalSynchronization: item["totalSynchronizations"],
        averageSynchronizationDuration: item["averageSynchronizationDuration"],
        averageItemsProcessedPerSynchronization: item["averageItemsProcessedPerSynchronization"],
    };
}
export function knowledgeSourceStatisticsDeserializer(item) {
    return {
        totalSynchronizations: item["totalSynchronization"],
        averageSynchronizationDuration: item["averageSynchronizationDuration"],
        averageItemsProcessedPerSynchronization: item["averageItemsProcessedPerSynchronization"],
    };
}
export function knowledgeBaseRetrievalRequestSerializer(item) {
    return {
        intents: !item["intents"]
            ? item["intents"]
            : knowledgeRetrievalIntentUnionArraySerializer(item["intents"]),
        maxRuntimeInSeconds: item["maxRuntimeInSeconds"],
        maxOutputSizeInTokens: item["maxOutputSizeInTokens"],
        includeActivity: item["includeActivity"],
        knowledgeSourceParams: !item["knowledgeSourceParams"]
            ? item["knowledgeSourceParams"]
            : knowledgeSourceParamsUnionArraySerializer(item["knowledgeSourceParams"]),
    };
}
export function knowledgeRetrievalIntentUnionArraySerializer(result) {
    return result.map((item) => {
        return knowledgeRetrievalIntentUnionSerializer(item);
    });
}
export function knowledgeRetrievalIntentSerializer(item) {
    return { type: item["type"] };
}
export function knowledgeRetrievalIntentUnionSerializer(item) {
    switch (item.type) {
        case "semantic":
            return knowledgeRetrievalSemanticIntentSerializer(item);
        default:
            return knowledgeRetrievalIntentSerializer(item);
    }
}
/** The kind of knowledge base configuration to use. */
export var KnownKnowledgeRetrievalIntentType;
(function (KnownKnowledgeRetrievalIntentType) {
    /** A natural language semantic query intent. */
    KnownKnowledgeRetrievalIntentType["Semantic"] = "semantic";
})(KnownKnowledgeRetrievalIntentType || (KnownKnowledgeRetrievalIntentType = {}));
export function knowledgeRetrievalSemanticIntentSerializer(item) {
    return { type: item["type"], search: item["search"] };
}
export function knowledgeSourceParamsUnionArraySerializer(result) {
    return result.map((item) => {
        return knowledgeSourceParamsUnionSerializer(item);
    });
}
export function knowledgeSourceParamsSerializer(item) {
    return {
        knowledgeSourceName: item["knowledgeSourceName"],
        includeReferences: item["includeReferences"],
        includeReferenceSourceData: item["includeReferenceSourceData"],
        rerankerThreshold: item["rerankerThreshold"],
        kind: item["kind"],
    };
}
export function knowledgeSourceParamsUnionSerializer(item) {
    switch (item.kind) {
        case "searchIndex":
            return searchIndexKnowledgeSourceParamsSerializer(item);
        case "azureBlob":
            return azureBlobKnowledgeSourceParamsSerializer(item);
        case "indexedOneLake":
            return indexedOneLakeKnowledgeSourceParamsSerializer(item);
        case "web":
            return webKnowledgeSourceParamsSerializer(item);
        default:
            return knowledgeSourceParamsSerializer(item);
    }
}
export function searchIndexKnowledgeSourceParamsSerializer(item) {
    return {
        knowledgeSourceName: item["knowledgeSourceName"],
        includeReferences: item["includeReferences"],
        includeReferenceSourceData: item["includeReferenceSourceData"],
        rerankerThreshold: item["rerankerThreshold"],
        kind: item["kind"],
        filterAddOn: item["filterAddOn"],
    };
}
export function azureBlobKnowledgeSourceParamsSerializer(item) {
    return {
        knowledgeSourceName: item["knowledgeSourceName"],
        includeReferences: item["includeReferences"],
        includeReferenceSourceData: item["includeReferenceSourceData"],
        rerankerThreshold: item["rerankerThreshold"],
        kind: item["kind"],
    };
}
export function indexedOneLakeKnowledgeSourceParamsSerializer(item) {
    return {
        knowledgeSourceName: item["knowledgeSourceName"],
        includeReferences: item["includeReferences"],
        includeReferenceSourceData: item["includeReferenceSourceData"],
        rerankerThreshold: item["rerankerThreshold"],
        kind: item["kind"],
    };
}
export function webKnowledgeSourceParamsSerializer(item) {
    return {
        knowledgeSourceName: item["knowledgeSourceName"],
        includeReferences: item["includeReferences"],
        includeReferenceSourceData: item["includeReferenceSourceData"],
        rerankerThreshold: item["rerankerThreshold"],
        kind: item["kind"],
        language: item["language"],
        market: item["market"],
        count: item["count"],
        freshness: item["freshness"],
    };
}
export function knowledgeBaseRetrievalResponseDeserializer(item) {
    return {
        response: !item["response"]
            ? item["response"]
            : knowledgeBaseMessageArrayDeserializer(item["response"]),
        activity: !item["activity"]
            ? item["activity"]
            : knowledgeBaseActivityRecordUnionArrayDeserializer(item["activity"]),
        references: !item["references"]
            ? item["references"]
            : knowledgeBaseReferenceUnionArrayDeserializer(item["references"]),
    };
}
export function knowledgeBaseMessageArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseMessageDeserializer(item);
    });
}
export function knowledgeBaseMessageDeserializer(item) {
    return {
        role: item["role"],
        content: knowledgeBaseMessageContentUnionArrayDeserializer(item["content"]),
    };
}
export function knowledgeBaseMessageContentUnionArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseMessageContentUnionDeserializer(item);
    });
}
export function knowledgeBaseMessageContentDeserializer(item) {
    return {
        type: item["type"],
    };
}
export function knowledgeBaseMessageContentUnionDeserializer(item) {
    switch (item["type"]) {
        case "text":
            return knowledgeBaseMessageTextContentDeserializer(item);
        case "image":
            return knowledgeBaseMessageImageContentDeserializer(item);
        default:
            return knowledgeBaseMessageContentDeserializer(item);
    }
}
/** The type of message content. */
export var KnownKnowledgeBaseMessageContentType;
(function (KnownKnowledgeBaseMessageContentType) {
    /** Text message content kind. */
    KnownKnowledgeBaseMessageContentType["Text"] = "text";
    /** Image message content kind. */
    KnownKnowledgeBaseMessageContentType["Image"] = "image";
})(KnownKnowledgeBaseMessageContentType || (KnownKnowledgeBaseMessageContentType = {}));
export function knowledgeBaseMessageTextContentDeserializer(item) {
    return {
        type: item["type"],
        text: item["text"],
    };
}
export function knowledgeBaseMessageImageContentDeserializer(item) {
    return {
        type: item["type"],
        image: knowledgeBaseImageContentDeserializer(item["image"]),
    };
}
export function knowledgeBaseImageContentDeserializer(item) {
    return {
        url: item["url"],
    };
}
export function knowledgeBaseActivityRecordUnionArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseActivityRecordUnionDeserializer(item);
    });
}
export function knowledgeBaseActivityRecordDeserializer(item) {
    return {
        id: item["id"],
        type: item["type"],
        elapsedInMs: item["elapsedInMs"],
        error: !item["error"] ? item["error"] : knowledgeBaseErrorDetailDeserializer(item["error"]),
    };
}
export function knowledgeBaseActivityRecordUnionDeserializer(item) {
    switch (item["type"]) {
        case "modelWebSummarization":
            return knowledgeBaseModelWebSummarizationActivityRecordDeserializer(item);
        case "agenticReasoning":
            return knowledgeBaseAgenticReasoningActivityRecordDeserializer(item);
        default:
            return knowledgeBaseActivityRecordDeserializer(item);
    }
}
/** The type of activity record. */
export var KnownKnowledgeBaseActivityRecordType;
(function (KnownKnowledgeBaseActivityRecordType) {
    /** Search index retrieval activity. */
    KnownKnowledgeBaseActivityRecordType["SearchIndex"] = "searchIndex";
    /** Azure Blob retrieval activity. */
    KnownKnowledgeBaseActivityRecordType["AzureBlob"] = "azureBlob";
    /** Indexed OneLake retrieval activity. */
    KnownKnowledgeBaseActivityRecordType["IndexedOneLake"] = "indexedOneLake";
    /** Web retrieval activity. */
    KnownKnowledgeBaseActivityRecordType["Web"] = "web";
    /** LLM web summarization activity. */
    KnownKnowledgeBaseActivityRecordType["ModelWebSummarization"] = "modelWebSummarization";
    /** Agentic reasoning activity. */
    KnownKnowledgeBaseActivityRecordType["AgenticReasoning"] = "agenticReasoning";
})(KnownKnowledgeBaseActivityRecordType || (KnownKnowledgeBaseActivityRecordType = {}));
export function knowledgeBaseErrorDetailDeserializer(item) {
    return {
        code: item["code"],
        message: item["message"],
        target: item["target"],
        details: !item["details"]
            ? item["details"]
            : knowledgeBaseErrorDetailArrayDeserializer(item["details"]),
        additionalInfo: !item["additionalInfo"]
            ? item["additionalInfo"]
            : knowledgeBaseErrorAdditionalInfoArrayDeserializer(item["additionalInfo"]),
    };
}
export function knowledgeBaseErrorDetailArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseErrorDetailDeserializer(item);
    });
}
export function knowledgeBaseErrorAdditionalInfoArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseErrorAdditionalInfoDeserializer(item);
    });
}
export function knowledgeBaseErrorAdditionalInfoDeserializer(item) {
    return {
        type: item["type"],
        info: !item["info"]
            ? item["info"]
            : Object.fromEntries(Object.entries(item["info"]).map(([k, p]) => [k, p])),
    };
}
export function knowledgeBaseModelWebSummarizationActivityRecordDeserializer(item) {
    return {
        id: item["id"],
        type: item["type"],
        elapsedInMs: item["elapsedInMs"],
        error: !item["error"] ? item["error"] : knowledgeBaseErrorDetailDeserializer(item["error"]),
        inputTokensCount: item["inputTokens"],
        outputTokensCount: item["outputTokens"],
    };
}
export function knowledgeBaseAgenticReasoningActivityRecordDeserializer(item) {
    return {
        id: item["id"],
        type: item["type"],
        elapsedInMs: item["elapsedInMs"],
        error: !item["error"] ? item["error"] : knowledgeBaseErrorDetailDeserializer(item["error"]),
        reasoningTokens: item["reasoningTokens"],
        retrievalReasoningEffort: !item["retrievalReasoningEffort"]
            ? item["retrievalReasoningEffort"]
            : knowledgeRetrievalReasoningEffortUnionDeserializer(item["retrievalReasoningEffort"]),
    };
}
export function knowledgeRetrievalReasoningEffortDeserializer(item) {
    return {
        kind: item["kind"],
    };
}
export function knowledgeRetrievalReasoningEffortUnionDeserializer(item) {
    switch (item["kind"]) {
        case "minimal":
            return knowledgeRetrievalMinimalReasoningEffortDeserializer(item);
        default:
            return knowledgeRetrievalReasoningEffortDeserializer(item);
    }
}
/** The amount of effort to use during retrieval. */
export var KnownKnowledgeRetrievalReasoningEffortKind;
(function (KnownKnowledgeRetrievalReasoningEffortKind) {
    /** Does not perform any source selections, query planning, or iterative search. */
    KnownKnowledgeRetrievalReasoningEffortKind["Minimal"] = "minimal";
})(KnownKnowledgeRetrievalReasoningEffortKind || (KnownKnowledgeRetrievalReasoningEffortKind = {}));
export function knowledgeRetrievalMinimalReasoningEffortDeserializer(item) {
    return {
        kind: item["kind"],
    };
}
export function knowledgeBaseReferenceUnionArrayDeserializer(result) {
    return result.map((item) => {
        return knowledgeBaseReferenceUnionDeserializer(item);
    });
}
export function knowledgeBaseReferenceDeserializer(item) {
    return {
        type: item["type"],
        id: item["id"],
        activitySource: item["activitySource"],
        sourceData: !item["sourceData"]
            ? item["sourceData"]
            : Object.fromEntries(Object.entries(item["sourceData"]).map(([k, p]) => [k, p])),
        rerankerScore: item["rerankerScore"],
    };
}
export function knowledgeBaseReferenceUnionDeserializer(item) {
    switch (item["type"]) {
        case "searchIndex":
            return knowledgeBaseSearchIndexReferenceDeserializer(item);
        case "azureBlob":
            return knowledgeBaseAzureBlobReferenceDeserializer(item);
        case "indexedOneLake":
            return knowledgeBaseIndexedOneLakeReferenceDeserializer(item);
        case "web":
            return knowledgeBaseWebReferenceDeserializer(item);
        default:
            return knowledgeBaseReferenceDeserializer(item);
    }
}
/** The type of reference. */
export var KnownKnowledgeBaseReferenceType;
(function (KnownKnowledgeBaseReferenceType) {
    /** Search index document reference. */
    KnownKnowledgeBaseReferenceType["SearchIndex"] = "searchIndex";
    /** Azure Blob document reference. */
    KnownKnowledgeBaseReferenceType["AzureBlob"] = "azureBlob";
    /** Indexed OneLake document reference. */
    KnownKnowledgeBaseReferenceType["IndexedOneLake"] = "indexedOneLake";
    /** Web document reference. */
    KnownKnowledgeBaseReferenceType["Web"] = "web";
})(KnownKnowledgeBaseReferenceType || (KnownKnowledgeBaseReferenceType = {}));
export function knowledgeBaseSearchIndexReferenceDeserializer(item) {
    return {
        type: item["type"],
        id: item["id"],
        activitySource: item["activitySource"],
        sourceData: !item["sourceData"]
            ? item["sourceData"]
            : Object.fromEntries(Object.entries(item["sourceData"]).map(([k, p]) => [k, p])),
        rerankerScore: item["rerankerScore"],
        docKey: item["docKey"],
    };
}
export function knowledgeBaseAzureBlobReferenceDeserializer(item) {
    return {
        type: item["type"],
        id: item["id"],
        activitySource: item["activitySource"],
        sourceData: !item["sourceData"]
            ? item["sourceData"]
            : Object.fromEntries(Object.entries(item["sourceData"]).map(([k, p]) => [k, p])),
        rerankerScore: item["rerankerScore"],
        blobUrl: item["blobUrl"],
    };
}
export function knowledgeBaseIndexedOneLakeReferenceDeserializer(item) {
    return {
        type: item["type"],
        id: item["id"],
        activitySource: item["activitySource"],
        sourceData: !item["sourceData"]
            ? item["sourceData"]
            : Object.fromEntries(Object.entries(item["sourceData"]).map(([k, p]) => [k, p])),
        rerankerScore: item["rerankerScore"],
        docUrl: item["docUrl"],
    };
}
export function knowledgeBaseWebReferenceDeserializer(item) {
    return {
        type: item["type"],
        id: item["id"],
        activitySource: item["activitySource"],
        sourceData: !item["sourceData"]
            ? item["sourceData"]
            : Object.fromEntries(Object.entries(item["sourceData"]).map(([k, p]) => [k, p])),
        rerankerScore: item["rerankerScore"],
        url: item["url"],
        title: item["title"],
    };
}
//# sourceMappingURL=models.js.map