Vector Search

📢 Note: The API is currently in Beta.

After creating a pipeline, you can perform a Vector Search on it.

Call the retrieval endpoint

Make sure to include the code and imports from the Getting Started page.

First, we need to retrieve the pipeline ID. If you created the pipeline via API, you should have the ID in the response. Otherwise you can always list the pipelines and get the ID from there. From the platform, you can navigate into the pipeline page and check the id in the browser url.

Python

pipelines = v.PipelinesApi(api)
response = pipelines.retrieve_documents(org, pipeline_id, v.RetrieveDocumentsRequest(
    question="What are you?",
    num_results=5,
))
print(response.documents)

Node.js

const pipelineId = "your-pipeline-id";
const response = await pipelinesApi.retrieveDocuments({
    organization: org,
    pipeline: pipelineId,
    retrieveDocumentsRequest: {
        question: "<your-question>",
        numResults: 5,
    }
});
console.log(response.documents)