Inserir documentos em uma coleção usando o SDK para Python - DashVector: Central de Documentação do Alibaba Cloud

Insira um ou mais documentos em uma coleção do DashVector com o SDK para Python.

Se o ID de um documento já existir na coleção, a operação de inserção o ignora sem substituí-lo. Para atualizar um documento existente, use o método upsert. Se você omitir o ID do documento, o DashVector gera um automaticamente e o retorna na resposta.

Pré-requisitos

Antes de começar, verifique se você tem:

Um cluster do DashVector. Para mais detalhes, consulte Crie um cluster
Uma chave de API. Para mais detalhes, consulte Gerencie chaves de API
A versão mais recente do SDK do DashVector para Python. Para mais detalhes, consulte Instale o SDK do DashVector

Definição da API

Collection.insert(
    docs: Union[Doc, List[Doc], Tuple, List[Tuple]],
    partition: Optional[str] = None,
    async_req: False
) -> DashVectorResponse

Exemplos

Todos os exemplos usam uma coleção existente chamada quickstart. Substitua YOUR_API_KEY pela sua chave de API e YOUR_CLUSTER_ENDPOINT pelo endpoint do seu cluster antes de executar o código.

import dashvector
from dashvector import Doc
import numpy as np

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')

Nota

Crie a coleção quickstart antes de executar estes exemplos. Para mais detalhes, consulte a seção de exemplos em Crie uma coleção.

Inserir um único documento

# Insert a document using a Doc object
ret = collection.insert(
    Doc(
        id='1',
        vector=[0.1, 0.2, 0.3, 0.4]
    )
)
assert ret

# Shorthand: use a tuple instead of a Doc object
ret = collection.insert(
    ('2', [0.1, 0.1, 0.1, 0.1])               # (id, vector)
)

Inserir um documento com campos

Anexe metadados como pares chave-valor pelo parâmetro fields. Os campos definidos durante a criação da coleção devem corresponder aos tipos predefinidos. Campos adicionais são livres de esquema e aceitam valores dos tipos str, int, bool ou float. Para obter mais informações, consulte Schema-free.

# Insert a document with predefined and schema-free fields
ret = collection.insert(
    Doc(
        id='3',
        vector=np.random.rand(4),
        fields={
            # Predefined fields (types must match collection schema)
            # name:str, weight:float, age:int, id:dashvector.long
            'name': 'zhangsan', 'weight':70.0, 'age':30, 'id':1234567890,
            # Schema-free fields (no predefinition required)
            'anykey1': 'str-value', 'anykey2': 1,
            'anykey3': True, 'anykey4': 3.1415926
        }
    )
)

# Shorthand: use a tuple with fields
ret = collection.insert(
    ('4', np.random.rand(4), {'foo': 'bar'})  # (id, vector, fields)
)

Inserir vários documentos

# Batch insert 10 documents using Doc objects
ret = collection.insert(
    [
        Doc(id=str(i+5), vector=np.random.rand(4)) for i in range(10)
    ]
)

# Batch insert using tuples with fields
ret = collection.insert(
    [
        ('15', [0.2,0.7,0.8,1.3], {'age': 20}),
        ('16', [0.3,0.6,0.9,1.2], {'age': 30}),
        ('17', [0.4,0.5,1.0,1.1], {'age': 40})
    ]                                         # List[(id, vector, fields)]
)
assert ret

Inserir documentos de forma assíncrona

Defina async_req=True para inserções não bloqueantes. Chame .get() no objeto future retornado para obter o resultado.

# Asynchronously insert 10 documents
ret_funture = collection.insert(
    [
        Doc(id=str(i+18), vector=np.random.rand(4), fields={'name': 'foo' + str(i)}) for i in range(10)
    ],
    async_req=True
)
# Block until the asynchronous insert completes
ret = ret_funture.get()

Inserir um documento com vetor esparso

Use o parâmetro sparse_vector para armazenar representações esparsas junto com vetores densos.

ret = collection.insert(
    Doc(
        id='28',
        vector=[0.1, 0.2, 0.3, 0.4],
        sparse_vector={1:0.4, 10000:0.6, 222222:0.8}
    )
)

Parâmetros

Parâmetros da solicitação

Parâmetro	Tipo	Padrão	Descrição
`docs`	`Union[Doc, List[Doc], Tuple, List[Tuple]]`	Obrigatório	Um ou mais documentos para inserção
`partition`	`Optional[str]`	`None`	Nome da partição de destino
`async_req`	`bool`	`False`	Ative o modo assíncrono

Observações sobre os parâmetros:

Formato de tupla: Os elementos devem seguir a ordem (id, vector) ou (id, vector, fields). Uma tupla equivale a um objeto Doc.
Chaves e valores de campo: Cada chave de campo deve ser do tipo str. Os valores aceitam os tipos str, int, bool ou float.
- Se uma chave de campo for predefinida durante a criação da coleção, o valor deverá corresponder ao tipo predefinido.
- Se a chave de campo não for predefinida, ela será tratada como um campo livre de esquema e aceitará qualquer tipo de valor compatível.
Para obter mais informações sobre campos predefinidos, consulte Schema-free.

Resposta

O método retorna um objeto DashVectorResponse com as seguintes propriedades:

Propriedade	Tipo	Descrição	Exemplo
`code`	`int`	Código de status. O valor `0` indica sucesso. Consulte Códigos de status.	`0`
`message`	`str`	Mensagem de resultado	`success`
`request_id`	`str`	Identificador exclusivo da solicitação	`19215409-ea66-4db9-8764-26ce2eb5bb99`