Skip to main content

Needle

Bundles contain custom components that support specific third-party integrations with Orbis Studio.

This page describes the components that are available in the Needle bundle.

Needle Retriever​

The Needle Retriever component searches a Needle collection using semantic search and returns matching results as Data records. Needle is a managed retrieval service that indexes your documents and provides search via API.

Needle Retriever parameters​

Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.

NameTypeDescription
api_keySecretStringInput parameter. Your Needle API key from needle-ai.com.
collection_idStringInput parameter. The ID of the Needle collection to search.
queryStringInput parameter. The search query to run against the collection.

Needle Retriever outputs​

NameTypeDescription
dataJSONOutput parameter. Matching documents from the collection as Data records.

See also​