nikon/docsearch
1
0
Fork 0
Code Activity Actions

Simplify DocSearchProps types definitions

Browse source
This commit is contained in:
Paul Jankowski 2026-01-15 15:15:08 -05:00
parent 1a7290eb28
commit b53bc97688
No known key found for this signature in database
1 changed files with 42 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
packages/docsearch-react/src/DocSearch.tsx
View file

@ -36,6 +36,31 @@ export type AskAiSearchParameters = {
export type AgentStudioSearchParameters = Record<string, Omit<AskAiSearchParameters, 'facetFilters'>>;
export type AgentStudioAskAi = {
/**
* The API key to use for the ask AI feature. Your assistant will use this API key to search the index.
* If not provided, the API key will be used.
*/
apiKey?: string;
/**
* The app ID to use for the ask AI feature. Your assistant will use this app ID to search the index.
* If not provided, the app ID will be used.
*/
appId?: string;
/**
* The assistant ID to use for the ask AI feature.
*/
assistantId: string;
/**
* Enables displaying suggested questions on Ask AI's new conversation screen.
*
* @default false
*/
suggestedQuestions?: boolean;
agentStudio: true;
searchParameters?: AgentStudioSearchParameters;
};
export type DocSearchAskAi = {
/**
* The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@ -64,43 +89,22 @@ export type DocSearchAskAi = {
suggestedQuestions?: boolean;
// HACK: This is a hack for testing staging, remove before releasing
useStagingEnv?: boolean;
} & (
| {
/**
* **Experimental:** Whether to use Agent Studio as the chat backend.
*
* This is an experimental feature and its API may change without notice in future releases.
* Use with caution in production environments.
*
* @default false
*/
agentStudio?: never;
/**
* The search parameters to use for the ask AI feature.
*
* **NOTE**: If using `agentStudio = true`, the `searchParameters` object is
* keyed by the index name.
*/
searchParameters?: AskAiSearchParameters;
}
| {
agentStudio: false;
searchParameters?: AskAiSearchParameters;
}
| {
agentStudio: true;
/**
* The search parameters to use for the ask AI feature.
* Keyed by the index name.
*
* @example
* {
* "INDEX_NAME": { distinct: false }
* }
*/
searchParameters?: AgentStudioSearchParameters;
}
);
/**
* **Experimental:** Whether to use Agent Studio as the chat backend.
*
* This is an experimental feature and its API may change without notice in future releases.
* Use with caution in production environments.
*
* @default false
*/
agentStudio?: never | false;
/**
* The search parameters to use for the ask AI feature.
*
* **NOTE**: If using `agentStudio: true`, the search parameters are keyed by index name.
*/
searchParameters?: AskAiSearchParameters;
};
export interface DocSearchIndex {
name: string;
@ -131,7 +135,7 @@ export interface DocSearchProps {
/**
* Configuration or assistant id to enable ask ai mode. Pass a string assistant id or a full config object.
*/
askAi?: DocSearchAskAi | string;
askAi?: AgentStudioAskAi | DocSearchAskAi | string;
/**
* Intercept Ask AI requests (e.g. Submitting a prompt or selecting a suggested question).
*