How we constructed Textual content-to-SQL at Pinterest | by Pinterest Engineering | Pinterest Engineering Weblog | Apr, 2024

How we constructed Textual content-to-SQL at Pinterest | by Pinterest Engineering | Pinterest Engineering Weblog | Apr, 2024
How we constructed Textual content-to-SQL at Pinterest | by Pinterest Engineering | Pinterest Engineering Weblog | Apr, 2024
Pinterest Engineering
Pinterest Engineering Blog

Adam Obeng | Knowledge Scientist, Knowledge Platform Science; J.C. Zhong | Tech Lead, Analytics Platform; Charlie Gu | Sr. Supervisor, Engineering

Writing queries to resolve analytical issues is the core job for Pinterest’s knowledge customers. Nonetheless, discovering the fitting knowledge and translating an analytical drawback into right and environment friendly SQL code may be difficult duties in a fast-paced atmosphere with vital quantities of knowledge unfold throughout completely different domains.

We took the rise in availability of Giant Language Fashions (LLMs) as a possibility to discover whether or not we might help our knowledge customers with this job by growing a Textual content-to-SQL function which transforms these analytical questions straight into code.

Most knowledge evaluation at Pinterest occurs via Querybook, our in–home open supply large knowledge SQL question software. This software is the pure place for us to develop and deploy new options to help our knowledge customers, together with Textual content-to-SQL.

The Preliminary Model: A Textual content-to-SQL Resolution Utilizing an LLM

The primary model included an easy Textual content-to-SQL answer using an LLM. Let’s take a better take a look at its structure:

The consumer asks an analytical query, selecting the tables for use.

  1. The related desk schemas are retrieved from the desk metadata retailer.
  2. The query, chosen SQL dialect, and desk schemas are compiled right into a Textual content-to-SQL immediate.
  3. The immediate is fed into the LLM.
  4. A streaming response is generated and exhibited to the consumer.

Desk Schema

The desk schema acquired from the metadata retailer consists of:

  • Desk identify
  • Desk description
  • Columns
  • Column identify
  • Column sort
  • Column description

Low-Cardinality Columns

Sure analytical queries, akin to “what number of lively customers are on the ‘internet’ platform”, might generate SQL queries that don’t conform to the database’s precise values if generated naively. For instance, the the place clause within the response would possibly bewhere platform=’internet’ versus the proper the place platform=’WEB’. To handle such points, distinctive values of low-cardinality columns which might continuously be used for this sort of filtering are processed and included into the desk schema, in order that the LLM could make use of this data to generate exact SQL queries.

Context Window Restrict

Extraordinarily giant desk schemas would possibly exceed the everyday context window restrict. To handle this drawback, we employed a number of strategies:

  • Diminished model of the desk schema: This consists of solely essential components such because the desk identify, column identify, and kind.
  • Column pruning: Columns are tagged within the metadata retailer, and we exclude sure ones from the desk schema primarily based on their tags.

Response Streaming

A full response from an LLM can take tens of seconds, so to keep away from customers having to attend, we employed WebSocket to stream the response. Given the requirement to return diversified data moreover the generated SQL, a correctly structured response format is essential. Though plain textual content is easy to stream, streaming JSON may be extra advanced. We adopted Langchain’s partial JSON parsing for the streaming on our server, after which the parsed JSON shall be despatched again to the shopper via WebSocket.


Right here is the present prompt we’re utilizing for Text2SQL:

Analysis & Learnings

Our preliminary evaluations of Textual content-to-SQL efficiency have been principally performed to make sure that our implementation had comparable efficiency with outcomes reported within the literature, provided that the implementation principally used off-the-shelf approaches. We discovered comparable outcomes to these reported elsewhere on the Spider dataset, though we famous that the duties on this benchmark have been considerably simpler than the issues our customers face, particularly that it considers a small variety of pre-specified tables with few and well-labeled columns.

As soon as our Textual content-to-SQL answer was in manufacturing, we have been additionally capable of observe how customers interacted with the system. As our implementation improved and as customers turned extra aware of the function, our first-shot acceptance charge for the generated SQL elevated from 20% to above 40%. In apply, most queries which can be generated require a number of iterations of human or AI era earlier than being finalized. As a way to decide how Textual content-to-SQL affected knowledge consumer productiveness, probably the most dependable methodology would have been to experiment. Utilizing such a way, earlier analysis has found that AI help improved job completion velocity by over 50%. In our actual world knowledge (which importantly doesn’t management for variations in duties), we discover a 35% enchancment in job completion velocity for writing SQL queries utilizing AI help.

Whereas the primary model carried out decently — assuming the consumer is conscious of the tables to be employed — figuring out the proper tables amongst the a whole lot of 1000’s in our knowledge warehouse is definitely a major problem for customers. To mitigate this, we built-in Retrieval Augmented Era (RAG) to information customers in deciding on the fitting tables for his or her duties. Right here’s a evaluation of the refined infrastructure incorporating RAG:

  1. An offline job is employed to generate a vector index of tables’ summaries and historic queries towards them.
  2. If the consumer doesn’t specify any tables, their query is reworked into embeddings, and a similarity search is performed towards the vector index to deduce the highest N appropriate tables.
  3. The highest N tables, together with the desk schema and analytical query, are compiled right into a immediate for LLM to pick out the highest Okay most related tables.
  4. The highest Okay tables are returned to the consumer for validation or alteration.
  5. The usual Textual content-to-SQL course of is resumed with the user-confirmed tables.

