Versión: 2.0.0

Referencia API

Introducción

Cada nodo Gaia es un servidor API compatible con OpenAI. Puedes construir tu aplicación basándote en la API del nodo Gaia. Usted también puede reemplazar la configuración de la API de OpenAI con la API del nodo Gaia en otros marcos de agentes de IA.

La URL base para enviar todas las solicitudes API es https://node_id.gaianet.network/v1.

nota

Asegúrese de sustituir SU_CLAVE_API_VA_AQUÍ con su clave API propia. Para obtener su propia clave API, siga estos pasos este tutorial.

Puntos finales

Chat

En chat/conclusiones devuelve una respuesta LLM basada en la solicitud del sistema y la consulta del usuario.

Sin flujo

Por defecto, la API responde con una respuesta completa en la respuesta HTTP.

Solicitar

curl -X POST https://node_id.gaianet.network/v1/chat/completions \
  -H 'accept:application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY_GOES_HERE' \
  -d '{"messages":[{"role":"system", "content": "You are a helpful assistant."}, {"role":"user", "content": "What is the capital of France?"}], "model": "model_name"}'

Respuesta:

{"id":"chatcmpl-bcfeebe0-5372-42c0-ac92-0615213e1c97","object":"chat.completion","created":1716380086,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","choices":[{"index":0,"message":{"role":"assistant","content":"Paris."},"finish_reason":"stop"}],"usage":{"prompt_tokens":61,"completion_tokens":4,"total_tokens":65}}%

streaming

Añadir "stream":true en tu solicitud para que la API envíe respuestas parciales a medida que el LLM genera su respuesta.

Petición:

curl -X POST https://node_id.gaianet.network/v1/chat/completions \
  -H 'accept:application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY_GOES_HERE' \
  -d '{"messages":[{"role":"system", "content": "You are a helpful assistant."}, {"role":"user", "content": "What is the capital of France?"}], "model": "model_name", "stream":true}'

Respuesta:

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":"I"},"logprobs":null,"finish_reason":null}],"created":1716381054,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":" am"},"logprobs":null,"finish_reason":null}],"created":1716381054,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":" a"},"logprobs":null,"finish_reason":null}],"created":1716381054,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

...

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":" an"},"logprobs":null,"finish_reason":null}],"created":1716381055,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":" AI"},"logprobs":null,"finish_reason":null}],"created":1716381055,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

data: {"id":"chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4","choices":[{"index":0,"delta":{"role":"assistant","content":"."},"logprobs":null,"finish_reason":null}],"created":1716381055,"model":"Llama-3-8B-Instruct-262k-Q5_K_M","system_fingerprint":"fp_44709d6fcb","object":"chat.completion.chunk"}

data: [DONE]

Cuerpo de la solicitud

Campo	Tipo	Requerido	Descripción	Por defecto	Ejemplo
mensajes	Lista	Requerido	Una lista de mensajes para la conversación. 1 . Mensaje del sistema (depende del modo de idioma grande que utilice) * `contenido` de los mensajes del sistema * `"rol": "sistema"` es necesario 2. Mensaje del usuario (obligatorio) * `contenido` es necesario. * `"rol": "usuario"` es necesario	N/A	"messages": ["role": "system","content": "You are a helpful assistant."},{"role": "user", "content": "Hello!"}]
modelo	Cadena	Requerido	El modelo de chat que utilizó	N/A	Llama-3-8B-262k-Q5_K_M
top_p	Número	Opcional	Una alternativa al muestreo con temperatura. Valores más altos como 0,8 harán que la salida sea más aleatoria, mientras que valores más bajos como 0,2 la harán más centrada y determinista.	1	Número comprendido entre 0 y 1.
temperatura	Número	Opcional	Valores más altos, como 0,8, harán que el resultado sea más aleatorio, mientras que valores más bajos, como 0,2, lo harán más centrado y determinista.	1	Número comprendido entre 0 y 2.
pena_de_presencia	Número	Opcional	Los valores positivos penalizan los tokens nuevos en función de si aparecen en el texto hasta el momento, lo que aumenta la probabilidad de que el modelo hable de temas nuevos.	0	Número comprendido entre -2,0 y 2,0.
flujo	booleano	Opcional	Dar salida a la respuesta en streaming	FALSO	"stream":true
frecuencia_penal	Número	Opcional	Los valores positivos penalizan los nuevos tokens en función de su frecuencia existente en el texto hasta el momento, lo que disminuye la probabilidad de que el modelo repita textualmente la misma línea.	0	Número comprendido entre -2,0 y 2,0.

