​

Available Parameters

​

Configuring Parameters in the Playground

​

Using Parameters in API Requests

When making API requests, you can include these parameters in your query string:

curl -X GET "https://api.search-artemis.com/search?search_query=HIPAA%20compliant%20companies&num_batches=2&top_k=5" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Advanced Search Parameters

We also provide advanced search parameters that you can use to further refine your search results.

​

Filter Query

If your dataset has filter columns, you can use the filter_query parameter to filter the search results using the filter columns in the dataset.

Your filter query should be included in the form { filter_query: "YOUR_FILTER_QUERY" } in the body of your search request.

The filter query you provide may be any valid Pandas query string and assume the ‘python’ engine is used to evaluate the query. Learn more about valid filter queries here.

​

Example 1:

If you had a dataset of companies with a filter column called company_size with the values small, medium, and large, you could filter the search results to only include search results with the company_size of ‘large’ by setting the filter_query parameter to company_size == 'large'.

Your search body would look like this:

{
  ...
  "filter_query": "company_size == 'large'"
}

​

Example 2:

If you had a dataset of companies with a filter column called country which contained the names of countries associated with each search result, you could filter the search results to only include search results with a country that started with United by setting the filter_query parameter to country.str.contains('United', case=False, na=False).

Your search body would look like this:

{
  ...
  "filter_query": "country.str.contains('United', case=False, na=False)"
}

​

Best Practices

• Start with a larger top_k value and gradually decrease it as you refine your search.
• Experiment with different num_batches values to balance between search depth and response time.

​

Next Steps

• View our API reference for more details on search parameters.