-
Notifications
You must be signed in to change notification settings - Fork 5
Add Mixpeek guide #242
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.
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
katieschilling
wants to merge
1
commit into
main
Choose a base branch
from
katie/add-mixpeek
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add Mixpeek guide #242
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # Mixpeek | ||
|
|
||
| Mixpeek is a multimodal platform that provides a semantic layer that works | ||
| out-of-the box. Connect your Tigris bucket to Mixpeek, and it lets you | ||
| automatically index and search across text, images, audio, video, and other file | ||
| types using natural language and vector similarity. It connects to your object | ||
| storage (like Tigris) to perform data extraction, generate embeddings, and | ||
| enable semantic queries—by default, with no additional configuration. With | ||
| Tigris, your data is globally replicated and instantly available via a simple | ||
| S3-compatible API, making it easy for Mixpeek to keep everything indexed and | ||
| searchable in real time. | ||
|
|
||
| By the end of this guide, you'll have: | ||
|
|
||
| - Connected Mixpeek to your Tigris bucket | ||
| - Uploaded files for indexing | ||
| - Performed a multimodal search over your stored content | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, make sure you have: | ||
|
|
||
| - A Tigris object storage bucket already created | ||
| - Your Tigris access key and secret | ||
| - A Mixpeek account and API key | ||
|
|
||
| ## 1. Set Environment Variables | ||
|
|
||
| Start by setting your credentials and endpoint information in your environment: | ||
|
|
||
| ```bash | ||
| export MIXPEEK_API_KEY=<your_mixpeek_api_key> | ||
| export AWS_ACCESS_KEY_ID=<your_tigris_access_key> | ||
| export AWS_SECRET_ACCESS_KEY=<your_tigris_secret_key> | ||
| export AWS_REGION=auto | ||
| export AWS_S3_ENDPOINT=https://fly.storage.tigris.dev | ||
| export BUCKET_NAME=<your_bucket_name> | ||
| ``` | ||
|
|
||
| ## 2. Initialize Mixpeek with Tigris Storage | ||
|
|
||
| Use the Mixpeek Python SDK to register your Tigris bucket as a storage source: | ||
|
|
||
| ```python | ||
| from mixpeek import Mixpeek | ||
| import os | ||
|
|
||
| mp = Mixpeek(api_key=os.getenv("MIXPEEK_API_KEY")) | ||
|
|
||
| mp.set_storage( | ||
| name="tigris-bucket", | ||
| type="s3", | ||
| endpoint=os.getenv("AWS_S3_ENDPOINT"), | ||
| access_key=os.getenv("AWS_ACCESS_KEY_ID"), | ||
| secret_key=os.getenv("AWS_SECRET_ACCESS_KEY"), | ||
| region=os.getenv("AWS_REGION") | ||
| ) | ||
| ``` | ||
|
|
||
| ## 3. Upload Files to Tigris | ||
|
|
||
| Mixpeek can automatically index files you upload to your bucket. Here’s how to | ||
| upload via the SDK: | ||
|
|
||
| ```python | ||
| mp.upload( | ||
| bucket="tigris-bucket", | ||
| key="datasets/report.pdf", | ||
| metadata={"project": "Q3 Analysis", "type": "report"} | ||
| ) | ||
| ``` | ||
|
|
||
| ## 4. Run a Multimodal Search | ||
|
|
||
| Once your files are indexed, you can search across them using natural language: | ||
|
|
||
| ```python | ||
| results = mp.search("PDFs with revenue graphs and charts") | ||
| for result in results: | ||
| print(result["key"], result["score"]) | ||
| ``` | ||
|
|
||
| You can combine semantic search with metadata filtering and keyword matching to | ||
| fine-tune results. | ||
|
|
||
| ## You Did It! | ||
|
|
||
| You now have a working integration between Tigris and Mixpeek. | ||
|
|
||
| - Files uploaded to your Tigris bucket are automatically indexed | ||
| - Vector embeddings and metadata are extracted behind the scenes | ||
| - You can search across text, images, audio, video, and more using natural | ||
| language | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -200,6 +200,11 @@ const sidebars = { | |
| }, | ||
| ], | ||
| }, | ||
| { | ||
| type: "doc", | ||
| label: "Mixpeek", | ||
| id: "guides/mixpeek", | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://t3.storage.dev