SemanticSearchIndex

This functionality requires an external account »

SemanticSearchIndex[…]

represents a semantic search index object.

Details and Options

  • SemanticSearchIndex represents a corpus of documents that can be searched by semantic similarity.
  • Indexes are usually created by CreateSemanticSearchIndex.
  • Index properties can be accessed via SemanticSearchIndex[…]["prop"].
  • The following properties are supported:
  • "Database"vector database backing the index
    "DocumentCount"number of documents stored in the index
    "Embeddings"vector embeddings of the entries
    "FeatureExtractor"how features are extracted from text segments
    "ID"index ID
    "ItemCount"number of segments stored in the index
    "Items"stored segments
    "Label"item labels
    "Location"where the database is stored
    "TagKeys"keys of the tag association
    "Tags"tags associated with each entry
    "Tokenizer"how the text segment is split into tokens
    {prop1,…}a list of properties
  • The following options can be specified:
  • OverwriteTargetAutomaticwhether to overwrite an existing location
    GeneratedAssetLocation $GeneratedAssetLocationwhere to save the database

Examples

open allclose all

Basic Examples  (2)

Create a semantic search index:

Check the available index properties:

Create a semantic search index based on a piece of text:

Perform a semantic search operation:

Scope  (4)

Extract a list of index properties:

Extract an index property:

Extract multiple properties:

Use the index to perform a search operation:

Store a SemanticSearchIndex in a file:

Recreate the index form the file:

Options  (1)

GeneratedAssetLocation  (1)

Create a SemanticSearchIndex:

Copy the index in a new location:

Delete the original database:

Wolfram Research (2024), SemanticSearchIndex, Wolfram Language function, https://reference.wolfram.com/language/ref/SemanticSearchIndex.html.

Text

Wolfram Research (2024), SemanticSearchIndex, Wolfram Language function, https://reference.wolfram.com/language/ref/SemanticSearchIndex.html.

CMS

Wolfram Language. 2024. "SemanticSearchIndex." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/SemanticSearchIndex.html.

APA

Wolfram Language. (2024). SemanticSearchIndex. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SemanticSearchIndex.html

BibTeX

@misc{reference.wolfram_2024_semanticsearchindex, author="Wolfram Research", title="{SemanticSearchIndex}", year="2024", howpublished="\url{https://reference.wolfram.com/language/ref/SemanticSearchIndex.html}", note=[Accessed: 16-September-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_semanticsearchindex, organization={Wolfram Research}, title={SemanticSearchIndex}, year={2024}, url={https://reference.wolfram.com/language/ref/SemanticSearchIndex.html}, note=[Accessed: 16-September-2024 ]}