Skip to content

Get data

Text

This is plain, minimally processed text that gets sent to the next step - usually either directly to the base LLM, or sent through a chain.

KB Documentation

KB stands for KnowledgeBase, and the query is used to retrieve snippets of document from the configured KnowledgeBase.

{{ kb|query:"your KB query" | snippet: "" | scoreRange: "" | filter: "" }}

Parameters

  • Query: The KB query. Best results are achieved by removing stopwords from this text, or using keywords.
  • Snippet: Snippet size (character count): 10 - 2000.
  • Score range: Upper bound of document scores to return: 0.0 - 1.0. For example, a score range of "0.8" will return the highest 80% scoring documents, discarding the lowest/20% of scored documents.
  • Filter: If there is a filter field set for the connected KnowledgeBase (in the Configure Tab), set the value to filter/match.

Returns

Documentation snippets from configured KnowledgeBase data source.

Note

This sets some global variables after use, like kb.score, kb.context, kb.url, and more. All of the KB search return values are available under this kb object. Use the Inspector to see all variables set.

Seek

Perform a seek action, as if entering a question on the seek tab. 

{{ seek|query:"your Seek query" | stump: "" | filter: "" | language: "" | seekLLM: "" }}

Parameters

  • Query: The question/query.
  • Stump: Information to add as priority in the Context. Use this to add relevant data/documentation to help seek answer your question.
  • Filter: If there is a filter field set for the connected KnowledgeBase (in the Configure Tab), set the value to filter/match.
  • Language: Target language for the generated answer.
  • Seek LLM: Explicitly set the LLM to use for this query. Available on BYOLLM (Bring your own LLM) plans.

Returns

A natural language generated answer to query.

Note

This sets some global variables after use, like seek.score, seek.answer, seek.semanticScore, and more. All of seek's return values are available under this seek object. Use the Inspector to see all variables set.

REST

Connect to any REST API.

{{ post|url: "" | headers: "" | body: "" | operation: "POST" | jsonToVars: "true" }}

Parameters

  • URL: The API connection target.
  • Headers: JSON headers of the request.
  • Body: The body of the request.
  • Operation: The type of connection request: POST, GET, PUT, DELETE, PATCH
  • JSON to Vars: Parse the API/JSON response into mAIstro-usable environment variables: true, false

Note

This sets some global variables if "JSON to Vars" is enabled. Use the Inspector to see all variables set from the API response.

Returns

  • If jsonToVars is false, the JSON response from the API request.
  • If jsonToVars is true, returns blank/empty as the return response is imported into the environment as variables.

Website Text

Scrapes the URL given for any available plain text.

{{ web|url:"https://yourpage.com/" }}

Parameters

  • URL: The API connection target.

Returns

  • The plain text contents of URL.
Example Usage 
{{ web|url:"https://en.wikipedia.org/wiki/Roman" }}=>{{ keywords|nouns:false }}

This will extract proper nouns from the Wikipedia page for Roman. The result will be similar to:

Wikipedia, encyclopedia, Roman, Romans, român, Wiktionary, Rome, Italy Ancient Rome, BC, Rome Epistle, Testament, Christian Bible Roman, Music Romans, Sound Horizon, EP, Teen, Boy, Morning Musume Film, Film Roman, Indian Malayalam, Doctor, People Roman, Romans Ῥωμαῖοι, Rhomaioi, Greeks, Middle Ages, Ottoman, Rûm, Muslim, Bulgaria Roman Municipality Roman, Eure, France Roman, Romania Roman County, Sakha Republic, Russia Roman River, Essex, England Roman Valley, Nova Scotia, Canada Romans Romans, Ain, France Romans, Deux, Sèvres, France Romans dIsonzo, Italy Romans, sur-Isère, France Religion Roman Catholic, Roman Catholic, Nancy Grace Roman Space Telescope, Roman Space Telescope, NASA, ROMAN, Search, Wikipedia., Romans History, Greco, Romany, Gypsies, Roma, Disambiguation, Wikidata