openai-cookbook/text_comparison_examples.md
Christine Belzie 45c6406e8b
[revise] small edits and fixed typos (#510)
* [revise] made small edits and fixed typos

* fix: revert back to original descriptions

* small language updates

---------

Co-authored-by: Simón Fishman <simonpfish@gmail.com>
2023-08-25 13:08:49 -07:00

3.5 KiB

Text comparison examples

The OpenAI API embeddings endpoint can be used to measure relatedness or similarity between pieces of text.

By leveraging GPT-3's understanding of text, these embeddings achieved state-of-the-art results on benchmarks in unsupervised learning and transfer learning settings.

Embeddings can be used for semantic search, recommendations, cluster analysis, near-duplicate detection, and more.

For more information, read OpenAI's blog post announcements:

For comparison with other embedding models, see Massive Text Embedding Benchmark (MTEB) Leaderboard

Embeddings can be used for search either by themselves or as a feature in a larger system.

The simplest way to use embeddings for search is as follows:

  • Before the search (precompute):
    • Split your text corpus into chunks smaller than the token limit (8,191 tokens for text-embedding-ada-002)
    • Embed each chunk of text
    • Store those embeddings in your own database or in a vector search provider like Pinecone, Weaviate or Qdrant
  • At the time of the search (live compute):
    • Embed the search query
    • Find the closest embeddings in your database
    • Return the top results

An example of how to use embeddings for search is shown in Semantic_text_search_using_embeddings.ipynb.

In more advanced search systems, the cosine similarity of embeddings can be used as one feature among many in ranking search results.

Question answering

The best way to get reliably honest answers from GPT-3 is to give it source documents in which it can locate correct answers. Using the semantic search procedure above, you can cheaply search through a corpus of documents for relevant information and then give that information to GPT-3 via the prompt to answer a question. We demonstrate this in Question_answering_using_embeddings.ipynb.

Recommendations

Recommendations are quite similar to search, except that instead of a free-form text query, the inputs are items in a set.

An example of how to use embeddings for recommendations is shown in Recommendation_using_embeddings.ipynb.

Similar to search, these cosine similarity scores can either be used on their own to rank items or as features in larger ranking algorithms.

Customizing Embeddings

Although OpenAI's embedding model weights cannot be fine-tuned, you can nevertheless use training data to customize embeddings to your application.

In Customizing_embeddings.ipynb, we provide an example method for customizing your embeddings using training data. The idea of the method is to train a custom matrix to multiply embedding vectors by in order to get new customized embeddings. With good training data, this custom matrix will help emphasize the features relevant to your training labels. You can equivalently consider the matrix multiplication as (a) a modification of the embeddings or (b) a modification of the distance function used to measure the distances between embeddings.