Skip to content
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

Clarify what does Parameters, Au.Head and S.Secret stand for in astra db list list-embedding-providers #216

Open
msmygit opened this issue Jan 27, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@msmygit
Copy link
Collaborator

msmygit commented Jan 27, 2025

Is your feature request related to a problem? Please describe.
Using 0.6 version when I run the below, I get the correct output as,

 % astra db list-embedding-providers vector
+----------------------+--------------------------+--------+------------+---------+----------+
| Key                  | DisplayName              | Models | Parameters | Au.Head | S.Secret |
+----------------------+--------------------------+--------+------------+---------+----------+
| cohere               | Cohere                   | 3      | 0          | ■       | ■        |
| openai               | OpenAI                   | 3      | 2          | ■       | ■        |
| huggingfaceDedicated | Hugging Face - Dedicated | 1      | 3          | ■       | ■        |
| azureOpenAI          | Azure OpenAI             | 3      | 2          | ■       | ■        |
| bedrock              | Amazon Bedrock           | 2      | 1          | ■       | ■        |
| jinaAI               | Jina AI                  | 5      | 0          | ■       | ■        |
| voyageAI             | Voyage AI                | 7      | 1          | ■       | ■        |
| upstageAI            | Upstage                  | 1      | 0          | ■       | ■        |
| huggingface          | Hugging Face - Serverless| 6      | 0          | ■       | ■        |
| mistral              | Mistral AI               | 1      | 0          | ■       | ■        |
+----------------------+--------------------------+--------+------------+---------+----------+

although it is unclear what are the last 3 columns are for.

Describe the solution you'd like
Maybe provide some details about it on the help command output:

% astra help db list-embedding-providers
NAME
        astra db list-embedding-providers - Display the list of embedding
        providers in an database

SYNOPSIS
        astra db list-embedding-providers
                [ {-cf | --config-file} <CONFIG_FILE> ]
                [ {-conf | --config} <CONFIG_SECTION> ] [ --env <Environment> ]
                [ --no-color ] [ {-o | --output} <FORMAT> ]
                [ --token <AUTH_TOKEN> ] [ {-v | --verbose} ] [--] <DB>

OPTIONS
        -cf <CONFIG_FILE>, --config-file <CONFIG_FILE>
            Configuration file (default = ~/.astrarc)

        -conf <CONFIG_SECTION>, --config <CONFIG_SECTION>
            Section in configuration file (default = ~/.astrarc)

        --env <Environment>
            Astra Environment to use

        --no-color
            Remove all colors in output

        -o <FORMAT>, --output <FORMAT>
            Output format, valid values are: human,json,csv

        --token <AUTH_TOKEN>
            Key to use authenticate each call.

        -v, --verbose
            Verbose mode with log in console

        --
            This option can be used to separate command-line options from the
            list of arguments (useful when arguments might be mistaken for
            command-line options)

        <DB>
            Database name (if unique) or Database identifier

Describe alternatives you've considered
n/a

Additional context
n/a

@msmygit msmygit added enhancement New feature or request help wanted Extra attention is needed labels Jan 27, 2025
@clun
Copy link
Collaborator

clun commented Jan 27, 2025

Ack sure good idea, more information can be extracted for one particular provider with the following

astra db describe-embedding-provider vector --embedding-provider openai

example output

+-------------------+---------------------------------------------------------------------------------------------+
| Attribute         | Value                                                                                       |
+-------------------+---------------------------------------------------------------------------------------------+
| Key               | openai                                                                                      |
| DisplayName       | OpenAI                                                                                      |
| Parameters        | [0] organizationId (STRING)                                                                 |
|                   | [1] projectId (STRING)                                                                      |
| Models:           |                                                                                             |
| Name              | text-embedding-3-small                                                                      |
| Parameters        | [0] vectorDimension (number) , defaultValue=1536                                            |
| Name              | text-embedding-3-large                                                                      |
| Parameters        | [0] vectorDimension (number) , defaultValue=3072                                            |
| Name              | text-embedding-ada-002                                                                      |
| Vector Dimension  | 1536                                                                                        |
| Header Auth:      |                                                                                             |
| Tokens            | [0] forwarded=Authorization, accepted=x-embedding-api-key                                   |
| Shar.Secret Auth: |                                                                                             |
| Tokens            | [0] forwarded=Authorization, accepted=providerKey                                           |
| Supported Auth:   |                                                                                             |
| Authentication    | [0] NONE: []                                                                                |
|                   | [1] SHARED_SECRET: [EmbeddingProvider.Token(forwarded=Authorization, accepted=providerKey)] |
|                   | [2] HEADER: [EmbeddingProvider.Token(forwarded=Authorization, accepted=x-embedding-api-key)]|
+-------------------+---------------------------------------------------------------------------------------------+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants