Client Only Tool
client_only_toolFull Description
This tool should only be able to be called by the Widget Resource, and should not be called by the Agent
Parameters
payloadPersonalized finance decisions
Intuit Credit Karma provides 4 tools that can be used to interact with its services.
client_only_toolThis tool should only be able to be called by the Widget Resource, and should not be called by the Agent
payloadcredit_cards.recommendations.listReturns personalized credit card offers for the user. Use this tool when the user wants to find credit cards matching their needs or preferences. Before calling this tool, encourage the user to specify their preferences such as: rewards type (cash back, points, or miles), building credit (secured cards), no annual fee, travel benefits, low interest rates, or other specific features. Just ask for these filters at a high level, don't detail all options explicitly.
categoriesFilterarrayCategory filters for credit card offers
featuresFlagsFilterarrayFeatures filters for credit card offers. Only specify filters that were specifically requested. Do not infer any additional filters.
minimumCreditLimitnumberThe minimum credit limit for filtering credit cards
partnerIdsFilterarrayPartnerId filter for credit card offers
rewardsTypesFilterarrayRewards types filters for credit card offers
credit_score.factors.getReturns the user's current credit score factors with relative importance and the user's rating for each. It also displays the user's current credit score range. Use this when the user asks what they can do to improve their credit score or what is impacting their score. It can also help if the user asks about their credit score.
personal_loans.recommendations.listFetch personalized personal loan offers from vetted lenders via Credit Karma. Use this when the user intends to get a personal loan for a specific purpose (not just learning about loans). If you cannot infer the loan purpose from the conversation, then ask the user to provide it. Before calling the tool, ensure that the user provided the loan amount and their annual income.
annualIncomenumberUser's annual income in dollars. Lenders use income to determine eligibility, interest rates, and whether you can comfortably make loan payments.
loanAmountnumberThe loan amount the user is looking for
loanPurposestringThe purpose of the loan. When listing available options, don't use the enum values, use the natural language descriptions instead.
CONSOLIDATE_DEBTCOVER_UNEXPECTED_COSTHOME_IMPROVEMENTMAJOR_PURCHASEOTHERREFINANCE_CREDIT_CARDhousingStatusstringWhether user owns or rents their home
OWNRENTmaximumLoanTermnumberMaximum loan term in months
maximumMonthlyPaymentnumberMaximum monthly payment in dollars
maximumOriginationFeenumberMaximum origination fee in dollars or percentage
minimumLoanTermnumberMinimum loan term in months
minimumMonthlyPaymentnumberMinimum monthly payment in dollars
minimumOriginationFeenumberMinimum origination fee in dollars or percentage
monthlyHousingPaymentnumberUser's monthly housing payment in dollars. Lenders use this to understand your fixed living expenses, verify stability and residency, prevent fraud, and tailor loan offers.
sortBystringSort type for offers. Do not apply this filter if the user does not specify a sort type.
APRMONTHLY_PAYMENTTOTAL_INTEREST_AND_FEES