AI Search Spoke

  • Release version: Xanadu
  • Updated August 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 manage data from third-party applications within the AI Search server using Workflow Studio. Users can access this data through the AI Search portal, facilitating enhanced search and indexing capabilities.

    Show full answer Show less

    This spoke requires an Integration Hub subscription and depends on the activation of specific plugins, including AI Search (com.glide.ais) and External Content for AI Search (com.glide.ais.externalcontent). Some plugins may require appropriate licensing when used beyond the spoke's implementation.

    Key Features

    • Commit Index: Commits queued documents in the batcher and indexes them with synchronous feedback.
    • Delete Document(s): Deletes individual or multiple records from the AI Search content index, with optional query filtering.
    • Get Max File Size: Retrieves the maximum file size allowed for ingestion into AI Search.
    • Ingest Document: Adds document properties into the batcher using JSON-formatted name-value pairs, with optional security principal access permissions to control visibility.
    • Ingest Document Using Download URL: Downloads and ingests documents directly from URLs, requiring the domain to be trusted and allowing specification of access permissions. Supports only unauthenticated URLs.
    • Initialize Batcher and Release Batcher: Manages batchers to queue documents for indexing and releases used batchers from the pool.
    • Is AIS Available For Ingestion: Checks AI Search availability for document ingestion.
    • Look up Supported File Extensions: Retrieves a list of file extensions supported by AI Search.
    • Update By Query: Updates all indexed records matching a specified query.

    Security principal access permissions allow fine-grained control over who can read or deny access to documents, using JSON configurations for users and groups.

    Practical Considerations

    • Ensure Integration Hub subscription and dependent plugins are activated before installation.
    • When ingesting documents via URL, add the domain to the trusted list and ensure the URL permits unauthenticated access (no session or cookie authentication supported).
    • Use security principal permissions to control access at user and group levels for ingested content.
    • Refer to the AI Search spoke setup documentation for detailed configuration instructions.

    Store data from the required third-party application in the AI Search server through Workflow Studio. 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.