Gestión de hilos de la API de asistente con Crear, Recuperar y Eliminar - Model Studio - Alibaba Cloud_Alibaba Cloud Model Studio(Model Studio) - Alibaba Cloud Model Studio

Este tema describe la clase Thread en la API de asistente, incluyendo cómo crear, recuperar, modificar y eliminar hilos.

ImportanteLa API de Asistentes está siendo descontinuada. Migre a la API de Responses como alternativa. La API de Responses incluye múltiples herramientas integradas y admite la gestión de contexto de múltiples turnos.

Visión general: Para obtener más información sobre las funciones y el uso básico de la API de asistente, consulte Visión general de la API de asistente.

Período de retención: Todas las instancias de Thread se almacenan en el servidor de Alibaba Cloud Model Studio y no caducan. Puede utilizar el ID del hilo para recuperar información de contexto.

Nombre de la función	Tipo
create	Crea una clase Thread.
recuperar	Recupera una clase Thread.
update	Modifica una clase Thread.
eliminar	Elimina una clase Thread.

Crear un hilo

HTTP

Código de ejemplo

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "messages": [
        {
            "role": "user",
            "content": "hello"
        }
    ]
}'

Parámetros de solicitud

Nombre del parámetro de entrada	Descripciones de los parámetros de entrada	Tipo	Obligatorio
messages	Los mensajes pasados al hilo.	Clase Message	No
metadata	Nombre del hilo	object	No

Respuesta

{
    "id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "object": "thread",
    "created_at": 1711448377850,
    "metadata": {},
    "request_id": "dd9489ec-dbdb-95d4-9ff8-cfe29b61db27"
}

Parámetros de respuesta

La respuesta devuelve un objeto de hilo con los siguientes campos adicionales:

id: El ID del hilo.
request_id: El ID de la solicitud.

SDK

Código de ejemplo

python

import json
from dashscope import Threads
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

thread = Threads.create(
    # We recommend that you set the API key as an environment variable. If not, replace the following line with api_key="sk-xxx" using your Model Studio API key.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    messages=[{"role": "user", "content": "How does AI work? Explain it in simple terms."}]
)
print(json.dumps(thread, default=lambda o: o.__dict__, sort_keys=True, indent=4))

java

import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.AssistantThread;
import com.alibaba.dashscope.threads.ThreadParam;
import com.alibaba.dashscope.threads.Threads;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Threads threads = new Threads();
        // We recommend that you set the API key as an environment variable. If not, replace the following line with apiKey("sk-xxx") using your Model Studio API key.
        AssistantThread assistantThread = threads.create(ThreadParam.builder()
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build());
    }
}

Parámetros de solicitud

Parámetro	Tipo	Valor predeterminado	Descripción
messages	List[Dict]	None	Los mensajes iniciales del hilo.
metadata	Dict	None	Pares clave-valor para asociar con el hilo.
workspace	str	None	El ID del espacio de trabajo de Alibaba Cloud Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	str	None	La clave de API para Alibaba Cloud Model Studio. Le recomendamos que configure la clave de API como variable de entorno.

Resultado

El resultado es un objeto Thread. El siguiente código muestra el objeto en formato JSON:

{
    "created_at": 1711338305031,
    "id": "thread_97934051-2c15-44bf-97de-310039d873f9",
    "metadata": {},
    "object": "thread",
    "request_id": "982d4b9a-b982-9d53-9c79-a75b32f7168a",
    "status_code": 200
}

Parámetros de salida

Nombre del campo	Tipo	Descripción
status_code	int	El código de estado HTTP. Un valor de 200 indica que la llamada fue exitosa. Otros valores indican que la llamada falló.
id	str	El ID del hilo, que es una cadena UUID.
metadata	Dict	Los pares clave-valor asociados con el hilo.
created_at	timestamp	La hora en que se creó el hilo.
code	str	El código de error que se devuelve si la solicitud falla. Este parámetro no se devuelve si la solicitud es exitosa. Solo Python
message	str	El mensaje de error. Este campo se devuelve solo cuando la solicitud falla. Solo Python

Recuperar un hilo

HTTP

Código de ejemplo

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parámetros de solicitud

Nombre del parámetro	Descripción de parámetros	Tipo	Obligatorio
thread_id	El ID del hilo que se va a recuperar.	str	Sí

Resultado

{
    "id": "thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7",
    "object": "thread",
    "created_at": 1711507920700,
    "metadata": {},
    "request_id": "4d4e73ad-15fb-96ac-9262-0643a0fdb5ca"
}

Parámetros de respuesta

La respuesta contiene el objeto de hilo recuperado, que incluye los siguientes campos adicionales:

ID: ID del hilo
request_id: El ID de la solicitud.

SDK

Código de ejemplo

python

from dashscope import Threads
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

