Codeunit 4596 SOA Broader Item Search

Sales Order Agent, Microsoft.Agent.SalesOrderAgent

src/Apps/W1/SalesOrderAgent/app/src/ItemSearch/SOABroaderItemSearch.Codeunit.al213 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------#pragma warning disable AS0007namespace Microsoft.Agent.SalesOrderAgent;using Microsoft.Inventory.Item;using System.AI;codeunit 4596 "SOA Broader Item Search"{    Access = Internal;    InherentEntitlements = X;    InherentPermissions = X;    internal procedure BroaderItemSearch(var ItemFilter: Text; SearchFilter: Text)    var        DummyCandidateArray: JsonArray;    begin        BroaderItemSearch(ItemFilter, SearchFilter, DummyCandidateArray);    end;    internal procedure BroaderItemSearch(var ItemFilter: Text; SearchFilter: Text; var CandidateArray: JsonArray)    var        BroaderItemSearchFunc: Codeunit "SOA Broader Item Search Func";        ExtractedItemEntities: JsonArray;        SearchQuery: Text;        IncludeSynonyms: Boolean;        UseContextAwareRanking: Boolean;        MaximumQueryResultsToRank: Integer;        Top: Integer;    begin        if AICall(BroaderItemSearchFunc, BuildBroaderItemSearchSystemPrompt(), ItemFilter, SearchFilter) then begin            BroaderItemSearchFunc.GetBroaderSearchResults(ItemFilter, CandidateArray);            BroaderItemSearchFunc.GetSearchParameters(ExtractedItemEntities, SearchQuery, IncludeSynonyms, UseContextAwareRanking, MaximumQueryResultsToRank, Top);            OnAfterBroaderSearchLog(ItemFilter, ExtractedItemEntities, SearchQuery, IncludeSynonyms, UseContextAwareRanking, MaximumQueryResultsToRank, Top);        end;    end;    [NonDebuggable]    [TryFunction]    local procedure AICall(var BroaderItemSearchFunc: Codeunit "SOA Broader Item Search Func"; SystemPromptTxt: SecretText; var ItemFilter: Text; SearchFilter: Text)    var        AzureOpenAI: Codeunit "Azure OpenAi";        AOAIDeployments: Codeunit "AOAI Deployments";        AOAIOperationResponse: Codeunit "AOAI Operation Response";        AOAIFunctionResponse: Codeunit "AOAI Function Response";        AOAIChatCompletionParams: Codeunit "AOAI Chat Completion Params";        AOAIChatMessages: Codeunit "AOAI Chat Messages";        CompletionAnswer: Text;    begin        // Generate OpenAI Completion        AzureOpenAI.SetAuthorization(Enum::"AOAI Model Type"::"Chat Completions", AOAIDeployments.GetGPT56CeresLatest());        AzureOpenAI.SetCopilotCapability(Enum::"Copilot Capability"::"Sales Order Agent");        AOAIChatCompletionParams.SetMaxTokens(MaxTokens());        AOAIChatCompletionParams.SetTemperature(0);        BroaderItemSearchFunc.SetSearchQuery(SearchFilter);        AOAIChatMessages.AddTool(BroaderItemSearchFunc);        AOAIChatMessages.SetPrimarySystemMessage(SystemPromptTxt);        AOAIChatMessages.AddUserMessage(SearchFilter);        AzureOpenAI.GenerateChatCompletion(AOAIChatMessages, AOAIChatCompletionParams, AOAIOperationResponse);        if AOAIOperationResponse.IsSuccess() then begin            CompletionAnswer := AOAIOperationResponse.GetResult();            if AOAIOperationResponse.IsFunctionCall() then                foreach AOAIFunctionResponse in AOAIOperationResponse.GetFunctionResponses() do                    ItemFilter := BroaderItemSearchFunc.Execute(AOAIFunctionResponse.GetArguments());        end;    end;    [NonDebuggable]    local procedure BuildBroaderItemSearchSystemPrompt(): SecretText    var        SOAInstructions: Codeunit "SOA Instructions";        BroaderItemSearchSystemPrompt: SecretText;    begin        BroaderItemSearchSystemPrompt := SOAInstructions.GetBroaderItemSearchSystemPrompt();        exit(BroaderItemSearchSystemPrompt);    end;    [TryFunction]    internal procedure SearchBroader(ItemResultsArray: JsonArray; SearchQuery: Text; Top: Integer; MaximumQueryResultsToRank: Integer; IncludeSynonyms: Boolean; UseContextAwareRanking: Boolean; var ItemFilter: Text; var CandidateArray: JsonArray)    var        Item: Record "Item";        GlobalItemSearch: Codeunit "Global Item Search";        ItemToken: JsonToken;        SearchAdditionalKeyWords: List of [Text];        SearchPrimaryKeyWords: List of [Text];    begin        GlobalItemSearch.InitializeSearchOptionsObject(IncludeSynonyms, UseContextAwareRanking);        GlobalItemSearch.AddSearchFilter(Item.FieldNo(Blocked), Text.StrSubstNo('<> %1', true));        GlobalItemSearch.AddSearchFilter(Item.FieldNo("Sales Blocked"), Text.StrSubstNo('<> %1', true));        if UseContextAwareRanking then            GlobalItemSearch.AddSearchRankingContext(SearchQuery, '', MaximumQueryResultsToRank);        GlobalItemSearch.SetupSOACapabilityInformation();        //Add Search Queries        ItemResultsArray.Get(0, ItemToken);        SearchPrimaryKeyWords.Add(GetMandatoryKeyword(ItemToken));        GlobalItemSearch.SetupSearchQuery(SearchPrimaryKeyWords.Get(1), SearchPrimaryKeyWords, SearchAdditionalKeyWords, false, Top);        // Search items using platform data search and keep ColumnValues for downstream ranking.        Clear(CandidateArray);        if GlobalItemSearch.SearchAndReturnResultsWithColumnValues(SearchPrimaryKeyWords.Get(1), 0.2, CandidateArray) then            ItemFilter := BuildResultFilterFromCandidates(CandidateArray, '|')        else            ItemFilter := '';    end;    internal procedure BuildResultFilterFromCandidates(CandidateArray: JsonArray; Delimiter: Text): Text    var        CandidateToken: JsonToken;        SystemIdToken: JsonToken;        CandidateObject: JsonObject;        ResultFilter: TextBuilder;    begin        if Delimiter = '' then            Delimiter := '|';        foreach CandidateToken in CandidateArray do begin            CandidateObject := CandidateToken.AsObject();            if CandidateObject.Get('system_id', SystemIdToken) then begin                if ResultFilter.Length() > 0 then                    ResultFilter.Append(Delimiter);                ResultFilter.Append(SystemIdToken.AsValue().AsText());            end;        end;        exit(ResultFilter.ToText());    end;    local procedure GetMandatoryKeyword(ItemObjectToken: JsonToken) SearchKeyword: Text    var        JsonToken: JsonToken;    begin        if ItemObjectToken.AsObject().Get('item_name', JsonToken) then            SearchKeyword := '(' + JsonToken.AsValue().AsText() + AddSynonyms(ItemObjectToken) + AddConcatenatedKeyword(ItemObjectToken) + AddPluralItemName(ItemObjectToken) + GetOptionalKeywords(ItemObjectToken) + ')';    end;    local procedure AddSynonyms(ItemObjectToken: JsonToken): Text    var        JsonToken: JsonToken;        JsonArray: JsonArray;        Synonyms: Text;    begin        if ItemObjectToken.AsObject().Get('synonyms', JsonToken) then begin            JsonArray := JsonToken.AsArray();            foreach JsonToken in JsonArray do                Synonyms += '|' + JsonToken.AsValue().AsText();        end;        exit(Synonyms);    end;    local procedure AddConcatenatedKeyword(ItemObjectToken: JsonToken): Text    var        JsonToken: JsonToken;        ConcatenatedKeyword: Text;    begin        if not ItemObjectToken.AsObject().Get('concatenated_keyword', JsonToken) then            exit('');        if JsonToken.AsValue().IsNull() then            exit('');        ConcatenatedKeyword := JsonToken.AsValue().AsText();        if ConcatenatedKeyword = '' then            exit('');        ConcatenatedKeyword := '|' + ConcatenatedKeyword;        exit(ConcatenatedKeyword);    end;    local procedure AddPluralItemName(ItemObjectToken: JsonToken): Text    var        JsonToken: JsonToken;        PluralItemName: Text;    begin        if ItemObjectToken.AsObject().Get('item_name_plural', JsonToken) then begin            PluralItemName := JsonToken.AsValue().AsText();            if PluralItemName <> '' then                PluralItemName := '|' + PluralItemName;        end;        exit(PluralItemName);    end;    local procedure GetOptionalKeywords(ItemObjectToken: JsonToken): Text    var        JsonToken: JsonToken;        JsonArray: JsonArray;        OptionalKeywords: Text;    begin        if ItemObjectToken.AsObject().Get('features', JsonToken) then begin            JsonArray := JsonToken.AsArray();            foreach JsonToken in JsonArray do                OptionalKeywords += '|' + JsonToken.AsValue().AsText();        end;        exit(OptionalKeywords);    end;    local procedure MaxTokens(): Integer    begin        exit(4096);    end;    [InternalEvent(false, false)]    local procedure OnAfterBroaderSearchLog(ItemFilter: Text; ItemResultsArray: JsonArray; SearchQuery: Text; IncludeSynonyms: Boolean; UseContextAwareRanking: Boolean; MaximumQueryResultsToRank: Integer; Top: Integer)    begin    end;}