Query

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.

Parameters

Example

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]))

Return Value

Exceptions

Generate Plan

Generate a query plan for the given query, but do not run it.

Parameters

Example

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?"
))

Return Value

Exceptions

Edit Plan

Edit a plan.

Parameters

Example

Return Value

Exceptions

Run a query either from a Query based on a string or a Query based on a plan.

Parameters

Example

from aryn_sdk.client.client import Client, Query
c = Client()
docset_id = None # my docset id

# Do RAG on the documents
results = c.query(query=Query(docset_id=docset_id, query="test_query", stream=True, rag_mode=True))

# Do Deep Analytics which involves generating a logical plan and running it on the documents
results = c.query(query=Query(docset_id=docset_id, query="test_query", stream=True))

Return Value

Exceptions

Aryn SDK Reference

​Search

​Generate Plan

​Edit Plan

​Query

Search

Generate Plan

Edit Plan

Query