Skip to main content

Prerequisites (once per project/toolkit)

  • Credential for your toolkit (required for all except Artifact). See Create a Credential.
  • Vector Storage: PgVector selected in Settings → AI Configuration.
  • Embedding Model selected in AI Configuration (defaults available).
  • A configured Toolkit that supports indexing. See Indexing Overview.
Supported toolkits: ADO Repos, ADO Wiki, ADO Plans, ADO Boards, Bitbucket, GitHub, GitLab, Confluence, Jira, SharePoint, Artifact, Figma, TestRail, Xray Cloud, Zephyr Enterprise, Zephyr Essential, Zephyr Scale.

Index Data

Create or update an index from your source system. Where to run it: Recommended: Indexes Tab Interface Open your Toolkit → Indexes → ”+” → configure → RUN. Index Data – form Alternative: TEST SETTINGS Open your Toolkit → TEST SETTINGS → select “Index data” → configure → RUN TOOL Index test settings

Purpose

  • Build a new index collection or update an existing one for later search and Q&A.

Common Settings and Parameters

Toolkit Specific Settings and Parameters


Search Index

Search your indexed content using natural language. Recommended: Indexes Tab Interface Open your Toolkit → Indexes → “Run” tab → select “Search index” → configure → RUN. Index Data – form Alternative: TEST SETTINGS Toolkit → TEST SETTINGS → select “Search index” → configure → RUN TOOL.

Purpose

  • Retrieve relevant chunks from one or more index collections.

Common Settings and Parameters

Applicable to all toolkits that support indexing.

Stepback Search Index

Advanced search that first “simplifies” your query for better matches and can consider conversation context. Recommended: Indexes Tab Interface Open your Toolkit → Indexes → “Run” tab → select “Stepback search index” → configure → RUN. Stepback Search – form Alternative: TEST SETTINGS Toolkit → TEST SETTINGS → select “Stepback search index” → configure → RUN TOOL.

Purpose

  • Improve retrieval by transforming your question (e.g., “How do I configure GitHub auth?” → “configure GitHub authentication”). Returns raw results.

Common Settings and Parameters

  • Applicable to all toolkits that support indexing.
  • Output is a list of matching documents/chunks. If you prefer a generated answer, use Stepback Summary Index.

Stepback Summary Index

Contextual search plus an AI‑generated answer, with optional citations. Recommended: Indexes Tab Interface Open your Toolkit → Indexes → “Run” tab → select “Stepback Sumary index” → configure → RUN. Stepback Search – form Alternative: TEST SETTINGS: Toolkit → TEST SETTINGS → select “Stepback summary index”→ configure → RUN..

Purpose

  • Combine stepback search with a concise, human‑readable answer. Good for end‑users who want a direct response.

Common Settings and Parameters

  • Applicable to all toolkits that support indexing.
  • If the answer lacks sources, increase Search Top or lower Cut Off slightly to include more candidate passages.

Remove Index

Delete an existing collection (index) when it’s no longer needed. Recommended: Indexes Tab Interface Open your Toolkit → Indexes → “Select Index” → Delete. Delete Index Alternative: TEST SETTINGS: Toolkit → TEST SETTINGS → “Remove index”. Remove Index – form

Purpose

  • Clean up test data or retire outdated collections.

Applies to toolkits

  • All toolkits that support indexing.

Fields

Removing an index deletes its data from vector storage for this toolkit. Make sure you’re targeting the correct collection.

List Collections

List all available collections for the toolkit. Recommended: Indexes Tab Interface Open your Toolkit → Indexes → “Left sidebar. List Index Alternative: TEST SETTINGS: Toolkit → TEST SETTINGS → “List collections”. List Collections – output

Purpose

  • Quickly verify what indexes exist and their names (suffixes).

Fields


Stepback tools: quick comparison


Tips and troubleshooting

  • If Search returns few/no results, try lowering Cut Off (e.g., from 0.5 to 0.35) or increasing Search Top.
  • Use Collection Suffix consistently (e.g., prod/test) so you can target the right dataset later.
  • For better Q&A, consider Proposal chunking when indexing (enables titles/summaries/propositions).
  • Known limitations and workarounds: see Release Notes 1.7.0.