Cuerpo de la respuesta

Campo	Tipo	Streaming o no streaming	Descripción	Por defecto	Ejemplo
id	cadena	Ambos	Un identificador único para la finalización del chat.	Generado aleatoriamente	chatcmpl-73a1f57d-185e-42c2-b8a6-ba0bae58f3b4
objeto	cadena	Ambos	El tipo de objeto	`chat.completion.chunk` en modo streaming. `chat.completion` en modo no streaming.	`chat.completion.chunk` en modo streaming. `chat.completion` en modo no streaming.
opciones	matriz	Ambos	Una lista de opciones para completar el chat.		"choices":[{"index":0,"message":{"role":"assistant","content":"Paris."},"finish_reason":"stop"}]
creado	entero	Ambos	La marca de tiempo Unix (en segundos) de cuando se creó la finalización del chat.	N/A	1716380086
modelo	cadena	Ambos	El modelo utilizado para completar el chat.	Depende del modelo que utilices.	Llama-3-8B-Instruct-Q5_K_M
uso	objeto	Ambos	Estadísticas de uso de la solicitud de finalización, incluyendo completion_tokens, prompt_tokens y total_tokens.	N/A	"usage":{"prompt_tokens":61,"completion_tokens":4,"total_tokens":65}

Inserción

En incrustaciones calcula incrustaciones para consultas de usuarios o trozos de archivos.

Solicitar

curl -X POST https://node_id.gaianet.network/v1/embeddings \
    -H 'accept:application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY_GOES_HERE' \
    -d '{"model": "nomic-embed-text-v1.5.f16", "input":["Paris, city and capital of France, ..., for Paris has retained its importance as a centre for education and intellectual pursuits.", "Paris’s site at a crossroads ..., drawing to itself much of the talent and vitality of the provinces."]}'

Respuesta:

{
    "object": "list",
    "data": [
        {
            "index": 0,
            "object": "embedding",
            "embedding": [
                0.1428378969,
                -0.0447309874,
                0.007660218049,
                ...
                -0.0128974719,
                -0.03543198109,
                0.03974733502,
                0.00946635101,
                -0.01531364303
            ]
        },
        {
            "index": 1,
            "object": "embedding",
            "embedding": [
                0.0697753951,
                -0.0001159032545,
                0.02073983476,
                ...
                0.03565846011,
                -0.04550019652,
                0.02691745944,
                0.02498772368,
                -0.003226313973
            ]
        }
    ],
    "model": "nomic-embed-text-v1.5.f16",
    "usage": {
        "prompt_tokens": 491,
        "completion_tokens": 0,
        "total_tokens": 491
    }
}

Recuperar

En recuperar puede recuperar texto de la colección de vectores del nodo basándose en la consulta del usuario.

Petición:

curl -X POST https://node_id.gaianet.network/v1/retrieve \
    -H 'accept:application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY_GOES_HERE' \
    -d '{"messages":[{"role":"system", "content": "You are a helpful assistant."}, {"role":"user", "content": "What is the location of Paris?"}], "model":"nomic-embed-text-v1.5.f16"}'

Respuesta:

