Aryn SDK Reference
Query
Documentation for how to call the Query APIs using the Aryn SDK
Please find the documentation for the functions that call the Query APIs using the SDK below. All parameters are optional unless specified otherwise.
Search
Search over a docset and get back documents or elements that match your search criteria.
docset_id: A string specifying the id of the docset you are searching over.query: A string that specifies what term you are searching for within the contents of your documents. The query_type parameter specified below will control exactly how this query parameter is used to search over your documents.query_type: An enum that can be eitherkeyword,vector, orlexical:- When
keywordis specified, the search call will perform a substring match and return results that contain strings that contain the query term specified. - When
vectoris specified, the search call will internally embed the query with the embedding function associated with the docset you are querying on and perform a k-nearest neighbor search to retrieve the results. - When
lexicalis specified, the search call will perform an exact string match and return results where the query string shows up as a standalone word.
- When
properties_filter: A string that specifies a boolean expression. This expression specifies the condition to use when extracting documents or elements from the docset. The boolean expression is a string consisting of conditions separated by the AND/OR keywords. The following are a few examples:- “(company_name=‘Microsoft’ AND year=‘2024’)”
- “(company_ticker=‘AMZN’ AND year=‘2023’) AND (quarter=‘Q2’ or quarter=‘Q4’)”
k: The number of records to return back.return_type: An enum that an be eitherdocorelement. Whendocis specified, documents that match the search criteria are retuned. Whenelementis specified, specific sections of the document (i.e. elements) are returned.page_token: A string used for pagination purposes. If provided, this will indicate to the server where to begin the next set of records to return. Valid for 24 hours.
from aryn_sdk.client.client import Client, SearchRequest
results = myClient.search(docset_id = [your-docset-ID], query = SearchRequest(query=[your-query-phrase], properties_filter=[your-filter-string], query_type=[KEYWORD|VECTOR], return_type=[DOC|ELEMENT]))
A SearchResponse object which contains the following attributes:
results: A list containing either the documents or elements that matched the search criteria.query_embedding: If the query_type selected is ‘vector’, this field indicates the embedding vector that was used to perform the search.next_page_token: The pagination token. If None, there are no more search results to retrieve. If not None, the caller may use this to retrieve more results for the particular search query.
User errors:
HTTPError: Error:status_code 403. Reason:"No Aryn API Key provided"- Fix: Please provide an API key either as a parameter or specify it in the environment variable
ARYN_API_KEY.
- Fix: Please provide an API key either as a parameter or specify it in the environment variable
HTTPError: Error:status_code 403. Reason:"Invalid Aryn API key"- Fix: Please provide a valid API key either as a parameter or specify it in the environment variable
ARYN_API_KEY.
- Fix: Please provide a valid API key either as a parameter or specify it in the environment variable
HTTPError: Error:status_code 403. Reason:"Expired Aryn API key"- Fix: Please get a new API key here.
HTTPError: Error:status_code 404. Reason:"Docset not found error"- Fix: Please try again with a valid docset id.
HTTPError: Error:status_code 400. Reason:"Incorrect input"- Fix: Please try again with correct input.
Other errors:
HTTPError: Error:status_code 5xx. Reason:Internal Server Error
Generate Plan
Generate a query plan for the given query, but do not run it.
A Query object describing the query to build and return a LogicalPlan for.
from aryn_sdk.client.client import Client, generate_plan, Query
c = Client()
c.generate_plan(query=Query(
docset_id="aryn:ds-u3915kxzdi8fosmv542ynv4",
query="What was the breakdown of aircraft types for incidents with substantial damage?"
))
A LogicalPlan object.
HTTPError 403: “No Aryn API Key provided”HTTPError 403: “Invalid Aryn API key”HTTPError 403: “Expired Aryn API key”HTTPError 5xx: Internal Server Error
Edit Plan
Edit a plan.
from aryn_sdk.client.client import Client, edit_plan
c = Client()
c.edit_plan(query=myQuery, feedback="Add a filter to select just documents that mention inflation.")
A LogicalPlan object.
HTTPError 403: “No Aryn API Key provided”HTTPError 403: “Invalid Aryn API key”HTTPError 403: “Expired Aryn API key”HTTPError 5xx: Internal Server Error
Query
Run a query either from a Query based on a string or a Query based on a plan.
The query to run.
from aryn_sdk.client.client import Client, query
c = Client()
c.query(query=myQuery)
Either a QueryResult or an Iterator[QueryEvent].
HTTPError 403: “No Aryn API Key provided”HTTPError 403: “Invalid Aryn API key”HTTPError 403: “Expired Aryn API key”HTTPError 5xx: Internal Server Error
Was this page helpful?
On this page