Skip to content
SparkyaiPeopleSoft

Set up NL Search

Setting up NL Search touches three systems: PeopleSoft Search, a server for the NL Search Service, and your LLM provider. These pages take you through them in order, and end with a user typing “Vouchers over $10,000 from Acme entered last month” and getting the right vouchers, and only the ones they may see.

Steps

Section titled “Steps”

  1. Prepare the search definitions for vouchers, with their attributes, their security, and index builds that keep them current.

  2. Run the NL Search Service in a container behind nginx, with the first intent, prompt, and test set.

  3. Connect PeopleSoft to the service: the integration gateway’s client certificate, and the search application class.

  4. Add the search page to PeopleSoft, with a tile.

  5. Follow a search, server by server, to see every hop work, and to know where to look when one doesn’t.

  6. Test and go live, starting with a pilot group.

Who does what

Section titled “Who does what”
Step Done by
Prepare the search definitions A PeopleSoft developer, with your search administrator
Run the NL Search Service Your operations team
Connect PeopleSoft to the service Your PeopleSoft administrator for the gateway, and a developer for the class
Add the search page A PeopleSoft developer, with a portal administrator for the tile
Follow a search, server by server Anyone on the project who can read the logs
Test and go live The project team, with test users in each role

What you need

Section titled “What you need”
  • PeopleSoft Search on OpenSearch, from PeopleTools 8.59.21 or 8.60.07, with the Search Framework already working: a search instance that passes its tests, and Integration Broker configured, because OpenSearch calls back to PeopleSoft for each user’s security. PeopleTools 8.63 or later adds semantic search.
  • An LLM API with structured output, and an embedding model, with credentials for the service.
  • A Linux server with Podman, close to PeopleSoft, with a DNS name and a TLS certificate for the service.
  • A client certificate for the integration gateway, from a certificate authority that the service will trust, so the service accepts requests from PeopleSoft and nothing else.
  • Network access from the integration gateway to the service over HTTPS, and from the service to your LLM provider. The service never connects to PeopleSoft or OpenSearch.

Names these pages use

Section titled “Names these pages use”
Name What it is
fin.example.com The PeopleSoft web server, with the integration gateway
nlsearch.example.com The NL Search Service
ZZ_VOUCHERS The voucher search definition, and its search category
ZZ_VOUCHERS_QRY The query behind the search definition
ZZ_NLSEARCH:Search The search application class
ZZ_NL_SEARCH The search page’s Fluid component
ZZ_NLS_USER The permission list for NL Search users
aipeoplesoft-nlsearch:1.0 The NL Search Service’s container image

Replace them with your own as you go.