Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions api/assistant/create-assistant-message-v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
body: {
fp: "anonymous",
retrievalPageSize: 5,
currentPath: "/guides/getting-started",
context: [
{
type: "code",
Expand Down Expand Up @@ -92,15 +93,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 96 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#L96

Use parentheses judiciously.

**Optional configuration:**

- `body.currentPath` - The path of the page the user is currently viewing (e.g., `/guides/getting-started`). When provided, the assistant uses this context to provide more relevant answers.

Check warning on line 100 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#L100

Use parentheses judiciously.

Check warning on line 100 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#L100

Use 'for example' instead of 'e.g.'.
- `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 104 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#L104

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

Check warning on line 105 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#L105

Use parentheses judiciously.

</Step>
</Steps>
Expand Down
2 changes: 2 additions & 0 deletions api/assistant/create-assistant-message.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
body: {
fp: 'anonymous',
retrievalPageSize: 5,
currentPath: '/guides/getting-started',
context: [
{
type: 'code',
Expand Down Expand Up @@ -67,14 +68,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 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.
- `body.retrievalPageSize` - Number of search results to use (recommended: 5).

Check warning on line 72 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#L72

Use parentheses judiciously.

**Optional configuration:**
- `body.currentPath` - The path of the page the user is currently viewing (e.g., `/guides/getting-started`). When provided, the assistant uses this context to provide more relevant answers.

Check warning on line 75 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#L75

Use parentheses judiciously.

Check warning on line 75 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#L75

Use 'for example' instead of 'e.g.'.
- `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 79 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#L79

Use parentheses judiciously.

</Step>
</Steps>
Expand Down
8 changes: 8 additions & 0 deletions discovery-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,10 @@
}
},
"description": "Optional filter criteria for the search."
},
"currentPath": {
"type": "string",
"description": "The path of the page the user is currently viewing. When provided, the assistant includes this context in its system prompt, allowing it to provide more relevant answers based on the user's location in the documentation. Maximum 200 characters."
}
}
}
Expand Down Expand Up @@ -678,6 +682,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 includes this context in its system prompt, allowing it to provide more relevant answers based on the user's location in the documentation. Maximum 200 characters."
}
}
}
Expand Down