AI Search Spoke

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of AI Search Spoke

    The AI Search Spoke enables ServiceNow customers to store and access data from third-party applications through the AI Search server using Flow Designer. It requires an Integration Hub subscription and the latest version is 2.0.3.

    Show full answer Show less

    Key Features

    • Integration Requirements: Ensure activation of dependent plugins, including AI Search (com.glide.ais) and External Content for AI Search (com.glide.ais.externalcontent).
    • Actions Available:
      • Commit Index: Commits and indexes queued documents, providing synchronous feedback.
      • Delete Document: Deletes a specific record from the AI Search index.
      • Delete Documents: Deletes multiple records based on specified criteria.
      • Get Max File Size: Retrieves the maximum file size for document ingestion.
      • Ingest Document: Ingests document properties into the batcher, with optional security permissions.
      • Initialize Batcher: Prepares a new batcher for document queuing.
      • Is AIS Available For Ingestion: Checks the availability of AI Search for ingesting documents.
      • Update By Query: Updates records in the AI Search index that match a specified query.

    Key Outcomes

    By utilizing the AI Search Spoke, ServiceNow customers can effectively manage document indexing and retrieval, ensuring their data is organized and accessible. The ability to specify security permissions enhances data governance and access control. Additionally, customers can automate tasks and streamline workflows within their ServiceNow environment.

    Store data from the required third-party application in the AI Search server through Flow Designer. Access data through the AI Search portal.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Integration Hub subscription

    This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

    Spoke version

    AI Search spoke v2.0.3 is the latest version.

    Spoke dependencies

    If you’re having trouble installing the app, ensure that these dependent plugins are activated:
    • AI Search (com.glide.ais)
    • External Content for AI Search (com.glide.ais.external_content)
    Note:
    Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

    Spoke actions

    The AI Search spoke provides actions to automate tasks when events occur in your ServiceNow instance. Available actions include:

    Action Description
    Commit Index Commits queued documents in the batcher and indexes them. Synchronously returns feedback about the indexed content.
    Delete Document

    Deletes a record from the AI Search content index.
    Delete Documents

    Deletes all records that use a specified external content schema table from the AI Search content index. You can optionally specify a Glide query to limit the set of documents deleted from the specified schema table.
    Get Max File Size

    Retrieves the maximum file size which can be ingested into AI Search.
    Ingest Document

    Ingests properties of the specified document into the batcher. In releases starting with Rome, you can optionally specify security principal access permissions for the document.

    Specify the document's properties as name-value pairs in a JSON object formatted as in the following example: 
    {
  "title": "Report 2021-02-26",
  "author": "Abel Tuter",
  "url": "http://example.com/reports/2021/02/26/"
}
    You can specify the document's security principal access permissions as name-value pairs in a JSON object formatted as in the following example:
    {
  "everyone": false,
  "groups.deny": [
    "report-users",
    "hr-users"
  ],
  "groups.read": [
    "report-admins",
    "hr-admins"
  ],
  "none": false,
  "users.deny": [
    "ad\bow-ruggeri",
    "don_goodliffe"
  ],
  "users.read": [
    "ad\beth-anglin",
    "ad\abel-tuter",
    "carol.coughlin@sharepoint"
  ]
}

    For more details on security principal access permissions, see External content access permissions.
    Ingest Document Using Download URL

    Downloads a document from a URL and ingests it into the batcher. In releases starting with Rome, you can optionally specify security principal access permissions for the document.

    Add the URL's domain to the AI Search spoke's list of trusted domains before you specify this action's Download URL input. For details on modifying the spoke's list of trusted domains, see Set up the AI Search spoke.

    This action doesn't support authentication session IDs or cookies, so the document URL must allow unauthenticated access.

    Specify the document's properties as name-value pairs in a JSON object formatted as in the following example: 
    {
  "title": "Report 2021-02-26",
  "author": "Abel Tuter"
}
    The document's url property is automatically populated with the value of the Download URL input.
    You can specify the document's security principal access permissions as name-value pairs in a JSON object formatted as in the following example:
    {
  "everyone": false,
  "groups.deny": [
    "report-users",
    "hr-users"
  ],
  "groups.read": [
    "report-admins",
    "hr-admins"
  ],
  "none": false,
  "users.deny": [
    "ad\bow-ruggeri",
    "don_goodliffe"
  ],
  "users.read": [
    "ad\beth-anglin",
    "ad\abel-tuter",
    "carol.coughlin@sharepoint"
  ]
}

    For more details on security principal access permissions, see External content access permissions.
    Initialize Batcher Initializes a new batcher to queue documents for indexing.
    Is AIS Available For Ingestion

    Checks whether AI Search is available for ingestion.
    Look up Supported File Extensions

    Retrieves file extensions supported by AI Search.
    Release Batcher

    Releases a used batcher from pool.
    Update By Query

    Updates all the records in the AI Search content index that match the specified query.
    See Set up the AI Search spoke for information about setting up the AI Search spoke.