{
    "points": [
        {
            "source": "\"Paris is located in northern central France, in a north-bending arc of the river Seine whose crest includes two islands, the Île Saint-Louis and the larger Île de la Cité, which form the oldest part of the city. The river's mouth on the English Channel is about 233 mi downstream from the city. The city is spread widely on both banks of the river. Overall, the city is relatively flat, and the lowest point is 35 m above sea level. Paris has several prominent hills, the highest of which is Montmartre at 130 m.\\n\"",
            "score": 0.74011195
        },
        {
            "source": "\"The Paris region is the most active water transport area in France, with most of the cargo handled by Ports of Paris in facilities located around Paris. The rivers Loire, Rhine, Rhône, Me\\n\"",
            "score": 0.63990676
        },
        {
            "source": "\"Paris\\nCountry\\tFrance\\nRegion\\nÎle-de-France\\r\\nDepartment\\nParis\\nIntercommunality\\nMétropole du Grand Paris\\nSubdivisions\\n20 arrondissements\\nGovernment\\n • Mayor (2020–2026)\\tAnne Hidalgo (PS)\\r\\nArea\\n1\\t105.4 km2 (40.7 sq mi)\\n • Urban\\n (2020)\\t2,853.5 km2 (1,101.7 sq mi)\\n • Metro\\n (2020)\\t18,940.7 km2 (7,313.0 sq mi)\\nPopulation\\n (2023)\\n2,102,650\\n • Rank\\t9th in Europe\\n1st in France\\r\\n • Density\\t20,000/km2 (52,000/sq mi)\\n • Urban\\n (2019)\\n10,858,852\\n • Urban density\\t3,800/km2 (9,900/sq mi)\\n • Metro\\n (Jan. 2017)\\n13,024,518\\n • Metro density\\t690/km2 (1,800/sq mi)\\nDemonym(s)\\nParisian(s) (en) Parisien(s) (masc.), Parisienne(s) (fem.) (fr), Parigot(s) (masc.), \\\"Parigote(s)\\\" (fem.) (fr, colloquial)\\nTime zone\\nUTC+01:00 (CET)\\r\\n • Summer (DST)\\nUTC+02:00 (CEST)\\r\\nINSEE/Postal code\\t75056 /75001-75020, 75116\\r\\nElevation\\t28–131 m (92–430 ft)\\n(avg. 78 m or 256 ft)\\nWebsite\\twww.paris.fr\\r\\n1 French Land Register data, which excludes lakes, ponds, glaciers > 1 km2 (0.386 sq mi or 247 acres) and river estuaries.\\n\"",
            "score": 0.62259054
        },
        {
            "source": "\" in Paris\\n\"",
            "score": 0.6152092
        },
        {
            "source": "\"The Parisii, a sub-tribe of the Celtic Senones, inhabited the Paris area from around the middle of the 3rd century BC. One of the area's major north–south trade routes crossed the Seine on the île de la Cité, which gradually became an important trading centre. The Parisii traded with many river towns (some as far away as the Iberian Peninsula) and minted their own coins.\\n\"",
            "score": 0.5720232
        }
    ],
    "limit": 5,
    "score_threshold": 0.4
}

Obtener el modelo

En modelos proporciona los modelos de chat e incrustación disponibles en el nodo.

Petición:

curl -X POST https://node_id.gaianet.network/v1/models

Respuesta:

{"object":"list","data":[{"id":"Llama-3-8B-Instruct-262k-Q5_K_M","created":1716383261,"object":"model","owned_by":"Not specified"},{"id":"nomic-embed-text-v1.5.f16","created":1716383261,"object":"model","owned_by":"Not specified"}]}%

Obtener la información del nodo

En información proporciona información detallada sobre el nodo.

Petición:

curl -X POST https://node_id.gaianet.network/v1/info

Respuesta:

{
    "version": "0.5.0",
    "plugin_version": "b2694 (commit 0d56246f)",
    "port": "8080",
    "models": [
        {
            "name": "Llama-2-7b-chat-hf-Q5_K_M",
            "type": "chat",
            "prompt_template": "Llama2Chat",
            "n_predict": 1024,
            "n_gpu_layers": 100,
            "ctx_size": 4096,
            "batch_size": 512,
            "temperature": 1.0,
            "top_p": 1.0,
            "repeat_penalty": 1.1,
            "presence_penalty": 0.0,
            "frequency_penalty": 0.0
        },
        {
            "name": "all-MiniLM-L6-v2-ggml-model-f16",
            "type": "embedding",
            "prompt_template": "Llama2Chat",
            "n_predict": 1024,
            "n_gpu_layers": 100,
            "ctx_size": 384,
            "batch_size": 512,
            "temperature": 1.0,
            "top_p": 1.0,
            "repeat_penalty": 1.1,
            "presence_penalty": 0.0,
            "frequency_penalty": 0.0
        }
    ],
    "qdrant_config": {
        "url": "http://localhost:6333",
        "collection_name": "default",
        "limit": 5,
        "score_threshold": 0.4
    }
} 

Códigos de estado

Código de respuesta HTTP	Descripción	Razón	Soluciones
404	No se ha encontrado	La URL del punto final no es válida	Compruebe la URL del punto final
500	Error interno del servidor	No se encuentra el modelo.	Por favor, compruebe el nombre del modelo.
400	Mala petición

Introducción​

Puntos finales​

Chat​

Sin flujo​

streaming​

Cuerpo de la solicitud​

Cuerpo de la respuesta​

Inserción​

Recuperar​

Obtener el modelo​

Obtener la información del nodo​

Códigos de estado​

Introducción

Puntos finales

Chat

Sin flujo

streaming

Cuerpo de la solicitud

Cuerpo de la respuesta

Inserción

Recuperar

Obtener el modelo

Obtener la información del nodo

Códigos de estado