Este tópico descreve como criar uma coleção com o SDK para Python.
Pré-requisitos
Cluster criado. Para mais informações, consulte Crie um cluster.
Chave de API obtida. Para mais informações, consulte Gerenciamento de chaves de API.
Versão mais recente do SDK instalada. Para mais informações, consulte Instale o DashVector SDK.
Definição da API
Client.create(
name: str,
dimension: int,
dtype: Union[Type[int], Type[float]] = float,
fields_schema: Optional[Dict[str, Union[Type[str], Type[int], Type[float], Type[bool], Type[long]]]] = None,
metric: str = 'cosine',
timeout: Optional[int] = None
) -> DashVectorResponse
Exemplo
Substitua YOUR_API_KEY pela sua chave de API e YOUR_CLUSTER_ENDPOINT pelo endpoint do seu cluster no código de exemplo para garantir a execução correta.
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
# Create a collection and set its name to quickstart, the number of vector dimensions to 4,
# vector data type to the default value of float,
# and distance metric to dotproduct.
# Predefine the name, weight, age and id fields, and set their data types to str, float, int and dashvector.long respectively.
# Set timeout to -1 to enable the asynchronous mode for the create method.
ret = client.create(
name='quickstart',
dimension=4,
metric='dotproduct',
dtype=float,
# To preserve the semantic clarity of type annotations,
# DashVector defines the Long type through the typing module,
# which provides type annotation support for scenarios where large integers need to be explicitly annotated
fields_schema={'name': str, 'weight': float, 'age': int, 'id': dashvector.long},
timeout=-1
)
# Check whether the collection is successfully created.
if ret:
print('create collection success!')
# You can also use the following code to check whether the collection is successfully created.
# from dashvector import DashVectorCode
# if ret.code == DashVectorCode.Success:
# print('create collection success!')
Parâmetros da solicitação
Parâmetro | Tipo | Valor padrão | Descrição |
name | str | - | Nome da coleção a ser criada. |
dimension | int | - | Número de dimensões do vetor. |
dtype | Union[Type[int], Type[float]] | float | Opcional. Tipo de dados do vetor. |
fields_schema
| Optional[Dict[str,Union[Type[str], Type[int], Type[float], Type[bool], Type[long]]]] | None | Opcional. Campos predefinidos. |
metric | str | cosine | Opcional. Métrica de distância. Valores válidos: Se o valor for |
timeout | Optional[int] | None |
|
Para mais informações sobre as vantagens de predefinir campos durante a criação da coleção, consulte Campos sem esquema.
Parâmetros de resposta
A operação retorna um objeto DashVectorResponse com o resultado descrito na tabela a seguir.
|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|
code |
int |
Código de status retornado. Para mais informações, consulte Códigos de status. |
0 |
|
message |
str |
Mensagem retornada. |
success |
|
request_id |
str |
ID exclusivo da solicitação. |
19215409-ea66-4db9-8764-26ce2eb5bb99 |