Search Node | Vellum | Documentation

from vellum import (
    SearchRequestOptionsRequest,
    SearchWeightsRequest,
    SearchResultMergingRequest,
    SearchFiltersRequest,
)
from vellum.workflows.nodes.displayable import SearchNode
class MySearchNode(SearchNode):
    query = "Hello, world"
    document_index = "my_document_index"
    options = SearchRequestOptionsRequest(
        limit=8,
        weights=SearchWeightsRequest(
            semantic_similarity=0.8,
            keywords=0.2,
        ),
        result_merging=SearchResultMergingRequest(
            enabled=True
        ),
        filters=SearchFiltersRequest(
            external_ids=None,
            metadata=None,
        ),
    )
    chunk_separator = "\n\n#####\n\n"

from vellum import SearchResult, SearchResultDocument
MySearchNode.Outputs(
    text="Goodbye, world",
    results=[
        SearchResult(
            text="Goodbye, world",
            score=0.5,
            keywords=[...],
            document=SearchResultDocument(
                id="<id>",
                label="My Document",
                external_id="<external-id>",
                metadata={},
            ),
            meta=None,
        ),
        ...
    ],
)

vellum.workflows.nodes.SearchNode

Used to perform a hybrid search against a Document Index in Vellum.

Attributes

document_index

Union[UUID, str]Required

Either the UUID or name of the Vellum Document Index that you’d like to search against

query

strRequired

The query to search for

options

SearchRequestOptionsRequest

Runtime configuration for the search

chunk_separator

str

The separator to use when joining the text of each search result

Outputs

text

str

The concatenated text output from the search

results

List[SearchResult]

The raw results from the search

1	from vellum import (
2	SearchRequestOptionsRequest,
3	SearchWeightsRequest,
4	SearchResultMergingRequest,
5	SearchFiltersRequest,
6	)
7	from vellum.workflows.nodes.displayable import SearchNode
8
9	class MySearchNode(SearchNode):
10	query = "Hello, world"
11	document_index = "my_document_index"
12	options = SearchRequestOptionsRequest(
13	limit=8,
14	weights=SearchWeightsRequest(
15	semantic_similarity=0.8,
16	keywords=0.2,
17	),
18	result_merging=SearchResultMergingRequest(
19	enabled=True
20	),
21	filters=SearchFiltersRequest(
22	external_ids=None,
23	metadata=None,
24	),
25	)
26	chunk_separator = "\n\n#####\n\n"

1	from vellum import SearchResult, SearchResultDocument
2
3	MySearchNode.Outputs(
4	text="Goodbye, world",
5	results=[
6	SearchResult(
7	text="Goodbye, world",
8	score=0.5,
9	keywords=[...],
10	document=SearchResultDocument(
11	id="<id>",
12	label="My Document",
13	external_id="<external-id>",
14	metadata={},
15	),
16	meta=None,
17	),
18	...
19	],
20	)