thread = Threads.retrieve(
    'thread_id',
    # We recommend that you set the API key as an environment variable. If not, replace the following line with api_key="sk-xxx" using your Model Studio API key.
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

java

import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.AssistantThread;
import com.alibaba.dashscope.threads.Threads;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Threads threads = new Threads();
        // Pass the thread_id and apiKey directly
        // We recommend that you set the API key as an environment variable. If not, replace the following line with apiKey("sk-xxx") using your Model Studio API key.
        AssistantThread assistantThread = threads.retrieve(
            "thread_id",
            System.getenv("DASHSCOPE_API_KEY")
        );
    }
}

Parámetros de solicitud

Parámetro	Tipo	Valor predeterminado	Descripción
thread_id	str	-	El ID del hilo a consultar.
workspace	str	None	El ID del espacio de trabajo de Alibaba Cloud Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	str	None	La clave de API para Alibaba Cloud Model Studio. Le recomendamos que configure la clave de API como variable de entorno.

Parámetros de respuesta

Consulte el resultado de la creación.

Modificar un hilo

HTTP

Código de ejemplo

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "metadata": {
        "modified": "true",
        "user": "abc123"
    }
}'

Parámetros de solicitud

Nombre del parámetro de entrada	Descripciones de parámetros de entrada	Tipo	Obligatorio
thread_id	El ID del hilo a modificar.	str	Sí
metadata	Nombre del hilo	dict	No

Resultado

{
    "id": "thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7",
    "object": "thread",
    "created_at": 1711507920700,
    "metadata": {
        "modified": "true",
        "user": "abc123"
    },
    "request_id": "a9ad63fa-b884-94be-9ec6-5000882de3c4"
}

Parámetros de respuesta

La salida contiene la clase de hilo recuperada y campos adicionales que no están especificados en los parámetros proporcionados por el usuario:

id: thread_id
request_id: El ID de la solicitud.

SDK

Código de ejemplo

python

from dashscope import Threads
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

thread = Threads.update(
    'thread_id',
    # We recommend that you set the API key as an environment variable. If not, replace the following line with api_key="sk-xxx" using your Model Studio API key.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    metadata={'key': 'value'}
)

java

import java.util.Collections;
import com.alibaba.dashscope.common.UpdateMetadataParam;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.Threads;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Threads threads = new Threads();
        UpdateMetadataParam updateMetadataParam = UpdateMetadataParam.builder()
                .metadata(Collections.singletonMap("key", "value"))
                // We recommend that you set the API key as an environment variable. If not, replace the following line with apiKey("sk-xxx") and use your Model Studio API key.
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        threads.update("thread_id", updateMetadataParam);
    }
}

Parámetros de solicitud

Parámetro	Tipo	Valor predeterminado	Descripción
thread_id	str	-	El ID del hilo que se va a actualizar.
metadata	Dict	None	La información para asociar con el hilo.
workspace	str	None	El ID del espacio de trabajo de Alibaba Cloud Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	str	None	La clave de API para Alibaba Cloud Model Studio. Le recomendamos que configure la clave de API como variable de entorno.

Parámetros de respuesta

Esta operación es igual que la operación de creación.

Eliminar un hilo

HTTP

Código de ejemplo

curl --location --request DELETE 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parámetros de solicitud

Nombre del parámetro de entrada	Descripción	Tipo	Obligatorio
id	El ID del hilo que se va a eliminar	str	Sí

Respuesta

{
    "id": "thread_c7ebb0ca-2e4f-43e5-b223-6e1f8c6fccc7",
    "object": "thread.deleted",
    "deleted": true,
    "request_id": "b4edb7b8-5855-9787-b5c3-0374ee2b3b2c"
}

Parámetros de respuesta

El estado del hilo después de la eliminación.

SDK

Código de ejemplo

python

from dashscope import Threads
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

thread = Threads.delete(
    'thread_id',
    # We recommend that you set the API key as an environment variable. If not, replace the following line with api_key="sk-xxx" using your Model Studio API key.
    api_key=os.getenv("DASHSCOPE_API_KEY")
)

java

import com.alibaba.dashscope.common.DeletionStatus;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.Threads;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Threads threads = new Threads();
        // We recommend that you set the API key as an environment variable. If not, replace the following line with apiKey("sk-xxx") using your Model Studio API key.
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        DeletionStatus assistantThread = threads.delete("thread_id", apiKey);
    }
}

Parámetros de solicitud

Parámetro	Tipo	Valor predeterminado	Descripción
thread_id	str	-	El ID del hilo que se va a eliminar.
workspace	str	None	El ID del espacio de trabajo de Alibaba Cloud Model Studio. Este parámetro es obligatorio solo cuando `api_key` es una clave de API de subespacio de trabajo.
api_key	str	None	La clave de API para Alibaba Cloud Model Studio. Le recomendamos que configure la clave de API como variable de entorno.

Parámetros de respuesta

Nombre del campo	Tipo	Descripción
id	str	El ID del objeto eliminado.
deleted	bool	Confirm Eliminación

Códigos de error

Si una llamada al modelo falla y se devuelve un mensaje de error, consulte Códigos de error para solucionar problemas.