Parse Query Into Restrictions
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Query\": \"<string>\",\n \"Currents\": \"<string>\",\n \"PreviousQuery\": {\n \"Query\": \"<string>\",\n \"ResponseMarkdown\": \"<string>\",\n \"Entity\": \"<string>\",\n \"ODataQuery\": \"<string>\",\n \"Restrictions\": [\n {\n \"Name\": \"<string>\",\n \"Operator\": \"<string>\",\n \"Values\": [\n \"<string>\"\n ],\n \"DisplayValues\": [\n \"<string>\"\n ],\n \"ColumnInfo\": {\n \"DisplayName\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"DisplayType\": \"<string>\",\n \"CanOrderBy\": true,\n \"Name\": \"<string>\",\n \"CanRestrictBy\": true,\n \"RestrictionType\": \"<string>\",\n \"RestrictionListName\": \"<string>\",\n \"IsVisible\": true,\n \"ExtraInfo\": \"<string>\",\n \"Width\": \"<string>\",\n \"IconHint\": \"<string>\",\n \"HeadingIconHint\": \"<string>\"\n },\n \"IsActive\": true,\n \"SubRestrictions\": \"<array>\",\n \"InterParenthesis\": 123,\n \"UniqueHash\": 123\n }\n ],\n \"InternalContext\": \"<string>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Query: '<string>',
Currents: '<string>',
PreviousQuery: {
Query: '<string>',
ResponseMarkdown: '<string>',
Entity: '<string>',
ODataQuery: '<string>',
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
InternalContext: '<string>'
}
})
};
fetch('http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Query' => '<string>',
'Currents' => '<string>',
'PreviousQuery' => [
'Query' => '<string>',
'ResponseMarkdown' => '<string>',
'Entity' => '<string>',
'ODataQuery' => '<string>',
'Restrictions' => [
[
'Name' => '<string>',
'Operator' => '<string>',
'Values' => [
'<string>'
],
'DisplayValues' => [
'<string>'
],
'ColumnInfo' => [
'DisplayName' => '<string>',
'DisplayTooltip' => '<string>',
'DisplayType' => '<string>',
'CanOrderBy' => true,
'Name' => '<string>',
'CanRestrictBy' => true,
'RestrictionType' => '<string>',
'RestrictionListName' => '<string>',
'IsVisible' => true,
'ExtraInfo' => '<string>',
'Width' => '<string>',
'IconHint' => '<string>',
'HeadingIconHint' => '<string>'
],
'IsActive' => true,
'SubRestrictions' => '<array>',
'InterParenthesis' => 123,
'UniqueHash' => 123
]
],
'InternalContext' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions"
payload = {
"Query": "<string>",
"Currents": "<string>",
"PreviousQuery": {
"Query": "<string>",
"ResponseMarkdown": "<string>",
"Entity": "<string>",
"ODataQuery": "<string>",
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": ["<string>"],
"DisplayValues": ["<string>"],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": True,
"Name": "<string>",
"CanRestrictBy": True,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": True,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": True,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"UniqueHash": 123
}
],
"InternalContext": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Query: '<string>',
Currents: '<string>',
PreviousQuery: {
Query: '<string>',
ResponseMarkdown: '<string>',
Entity: '<string>',
ODataQuery: '<string>',
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
InternalContext: '<string>'
}
})
};
fetch('http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Query": "<string>",
"ResponseMarkdown": "<string>",
"Entity": "<string>",
"ODataQuery": "<string>",
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": [
"<string>"
],
"DisplayValues": [
"<string>"
],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": true,
"Name": "<string>",
"CanRestrictBy": true,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": true,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": true,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"InterOperator": "None",
"UniqueHash": 123
}
],
"InternalContext": "<string>"
}Parse Query Into Restrictions
Return archive restrictions based on a natural language query.
NsApiSlow threshold: 1000 ms.
Parse Query Into Restrictions
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Query\": \"<string>\",\n \"Currents\": \"<string>\",\n \"PreviousQuery\": {\n \"Query\": \"<string>\",\n \"ResponseMarkdown\": \"<string>\",\n \"Entity\": \"<string>\",\n \"ODataQuery\": \"<string>\",\n \"Restrictions\": [\n {\n \"Name\": \"<string>\",\n \"Operator\": \"<string>\",\n \"Values\": [\n \"<string>\"\n ],\n \"DisplayValues\": [\n \"<string>\"\n ],\n \"ColumnInfo\": {\n \"DisplayName\": \"<string>\",\n \"DisplayTooltip\": \"<string>\",\n \"DisplayType\": \"<string>\",\n \"CanOrderBy\": true,\n \"Name\": \"<string>\",\n \"CanRestrictBy\": true,\n \"RestrictionType\": \"<string>\",\n \"RestrictionListName\": \"<string>\",\n \"IsVisible\": true,\n \"ExtraInfo\": \"<string>\",\n \"Width\": \"<string>\",\n \"IconHint\": \"<string>\",\n \"HeadingIconHint\": \"<string>\"\n },\n \"IsActive\": true,\n \"SubRestrictions\": \"<array>\",\n \"InterParenthesis\": 123,\n \"UniqueHash\": 123\n }\n ],\n \"InternalContext\": \"<string>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Query: '<string>',
Currents: '<string>',
PreviousQuery: {
Query: '<string>',
ResponseMarkdown: '<string>',
Entity: '<string>',
ODataQuery: '<string>',
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
InternalContext: '<string>'
}
})
};
fetch('http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Query' => '<string>',
'Currents' => '<string>',
'PreviousQuery' => [
'Query' => '<string>',
'ResponseMarkdown' => '<string>',
'Entity' => '<string>',
'ODataQuery' => '<string>',
'Restrictions' => [
[
'Name' => '<string>',
'Operator' => '<string>',
'Values' => [
'<string>'
],
'DisplayValues' => [
'<string>'
],
'ColumnInfo' => [
'DisplayName' => '<string>',
'DisplayTooltip' => '<string>',
'DisplayType' => '<string>',
'CanOrderBy' => true,
'Name' => '<string>',
'CanRestrictBy' => true,
'RestrictionType' => '<string>',
'RestrictionListName' => '<string>',
'IsVisible' => true,
'ExtraInfo' => '<string>',
'Width' => '<string>',
'IconHint' => '<string>',
'HeadingIconHint' => '<string>'
],
'IsActive' => true,
'SubRestrictions' => '<array>',
'InterParenthesis' => 123,
'UniqueHash' => 123
]
],
'InternalContext' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions"
payload = {
"Query": "<string>",
"Currents": "<string>",
"PreviousQuery": {
"Query": "<string>",
"ResponseMarkdown": "<string>",
"Entity": "<string>",
"ODataQuery": "<string>",
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": ["<string>"],
"DisplayValues": ["<string>"],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": True,
"Name": "<string>",
"CanRestrictBy": True,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": True,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": True,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"UniqueHash": 123
}
],
"InternalContext": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Query: '<string>',
Currents: '<string>',
PreviousQuery: {
Query: '<string>',
ResponseMarkdown: '<string>',
Entity: '<string>',
ODataQuery: '<string>',
Restrictions: [
{
Name: '<string>',
Operator: '<string>',
Values: ['<string>'],
DisplayValues: ['<string>'],
ColumnInfo: {
DisplayName: '<string>',
DisplayTooltip: '<string>',
DisplayType: '<string>',
CanOrderBy: true,
Name: '<string>',
CanRestrictBy: true,
RestrictionType: '<string>',
RestrictionListName: '<string>',
IsVisible: true,
ExtraInfo: '<string>',
Width: '<string>',
IconHint: '<string>',
HeadingIconHint: '<string>'
},
IsActive: true,
SubRestrictions: '<array>',
InterParenthesis: 123,
UniqueHash: 123
}
],
InternalContext: '<string>'
}
})
};
fetch('http://localhost:56350/api/v1/Agents/AI/ParseQueryIntoRestrictions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Query": "<string>",
"ResponseMarkdown": "<string>",
"Entity": "<string>",
"ODataQuery": "<string>",
"Restrictions": [
{
"Name": "<string>",
"Operator": "<string>",
"Values": [
"<string>"
],
"DisplayValues": [
"<string>"
],
"ColumnInfo": {
"DisplayName": "<string>",
"DisplayTooltip": "<string>",
"DisplayType": "<string>",
"CanOrderBy": true,
"Name": "<string>",
"CanRestrictBy": true,
"RestrictionType": "<string>",
"RestrictionListName": "<string>",
"IsVisible": true,
"ExtraInfo": "<string>",
"Width": "<string>",
"IconHint": "<string>",
"HeadingIconHint": "<string>"
},
"IsActive": true,
"SubRestrictions": "<array>",
"InterParenthesis": 123,
"InterOperator": "None",
"UniqueHash": 123
}
],
"InternalContext": "<string>"
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Query, Currents, PreviousQuery
ParseQueryIntoRestrictions: Return archive restrictions based on a natural language query.
Response
OK
Natural language search results. Carrier object for NaturalLanguageSearch. Services for the NaturalLanguageSearch Carrier is available from the AI Agent.
User's query.
Markdown response from the AI.
Type of entity we are searching. e.g. 'contact', 'project' etc.
Search criteria in ODATA format
Archive restrictions for the search query.
Show child attributes
Show child attributes
AI internal context - opaque to callers.
Related topics
How to perform an archive provider queryBuilding a queryEncoded valuesRunning a queryNSArchiveRestrictionInfoPopulate Restrictions⌘I