[DOC-12077] base64 Vector Embeddings (SERVER VERSION) #213
Conversation
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
Adding new field data type to field-data-types-reference and search-index-params Updating properties in search-request-params, to include vector_base64 Modifying create-vector-search-index-ui to reflect base64 encoded strings - made additional updates for clarity, based on some feedback received
…how the navy document looks with base64 encoded strings Added example query for base64 vectors Updated run-vector-search-ui.adoc to include example with base64 strings
bfavini
reviewed
Jul 8, 2024
| + | ||
| Vectors must be represented as an array of floating point numbers. | ||
| .. In the *Type* list, select *vector*. | ||
| .. In the *Type* list, select do one of the following: |
There was a problem hiding this comment.
@sarahlwelton should you delete "select here? "select do one of the following"?
Contributor
Author
There was a problem hiding this comment.
See this is why I wanted a review :D Thank you!
bfavini
reviewed
Jul 8, 2024
| include::example$run-vector-search-payload-base64-ui.jsonc[] | ||
| ---- | ||
|
|
||
| NOTE: You can only use base64 encoded strings in your Vector Search queries if your documents use base64 encoded strings, indexed with the *vector_base64* field data type. |
There was a problem hiding this comment.
You can use base64 encoded strings in your Vector Search only if your documents use base64-encoded strings...
bfavini
pushed a commit
that referenced
this pull request
Jul 19, 2024
* Added error for CYCLE clause in WITH RECURSIVE page in 7.6.2 (#231) * Added error for 7.6.2 * Added patch release * [DOC-12129] base64 encoding/decoding functions in Eventing (Server 7.6.2) (#229) * Added info about base64 functions * Small update to language construct page * DOC-11756: JavaScript language restrictions for JS-UDFs [Server 7.6.2] (#237) * DOC-11756 Language Restrictions * DOC-10013 Update title of calling JavaScript topic * DOC-10013 Update JavaScript UDF introduction to describe inline and external functions * DOC-10013 Add titles to diagram preview doc * DOC-10013 Improve partial for external libraries and scopes * DOC-10013 Add partial for SQL++ Managed UDFs * DOC-10013 Minor wording updates for JavaScript UDF diagrams * DOC-10013 Minor wording updates for JavaScript UDF reference * DOC-10013 Update links for JavaScript UDF reference * DOC-10013 Minor formatting updates for CREATE FUNCTION * DOC-10013 These lines left blank intentionally * DOC-10013 Add extra link to Calling SQL++ from JavaScript * Remove unused nav partial for JavaScript UDFs * Drive-by fix: link to Query Admin page * Drive-by fix: replace SVG files with Kroki diagrams * Updates after review * DOC-12048: New indexer setting for default value of "defer build" (#239) * Add section on deferring index builds by default * Add horizontal style for all index arguments * Use tables for object parameters * Remove outdated version notices * Minor formatting changes: consistent brackets, admonition placement * Added note that you cannot use WITH NODES if you have enabled file-based index rebalancing * [DOC-12139] Raise Dimensionality Support for Vector Search (#212) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12139] Update the two mentions of dimensionality in vector-search-field-descriptions partial and create-vector-search-index-ui * Revert "[DOC-12038] Adding note about travel sample docs not including xattrs" This reverts commit ad934e8. * Revert "[DOC-12038] Adding note about xattrs support to search.adoc" This reverts commit 4c3f14d. * Revert "[DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh" This reverts commit 99e3c0f. * [DOC-12139] Add version caveat to dimensionality changes. * [DOC-12077] base64 Vector Embeddings (SERVER VERSION) (#213) * [DOC-12077] Quick initial pass adding info on base64 Adding new field data type to field-data-types-reference and search-index-params Updating properties in search-request-params, to include vector_base64 Modifying create-vector-search-index-ui to reflect base64 encoded strings - made additional updates for clarity, based on some feedback received * [DOC-12077] Added vector-search-base64-document-example.json to show how the navy document looks with base64 encoded strings Added example query for base64 vectors Updated run-vector-search-ui.adoc to include example with base64 strings * [DOC-12077] Add version caveat to all changes. * [DOC-12077] Adding missing word and space * [DOC-12077] Comments from writer review * [DOC-12047] Edit JSON Query Requests in Couchbase Web Console (#209) * [DOC-12047] Updating run-searches, simple-search-rest-api, simple-search-ui, and geo-search-ui to add more info about getting command line examples and editing query request JSON directly in the UI * [DOC-12047] Adding caveats about required patch version. * Change language around version caveat * Change language around version caveat * Update simple-search-ui.adoc * [DOC-12074] Support match_none as the Default `query` object for Vector Searches (#210) * [DOC-12074] Updating run-vector-search-payload-ui to remove the match_none object, as it's not necessary Updating search-request-params and run-vector-search-ui to reflect that the match_none object is no longer required * [DOC-12074] Removing "match_none" from SQL++ query example * [DOC-12074] Adding version information to default match_none query object behaviour * Update search-request-params.adoc * [DOC-12038] Use XATTRS in Search Indexes, Search Queries, and SQL++ Search Functions (SERVER) (#211) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12038] Add version limitation info to all changes. * Update metafun.adoc * Update searchfun.adoc * Update customize-index.adoc * Update search.adoc * DOC-12187 File based rebalance now supports placing indexes on nodes (#234) * Change statements about index placement with file-based rebalance enabled ito indicate it's no longer a restriction. * Changes based on Varun's feedback. * [DOC-12049] LOOKUPIN operation in Eventing (Server 7.6.2) (#230) * Added subdocument LOOKUPIN operation to page * Added new example page and made small changes to existing pages * Added new page link to examples page * Update eventing-advanced-keyspace-accessors.adoc * Update eventing-handler-advancedLookupInOp.adoc * Update eventing-advanced-keyspace-accessors.adoc * Update nav.adoc for Server 7.6.2 (#241) --------- Co-authored-by: Julia Browne <[email protected]> Co-authored-by: Simon Dew <[email protected]> Co-authored-by: Sarah Welton <[email protected]> Co-authored-by: sarahlwelton <[email protected]> Co-authored-by: Gary Gray <[email protected]>
simon-dew
added a commit
that referenced
this pull request
Dec 3, 2024
* Added error for CYCLE clause in WITH RECURSIVE page in 7.6.2 (#231) * Added error for 7.6.2 * Added patch release * [DOC-12129] base64 encoding/decoding functions in Eventing (Server 7.6.2) (#229) * Added info about base64 functions * Small update to language construct page * DOC-11756: JavaScript language restrictions for JS-UDFs [Server 7.6.2] (#237) * DOC-11756 Language Restrictions * DOC-10013 Update title of calling JavaScript topic * DOC-10013 Update JavaScript UDF introduction to describe inline and external functions * DOC-10013 Add titles to diagram preview doc * DOC-10013 Improve partial for external libraries and scopes * DOC-10013 Add partial for SQL++ Managed UDFs * DOC-10013 Minor wording updates for JavaScript UDF diagrams * DOC-10013 Minor wording updates for JavaScript UDF reference * DOC-10013 Update links for JavaScript UDF reference * DOC-10013 Minor formatting updates for CREATE FUNCTION * DOC-10013 These lines left blank intentionally * DOC-10013 Add extra link to Calling SQL++ from JavaScript * Remove unused nav partial for JavaScript UDFs * Drive-by fix: link to Query Admin page * Drive-by fix: replace SVG files with Kroki diagrams * Updates after review * DOC-12048: New indexer setting for default value of "defer build" (#239) * Add section on deferring index builds by default * Add horizontal style for all index arguments * Use tables for object parameters * Remove outdated version notices * Minor formatting changes: consistent brackets, admonition placement * Added note that you cannot use WITH NODES if you have enabled file-based index rebalancing * [DOC-12139] Raise Dimensionality Support for Vector Search (#212) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12139] Update the two mentions of dimensionality in vector-search-field-descriptions partial and create-vector-search-index-ui * Revert "[DOC-12038] Adding note about travel sample docs not including xattrs" This reverts commit ad934e8. * Revert "[DOC-12038] Adding note about xattrs support to search.adoc" This reverts commit 4c3f14d. * Revert "[DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh" This reverts commit 99e3c0f. * [DOC-12139] Add version caveat to dimensionality changes. * [DOC-12077] base64 Vector Embeddings (SERVER VERSION) (#213) * [DOC-12077] Quick initial pass adding info on base64 Adding new field data type to field-data-types-reference and search-index-params Updating properties in search-request-params, to include vector_base64 Modifying create-vector-search-index-ui to reflect base64 encoded strings - made additional updates for clarity, based on some feedback received * [DOC-12077] Added vector-search-base64-document-example.json to show how the navy document looks with base64 encoded strings Added example query for base64 vectors Updated run-vector-search-ui.adoc to include example with base64 strings * [DOC-12077] Add version caveat to all changes. * [DOC-12077] Adding missing word and space * [DOC-12077] Comments from writer review * [DOC-12047] Edit JSON Query Requests in Couchbase Web Console (#209) * [DOC-12047] Updating run-searches, simple-search-rest-api, simple-search-ui, and geo-search-ui to add more info about getting command line examples and editing query request JSON directly in the UI * [DOC-12047] Adding caveats about required patch version. * Change language around version caveat * Change language around version caveat * Update simple-search-ui.adoc * [DOC-12074] Support match_none as the Default `query` object for Vector Searches (#210) * [DOC-12074] Updating run-vector-search-payload-ui to remove the match_none object, as it's not necessary Updating search-request-params and run-vector-search-ui to reflect that the match_none object is no longer required * [DOC-12074] Removing "match_none" from SQL++ query example * [DOC-12074] Adding version information to default match_none query object behaviour * Update search-request-params.adoc * [DOC-12038] Use XATTRS in Search Indexes, Search Queries, and SQL++ Search Functions (SERVER) (#211) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12038] Add version limitation info to all changes. * Update metafun.adoc * Update searchfun.adoc * Update customize-index.adoc * Update search.adoc * DOC-12187 File based rebalance now supports placing indexes on nodes (#234) * Change statements about index placement with file-based rebalance enabled ito indicate it's no longer a restriction. * Changes based on Varun's feedback. * [DOC-12049] LOOKUPIN operation in Eventing (Server 7.6.2) (#230) * Added subdocument LOOKUPIN operation to page * Added new example page and made small changes to existing pages * Added new page link to examples page * Update eventing-advanced-keyspace-accessors.adoc * Update eventing-handler-advancedLookupInOp.adoc * Update eventing-advanced-keyspace-accessors.adoc * Update nav.adoc for Server 7.6.2 (#241) --------- Co-authored-by: Julia Browne <[email protected]> Co-authored-by: Simon Dew <[email protected]> Co-authored-by: Sarah Welton <[email protected]> Co-authored-by: sarahlwelton <[email protected]> Co-authored-by: Gary Gray <[email protected]>
simon-dew
added a commit
that referenced
this pull request
Dec 4, 2024
* Added error for CYCLE clause in WITH RECURSIVE page in 7.6.2 (#231) * Added error for 7.6.2 * Added patch release * [DOC-12129] base64 encoding/decoding functions in Eventing (Server 7.6.2) (#229) * Added info about base64 functions * Small update to language construct page * DOC-11756: JavaScript language restrictions for JS-UDFs [Server 7.6.2] (#237) * DOC-11756 Language Restrictions * DOC-10013 Update title of calling JavaScript topic * DOC-10013 Update JavaScript UDF introduction to describe inline and external functions * DOC-10013 Add titles to diagram preview doc * DOC-10013 Improve partial for external libraries and scopes * DOC-10013 Add partial for SQL++ Managed UDFs * DOC-10013 Minor wording updates for JavaScript UDF diagrams * DOC-10013 Minor wording updates for JavaScript UDF reference * DOC-10013 Update links for JavaScript UDF reference * DOC-10013 Minor formatting updates for CREATE FUNCTION * DOC-10013 These lines left blank intentionally * DOC-10013 Add extra link to Calling SQL++ from JavaScript * Remove unused nav partial for JavaScript UDFs * Drive-by fix: link to Query Admin page * Drive-by fix: replace SVG files with Kroki diagrams * Updates after review * DOC-12048: New indexer setting for default value of "defer build" (#239) * Add section on deferring index builds by default * Add horizontal style for all index arguments * Use tables for object parameters * Remove outdated version notices * Minor formatting changes: consistent brackets, admonition placement * Added note that you cannot use WITH NODES if you have enabled file-based index rebalancing * [DOC-12139] Raise Dimensionality Support for Vector Search (#212) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12139] Update the two mentions of dimensionality in vector-search-field-descriptions partial and create-vector-search-index-ui * Revert "[DOC-12038] Adding note about travel sample docs not including xattrs" This reverts commit ad934e8. * Revert "[DOC-12038] Adding note about xattrs support to search.adoc" This reverts commit 4c3f14d. * Revert "[DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh" This reverts commit 99e3c0f. * [DOC-12139] Add version caveat to dimensionality changes. * [DOC-12077] base64 Vector Embeddings (SERVER VERSION) (#213) * [DOC-12077] Quick initial pass adding info on base64 Adding new field data type to field-data-types-reference and search-index-params Updating properties in search-request-params, to include vector_base64 Modifying create-vector-search-index-ui to reflect base64 encoded strings - made additional updates for clarity, based on some feedback received * [DOC-12077] Added vector-search-base64-document-example.json to show how the navy document looks with base64 encoded strings Added example query for base64 vectors Updated run-vector-search-ui.adoc to include example with base64 strings * [DOC-12077] Add version caveat to all changes. * [DOC-12077] Adding missing word and space * [DOC-12077] Comments from writer review * [DOC-12047] Edit JSON Query Requests in Couchbase Web Console (#209) * [DOC-12047] Updating run-searches, simple-search-rest-api, simple-search-ui, and geo-search-ui to add more info about getting command line examples and editing query request JSON directly in the UI * [DOC-12047] Adding caveats about required patch version. * Change language around version caveat * Change language around version caveat * Update simple-search-ui.adoc * [DOC-12074] Support match_none as the Default `query` object for Vector Searches (#210) * [DOC-12074] Updating run-vector-search-payload-ui to remove the match_none object, as it's not necessary Updating search-request-params and run-vector-search-ui to reflect that the match_none object is no longer required * [DOC-12074] Removing "match_none" from SQL++ query example * [DOC-12074] Adding version information to default match_none query object behaviour * Update search-request-params.adoc * [DOC-12038] Use XATTRS in Search Indexes, Search Queries, and SQL++ Search Functions (SERVER) (#211) * [DOC-12038] Added xattrs object to REST API example, create-search-index-payload.sh Created a new example to show all of the nested JSON objects in a search index definition with nest-json-object-example.jsonc Added an xattrs example to query-field-name.jsonc Added xattrs to simple-search-index-payload.jsonc Added a clarifying sentence to create-child-mapping.adoc Added context about xattrs mapping to create-search-index-rest-api.adoc Created create-xattrs-mapping.adoc Added a link and then info on xattrs mappings to customize-index.adoc Added info and examples on xattrs objects to search-index-params.adoc Added examples for searching xattrs to search-request-params.adoc Added create-xattrs-mapping to nav.adoc * [DOC-12038] Adding note about xattrs support to search.adoc Updating metafun and searchfun to explain accessing xattrs from Search Service in SQL++ * [DOC-12038] Adding note about travel sample docs not including xattrs * [DOC-12038] Add version limitation info to all changes. * Update metafun.adoc * Update searchfun.adoc * Update customize-index.adoc * Update search.adoc * DOC-12187 File based rebalance now supports placing indexes on nodes (#234) * Change statements about index placement with file-based rebalance enabled ito indicate it's no longer a restriction. * Changes based on Varun's feedback. * [DOC-12049] LOOKUPIN operation in Eventing (Server 7.6.2) (#230) * Added subdocument LOOKUPIN operation to page * Added new example page and made small changes to existing pages * Added new page link to examples page * Update eventing-advanced-keyspace-accessors.adoc * Update eventing-handler-advancedLookupInOp.adoc * Update eventing-advanced-keyspace-accessors.adoc * Update nav.adoc for Server 7.6.2 (#241) --------- Co-authored-by: Julia Browne <[email protected]> Co-authored-by: Simon Dew <[email protected]> Co-authored-by: Sarah Welton <[email protected]> Co-authored-by: sarahlwelton <[email protected]> Co-authored-by: Gary Gray <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With 7.6.2, Vector Search will support a new field data type,
vector_base64, which will let users index and query vectors stored as base64 encoded strings, instead of arrays.These changes support the new field data type and query object specific to base64 vectors - for the Server documentation.