MLE-23398 Added docs for vector functions#115
Merged
Conversation
Hat tip to Copilot.
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for vector embedding functionality in the MarkLogic Python client, specifically covering how to use base64 encoding utilities for vector data when writing documents.
- Added a new section explaining vector embeddings support in MarkLogic 12 and the Python client
- Provided code example demonstrating the use of
base64_encodefunction from themarklogic.vectorsmodule - Documented the performance benefits of encoding vectors as base64 strings before database storage
| "embedding": encoded_vector # Store as encoded string | ||
| } | ||
|
|
||
| doc = Document("/documents/sample-doc.json", document_content, permissions=default_perms) |
There was a problem hiding this comment.
The variable default_perms is used in the example but is not defined or explained. Consider either defining this variable in the example or adding a comment explaining where it comes from, such as referencing earlier documentation sections.
BillFarber
approved these changes
Aug 6, 2025
Contributor
Author
|
The vector tests are failing because Jenkinsfile is using MarkLogic 11, I'll fix in a separate PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hat tip to Copilot.