Skip to content

Add external_user_id to semantic search docs and update its desc in a… #49

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
aralyekta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add external_user_id to semantic search docs and update its desc in a… #49

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
2 changes: 1 addition & 1 deletion api-reference/endpoints/ask-question.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To ask follow-up questions, include the `session_id` from a previous response in
</ParamField>

<ParamField body="external_user_id" type="string">
External user identifier for tracking user-specific conversation sessions. When provided, this ID is stored in the session. If a session already exists with a different external_user_id, the request will be rejected.
External user identifier for tracking user-specific conversation sessions. When provided, this ID is stored in the session. If a session already exists with a different external_user_id, the request will be rejected. It needs to be UUID.
</ParamField>

<ParamField body="fetch_existing" type="boolean" default={false}>
Expand Down
4 changes: 4 additions & 0 deletions api-reference/endpoints/semantic-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Retrieve sources that are most relevant to a given question. This endpoint fetch
Array of labels to filter sources by. If provided, only sources with matching labels will be returned. If multiple labels are provided, they are OR'ed. Meaning data sources belonging to any of those labels are returned.
</ParamField>

<ParamField body="external_user_id" type="string">
External user identifier. This allows you to track search queries per user in your analytics. It should be UUID.
</ParamField>

### Response

The response contains an array of source objects and total count.
Expand Down