Skip to content

Add currentPath parameter to assistant API #3786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify-development wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add currentPath parameter to assistant API #3786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/assistant/create-assistant-message-v2.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,16 @@

- `transport` - Use `DefaultChatTransport` to configure the API connection.
- `body.fp` - Fingerprint identifier (use `'anonymous'` or a unique user identifier).
- `body.retrievalPageSize` - Number of search results to use (recommended: 5).

Check warning on line 95 in api/assistant/create-assistant-message-v2.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message-v2.mdx#L95 

Use parentheses judiciously.

**Optional configuration:**

- `body.context` - Array of contextual information to provide to the assistant. Each context object contains:
- `type` - Either `'code'` or `'textSelection'`.
- `value` - The code snippet or selected text content.
- `path` (optional) - Path to the source file or page.

Check warning on line 102 in api/assistant/create-assistant-message-v2.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message-v2.mdx#L102 

Use parentheses judiciously.
- `elementId` (optional) - Identifier for the UI element containing the context.

Check warning on line 103 in api/assistant/create-assistant-message-v2.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message-v2.mdx#L103 

Use parentheses judiciously.
- `body.currentPath` - The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters.

</Step>
</Steps>
Expand Down
1 change: 1 addition & 0 deletions api/assistant/create-assistant-message.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,15 @@
**Required configuration for Mintlify:**
- `streamProtocol: 'data'` - Required for streaming responses.
- `sendExtraMessageFields: true` - Required to send message metadata.
- `body.fp` - Fingerprint identifier (use 'anonymous' or a user identifier).

Check warning on line 70 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L70 

Use parentheses judiciously.
- `body.retrievalPageSize` - Number of search results to use (recommended: 5).

Check warning on line 71 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L71 

Use parentheses judiciously.

**Optional configuration:**
- `body.context` - Array of contextual information to provide to the assistant. Each context object contains:
- `type` - Either `'code'` or `'textSelection'`.
- `value` - The code snippet or selected text content.
- `elementId` (optional) - Identifier for the UI element containing the context.

Check warning on line 77 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L77 

Use parentheses judiciously.
- `body.currentPath` - The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters.

</Step>
</Steps>
Expand Down
41 changes: 41 additions & 0 deletions discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,43 @@
}
},
"description": "Optional filter criteria for the search."
},
"context": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"code",
"textSelection"
],
"description": "The type of context being provided."
},
"value": {
"type": "string",
"description": "The code snippet or selected text content."
},
"path": {
"type": "string",
"description": "Optional path to the source file or page."
},
"elementId": {
"type": "string",
"description": "Optional identifier for the UI element containing the context."
}
},
"required": [
"type",
"value"
]
},
"description": "Optional array of contextual information to provide to the assistant."
},
"currentPath": {
"type": "string",
"description": "The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters."
}
}
}
Expand Down Expand Up @@ -678,6 +715,10 @@
]
},
"description": "Optional array of contextual information to provide to the assistant."
},
"currentPath": {
"type": "string",
"description": "The path of the page the user is currently viewing. When provided, the assistant uses this context to provide more relevant answers. Maximum length: 200 characters."
}
}
}
Expand Down