docs: clarify 'destination' argument #262
Open
Conversation
This file contains 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
| | embedding | [Embedding configuration](#embedding-configuration) | - | ✔ | Set how to embed the data. | | ||
| | chunking | [Chunking configuration](#chunking-configuration) | - | ✔ | Set the way to split text data, using functions like `ai.chunking_character_text_splitter()`. | | ||
| | indexing | [Indexing configuration](#indexing-configuration) | `ai.indexing_default()` | ✖ | Specify how to index the embeddings. For example, `ai.indexing_diskann()` or `ai.indexing_hnsw()`. | | ||
| | formatting | [Formatting configuration](#formatting-configuration) | `ai.formatting_python_template()` | ✖ | Define the data format before embedding, using `ai.formatting_python_template()`. | | ||
| | scheduling | [Scheduling configuration](#scheduling-configuration) | `ai.scheduling_default()` | ✖ | Set how often to run the vectorizer. For example, `ai.scheduling_timescaledb()`. | | ||
| | processing | [Processing configuration](#processing-configuration ) | `ai.processing_default()` | ✖ | Configure the way to process the embeddings. | | ||
| | target_schema | name | - | ✖ | Specify the schema where the embeddings will be stored. | | ||
| | target_schema | name | - | ✖ | Specify the schema where the embeddings will be stored. This argument takes preference over *destination*. | |
There was a problem hiding this comment.
Suggested change
| | target_schema | name | - | ✖ | Specify the schema where the embeddings will be stored. This argument takes preference over *destination*. | | |
| | target_schema | name | - | ✖ | Specify the schema where the embeddings will be stored. This argument takes precedence over *destination*. | |
| | target_table | name | - | ✖ | Specify name of the table where the embeddings will be stored. | | ||
| | view_schema | name | - | ✖ | Specify the schema where the view is created. | | ||
| | view_name | name | - | ✖ | Specify the name of the view to be created. | | ||
| | queue_schema | name | - | ✖ | Specify the schema where the work queue table is created.. | | ||
| | view_name | name | - | ✖ | Specify the name of the view to be created. This argument takes preference over *destination*. | |
There was a problem hiding this comment.
Suggested change
| | view_name | name | - | ✖ | Specify the name of the view to be created. This argument takes preference over *destination*. | | |
| | view_name | name | - | ✖ | Specify the name of the view to be created. This argument takes precedence over *destination*. | |
| @@ -127,18 +127,18 @@ in other management functions. | |||
| | Name | Type | Default | Required | Description | | |||
| |------------------|--------------------------------------------------------|-----------------------------------|----------|----------------------------------------------------------------------------------------------------| | |||
| | source | regclass | - | ✔ | The source table that embeddings are generated for. | | |||
| | destination | name | - | ✖ | A name for the table the embeddings are stored in. | | |||
| | destination | name | - | ✖ | A name for the table the embeddings will be or are stored in. If defined, *view_name* argument takes this value, and the value of the *target_table* argument is set as `<destination>_store`. | | |||
There was a problem hiding this comment.
I find it confusing that we reference other arguments to explain how this works.
Suggested change
| | destination | name | - | ✖ | A name for the table the embeddings will be or are stored in. If defined, *view_name* argument takes this value, and the value of the *target_table* argument is set as `<destination>_store`. | | |
| | destination | name | - | ✖ | Sets the name of the embedding table and view. Use this to avoid naming conflicts when configuring additional vectorizers for a source table. The view is named `<destination>`, and the embedding table is named `<destination>_store`. | |
There was a problem hiding this comment.
I felt we should clarify that, normally, you either define destination or target_table and view_name. How could we add this without naming those args?
There was a problem hiding this comment.
I understand your point. I think that we could settle both your concern and mine by adding the following sentence to my suggestion above: "Note: the view_name and table_name arguments take precedence, if set."
This allows us to both 1. Define how destination works on its own terms, and 2. Inform the user that view_name and table_name are related to destination.
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.
I believe we must clarify a bit what the
destinationfield is used for and how VStarget_tableandview_name, the more granular options.Open to suggestions, this can taken as the starting point of a discussion.