Value Count Summarizer
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "application". | "application" |
| _type | Yes | - | No | The value must be "application". | "application" |
| appName | Yes | - | No | The name of the application | "ValCountSum" |
| appType | Yes | - | No | The value must be "valuecount-summarizer". | "valuecount-summarizer" |
| config | Yes | - | No | The value must be "com.accenture.aspire:app-valuecount-summarizer". | "com.accenture.aspire:app-valuecount-summarizer" |
| description | Yes | - | No | The description | "count-summarizer" |
| properties | Yes | - | No | Configuration object | |
| processIntegerTypes | Yes | true | No | If enabled integer values will be counted. | true |
| addUniqueIntegerValues | Yes | true | No | If enabled unique integer values will be processed as sub jobs. | true |
| uniqueIntegerThresholdType | Yes | percentage | No | Type of threshold ("percentage" or "maxCount") to use to determine which unique values will be processed as sub jobs | "maxCount" |
| pctgIntegerThreshold | No | 0.05 | No | Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is "percentage" | 0.05 |
| maxUniqueIntegerValues | No | 1000 | No | The number of unique values to process, after reaching the sample size other values will be ignored.Used only if the threshold type is "maxCount" | 1000 |
| processFloatTypes | Yes | true | No | If enabled float values will be counted. | true |
| addUniqueFloatValues | Yes | true | No | If enabled unique float values will be processed as sub jobs. | true |
| uniqueFloatThresholdType | Yes | percentage | No | Type of threshold ("percentage" or "maxCount") to use to determine which unique values will be processed as sub jobs | "maxCount" |
| pctgFloatThreshold | No | 0.05 | No | Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is "percentage" | 0.05 |
| maxUniqueFloatValues | No | 1000 | No | The number of unique values to process, after reaching the sample size other values will be ignored.Used only if the threshold type is "maxCount" | 1000 |
| processTextTypes | Yes | true | No | If enabled text values will be counted. | true |
| addUniqueTextValues | Yes | true | No | If enabled unique text values will be processed as sub jobs. | true |
| uniqueTextThresholdType | Yes | percentage | No | Type of threshold ("percentage" or "maxCount") to use to determine which unique values will be processed as sub jobs | "maxCount" |
| pctgTextThreshold | No | 0.05 | No | Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is "percentage" | 0.05 |
| maxUniqueFloatValues | No | 1000 | No | The number of unique values to process, after reaching the sample size other values will be ignored.Used only if the threshold type is "maxCount" | 1000 |
Example
POST aspire/_api/credentials
{
"type": "<Connector Type>",
"description": "<Connector Name> Credential",
"properties": {
}
}
Update Credential
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the credential to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| description | Yes | - | No | Name of the credential object. | "Value Count SummarizerCredential" |
| properties | Yes | - | No | Configuration object | |
Example
PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065
{
"id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
"description": "<Connector Name> Credential",
"properties": {
}
}
Create Connection
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be | |
| description | Yes | - | No | Name of the connection object. | "MyValue Count SummarizerConnection" |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | Yes | - | No | Configuration object | |
Example
POST aspire/_api/connections
{
"type": "<Connector Type>",
"description": "<Connector Name> Test Connector",
"properties": {
}
}
Update Connection
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
| description | No | - | No | Name of the connection object. | "My |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| properties | Yes | - | No | Configuration object | |
Example
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "<Connector Name> Test Connector",
"properties": {
}
}
Create Connector Instance
For the creation of the Connector object using the Rest API check this page
Create Seed
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | Yes | - | No | <seed description> | |
| type | Yes | - | No | The value must be . | |
| description | Yes | - | No | Name of the seed object. | "My Value Count Summarizer Seed" |
| connector | Yes | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | Yes | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
| properties | Yes | - | No | Configuration object | |
Example
POST aspire/_api/seeds
{
"type": "<Connector Type>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
}
}
Update Seed
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | Yes | - | No | Id of the seed to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| seed | No | - | No | <seed description> | |
| description | No | - | No | Name of the seed object. | "MyValue Count SummarizerSeed" |
| connector | No | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
| connection | No | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
| workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.add | No | [ ] | Yes | The ids of the workflows to add. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| workflows.remove | No | [ ] | Yes | The ids of the workflows to remove. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
| throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.add | No | [ ] | Yes | The ids of the routingPolicies to add. | ["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
| routingPolicies.remove | No | [ ] | Yes | The ids of the routingPolicies to remove. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"] |
| tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag3"] |
| tags.add | No | [ ] | Yes | The tags to add | ["tag4"] |
| tags.remove | No | [ ] | Yes | The tags to remove | ["tag2"] |
| properties | Yes | - | No | Configuration object | |
Example
PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "<seed example>",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag", "tag2"],
"properties": {
}
}
Overview
Content Tools
Copyright © 2024 Accenture
