docs: params/output semántico en 506 funciones para composabilidad
Añade campos params y output al frontmatter YAML de las 506 funciones del registry. Cada parámetro tiene descripción semántica (qué representa, unidades, rango típico) y cada función describe qué produce su output. Permite a agentes razonar sobre cadenas de composición (ej: prices → log_return → sharpe_ratio) sin leer código.
This commit is contained in:
@@ -14,6 +14,14 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [sentence_transformers]
|
||||
params:
|
||||
- name: model
|
||||
desc: "instancia SentenceTransformer cargada con embedding_load_model"
|
||||
- name: texts
|
||||
desc: "lista de strings a codificar como embeddings"
|
||||
- name: mode
|
||||
desc: "contexto semántico: 'document' para indexación, 'query' para búsqueda (aplica prefijos e5)"
|
||||
output: "list[list[float]]: embeddings normalizados (L2=1), dimensión 384 para e5-small"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,10 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [sentence_transformers]
|
||||
params:
|
||||
- name: path
|
||||
desc: "ruta al directorio donde está guardado el modelo (ej: .local/models/e5-small)"
|
||||
output: "SentenceTransformer: instancia lista para embedding_encode"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,12 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [sentence_transformers]
|
||||
params:
|
||||
- name: model_id
|
||||
desc: "identificador de modelo en HuggingFace (ej: intfloat/multilingual-e5-small)"
|
||||
- name: path
|
||||
desc: "ruta local donde guardar el modelo descargado"
|
||||
output: "string: ruta absoluta donde se guardó el modelo"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,16 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [sqlite3, sqlite_vec, numpy]
|
||||
params:
|
||||
- name: db_path
|
||||
desc: "ruta a la base de datos SQLite con tabla virtual sqlite-vec"
|
||||
- name: table
|
||||
desc: "nombre de la tabla virtual donde buscar vectores"
|
||||
- name: query_embedding
|
||||
desc: "vector de embedding (list[float]) a usar como query"
|
||||
- name: k
|
||||
desc: "cantidad de vecinos más cercanos a retornar"
|
||||
output: "list[dict]: resultados ordenados con 'rowid' e 'distance' (coseno, menor=más similar)"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,16 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [usearch, numpy]
|
||||
params:
|
||||
- name: path
|
||||
desc: "ruta al archivo de índice USearch persistido"
|
||||
- name: query_embedding
|
||||
desc: "vector de embedding (list[float]) a usar como query"
|
||||
- name: k
|
||||
desc: "cantidad de vecinos aproximados a retornar"
|
||||
- name: dim
|
||||
desc: "dimensión del espacio de embeddings (por defecto 384 para e5-small)"
|
||||
output: "list[dict]: resultados con 'key' y 'distance' (inner product, mayor=más similar)"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,18 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [sqlite3, sqlite_vec, numpy]
|
||||
params:
|
||||
- name: db_path
|
||||
desc: "ruta a la base de datos SQLite (se crea si no existe)"
|
||||
- name: table
|
||||
desc: "nombre de la tabla virtual sqlite-vec a crear"
|
||||
- name: ids
|
||||
desc: "lista de identificadores enteros para los embeddings"
|
||||
- name: embeddings
|
||||
desc: "lista de vectores (list[list[float]]) a almacenar"
|
||||
- name: dim
|
||||
desc: "dimensión de los vectores (por defecto 384 para e5-small)"
|
||||
output: "int: cantidad de vectores insertados"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
@@ -14,6 +14,16 @@ returns: []
|
||||
returns_optional: false
|
||||
error_type: "error_go_core"
|
||||
imports: [usearch, numpy]
|
||||
params:
|
||||
- name: path
|
||||
desc: "ruta donde guardar el archivo de índice USearch"
|
||||
- name: ids
|
||||
desc: "lista de identificadores enteros para los embeddings"
|
||||
- name: embeddings
|
||||
desc: "lista de vectores (list[list[float]]) a indexar"
|
||||
- name: dim
|
||||
desc: "dimensión de los vectores (por defecto 384 para e5-small)"
|
||||
output: "int: cantidad de vectores indexados"
|
||||
tested: false
|
||||
tests: []
|
||||
test_file_path: ""
|
||||
|
||||
Reference in New Issue
Block a user