Offline Vector Index Creation

There are two sorts of doc embeddings within the vector index:

  • Desk summarization
  • Question summarization

Desk Summarization

There’s an ongoing desk standardization effort at Pinterest so as to add tiering for the tables. We index solely top-tier tables, selling using these higher-quality datasets. The desk summarization era course of entails the next steps:

  1. Retrieve the desk schema from the desk metadata retailer.
  2. Collect the latest pattern queries using the desk.
  3. Based mostly on the context window, incorporate as many pattern queries as potential into the desk summarization immediate, together with the desk schema.
  4. Ahead the immediate to the LLM to create the abstract.
  5. Generate and retailer embeddings within the vector retailer.

The desk abstract consists of description of the desk, the information it incorporates, in addition to potential use situations. Right here is the present prompt we’re utilizing for desk summarization:

Question Summarization

In addition to their position in desk summarization, pattern queries related to every desk are additionally summarized individually, together with particulars such because the question’s objective and utilized tables. Right here is the prompt we’re utilizing:

NLP Desk Search

When a consumer asks an analytical query, we convert it into embeddings utilizing the identical embedding mannequin. Then we conduct a search towards each desk and question vector indices. We’re utilizing OpenSearch because the vector retailer and utilizing its inbuilt similarity search capacity.

Contemplating that a number of tables may be related to a question, a single desk might seem a number of occasions within the similarity search outcomes. At present, we make the most of a simplified technique to combination and rating them. Desk summaries carry extra weight than question summaries, a scoring technique that may very well be adjusted sooner or later.

Aside from getting used within the Textual content-to-SQL, this NLP-based desk search can be used within the basic desk search in Querybook.

Desk Re-selection

Upon retrieving the highest N tables from the vector index, we have interaction an LLM to decide on probably the most related Okay tables by evaluating the query alongside the desk summaries. Relying on the context window, we embody as many tables as potential within the immediate. Right here is the prompt we’re utilizing for the desk re-selection:

As soon as the tables are re-selected, they’re returned to the consumer for validation earlier than transitioning to the precise SQL era stage.

Analysis & Learnings

We evaluated the desk retrieval part of our Textual content-to-SQL function utilizing offline knowledge from earlier desk searches. This knowledge was inadequate in a single essential respect: it captured consumer conduct earlier than they knew that NLP-based search was obtainable. Subsequently, this knowledge was used principally to make sure that the embedding-based desk search didn’t carry out worse than the present text-based search, reasonably than trying to measure enchancment. We used this analysis to pick out a way and set weights for the embeddings utilized in desk retrieval. This method revealed to us that the desk metadata generated via our knowledge governance efforts was of serious significance to general efficiency: the search hit charge with out desk documentation within the embeddings was 40%, however efficiency elevated linearly with the burden positioned on desk documentation as much as 90%.

Whereas our currently-implemented Textual content-to-SQL has considerably enhanced our knowledge analysts’ productiveness, there’s room for enhancements. Listed below are some potential areas of additional growth:

NLP Desk Search

At present, our vector index solely associates with the desk abstract. One potential enchancment may very well be the inclusion of additional metadata akin to tiering, tags, domains, and so forth., for extra refined filtering through the retrieval of comparable tables.

  • Scheduled or Actual-Time Index Replace

At present the vector index is generated manually. Implementing scheduled and even real-time updates every time new tables are created or queries executed would improve system effectivity.

  • Similarity Search and Scoring Technique Revision

Our present scoring technique to combination the similarity search outcomes is reasonably fundamental. High-quality-tuning this side might enhance the relevance of retrieved outcomes.

Question validation

At current, the SQL question generated by the LLM is straight returned to the consumer with out validation, leaving a possible danger that the question might not run as anticipated. Implementing question validation, maybe utilizing a constrained beam search, might present an additional layer of assurance.

Consumer suggestions

Introducing a consumer interface to effectively acquire consumer suggestions on the desk search and question era outcomes might supply priceless insights for enhancements. Such suggestions may very well be processed and included into the vector index or desk metadata retailer, in the end boosting system efficiency.


Whereas engaged on this challenge, we realized that the efficiency of text-to-SQL in an actual world setting is considerably completely different to that in current benchmarks, which have a tendency to make use of a small variety of well-normalized tables (that are additionally prespecified). It might be useful for utilized researchers to provide extra sensible benchmarks which embody a bigger quantity of denormalized tables and deal with desk search as a core a part of the issue.

To study extra about engineering at Pinterest, take a look at the remainder of our Engineering Weblog and go to our Pinterest Labs website. To discover and apply to open roles, go to our Careers web page.