pygeai 0.1.6__py3-none-any.whl → 0.6.0b15__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of pygeai might be problematic. Click here for more details.
- pygeai/__init__.py +11 -2
- pygeai/_docs/Makefile +20 -0
- pygeai/_docs/make.bat +35 -0
- pygeai/_docs/source/conf.py +117 -0
- pygeai/_docs/source/content/ai_lab/cli.rst +747 -0
- pygeai/_docs/source/content/ai_lab/models.rst +1734 -0
- pygeai/_docs/source/content/ai_lab/runner.rst +253 -0
- pygeai/_docs/source/content/ai_lab/spec.rst +431 -0
- pygeai/_docs/source/content/ai_lab/usage.rst +1011 -0
- pygeai/_docs/source/content/ai_lab.rst +102 -0
- pygeai/_docs/source/content/analytics.rst +598 -0
- pygeai/_docs/source/content/api_reference/admin.rst +161 -0
- pygeai/_docs/source/content/api_reference/assistant.rst +326 -0
- pygeai/_docs/source/content/api_reference/auth.rst +379 -0
- pygeai/_docs/source/content/api_reference/chat.rst +754 -0
- pygeai/_docs/source/content/api_reference/embeddings.rst +154 -0
- pygeai/_docs/source/content/api_reference/evaluation.rst +590 -0
- pygeai/_docs/source/content/api_reference/feedback.rst +237 -0
- pygeai/_docs/source/content/api_reference/files.rst +592 -0
- pygeai/_docs/source/content/api_reference/gam.rst +401 -0
- pygeai/_docs/source/content/api_reference/health.rst +58 -0
- pygeai/_docs/source/content/api_reference/project.rst +738 -0
- pygeai/_docs/source/content/api_reference/proxy.rst +318 -0
- pygeai/_docs/source/content/api_reference/rag.rst +710 -0
- pygeai/_docs/source/content/api_reference/rerank.rst +94 -0
- pygeai/_docs/source/content/api_reference/secrets.rst +495 -0
- pygeai/_docs/source/content/api_reference/usage_limits.rst +390 -0
- pygeai/_docs/source/content/api_reference.rst +58 -0
- pygeai/_docs/source/content/authentication.rst +295 -0
- pygeai/_docs/source/content/chat_gui.rst +121 -0
- pygeai/_docs/source/content/cli.rst +203 -0
- pygeai/_docs/source/content/debugger.rst +651 -0
- pygeai/_docs/source/content/intro.rst +67 -0
- pygeai/_docs/source/content/migration.rst +929 -0
- pygeai/_docs/source/content/modules.rst +7 -0
- pygeai/_docs/source/content/quickstart.rst +143 -0
- pygeai/_docs/source/content/samples.rst +394 -0
- pygeai/_docs/source/index.rst +75 -0
- pygeai/_docs/source/modules.rst +7 -0
- pygeai/_docs/source/pygeai.admin.rst +29 -0
- pygeai/_docs/source/pygeai.analytics.rst +53 -0
- pygeai/_docs/source/pygeai.assistant.data.rst +21 -0
- pygeai/_docs/source/pygeai.assistant.data_analyst.rst +29 -0
- pygeai/_docs/source/pygeai.assistant.rag.rst +53 -0
- pygeai/_docs/source/pygeai.assistant.rst +55 -0
- pygeai/_docs/source/pygeai.auth.rst +29 -0
- pygeai/_docs/source/pygeai.chat.rst +69 -0
- pygeai/_docs/source/pygeai.cli.commands.flows.rst +10 -0
- pygeai/_docs/source/pygeai.cli.commands.lab.rst +53 -0
- pygeai/_docs/source/pygeai.cli.commands.rst +222 -0
- pygeai/_docs/source/pygeai.cli.rst +62 -0
- pygeai/_docs/source/pygeai.cli.texts.rst +21 -0
- pygeai/_docs/source/pygeai.core.base.rst +53 -0
- pygeai/_docs/source/pygeai.core.common.rst +37 -0
- pygeai/_docs/source/pygeai.core.embeddings.rst +61 -0
- pygeai/_docs/source/pygeai.core.feedback.rst +37 -0
- pygeai/_docs/source/pygeai.core.files.rst +61 -0
- pygeai/_docs/source/pygeai.core.llm.rst +29 -0
- pygeai/_docs/source/pygeai.core.plugins.rst +37 -0
- pygeai/_docs/source/pygeai.core.rerank.rst +53 -0
- pygeai/_docs/source/pygeai.core.rst +63 -0
- pygeai/_docs/source/pygeai.core.secrets.rst +29 -0
- pygeai/_docs/source/pygeai.core.services.llm.rst +29 -0
- pygeai/_docs/source/pygeai.core.services.rst +37 -0
- pygeai/_docs/source/pygeai.core.utils.rst +37 -0
- pygeai/_docs/source/pygeai.dbg.rst +21 -0
- pygeai/_docs/source/pygeai.evaluation.dataset.rst +29 -0
- pygeai/_docs/source/pygeai.evaluation.plan.rst +29 -0
- pygeai/_docs/source/pygeai.evaluation.result.rst +29 -0
- pygeai/_docs/source/pygeai.evaluation.rst +31 -0
- pygeai/_docs/source/pygeai.flows.rst +29 -0
- pygeai/_docs/source/pygeai.gam.rst +29 -0
- pygeai/_docs/source/pygeai.health.rst +29 -0
- pygeai/_docs/source/pygeai.lab.agents.rst +37 -0
- pygeai/_docs/source/pygeai.lab.processes.rst +37 -0
- pygeai/_docs/source/pygeai.lab.rst +65 -0
- pygeai/_docs/source/pygeai.lab.spec.rst +29 -0
- pygeai/_docs/source/pygeai.lab.strategies.rst +37 -0
- pygeai/_docs/source/pygeai.lab.tools.rst +37 -0
- pygeai/_docs/source/pygeai.man.man1.rst +10 -0
- pygeai/_docs/source/pygeai.man.rst +18 -0
- pygeai/_docs/source/pygeai.migration.rst +29 -0
- pygeai/_docs/source/pygeai.organization.limits.rst +45 -0
- pygeai/_docs/source/pygeai.organization.rst +61 -0
- pygeai/_docs/source/pygeai.proxy.rst +53 -0
- pygeai/_docs/source/pygeai.rst +35 -0
- pygeai/_docs/source/pygeai.tests.admin.rst +21 -0
- pygeai/_docs/source/pygeai.tests.analytics.rst +45 -0
- pygeai/_docs/source/pygeai.tests.assistants.rag.rst +37 -0
- pygeai/_docs/source/pygeai.tests.assistants.rst +45 -0
- pygeai/_docs/source/pygeai.tests.auth.rst +29 -0
- pygeai/_docs/source/pygeai.tests.chat.rst +45 -0
- pygeai/_docs/source/pygeai.tests.cli.commands.lab.rst +37 -0
- pygeai/_docs/source/pygeai.tests.cli.commands.rst +165 -0
- pygeai/_docs/source/pygeai.tests.cli.docker.rst +10 -0
- pygeai/_docs/source/pygeai.tests.cli.rst +46 -0
- pygeai/_docs/source/pygeai.tests.core.base.data.rst +29 -0
- pygeai/_docs/source/pygeai.tests.core.base.rst +45 -0
- pygeai/_docs/source/pygeai.tests.core.common.data.rst +10 -0
- pygeai/_docs/source/pygeai.tests.core.common.rst +37 -0
- pygeai/_docs/source/pygeai.tests.core.embeddings.rst +37 -0
- pygeai/_docs/source/pygeai.tests.core.feedback.rst +21 -0
- pygeai/_docs/source/pygeai.tests.core.files.rst +53 -0
- pygeai/_docs/source/pygeai.tests.core.llm.rst +21 -0
- pygeai/_docs/source/pygeai.tests.core.plugins.rst +21 -0
- pygeai/_docs/source/pygeai.tests.core.rerank.rst +37 -0
- pygeai/_docs/source/pygeai.tests.core.rst +39 -0
- pygeai/_docs/source/pygeai.tests.core.secrets.rst +21 -0
- pygeai/_docs/source/pygeai.tests.core.services.rst +21 -0
- pygeai/_docs/source/pygeai.tests.core.utils.rst +21 -0
- pygeai/_docs/source/pygeai.tests.dbg.rst +21 -0
- pygeai/_docs/source/pygeai.tests.evaluation.dataset.rst +21 -0
- pygeai/_docs/source/pygeai.tests.evaluation.plan.rst +21 -0
- pygeai/_docs/source/pygeai.tests.evaluation.result.rst +21 -0
- pygeai/_docs/source/pygeai.tests.evaluation.rst +20 -0
- pygeai/_docs/source/pygeai.tests.gam.rst +21 -0
- pygeai/_docs/source/pygeai.tests.health.rst +21 -0
- pygeai/_docs/source/pygeai.tests.integration.assistants.rag.rst +21 -0
- pygeai/_docs/source/pygeai.tests.integration.assistants.rst +18 -0
- pygeai/_docs/source/pygeai.tests.integration.chat.rst +21 -0
- pygeai/_docs/source/pygeai.tests.integration.lab.agents.rst +69 -0
- pygeai/_docs/source/pygeai.tests.integration.lab.processes.rst +77 -0
- pygeai/_docs/source/pygeai.tests.integration.lab.reasoning_strategies.rst +37 -0
- pygeai/_docs/source/pygeai.tests.integration.lab.rst +21 -0
- pygeai/_docs/source/pygeai.tests.integration.lab.tools.rst +77 -0
- pygeai/_docs/source/pygeai.tests.integration.rst +20 -0
- pygeai/_docs/source/pygeai.tests.lab.agents.rst +29 -0
- pygeai/_docs/source/pygeai.tests.lab.processes.rst +29 -0
- pygeai/_docs/source/pygeai.tests.lab.rst +49 -0
- pygeai/_docs/source/pygeai.tests.lab.spec.rst +29 -0
- pygeai/_docs/source/pygeai.tests.lab.strategies.rst +29 -0
- pygeai/_docs/source/pygeai.tests.lab.tools.rst +29 -0
- pygeai/_docs/source/pygeai.tests.migration.rst +29 -0
- pygeai/_docs/source/pygeai.tests.organization.limits.rst +29 -0
- pygeai/_docs/source/pygeai.tests.organization.rst +53 -0
- pygeai/_docs/source/pygeai.tests.proxy.rst +61 -0
- pygeai/_docs/source/pygeai.tests.rst +33 -0
- pygeai/admin/clients.py +14 -11
- pygeai/admin/endpoints.py +2 -2
- pygeai/analytics/clients.py +505 -0
- pygeai/analytics/endpoints.py +35 -0
- pygeai/analytics/managers.py +606 -0
- pygeai/analytics/mappers.py +207 -0
- pygeai/analytics/responses.py +240 -0
- pygeai/assistant/clients.py +48 -57
- pygeai/assistant/data/__init__.py +0 -0
- pygeai/assistant/data/clients.py +15 -0
- pygeai/assistant/data_analyst/__init__.py +0 -0
- pygeai/assistant/data_analyst/clients.py +75 -0
- pygeai/assistant/data_analyst/endpoints.py +2 -0
- pygeai/assistant/endpoints.py +0 -2
- pygeai/assistant/managers.py +738 -0
- pygeai/assistant/mappers.py +153 -0
- pygeai/assistant/rag/clients.py +132 -21
- pygeai/assistant/rag/mappers.py +228 -0
- pygeai/assistant/rag/models.py +396 -0
- pygeai/assistant/rag/responses.py +10 -0
- pygeai/auth/__init__.py +0 -0
- pygeai/auth/clients.py +129 -0
- pygeai/auth/endpoints.py +6 -0
- pygeai/chat/clients.py +406 -31
- pygeai/chat/endpoints.py +3 -0
- pygeai/chat/iris.py +17 -0
- pygeai/chat/managers.py +64 -0
- pygeai/chat/session.py +38 -0
- pygeai/chat/settings.py +6 -0
- pygeai/chat/ui.py +678 -0
- pygeai/cli/__init__.py +0 -1
- pygeai/cli/commands/admin.py +9 -12
- pygeai/cli/commands/analytics.py +533 -0
- pygeai/cli/commands/assistant.py +11 -11
- pygeai/cli/commands/auth.py +299 -0
- pygeai/cli/commands/base.py +201 -7
- pygeai/cli/commands/chat.py +875 -14
- pygeai/cli/commands/common.py +30 -26
- pygeai/cli/commands/configuration.py +84 -9
- pygeai/cli/commands/docs.py +105 -0
- pygeai/cli/commands/embeddings.py +187 -0
- pygeai/cli/commands/evaluation.py +2069 -0
- pygeai/cli/commands/feedback.py +93 -0
- pygeai/cli/commands/files.py +312 -0
- pygeai/cli/commands/flows/__init__.py +0 -0
- pygeai/cli/commands/gam.py +349 -0
- pygeai/cli/commands/lab/__init__.py +0 -0
- pygeai/cli/commands/lab/ai_lab.py +4110 -0
- pygeai/cli/commands/lab/common.py +135 -0
- pygeai/cli/commands/lab/options.py +8 -0
- pygeai/cli/commands/lab/spec.py +273 -0
- pygeai/cli/commands/lab/utils.py +13 -0
- pygeai/cli/commands/llm.py +164 -0
- pygeai/cli/commands/migrate.py +1198 -0
- pygeai/cli/commands/options.py +86 -0
- pygeai/cli/commands/organization.py +560 -98
- pygeai/cli/commands/rag.py +306 -10
- pygeai/cli/commands/rerank.py +108 -0
- pygeai/cli/commands/secrets.py +357 -0
- pygeai/cli/commands/usage_limits.py +583 -0
- pygeai/cli/commands/validators.py +209 -0
- pygeai/cli/commands/version.py +44 -0
- pygeai/cli/error_handler.py +151 -0
- pygeai/cli/geai.py +171 -30
- pygeai/cli/geai_proxy.py +318 -0
- pygeai/cli/install_man.py +107 -0
- pygeai/cli/parsers.py +78 -25
- pygeai/cli/texts/help.py +712 -55
- pygeai/core/__init__.py +9 -1
- pygeai/core/base/clients.py +61 -10
- pygeai/core/base/mappers.py +208 -30
- pygeai/core/base/models.py +8 -308
- pygeai/core/base/responses.py +18 -1
- pygeai/core/base/session.py +110 -17
- pygeai/core/common/config.py +98 -16
- pygeai/core/common/decorators.py +44 -0
- pygeai/core/common/exceptions.py +104 -4
- pygeai/core/embeddings/__init__.py +19 -0
- pygeai/core/embeddings/clients.py +93 -0
- pygeai/core/embeddings/endpoints.py +1 -0
- pygeai/core/embeddings/managers.py +62 -0
- pygeai/core/embeddings/mappers.py +52 -0
- pygeai/core/embeddings/models.py +14 -0
- pygeai/core/embeddings/responses.py +31 -0
- pygeai/core/feedback/__init__.py +0 -0
- pygeai/core/feedback/clients.py +50 -0
- pygeai/core/feedback/endpoints.py +1 -0
- pygeai/core/feedback/models.py +10 -0
- pygeai/core/files/__init__.py +0 -0
- pygeai/core/files/clients.py +156 -0
- pygeai/core/files/endpoints.py +5 -0
- pygeai/core/files/managers.py +224 -0
- pygeai/core/files/mappers.py +44 -0
- pygeai/core/files/models.py +24 -0
- pygeai/core/files/responses.py +19 -0
- pygeai/core/handlers.py +32 -0
- pygeai/core/llm/__init__.py +0 -0
- pygeai/core/llm/clients.py +53 -0
- pygeai/core/llm/endpoints.py +4 -0
- pygeai/core/models.py +799 -0
- pygeai/core/plugins/__init__.py +0 -0
- pygeai/core/plugins/clients.py +32 -0
- pygeai/core/plugins/endpoints.py +1 -0
- pygeai/core/plugins/models.py +86 -0
- pygeai/core/rerank/__init__.py +0 -0
- pygeai/core/rerank/clients.py +35 -0
- pygeai/core/rerank/endpoints.py +1 -0
- pygeai/core/rerank/managers.py +47 -0
- pygeai/core/rerank/mappers.py +23 -0
- pygeai/core/rerank/models.py +27 -0
- pygeai/core/responses.py +104 -0
- pygeai/core/secrets/__init__.py +0 -0
- pygeai/core/secrets/clients.py +212 -0
- pygeai/core/secrets/endpoints.py +7 -0
- pygeai/core/services/llm/__init__.py +0 -0
- pygeai/core/services/llm/model.py +186 -0
- pygeai/core/services/llm/providers.py +15 -0
- pygeai/core/services/response.py +18 -0
- pygeai/core/services/rest.py +311 -89
- pygeai/core/utils/__init__.py +0 -0
- pygeai/core/utils/console.py +83 -0
- pygeai/core/utils/parsers.py +32 -0
- pygeai/core/utils/validators.py +10 -0
- pygeai/dbg/__init__.py +3 -0
- pygeai/dbg/debugger.py +870 -0
- pygeai/evaluation/__init__.py +0 -0
- pygeai/evaluation/clients.py +19 -0
- pygeai/evaluation/dataset/__init__.py +0 -0
- pygeai/evaluation/dataset/clients.py +514 -0
- pygeai/evaluation/dataset/endpoints.py +26 -0
- pygeai/evaluation/plan/__init__.py +0 -0
- pygeai/evaluation/plan/clients.py +302 -0
- pygeai/evaluation/plan/endpoints.py +16 -0
- pygeai/evaluation/result/__init__.py +0 -0
- pygeai/evaluation/result/clients.py +70 -0
- pygeai/evaluation/result/endpoints.py +2 -0
- pygeai/flows/__init__.py +0 -0
- pygeai/flows/endpoints.py +362 -0
- pygeai/flows/models.py +1304 -0
- pygeai/gam/__init__.py +0 -0
- pygeai/gam/clients.py +178 -0
- pygeai/gam/endpoints.py +4 -0
- pygeai/health/__init__.py +0 -0
- pygeai/health/clients.py +24 -0
- pygeai/health/endpoints.py +1 -0
- pygeai/lab/__init__.py +0 -0
- pygeai/lab/agents/__init__.py +0 -0
- pygeai/lab/agents/clients.py +426 -0
- pygeai/lab/agents/endpoints.py +12 -0
- pygeai/lab/agents/mappers.py +319 -0
- pygeai/lab/clients.py +24 -0
- pygeai/lab/constants.py +3 -0
- pygeai/lab/managers.py +1558 -0
- pygeai/lab/models.py +1719 -0
- pygeai/lab/processes/__init__.py +0 -0
- pygeai/lab/processes/clients.py +1051 -0
- pygeai/lab/processes/endpoints.py +26 -0
- pygeai/lab/processes/mappers.py +395 -0
- pygeai/lab/runners.py +90 -0
- pygeai/lab/spec/__init__.py +0 -0
- pygeai/lab/spec/loader.py +24 -0
- pygeai/lab/spec/parsers.py +39 -0
- pygeai/lab/strategies/__init__.py +0 -0
- pygeai/lab/strategies/clients.py +212 -0
- pygeai/lab/strategies/endpoints.py +5 -0
- pygeai/lab/strategies/mappers.py +58 -0
- pygeai/lab/tools/__init__.py +0 -0
- pygeai/lab/tools/clients.py +465 -0
- pygeai/lab/tools/endpoints.py +13 -0
- pygeai/lab/tools/mappers.py +131 -0
- pygeai/man/__init__.py +1 -0
- pygeai/man/man1/__init__.py +1 -0
- pygeai/man/man1/geai-proxy.1 +246 -0
- pygeai/man/man1/geai.1 +2615 -0
- pygeai/migration/__init__.py +33 -0
- pygeai/migration/strategies.py +603 -0
- pygeai/migration/tools.py +180 -0
- pygeai/organization/clients.py +246 -18
- pygeai/organization/endpoints.py +17 -8
- pygeai/organization/limits/__init__.py +0 -0
- pygeai/organization/limits/clients.py +281 -0
- pygeai/organization/limits/endpoints.py +15 -0
- pygeai/organization/limits/managers.py +331 -0
- pygeai/organization/limits/mappers.py +21 -0
- pygeai/organization/managers.py +537 -0
- pygeai/organization/mappers.py +111 -46
- pygeai/organization/responses.py +61 -11
- pygeai/proxy/__init__.py +0 -0
- pygeai/proxy/clients.py +216 -0
- pygeai/proxy/config.py +128 -0
- pygeai/proxy/managers.py +232 -0
- pygeai/proxy/servers.py +304 -0
- pygeai/proxy/tool.py +69 -0
- pygeai/tests/admin/__init__.py +0 -0
- pygeai/tests/admin/test_clients.py +148 -0
- pygeai/tests/analytics/__init__.py +0 -0
- pygeai/tests/analytics/test_clients.py +86 -0
- pygeai/tests/analytics/test_managers.py +94 -0
- pygeai/tests/analytics/test_mappers.py +84 -0
- pygeai/tests/analytics/test_responses.py +73 -0
- pygeai/tests/assistants/rag/__init__.py +0 -0
- pygeai/tests/assistants/rag/test_clients.py +346 -0
- pygeai/tests/assistants/rag/test_mappers.py +189 -0
- pygeai/tests/assistants/rag/test_models.py +292 -0
- pygeai/tests/assistants/test_clients.py +176 -80
- pygeai/tests/assistants/test_managers.py +198 -0
- pygeai/tests/assistants/test_mappers.py +111 -0
- pygeai/tests/auth/__init__.py +0 -0
- pygeai/tests/auth/test_clients.py +289 -0
- pygeai/tests/auth/test_oauth.py +172 -0
- pygeai/tests/auth/test_session_logging.py +150 -0
- pygeai/tests/chat/__init__.py +0 -0
- pygeai/tests/chat/test_clients.py +393 -0
- pygeai/tests/chat/test_iris.py +38 -0
- pygeai/tests/chat/test_session.py +62 -0
- pygeai/tests/chat/test_ui.py +224 -0
- pygeai/tests/cli/__init__.py +0 -0
- pygeai/tests/cli/commands/__init__.py +0 -0
- pygeai/tests/cli/commands/lab/__init__.py +0 -0
- pygeai/tests/cli/commands/lab/test_ai_lab.py +786 -0
- pygeai/tests/cli/commands/lab/test_common.py +208 -0
- pygeai/tests/cli/commands/lab/test_spec.py +246 -0
- pygeai/tests/cli/commands/test_assistant.py +202 -0
- pygeai/tests/cli/commands/test_chat.py +130 -0
- pygeai/tests/cli/commands/test_common.py +350 -0
- pygeai/tests/cli/commands/test_embeddings.py +132 -0
- pygeai/tests/cli/commands/test_evaluation.py +656 -0
- pygeai/tests/cli/commands/test_feedback.py +65 -0
- pygeai/tests/cli/commands/test_files.py +161 -0
- pygeai/tests/cli/commands/test_gam.py +201 -0
- pygeai/tests/cli/commands/test_llm.py +114 -0
- pygeai/tests/cli/commands/test_migrate.py +176 -0
- pygeai/tests/cli/commands/test_organization.py +276 -0
- pygeai/tests/cli/commands/test_rag.py +266 -0
- pygeai/tests/cli/commands/test_rerank.py +110 -0
- pygeai/tests/cli/commands/test_secrets.py +171 -0
- pygeai/tests/cli/commands/test_show_help.py +41 -0
- pygeai/tests/cli/commands/test_usage_limits.py +412 -0
- pygeai/tests/cli/commands/test_validators.py +160 -0
- pygeai/tests/cli/commands/test_version.py +81 -0
- pygeai/tests/cli/docker/__init__.py +0 -0
- pygeai/tests/cli/test_credentials_flag.py +316 -0
- pygeai/tests/cli/test_error_handler.py +225 -0
- pygeai/tests/cli/test_geai_driver.py +154 -0
- pygeai/tests/cli/test_parsers.py +154 -0
- pygeai/tests/core/base/__init__.py +0 -0
- pygeai/tests/core/base/data/__init__.py +0 -0
- pygeai/tests/core/base/data/mappers.py +117 -0
- pygeai/tests/core/base/data/models.py +312 -0
- pygeai/tests/core/base/test_mappers.py +569 -0
- pygeai/tests/core/base/test_models.py +261 -0
- pygeai/tests/core/base/test_responses.py +53 -0
- pygeai/tests/core/common/__init__.py +0 -0
- pygeai/tests/core/common/data/__init__.py +0 -0
- pygeai/tests/core/common/test_config.py +186 -0
- pygeai/tests/core/common/test_decorators.py +69 -0
- pygeai/tests/core/embeddings/__init__.py +0 -0
- pygeai/tests/core/embeddings/test_clients.py +225 -0
- pygeai/tests/core/embeddings/test_managers.py +171 -0
- pygeai/tests/core/embeddings/test_mappers.py +142 -0
- pygeai/tests/core/feedback/__init__.py +0 -0
- pygeai/tests/core/feedback/test_clients.py +64 -0
- pygeai/tests/core/files/__init__.py +0 -0
- pygeai/tests/core/files/test_clients.py +128 -0
- pygeai/tests/core/files/test_managers.py +219 -0
- pygeai/tests/core/files/test_mappers.py +137 -0
- pygeai/tests/core/files/test_models.py +103 -0
- pygeai/tests/core/files/test_responses.py +122 -0
- pygeai/tests/core/llm/__init__.py +0 -0
- pygeai/tests/core/llm/test_clients.py +142 -0
- pygeai/tests/core/plugins/__init__.py +0 -0
- pygeai/tests/core/plugins/test_clients.py +66 -0
- pygeai/tests/core/rerank/__init__.py +0 -0
- pygeai/tests/core/rerank/test_clients.py +76 -0
- pygeai/tests/core/rerank/test_managers.py +99 -0
- pygeai/tests/core/rerank/test_mappers.py +54 -0
- pygeai/tests/core/secrets/__init__.py +0 -0
- pygeai/tests/core/secrets/test_clients.py +264 -0
- pygeai/tests/core/services/__init__.py +0 -0
- pygeai/tests/core/services/test_rest.py +273 -0
- pygeai/tests/core/test_handlers.py +66 -0
- pygeai/tests/core/utils/__init__.py +0 -0
- pygeai/tests/core/utils/test_console.py +80 -0
- pygeai/tests/dbg/__init__.py +0 -0
- pygeai/tests/dbg/test_debugger.py +591 -0
- pygeai/tests/evaluation/__init__.py +0 -0
- pygeai/tests/evaluation/dataset/__init__.py +0 -0
- pygeai/tests/evaluation/dataset/test_clients.py +265 -0
- pygeai/tests/evaluation/plan/__init__.py +0 -0
- pygeai/tests/evaluation/plan/test_clients.py +195 -0
- pygeai/tests/evaluation/result/__init__.py +0 -0
- pygeai/tests/evaluation/result/test_clients.py +66 -0
- pygeai/tests/gam/__init__.py +0 -0
- pygeai/tests/gam/test_clients.py +195 -0
- pygeai/tests/health/__init__.py +0 -0
- pygeai/tests/health/test_clients.py +41 -0
- pygeai/tests/integration/__init__.py +0 -0
- pygeai/tests/integration/assistants/__init__.py +0 -0
- pygeai/tests/integration/assistants/rag/__init__.py +0 -0
- pygeai/tests/integration/assistants/rag/test_create_rag.py +91 -0
- pygeai/tests/integration/chat/__init__.py +0 -0
- pygeai/tests/integration/chat/test_generate_image.py +158 -0
- pygeai/tests/integration/lab/__init__.py +0 -0
- pygeai/tests/integration/lab/agents/__init__.py +0 -0
- pygeai/tests/integration/lab/agents/test_agents_list.py +106 -0
- pygeai/tests/integration/lab/agents/test_create_agent.py +319 -0
- pygeai/tests/integration/lab/agents/test_create_sharing_link.py +70 -0
- pygeai/tests/integration/lab/agents/test_delete_agent.py +75 -0
- pygeai/tests/integration/lab/agents/test_get_agent.py +94 -0
- pygeai/tests/integration/lab/agents/test_publish_agent_revision.py +127 -0
- pygeai/tests/integration/lab/agents/test_update_agent.py +250 -0
- pygeai/tests/integration/lab/processes/__init__.py +0 -0
- pygeai/tests/integration/lab/processes/test_create_process.py +345 -0
- pygeai/tests/integration/lab/processes/test_create_task.py +211 -0
- pygeai/tests/integration/lab/processes/test_delete_process.py +111 -0
- pygeai/tests/integration/lab/processes/test_get_process.py +201 -0
- pygeai/tests/integration/lab/processes/test_list_process_instances.py +91 -0
- pygeai/tests/integration/lab/processes/test_list_processes.py +138 -0
- pygeai/tests/integration/lab/processes/test_publish_process_revision.py +232 -0
- pygeai/tests/integration/lab/processes/test_update_process.py +289 -0
- pygeai/tests/integration/lab/reasoning_strategies/__init__.py +0 -0
- pygeai/tests/integration/lab/reasoning_strategies/test_get_reasoning_strategy.py +70 -0
- pygeai/tests/integration/lab/reasoning_strategies/test_list_reasoning_strategies.py +93 -0
- pygeai/tests/integration/lab/reasoning_strategies/test_update_reasoning_strategy.py +149 -0
- pygeai/tests/integration/lab/tools/__init__.py +0 -0
- pygeai/tests/integration/lab/tools/test_create_tool.py +288 -0
- pygeai/tests/integration/lab/tools/test_delete_tool.py +87 -0
- pygeai/tests/integration/lab/tools/test_get_parameter.py +98 -0
- pygeai/tests/integration/lab/tools/test_get_tool.py +91 -0
- pygeai/tests/integration/lab/tools/test_list_tools.py +106 -0
- pygeai/tests/integration/lab/tools/test_publish_tool_revision.py +119 -0
- pygeai/tests/integration/lab/tools/test_set_parameter.py +114 -0
- pygeai/tests/integration/lab/tools/test_update_tool.py +267 -0
- pygeai/tests/lab/__init__.py +0 -0
- pygeai/tests/lab/agents/__init__.py +0 -0
- pygeai/tests/lab/agents/test_clients.py +481 -0
- pygeai/tests/lab/agents/test_mappers.py +440 -0
- pygeai/tests/lab/processes/__init__.py +0 -0
- pygeai/tests/lab/processes/test_clients.py +1416 -0
- pygeai/tests/lab/processes/test_mappers.py +1092 -0
- pygeai/tests/lab/spec/__init__.py +0 -0
- pygeai/tests/lab/spec/test_loader.py +59 -0
- pygeai/tests/lab/spec/test_parsers.py +182 -0
- pygeai/tests/lab/strategies/__init__.py +0 -0
- pygeai/tests/lab/strategies/test_clients.py +241 -0
- pygeai/tests/lab/strategies/test_mappers.py +132 -0
- pygeai/tests/lab/test_managers.py +553 -0
- pygeai/tests/lab/test_mappers.py +245 -0
- pygeai/tests/lab/test_models.py +1154 -0
- pygeai/tests/lab/tools/__init__.py +0 -0
- pygeai/tests/lab/tools/test_clients.py +521 -0
- pygeai/tests/lab/tools/test_mappers.py +198 -0
- pygeai/tests/migration/__init__.py +0 -0
- pygeai/tests/migration/test_strategies.py +405 -0
- pygeai/tests/migration/test_tools.py +159 -0
- pygeai/tests/organization/limits/__init__.py +0 -0
- pygeai/tests/organization/limits/test_clients.py +567 -0
- pygeai/tests/organization/limits/test_managers.py +402 -0
- pygeai/tests/organization/test_clients.py +615 -64
- pygeai/tests/organization/test_managers.py +424 -0
- pygeai/tests/organization/test_mappers.py +153 -0
- pygeai/tests/organization/test_responses.py +137 -0
- pygeai/tests/proxy/__init__.py +1 -0
- pygeai/tests/proxy/test_clients.py +397 -0
- pygeai/tests/proxy/test_config.py +171 -0
- pygeai/tests/proxy/test_integration.py +305 -0
- pygeai/tests/proxy/test_managers.py +312 -0
- pygeai/tests/proxy/test_servers.py +387 -0
- pygeai/tests/proxy/test_tool.py +176 -0
- pygeai/tests/snippets/__init__.py +0 -0
- pygeai/tests/snippets/analytics/__init__.py +0 -0
- pygeai/tests/snippets/analytics/get_agent_usage_per_user.py +16 -0
- pygeai/tests/snippets/analytics/get_agents_created_and_modified.py +11 -0
- pygeai/tests/snippets/analytics/get_average_cost_per_request.py +10 -0
- pygeai/tests/snippets/analytics/get_overall_error_rate.py +10 -0
- pygeai/tests/snippets/analytics/get_top_10_agents_by_requests.py +12 -0
- pygeai/tests/snippets/analytics/get_total_active_users.py +10 -0
- pygeai/tests/snippets/analytics/get_total_cost.py +10 -0
- pygeai/tests/snippets/analytics/get_total_requests_per_day.py +12 -0
- pygeai/tests/snippets/analytics/get_total_tokens.py +12 -0
- pygeai/tests/snippets/assistants/__init__.py +0 -0
- pygeai/tests/snippets/assistants/create_chat_assistant.py +54 -0
- pygeai/tests/snippets/assistants/create_text_assistant.py +51 -0
- pygeai/tests/snippets/assistants/data_analyst/__init__.py +0 -0
- pygeai/tests/snippets/assistants/data_analyst/extend_and_check.py +100 -0
- pygeai/tests/snippets/assistants/data_analyst/extend_dataset.py +9 -0
- pygeai/tests/snippets/assistants/data_analyst/get_status.py +9 -0
- pygeai/tests/snippets/assistants/file_summarizer_assistant.py +149 -0
- pygeai/tests/snippets/assistants/get_assistant_data.py +8 -0
- pygeai/tests/snippets/assistants/get_assistant_list.py +7 -0
- pygeai/tests/snippets/assistants/rag/__init__.py +0 -0
- pygeai/tests/snippets/assistants/rag/create_rag_assistant.py +65 -0
- pygeai/tests/snippets/assistants/rag/delete_al_documents.py +7 -0
- pygeai/tests/snippets/assistants/rag/delete_document.py +10 -0
- pygeai/tests/snippets/assistants/rag/delete_rag_assistant.py +8 -0
- pygeai/tests/snippets/assistants/rag/get_document.py +10 -0
- pygeai/tests/snippets/assistants/rag/get_documents.py +7 -0
- pygeai/tests/snippets/assistants/rag/get_rag_assistant_data.py +8 -0
- pygeai/tests/snippets/assistants/rag/update_rag_assistant.py +48 -0
- pygeai/tests/snippets/assistants/rag/upload_document.py +19 -0
- pygeai/tests/snippets/assistants/send_feedback.py +14 -0
- pygeai/tests/snippets/assistants/update_chat_assistant.py +63 -0
- pygeai/tests/snippets/auth/__init__.py +0 -0
- pygeai/tests/snippets/chat/__init__.py +0 -0
- pygeai/tests/snippets/chat/cancel_request.py +7 -0
- pygeai/tests/snippets/chat/chat_completion.py +28 -0
- pygeai/tests/snippets/chat/chat_completion_1.py +40 -0
- pygeai/tests/snippets/chat/chat_completion_2.py +60 -0
- pygeai/tests/snippets/chat/chat_completion_3.py +27 -0
- pygeai/tests/snippets/chat/chat_completion_4.py +67 -0
- pygeai/tests/snippets/chat/chat_completion_streaming.py +63 -0
- pygeai/tests/snippets/chat/chat_completion_with_reasoning_effort.py +18 -0
- pygeai/tests/snippets/chat/get_request_status.py +7 -0
- pygeai/tests/snippets/chat/get_response.py +15 -0
- pygeai/tests/snippets/chat/get_response_complete_example.py +67 -0
- pygeai/tests/snippets/chat/get_response_streaming.py +20 -0
- pygeai/tests/snippets/chat/get_response_with_files.py +16 -0
- pygeai/tests/snippets/chat/get_response_with_instructions.py +19 -0
- pygeai/tests/snippets/chat/get_response_with_metadata.py +24 -0
- pygeai/tests/snippets/chat/get_response_with_parallel_tools.py +58 -0
- pygeai/tests/snippets/chat/get_response_with_reasoning.py +21 -0
- pygeai/tests/snippets/chat/get_response_with_store.py +38 -0
- pygeai/tests/snippets/chat/get_response_with_tools.py +36 -0
- pygeai/tests/snippets/chat/get_response_with_truncation.py +24 -0
- pygeai/tests/snippets/chat/send_chat_request.py +33 -0
- pygeai/tests/snippets/dbg/__init__.py +0 -0
- pygeai/tests/snippets/dbg/basic_debugging.py +32 -0
- pygeai/tests/snippets/dbg/breakpoint_management.py +48 -0
- pygeai/tests/snippets/dbg/file_debugging.py +72 -0
- pygeai/tests/snippets/dbg/module_debugging.py +61 -0
- pygeai/tests/snippets/dbg/stack_navigation.py +45 -0
- pygeai/tests/snippets/dbg/stepping_example.py +40 -0
- pygeai/tests/snippets/embeddings/__init__.py +0 -0
- pygeai/tests/snippets/embeddings/cache_example.py +31 -0
- pygeai/tests/snippets/embeddings/cohere_example.py +41 -0
- pygeai/tests/snippets/embeddings/generate_embeddings.py +26 -0
- pygeai/tests/snippets/embeddings/openai_base64_example.py +27 -0
- pygeai/tests/snippets/embeddings/openai_example.py +30 -0
- pygeai/tests/snippets/embeddings/similarity_example.py +42 -0
- pygeai/tests/snippets/evaluation/__init__.py +0 -0
- pygeai/tests/snippets/evaluation/dataset/__init__.py +0 -0
- pygeai/tests/snippets/evaluation/dataset/complete_workflow_example.py +195 -0
- pygeai/tests/snippets/evaluation/dataset/create_dataset.py +26 -0
- pygeai/tests/snippets/evaluation/dataset/create_dataset_from_file.py +11 -0
- pygeai/tests/snippets/evaluation/dataset/create_dataset_row.py +17 -0
- pygeai/tests/snippets/evaluation/dataset/create_expected_source.py +18 -0
- pygeai/tests/snippets/evaluation/dataset/create_filter_variable.py +19 -0
- pygeai/tests/snippets/evaluation/dataset/delete_dataset.py +9 -0
- pygeai/tests/snippets/evaluation/dataset/delete_dataset_row.py +10 -0
- pygeai/tests/snippets/evaluation/dataset/delete_expected_source.py +15 -0
- pygeai/tests/snippets/evaluation/dataset/delete_filter_variable.py +15 -0
- pygeai/tests/snippets/evaluation/dataset/get_dataset.py +9 -0
- pygeai/tests/snippets/evaluation/dataset/get_dataset_row.py +10 -0
- pygeai/tests/snippets/evaluation/dataset/get_expected_source.py +15 -0
- pygeai/tests/snippets/evaluation/dataset/get_filter_variable.py +15 -0
- pygeai/tests/snippets/evaluation/dataset/list_dataset_rows.py +9 -0
- pygeai/tests/snippets/evaluation/dataset/list_datasets.py +6 -0
- pygeai/tests/snippets/evaluation/dataset/list_expected_sources.py +10 -0
- pygeai/tests/snippets/evaluation/dataset/list_filter_variables.py +10 -0
- pygeai/tests/snippets/evaluation/dataset/update_dataset.py +15 -0
- pygeai/tests/snippets/evaluation/dataset/update_dataset_row.py +20 -0
- pygeai/tests/snippets/evaluation/dataset/update_expected_source.py +18 -0
- pygeai/tests/snippets/evaluation/dataset/update_filter_variable.py +19 -0
- pygeai/tests/snippets/evaluation/dataset/upload_dataset_rows_file.py +10 -0
- pygeai/tests/snippets/evaluation/plan/__init__.py +0 -0
- pygeai/tests/snippets/evaluation/plan/add_plan_system_metric.py +13 -0
- pygeai/tests/snippets/evaluation/plan/complete_workflow_example.py +136 -0
- pygeai/tests/snippets/evaluation/plan/create_evaluation_plan.py +24 -0
- pygeai/tests/snippets/evaluation/plan/create_rag_evaluation_plan.py +22 -0
- pygeai/tests/snippets/evaluation/plan/delete_evaluation_plan.py +9 -0
- pygeai/tests/snippets/evaluation/plan/delete_plan_system_metric.py +13 -0
- pygeai/tests/snippets/evaluation/plan/execute_evaluation_plan.py +11 -0
- pygeai/tests/snippets/evaluation/plan/get_evaluation_plan.py +9 -0
- pygeai/tests/snippets/evaluation/plan/get_plan_system_metric.py +13 -0
- pygeai/tests/snippets/evaluation/plan/get_system_metric.py +9 -0
- pygeai/tests/snippets/evaluation/plan/list_evaluation_plans.py +7 -0
- pygeai/tests/snippets/evaluation/plan/list_plan_system_metrics.py +9 -0
- pygeai/tests/snippets/evaluation/plan/list_system_metrics.py +7 -0
- pygeai/tests/snippets/evaluation/plan/update_evaluation_plan.py +22 -0
- pygeai/tests/snippets/evaluation/plan/update_plan_system_metric.py +14 -0
- pygeai/tests/snippets/evaluation/result/__init__.py +0 -0
- pygeai/tests/snippets/evaluation/result/complete_workflow_example.py +150 -0
- pygeai/tests/snippets/evaluation/result/get_evaluation_result.py +26 -0
- pygeai/tests/snippets/evaluation/result/list_evaluation_results.py +17 -0
- pygeai/tests/snippets/files/__init__.py +0 -0
- pygeai/tests/snippets/files/delete_file.py +9 -0
- pygeai/tests/snippets/files/get_file_content.py +10 -0
- pygeai/tests/snippets/files/get_file_data.py +9 -0
- pygeai/tests/snippets/files/get_file_list.py +6 -0
- pygeai/tests/snippets/files/upload_file.py +13 -0
- pygeai/tests/snippets/gam/__init__.py +0 -0
- pygeai/tests/snippets/gam/gam_access_token.py +87 -0
- pygeai/tests/snippets/lab/__init__.py +0 -0
- pygeai/tests/snippets/lab/agentic_flow_example_1.py +326 -0
- pygeai/tests/snippets/lab/agentic_flow_example_2.py +206 -0
- pygeai/tests/snippets/lab/agentic_flow_example_3.py +486 -0
- pygeai/tests/snippets/lab/agentic_flow_example_4.py +446 -0
- pygeai/tests/snippets/lab/agents/__init__.py +0 -0
- pygeai/tests/snippets/lab/agents/create_agent.py +48 -0
- pygeai/tests/snippets/lab/agents/create_agent_2.py +48 -0
- pygeai/tests/snippets/lab/agents/create_agent_edge_case.py +48 -0
- pygeai/tests/snippets/lab/agents/create_agent_with_permissions.py +39 -0
- pygeai/tests/snippets/lab/agents/create_agent_with_properties.py +46 -0
- pygeai/tests/snippets/lab/agents/create_agent_without_instructions.py +48 -0
- pygeai/tests/snippets/lab/agents/delete_agent.py +12 -0
- pygeai/tests/snippets/lab/agents/get_agent.py +24 -0
- pygeai/tests/snippets/lab/agents/get_agent_with_new_fields.py +62 -0
- pygeai/tests/snippets/lab/agents/get_sharing_link.py +13 -0
- pygeai/tests/snippets/lab/agents/list_agents.py +18 -0
- pygeai/tests/snippets/lab/agents/publish_agent_revision.py +12 -0
- pygeai/tests/snippets/lab/agents/update_agent.py +50 -0
- pygeai/tests/snippets/lab/agents/update_agent_properties.py +50 -0
- pygeai/tests/snippets/lab/assistant_to_agent.py +191 -0
- pygeai/tests/snippets/lab/crud_ui.py +462 -0
- pygeai/tests/snippets/lab/processes/__init__.py +0 -0
- pygeai/tests/snippets/lab/processes/create_process.py +24 -0
- pygeai/tests/snippets/lab/processes/create_task.py +8 -0
- pygeai/tests/snippets/lab/processes/jobs/__init__.py +0 -0
- pygeai/tests/snippets/lab/processes/jobs/list_jobs.py +21 -0
- pygeai/tests/snippets/lab/processes/kbs/__init__.py +0 -0
- pygeai/tests/snippets/lab/processes/kbs/create_kb.py +18 -0
- pygeai/tests/snippets/lab/processes/kbs/get_kb.py +26 -0
- pygeai/tests/snippets/lab/processes/kbs/list_kbs.py +30 -0
- pygeai/tests/snippets/lab/processes/kbs/try_all.py +73 -0
- pygeai/tests/snippets/lab/processes/list_processes.py +10 -0
- pygeai/tests/snippets/lab/runner_1.py +212 -0
- pygeai/tests/snippets/lab/samples/__init__.py +0 -0
- pygeai/tests/snippets/lab/samples/summarize_files.py +162 -0
- pygeai/tests/snippets/lab/strategies/__init__.py +0 -0
- pygeai/tests/snippets/lab/strategies/create_reasoning_strategy.py +22 -0
- pygeai/tests/snippets/lab/strategies/get_reasoning_strategy.py +10 -0
- pygeai/tests/snippets/lab/strategies/list_reasoning_strategies.py +16 -0
- pygeai/tests/snippets/lab/strategies/update_reasoning_strategy.py +26 -0
- pygeai/tests/snippets/lab/tools/__init__.py +0 -0
- pygeai/tests/snippets/lab/tools/create_tool.py +48 -0
- pygeai/tests/snippets/lab/tools/create_tool_edge_case.py +50 -0
- pygeai/tests/snippets/lab/tools/delete_tool.py +21 -0
- pygeai/tests/snippets/lab/tools/get_parameter.py +21 -0
- pygeai/tests/snippets/lab/tools/get_tool.py +22 -0
- pygeai/tests/snippets/lab/tools/list_tools.py +23 -0
- pygeai/tests/snippets/lab/tools/publish_tool_revision.py +13 -0
- pygeai/tests/snippets/lab/tools/set_parameters.py +33 -0
- pygeai/tests/snippets/lab/tools/update_tool.py +52 -0
- pygeai/tests/snippets/lab/use_cases/__init__.py +0 -0
- pygeai/tests/snippets/lab/use_cases/c_code_fixer_agent_flow.py +238 -0
- pygeai/tests/snippets/lab/use_cases/create_cli_expert.py +1640 -0
- pygeai/tests/snippets/lab/use_cases/create_lab_expert.py +4541 -0
- pygeai/tests/snippets/lab/use_cases/create_tool_headless_web_browser.py +133 -0
- pygeai/tests/snippets/lab/use_cases/create_web_designer.py +189 -0
- pygeai/tests/snippets/lab/use_cases/create_web_reader.py +185 -0
- pygeai/tests/snippets/lab/use_cases/file_summarizer_example.py +157 -0
- pygeai/tests/snippets/lab/use_cases/file_summarizer_example_2.py +157 -0
- pygeai/tests/snippets/lab/use_cases/update_cli_expert.py +1773 -0
- pygeai/tests/snippets/lab/use_cases/update_lab_expert.py +4541 -0
- pygeai/tests/snippets/lab/use_cases/update_web_designer.py +188 -0
- pygeai/tests/snippets/lab/use_cases/update_web_reader.py +195 -0
- pygeai/tests/snippets/lab/use_cases/update_web_reader_with_tool.py +210 -0
- pygeai/tests/snippets/migrate/__init__.py +45 -0
- pygeai/tests/snippets/migrate/agent_migration.py +110 -0
- pygeai/tests/snippets/migrate/assistant_migration.py +64 -0
- pygeai/tests/snippets/migrate/orchestrator_examples.py +179 -0
- pygeai/tests/snippets/migrate/process_migration.py +64 -0
- pygeai/tests/snippets/migrate/project_migration.py +42 -0
- pygeai/tests/snippets/migrate/tool_migration.py +64 -0
- pygeai/tests/snippets/organization/__init__.py +0 -0
- pygeai/tests/snippets/organization/add_project_member.py +10 -0
- pygeai/tests/snippets/organization/add_project_member_batch.py +44 -0
- pygeai/tests/snippets/organization/create_project.py +23 -0
- pygeai/tests/snippets/organization/delete_project.py +7 -0
- pygeai/tests/snippets/organization/export_request_data.py +7 -0
- pygeai/tests/snippets/organization/get_memberships.py +12 -0
- pygeai/tests/snippets/organization/get_organization_members.py +6 -0
- pygeai/tests/snippets/organization/get_project_data.py +7 -0
- pygeai/tests/snippets/organization/get_project_list.py +8 -0
- pygeai/tests/snippets/organization/get_project_members.py +6 -0
- pygeai/tests/snippets/organization/get_project_memberships.py +12 -0
- pygeai/tests/snippets/organization/get_project_roles.py +6 -0
- pygeai/tests/snippets/organization/get_project_tokens.py +7 -0
- pygeai/tests/snippets/organization/update_project.py +14 -0
- pygeai/tests/snippets/rerank/__init__.py +0 -0
- pygeai/tests/snippets/rerank/rerank_chunks.py +19 -0
- pygeai/tests/snippets/secrets/__init__.py +0 -0
- pygeai/tests/snippets/usage_limit/__init__.py +0 -0
- pygeai/tests/snippets/usage_limit/delete_usage_limit.py +16 -0
- pygeai/tests/snippets/usage_limit/get_all_usage_limit_from_organization.py +12 -0
- pygeai/tests/snippets/usage_limit/get_usage_limit_from_organization.py +11 -0
- pygeai/tests/snippets/usage_limit/get_usage_limit_from_project.py +13 -0
- pygeai/tests/snippets/usage_limit/set_usage_limit_organization.py +22 -0
- pygeai/tests/snippets/usage_limit/set_usage_limit_project.py +23 -0
- pygeai/tests/snippets/usage_limit/update_usage_limit_organization.py +23 -0
- pygeai/tests/snippets/usage_limit/update_usage_limit_project.py +24 -0
- pygeai/vendor/a2a/__init__.py +1 -0
- pygeai/vendor/a2a/auth/__init__.py +0 -0
- pygeai/vendor/a2a/auth/user.py +31 -0
- pygeai/vendor/a2a/client/__init__.py +19 -0
- pygeai/vendor/a2a/client/client.py +425 -0
- pygeai/vendor/a2a/client/errors.py +33 -0
- pygeai/vendor/a2a/client/helpers.py +22 -0
- pygeai/vendor/a2a/py.typed +0 -0
- pygeai/vendor/a2a/server/__init__.py +1 -0
- pygeai/vendor/a2a/server/agent_execution/__init__.py +18 -0
- pygeai/vendor/a2a/server/agent_execution/agent_executor.py +44 -0
- pygeai/vendor/a2a/server/agent_execution/context.py +155 -0
- pygeai/vendor/a2a/server/agent_execution/request_context_builder.py +20 -0
- pygeai/vendor/a2a/server/agent_execution/simple_request_context_builder.py +77 -0
- pygeai/vendor/a2a/server/apps/__init__.py +16 -0
- pygeai/vendor/a2a/server/apps/jsonrpc/__init__.py +16 -0
- pygeai/vendor/a2a/server/apps/jsonrpc/fastapi_app.py +88 -0
- pygeai/vendor/a2a/server/apps/jsonrpc/jsonrpc_app.py +426 -0
- pygeai/vendor/a2a/server/apps/jsonrpc/starlette_app.py +123 -0
- pygeai/vendor/a2a/server/context.py +23 -0
- pygeai/vendor/a2a/server/events/__init__.py +21 -0
- pygeai/vendor/a2a/server/events/event_consumer.py +149 -0
- pygeai/vendor/a2a/server/events/event_queue.py +156 -0
- pygeai/vendor/a2a/server/events/in_memory_queue_manager.py +85 -0
- pygeai/vendor/a2a/server/events/queue_manager.py +35 -0
- pygeai/vendor/a2a/server/request_handlers/__init__.py +20 -0
- pygeai/vendor/a2a/server/request_handlers/default_request_handler.py +435 -0
- pygeai/vendor/a2a/server/request_handlers/jsonrpc_handler.py +327 -0
- pygeai/vendor/a2a/server/request_handlers/request_handler.py +161 -0
- pygeai/vendor/a2a/server/request_handlers/response_helpers.py +133 -0
- pygeai/vendor/a2a/server/tasks/__init__.py +20 -0
- pygeai/vendor/a2a/server/tasks/inmemory_push_notifier.py +62 -0
- pygeai/vendor/a2a/server/tasks/inmemory_task_store.py +51 -0
- pygeai/vendor/a2a/server/tasks/push_notifier.py +25 -0
- pygeai/vendor/a2a/server/tasks/result_aggregator.py +151 -0
- pygeai/vendor/a2a/server/tasks/task_manager.py +253 -0
- pygeai/vendor/a2a/server/tasks/task_store.py +22 -0
- pygeai/vendor/a2a/server/tasks/task_updater.py +155 -0
- pygeai/vendor/a2a/types.py +1624 -0
- pygeai/vendor/a2a/utils/__init__.py +40 -0
- pygeai/vendor/a2a/utils/artifact.py +72 -0
- pygeai/vendor/a2a/utils/errors.py +69 -0
- pygeai/vendor/a2a/utils/helpers.py +176 -0
- pygeai/vendor/a2a/utils/message.py +83 -0
- pygeai/vendor/a2a/utils/task.py +57 -0
- pygeai/vendor/a2a/utils/telemetry.py +299 -0
- pygeai-0.6.0b15.dist-info/METADATA +205 -0
- pygeai-0.6.0b15.dist-info/RECORD +799 -0
- {pygeai-0.1.6.dist-info → pygeai-0.6.0b15.dist-info}/WHEEL +1 -1
- pygeai-0.6.0b15.dist-info/entry_points.txt +5 -0
- {pygeai-0.1.6.dist-info → pygeai-0.6.0b15.dist-info/licenses}/LICENSE +13 -1
- {pygeai-0.1.6.dist-info → pygeai-0.6.0b15.dist-info}/top_level.txt +0 -1
- docs/source/conf.py +0 -45
- pygeai/core/clients.py +0 -240
- pygeai/tests/core/test_clients.py +0 -49
- pygeai-0.1.6.dist-info/METADATA +0 -92
- pygeai-0.1.6.dist-info/RECORD +0 -65
- pygeai-0.1.6.dist-info/SOURCES.sync-conflict-20241223-145950-3QD4F42.txt +0 -41
- pygeai-0.1.6.dist-info/entry_points.txt +0 -2
- /pygeai/{agent → analytics}/__init__.py +0 -0
pygeai/man/man1/geai.1
ADDED
|
@@ -0,0 +1,2615 @@
|
|
|
1
|
+
.\" Man page for geai CLI
|
|
2
|
+
.\" Generated on May 23, 2025
|
|
3
|
+
.TH GEAI 1 "2025-05-23" "Globant Enterprise AI" "GEAI CLI Manual"
|
|
4
|
+
.SH NAME
|
|
5
|
+
geai \- Command Line Interface for Globant Enterprise AI
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
.B geai
|
|
8
|
+
.I command
|
|
9
|
+
.RI [ subcommand ]
|
|
10
|
+
.RI [ --option ]
|
|
11
|
+
.RI [ option-arg ]
|
|
12
|
+
.SH DESCRIPTION
|
|
13
|
+
The
|
|
14
|
+
.B geai
|
|
15
|
+
command-line interface (CLI) interacts with the PyGEAI SDK to manage tasks in Globant Enterprise AI (GEAI), including creating organizations and projects, defining assistants, managing workflows, handling files, and more.
|
|
16
|
+
.PP
|
|
17
|
+
The available commands and their subcommands are described below. For specific options, use:
|
|
18
|
+
.PP
|
|
19
|
+
.nf
|
|
20
|
+
.B geai
|
|
21
|
+
.I command
|
|
22
|
+
.B h
|
|
23
|
+
.fi
|
|
24
|
+
.PP
|
|
25
|
+
or
|
|
26
|
+
.PP
|
|
27
|
+
.nf
|
|
28
|
+
.B geai
|
|
29
|
+
.I command
|
|
30
|
+
.B help
|
|
31
|
+
.fi
|
|
32
|
+
.SS Commands
|
|
33
|
+
The following top-level commands are available:
|
|
34
|
+
.TP
|
|
35
|
+
.B help, h
|
|
36
|
+
Display help text for the specified command.
|
|
37
|
+
.TP
|
|
38
|
+
.B version, v
|
|
39
|
+
Display the version of the GEAI CLI.
|
|
40
|
+
.TP
|
|
41
|
+
.B check-updates, cu
|
|
42
|
+
Search for available updates for the GEAI CLI.
|
|
43
|
+
.TP
|
|
44
|
+
.B configure, config, c
|
|
45
|
+
Set up environment variables required to interact with GEAI.
|
|
46
|
+
.RS
|
|
47
|
+
.TP
|
|
48
|
+
.B --key, -k
|
|
49
|
+
Set the GEAI API key.
|
|
50
|
+
.TP
|
|
51
|
+
.B --url, -u
|
|
52
|
+
Set the GEAI API base URL.
|
|
53
|
+
.TP
|
|
54
|
+
.B --eval-url, --eu
|
|
55
|
+
Set the GEAI API evaluation URL for the evaluation module.
|
|
56
|
+
.TP
|
|
57
|
+
.B --alias, -a
|
|
58
|
+
Set an alias for the settings section.
|
|
59
|
+
.TP
|
|
60
|
+
.B --list, -l
|
|
61
|
+
List available aliases.
|
|
62
|
+
.RE
|
|
63
|
+
.TP
|
|
64
|
+
.B organization, org
|
|
65
|
+
Manage organization endpoints to handle project parameters. See
|
|
66
|
+
.B ORGANIZATION COMMANDS
|
|
67
|
+
for details.
|
|
68
|
+
.TP
|
|
69
|
+
.B assistant, ast
|
|
70
|
+
Manage assistant endpoints to handle assistant parameters. See
|
|
71
|
+
.B ASSISTANT COMMANDS
|
|
72
|
+
for details.
|
|
73
|
+
.TP
|
|
74
|
+
.B rag
|
|
75
|
+
Manage RAG (Retrieval-Augmented Generation) assistant endpoints. See
|
|
76
|
+
.B RAG ASSISTANT COMMANDS
|
|
77
|
+
for details.
|
|
78
|
+
.TP
|
|
79
|
+
.B chat
|
|
80
|
+
Manage chat endpoints to interact with assistants. See
|
|
81
|
+
.B CHAT COMMANDS
|
|
82
|
+
for details.
|
|
83
|
+
.TP
|
|
84
|
+
.B admin, adm
|
|
85
|
+
Manage admin endpoints for internal use. See
|
|
86
|
+
.B ADMIN COMMANDS
|
|
87
|
+
for details.
|
|
88
|
+
.TP
|
|
89
|
+
.B llm
|
|
90
|
+
Retrieve information about providers and models. See
|
|
91
|
+
.B LLM COMMANDS
|
|
92
|
+
for details.
|
|
93
|
+
.TP
|
|
94
|
+
.B files
|
|
95
|
+
Handle file-related operations. See
|
|
96
|
+
.B FILES COMMANDS
|
|
97
|
+
for details.
|
|
98
|
+
.TP
|
|
99
|
+
.B usage-limit, ulim
|
|
100
|
+
Manage usage limits for organizations and projects. See
|
|
101
|
+
.B USAGE LIMIT COMMANDS
|
|
102
|
+
for details.
|
|
103
|
+
.TP
|
|
104
|
+
.B embeddings, emb
|
|
105
|
+
Generate embeddings in GEAI. See
|
|
106
|
+
.B EMBEDDINGS COMMANDS
|
|
107
|
+
for details.
|
|
108
|
+
.TP
|
|
109
|
+
.B feedback, fbk
|
|
110
|
+
Send feedback on assistant responses. See
|
|
111
|
+
.B FEEDBACK COMMANDS
|
|
112
|
+
for details.
|
|
113
|
+
.TP
|
|
114
|
+
.B rerank, rr
|
|
115
|
+
Rerank document chunks based on a query. See
|
|
116
|
+
.B RERANK COMMANDS
|
|
117
|
+
for details.
|
|
118
|
+
.TP
|
|
119
|
+
.B evaluation, eval
|
|
120
|
+
Interact with dataset, plan, and result APIs in the evaluation module. See
|
|
121
|
+
.B EVALUATION COMMANDS
|
|
122
|
+
for details.
|
|
123
|
+
.TP
|
|
124
|
+
.B gam
|
|
125
|
+
Manage GAM authentication endpoints. See
|
|
126
|
+
.B GAM COMMANDS
|
|
127
|
+
for details.
|
|
128
|
+
.TP
|
|
129
|
+
.B secrets, sec
|
|
130
|
+
Handle GEAI secrets. See
|
|
131
|
+
.B SECRETS COMMANDS
|
|
132
|
+
for details.
|
|
133
|
+
.TP
|
|
134
|
+
.B ai-lab, ail
|
|
135
|
+
Interact with AI Lab endpoints. See
|
|
136
|
+
.B AI LAB COMMANDS
|
|
137
|
+
for details.
|
|
138
|
+
.TP
|
|
139
|
+
.B ai-lab-spec, spec
|
|
140
|
+
Load AI Lab components from JSON specifications. See
|
|
141
|
+
.B AI LAB SPEC COMMANDS
|
|
142
|
+
for details.
|
|
143
|
+
.TP
|
|
144
|
+
.B migrate, mig
|
|
145
|
+
Migrate data between organizations and instances. See
|
|
146
|
+
.B MIGRATE COMMANDS
|
|
147
|
+
for details.
|
|
148
|
+
.SH ERROR CODES
|
|
149
|
+
Certain errors include up to %n references specific to the error, denoted as %1, %2, ..., %n.
|
|
150
|
+
.TS
|
|
151
|
+
tab(|);
|
|
152
|
+
l l.
|
|
153
|
+
Error Code|Description
|
|
154
|
+
1|Assistant Not Found
|
|
155
|
+
2|Provider Type Not Found
|
|
156
|
+
3|Request Not Found
|
|
157
|
+
5|Api Key Not Found
|
|
158
|
+
6|Api Token Not Found
|
|
159
|
+
7|Api Token Out Of Scope
|
|
160
|
+
10|Query Text Empty
|
|
161
|
+
20|Bad Input Text
|
|
162
|
+
100|Provider Request Timeout
|
|
163
|
+
150|Provider Unknown Error
|
|
164
|
+
151|Provider Rate Limit
|
|
165
|
+
152|Provider Quota Exceeded
|
|
166
|
+
153|Provider Over Capacity
|
|
167
|
+
154|Quota Exceeded
|
|
168
|
+
401|Unauthorized
|
|
169
|
+
404|Bad Endpoint
|
|
170
|
+
405|Method Not Allowed
|
|
171
|
+
500|Internal Server Error
|
|
172
|
+
1001|Provider Configuration Error
|
|
173
|
+
1010|RAG Not Found
|
|
174
|
+
1101|Search Index Profile Name Not Found
|
|
175
|
+
1102|Request Failed
|
|
176
|
+
2000|Invalid ProjectName
|
|
177
|
+
2001|Invalid OrganizationId
|
|
178
|
+
2002|ProjectName %1 Already Exists In The Organization
|
|
179
|
+
2003|OrganizationName Already Exists
|
|
180
|
+
2004|Organization Not Found
|
|
181
|
+
2005|Project Not Found
|
|
182
|
+
2006|Project Not In Organization
|
|
183
|
+
2007|Name is Empty
|
|
184
|
+
2008|Prompt is Empty
|
|
185
|
+
2009|Invalid Type
|
|
186
|
+
2010|Not Implemented
|
|
187
|
+
2011|Assistant General Error
|
|
188
|
+
2012|Assistant Not Implemented
|
|
189
|
+
2013|Revision Is Empty
|
|
190
|
+
2014|Assistant Revision Not Found
|
|
191
|
+
2015|Assistant Revision Update Error
|
|
192
|
+
2016|AIModel Id For %1 %2
|
|
193
|
+
2017|RAG General Error
|
|
194
|
+
2018|Vector Store Not Found
|
|
195
|
+
2019|Index Profile General Error
|
|
196
|
+
2020|RAG Already Exists
|
|
197
|
+
2021|Document Not Found
|
|
198
|
+
2022|Invalid DocumentId
|
|
199
|
+
2023|Document General Error
|
|
200
|
+
2024|RAG Invalid
|
|
201
|
+
2025|Document Name Not Provided
|
|
202
|
+
2026|Verb Not Supported
|
|
203
|
+
2027|Document Extension Invalid
|
|
204
|
+
2028|Invalid File Size
|
|
205
|
+
2029|Project name already exists
|
|
206
|
+
2030|Assistant name already exists
|
|
207
|
+
2031|Assistant not in Project
|
|
208
|
+
2032|The status value is unexpected
|
|
209
|
+
2041|The assistant specified is of a different type than expected
|
|
210
|
+
3000|Data Analyst APIError: The connection with DataAnalyst Server could not be established
|
|
211
|
+
3003|The assistant is currently being updated and is not yet available
|
|
212
|
+
3004|Error validating metadata: each uploaded file requires related JSON metadata and vice versa
|
|
213
|
+
3005|Error validating metadata: no metadata was found for file 'nameOfFile'
|
|
214
|
+
.TE
|
|
215
|
+
.SH ORGANIZATION COMMANDS
|
|
216
|
+
.SS Synopsis
|
|
217
|
+
.B geai organization
|
|
218
|
+
.I subcommand
|
|
219
|
+
.RI [ --flag ]
|
|
220
|
+
.RI [ flag-arg ]
|
|
221
|
+
.SS Description
|
|
222
|
+
Manage key components such as organizations and projects.
|
|
223
|
+
.SS Subcommands
|
|
224
|
+
.TP
|
|
225
|
+
.B help, h
|
|
226
|
+
Display help text.
|
|
227
|
+
.TP
|
|
228
|
+
.B list-assistants
|
|
229
|
+
List assistant information.
|
|
230
|
+
.RS
|
|
231
|
+
.TP
|
|
232
|
+
.B --organization-id, --oid
|
|
233
|
+
UUID of the organization.
|
|
234
|
+
.TP
|
|
235
|
+
.B --project-id, --pid
|
|
236
|
+
UUID of the project.
|
|
237
|
+
.RE
|
|
238
|
+
.TP
|
|
239
|
+
.B list-projects
|
|
240
|
+
List project information.
|
|
241
|
+
.RS
|
|
242
|
+
.TP
|
|
243
|
+
.B --detail, -d
|
|
244
|
+
Level of detail: \fBsummary\fR (default) or \fBfull\fR.
|
|
245
|
+
.TP
|
|
246
|
+
.B --name, -n
|
|
247
|
+
Name of the project.
|
|
248
|
+
.RE
|
|
249
|
+
.TP
|
|
250
|
+
.B get-project
|
|
251
|
+
Get project information.
|
|
252
|
+
.RS
|
|
253
|
+
.TP
|
|
254
|
+
.B --project-id, --pid
|
|
255
|
+
GUID of the project (required).
|
|
256
|
+
.RE
|
|
257
|
+
.TP
|
|
258
|
+
.B create-project
|
|
259
|
+
Create a new project.
|
|
260
|
+
.RS
|
|
261
|
+
.TP
|
|
262
|
+
.B --name, -n
|
|
263
|
+
Name of the new project.
|
|
264
|
+
.TP
|
|
265
|
+
.B --description, -d
|
|
266
|
+
Description of the new project.
|
|
267
|
+
.TP
|
|
268
|
+
.B --email, -e
|
|
269
|
+
Project administrator's email.
|
|
270
|
+
.TP
|
|
271
|
+
.B --subscription-type
|
|
272
|
+
Subscription type: \fBFreemium\fR, \fBDaily\fR, \fBWeekly\fR, \fBMonthly\fR.
|
|
273
|
+
.TP
|
|
274
|
+
.B --usage-unit
|
|
275
|
+
Usage unit: \fBRequests\fR, \fBCost\fR.
|
|
276
|
+
.TP
|
|
277
|
+
.B --soft-limit
|
|
278
|
+
Soft limit for usage (lower threshold).
|
|
279
|
+
.TP
|
|
280
|
+
.B --hard-limit
|
|
281
|
+
Hard limit for usage (upper threshold, must be >= \fBsoft-limit\fR).
|
|
282
|
+
.TP
|
|
283
|
+
.B --renewal-status
|
|
284
|
+
Renewal status: \fBRenewable\fR, \fBNonRenewable\fR. Must be \fBNonRenewable\fR if \fBsubscription-type\fR is \fBFreemium\fR.
|
|
285
|
+
.RE
|
|
286
|
+
.TP
|
|
287
|
+
.B update-project
|
|
288
|
+
Update an existing project.
|
|
289
|
+
.RS
|
|
290
|
+
.TP
|
|
291
|
+
.B --project-id, --pid
|
|
292
|
+
GUID of the project (required).
|
|
293
|
+
.TP
|
|
294
|
+
.B --name, -n
|
|
295
|
+
Name of the project.
|
|
296
|
+
.TP
|
|
297
|
+
.B --description, -d
|
|
298
|
+
Description of the project.
|
|
299
|
+
.RE
|
|
300
|
+
.TP
|
|
301
|
+
.B delete-project
|
|
302
|
+
Delete an existing project.
|
|
303
|
+
.RS
|
|
304
|
+
.TP
|
|
305
|
+
.B --project-id, --pid
|
|
306
|
+
GUID of the project (required).
|
|
307
|
+
.RE
|
|
308
|
+
.TP
|
|
309
|
+
.B get-tokens
|
|
310
|
+
Get project tokens.
|
|
311
|
+
.RS
|
|
312
|
+
.TP
|
|
313
|
+
.B --project-id, --pid
|
|
314
|
+
GUID of the project (required).
|
|
315
|
+
.RE
|
|
316
|
+
.TP
|
|
317
|
+
.B export-request
|
|
318
|
+
Export request data.
|
|
319
|
+
.RS
|
|
320
|
+
.TP
|
|
321
|
+
.B --assistant-name
|
|
322
|
+
Assistant name (optional).
|
|
323
|
+
.TP
|
|
324
|
+
.B --status
|
|
325
|
+
Status (optional).
|
|
326
|
+
.TP
|
|
327
|
+
.B --skip
|
|
328
|
+
Number of entries to skip (integer).
|
|
329
|
+
.TP
|
|
330
|
+
.B --count
|
|
331
|
+
Number of entries to retrieve (integer).
|
|
332
|
+
.RE
|
|
333
|
+
.SS Examples
|
|
334
|
+
.TP
|
|
335
|
+
.B geai organization list-projects
|
|
336
|
+
List available projects for the configured organization.
|
|
337
|
+
.TP
|
|
338
|
+
.B geai organization create-project --name "NewProject" --description "A test project" --email "admin@example.com"
|
|
339
|
+
Create a new project named "NewProject".
|
|
340
|
+
.SH ASSISTANT COMMANDS
|
|
341
|
+
.SS Synopsis
|
|
342
|
+
.B geai assistant
|
|
343
|
+
.I subcommand
|
|
344
|
+
.RI [ --flag ]
|
|
345
|
+
.RI [ flag-arg ]
|
|
346
|
+
.SS Description
|
|
347
|
+
Manage assistants in GEAI.
|
|
348
|
+
.SS Subcommands
|
|
349
|
+
.TP
|
|
350
|
+
.B help, h
|
|
351
|
+
Display help text.
|
|
352
|
+
.TP
|
|
353
|
+
.B get-assistant
|
|
354
|
+
Get assistant details.
|
|
355
|
+
.RS
|
|
356
|
+
.TP
|
|
357
|
+
.B --detail, -d
|
|
358
|
+
Level of detail: \fBsummary\fR (default) or \fBfull\fR.
|
|
359
|
+
.TP
|
|
360
|
+
.B --assistant-id, --id
|
|
361
|
+
Assistant ID.
|
|
362
|
+
.RE
|
|
363
|
+
.TP
|
|
364
|
+
.B create-assistant
|
|
365
|
+
Create a new assistant.
|
|
366
|
+
.RS
|
|
367
|
+
.TP
|
|
368
|
+
.B --type, -t
|
|
369
|
+
Type of assistant: \fBtext\fR, \fBchat\fR (required).
|
|
370
|
+
.TP
|
|
371
|
+
.B --name, -n
|
|
372
|
+
Name of the assistant (required).
|
|
373
|
+
.TP
|
|
374
|
+
.B --description, -d
|
|
375
|
+
Description of the assistant.
|
|
376
|
+
.TP
|
|
377
|
+
.B --prompt
|
|
378
|
+
Prompt for the assistant (required).
|
|
379
|
+
.TP
|
|
380
|
+
.B --provider-name, --provider, -p
|
|
381
|
+
Provider to be used.
|
|
382
|
+
.TP
|
|
383
|
+
.B --model-name, -m
|
|
384
|
+
Model name according to the selected provider.
|
|
385
|
+
.TP
|
|
386
|
+
.B --temperature
|
|
387
|
+
Volatility of the assistant (decimal).
|
|
388
|
+
.TP
|
|
389
|
+
.B --max-tokens
|
|
390
|
+
Maximum number of tokens (integer).
|
|
391
|
+
.TP
|
|
392
|
+
.B --wd-title
|
|
393
|
+
Title for welcome data.
|
|
394
|
+
.TP
|
|
395
|
+
.B --wd-description
|
|
396
|
+
Description for welcome data.
|
|
397
|
+
.TP
|
|
398
|
+
.B --wd-feature
|
|
399
|
+
Feature in JSON format (e.g., \fB'{"title": "feature", "description": "Feature desc"}'\fR).
|
|
400
|
+
.TP
|
|
401
|
+
.B --wd-example-prompt
|
|
402
|
+
Example prompt in JSON format (e.g., \fB'{"title": "prompt", "description": "Prompt desc", "prompt_text": "Text"}'\fR).
|
|
403
|
+
.RE
|
|
404
|
+
.TP
|
|
405
|
+
.B update-assistant
|
|
406
|
+
Update an existing assistant.
|
|
407
|
+
.RS
|
|
408
|
+
.TP
|
|
409
|
+
.B --assistant-id, --id
|
|
410
|
+
Assistant ID.
|
|
411
|
+
.TP
|
|
412
|
+
.B --status
|
|
413
|
+
Status: \fB1\fR (Enabled), \fB2\fR (Disabled) (optional).
|
|
414
|
+
.TP
|
|
415
|
+
.B --action
|
|
416
|
+
Action: \fBsave\fR, \fBsaveNewRevision\fR (default), \fBsavePublishNewRevision\fR.
|
|
417
|
+
.TP
|
|
418
|
+
.B --revision-id
|
|
419
|
+
Revision ID (required if \fBaction\fR is \fBsave\fR).
|
|
420
|
+
.TP
|
|
421
|
+
.B --name, -n
|
|
422
|
+
Name of the assistant (required).
|
|
423
|
+
.TP
|
|
424
|
+
.B --description, -d
|
|
425
|
+
Description of the assistant.
|
|
426
|
+
.TP
|
|
427
|
+
.B --prompt
|
|
428
|
+
Prompt for the assistant (required).
|
|
429
|
+
.TP
|
|
430
|
+
.B --provider-name, --provider, -p
|
|
431
|
+
Provider to be used.
|
|
432
|
+
.TP
|
|
433
|
+
.B --model-name, -m
|
|
434
|
+
Model name according to the selected provider.
|
|
435
|
+
.TP
|
|
436
|
+
.B --temperature
|
|
437
|
+
Volatility of the assistant (decimal).
|
|
438
|
+
.TP
|
|
439
|
+
.B --max-tokens
|
|
440
|
+
Maximum number of tokens (integer).
|
|
441
|
+
.TP
|
|
442
|
+
.B --wd-title
|
|
443
|
+
Title for welcome data.
|
|
444
|
+
.TP
|
|
445
|
+
.B --wd-description
|
|
446
|
+
Description for welcome data.
|
|
447
|
+
.TP
|
|
448
|
+
.B --wd-feature
|
|
449
|
+
Feature in JSON format (e.g., \fB'{"title": "feature", "description": "Feature desc"}'\fR).
|
|
450
|
+
.TP
|
|
451
|
+
.B --wd-example-prompt
|
|
452
|
+
Example prompt in JSON format (e.g., \fB'{"title": "prompt", "description": "Prompt desc", "prompt_text": "Text"}'\fR).
|
|
453
|
+
.RE
|
|
454
|
+
.TP
|
|
455
|
+
.B delete-assistant
|
|
456
|
+
Delete an existing assistant.
|
|
457
|
+
.RS
|
|
458
|
+
.TP
|
|
459
|
+
.B --assistant-id, --id
|
|
460
|
+
Assistant ID.
|
|
461
|
+
.RE
|
|
462
|
+
.TP
|
|
463
|
+
.B chat
|
|
464
|
+
Send a chat request to an assistant.
|
|
465
|
+
.RS
|
|
466
|
+
.TP
|
|
467
|
+
.B --name, -n
|
|
468
|
+
Name of the assistant.
|
|
469
|
+
.TP
|
|
470
|
+
.B --messages, --msg
|
|
471
|
+
Chat request data in JSON format (e.g., \fB'[{"role": "user", "content": "Hello"}]'\fR).
|
|
472
|
+
.TP
|
|
473
|
+
.B --revision
|
|
474
|
+
Revision number (integer).
|
|
475
|
+
.TP
|
|
476
|
+
.B --revision-name
|
|
477
|
+
Name of the revision.
|
|
478
|
+
.TP
|
|
479
|
+
.B --variables, --var
|
|
480
|
+
Key/value properties (optional).
|
|
481
|
+
.RE
|
|
482
|
+
.TP
|
|
483
|
+
.B request-status
|
|
484
|
+
Retrieve the status of a request.
|
|
485
|
+
.RS
|
|
486
|
+
.TP
|
|
487
|
+
.B --request-id, --id
|
|
488
|
+
Request ID.
|
|
489
|
+
.RE
|
|
490
|
+
.TP
|
|
491
|
+
.B cancel-request
|
|
492
|
+
Cancel a request.
|
|
493
|
+
.RS
|
|
494
|
+
.TP
|
|
495
|
+
.B --request-id, --id
|
|
496
|
+
Request ID.
|
|
497
|
+
.RE
|
|
498
|
+
.SS Examples
|
|
499
|
+
.TP
|
|
500
|
+
.B geai assistant create-assistant --type chat --name "MyAssistant" --prompt "Hello, how can I help you?"
|
|
501
|
+
Create a new chat assistant named "MyAssistant".
|
|
502
|
+
.TP
|
|
503
|
+
.B geai assistant chat --name "MyAssistant" --messages '[{"role": "user", "content": "Hi"}]'
|
|
504
|
+
Send a chat message to "MyAssistant".
|
|
505
|
+
.SH RAG ASSISTANT COMMANDS
|
|
506
|
+
.SS Synopsis
|
|
507
|
+
.B geai rag
|
|
508
|
+
.I subcommand
|
|
509
|
+
.RI [ --flag ]
|
|
510
|
+
.RI [ flag-arg ]
|
|
511
|
+
.SS Description
|
|
512
|
+
Manage RAG (Retrieval-Augmented Generation) assistants in GEAI.
|
|
513
|
+
.SS Subcommands
|
|
514
|
+
.TP
|
|
515
|
+
.B help, h
|
|
516
|
+
Display help text.
|
|
517
|
+
.TP
|
|
518
|
+
.B list-assistants
|
|
519
|
+
List all RAG assistants in a project.
|
|
520
|
+
.TP
|
|
521
|
+
.B get-assistant
|
|
522
|
+
Get a specific RAG assistant.
|
|
523
|
+
.RS
|
|
524
|
+
.TP
|
|
525
|
+
.B --name, -n
|
|
526
|
+
RAG assistant name (required).
|
|
527
|
+
.RE
|
|
528
|
+
.TP
|
|
529
|
+
.B create-assistant
|
|
530
|
+
Create a new RAG assistant.
|
|
531
|
+
.RS
|
|
532
|
+
.TP
|
|
533
|
+
.B --name, -n
|
|
534
|
+
RAG assistant name (required).
|
|
535
|
+
.TP
|
|
536
|
+
.B --description, -d
|
|
537
|
+
Description of the RAG assistant.
|
|
538
|
+
.TP
|
|
539
|
+
.B --template, --tpl
|
|
540
|
+
Name of an existing RAG to base configuration (optional).
|
|
541
|
+
.TP
|
|
542
|
+
.B --history-count, --hc
|
|
543
|
+
History count (integer).
|
|
544
|
+
.TP
|
|
545
|
+
.B --cache, -c
|
|
546
|
+
Cache (boolean).
|
|
547
|
+
.TP
|
|
548
|
+
.B --frequency-penalty, --fp
|
|
549
|
+
Frequency penalty (decimal).
|
|
550
|
+
.TP
|
|
551
|
+
.B --max-tokens, --mt
|
|
552
|
+
Maximum tokens (integer).
|
|
553
|
+
.TP
|
|
554
|
+
.B --model-name, -m
|
|
555
|
+
Model name.
|
|
556
|
+
.TP
|
|
557
|
+
.B -n
|
|
558
|
+
Number (integer).
|
|
559
|
+
.TP
|
|
560
|
+
.B --presence-penalty, --pp
|
|
561
|
+
Presence penalty (decimal).
|
|
562
|
+
.TP
|
|
563
|
+
.B --provider, -p
|
|
564
|
+
Provider.
|
|
565
|
+
.TP
|
|
566
|
+
.B --stream
|
|
567
|
+
Stream (boolean).
|
|
568
|
+
.TP
|
|
569
|
+
.B --temperature, --temp, -t
|
|
570
|
+
Temperature (decimal).
|
|
571
|
+
.TP
|
|
572
|
+
.B --top-p
|
|
573
|
+
Top P (decimal).
|
|
574
|
+
.TP
|
|
575
|
+
.B --llm-type
|
|
576
|
+
LLM type: empty (default) or \fBjson_object\fR.
|
|
577
|
+
.TP
|
|
578
|
+
.B --verbose, -v
|
|
579
|
+
Verbose (boolean).
|
|
580
|
+
.TP
|
|
581
|
+
.B -k
|
|
582
|
+
K (integer).
|
|
583
|
+
.TP
|
|
584
|
+
.B --search-type
|
|
585
|
+
Search type: \fBsimilarity\fR (default) or \fBmmr\fR.
|
|
586
|
+
.TP
|
|
587
|
+
.B --fetch-k, --fk
|
|
588
|
+
Fetch K (number, valid for \fBmmr\fR).
|
|
589
|
+
.TP
|
|
590
|
+
.B --lambda, -l
|
|
591
|
+
Lambda (decimal, valid for \fBmmr\fR).
|
|
592
|
+
.TP
|
|
593
|
+
.B --search-prompt, --sp
|
|
594
|
+
Prompt.
|
|
595
|
+
.TP
|
|
596
|
+
.B --return-source-documents, --rsd
|
|
597
|
+
Return source documents (boolean).
|
|
598
|
+
.TP
|
|
599
|
+
.B --score-threshold, --st
|
|
600
|
+
Score threshold (decimal).
|
|
601
|
+
.TP
|
|
602
|
+
.B --search-template, --stpl
|
|
603
|
+
Template.
|
|
604
|
+
.TP
|
|
605
|
+
.B --retriever-type
|
|
606
|
+
Retriever type: \fBvectorStore\fR, \fBmultiQuery\fR, \fBselfQuery\fR, \fBhyde\fR, \fBcontextualCompression\fR.
|
|
607
|
+
.TP
|
|
608
|
+
.B --retriever-search-type
|
|
609
|
+
Search type: \fBsimilarity\fR, \fBsimilarity_hybrid\fR, \fBsemantic_hybrid\fR (Azure AISearch specific, defaults to \fBsimilarity\fR).
|
|
610
|
+
.TP
|
|
611
|
+
.B --step
|
|
612
|
+
Step: \fBall\fR (default) or \fBdocuments\fR.
|
|
613
|
+
.TP
|
|
614
|
+
.B --retriever-prompt, --rp
|
|
615
|
+
Prompt (not needed for \fBvectorStore\fR).
|
|
616
|
+
.TP
|
|
617
|
+
.B --chunk-overlap
|
|
618
|
+
Overlap size between chunks in the main document.
|
|
619
|
+
.TP
|
|
620
|
+
.B --chunk-size
|
|
621
|
+
Size of each chunk in the main document.
|
|
622
|
+
.TP
|
|
623
|
+
.B --use-parent-document
|
|
624
|
+
Enable parent-child document relationships (boolean).
|
|
625
|
+
.TP
|
|
626
|
+
.B --child-k
|
|
627
|
+
Parameter for child document processing.
|
|
628
|
+
.TP
|
|
629
|
+
.B --child-chunk-size
|
|
630
|
+
Size of each chunk in the child document.
|
|
631
|
+
.TP
|
|
632
|
+
.B --child-chunk-overlap
|
|
633
|
+
Overlap size between chunks in the child document.
|
|
634
|
+
.TP
|
|
635
|
+
.B --wd-title
|
|
636
|
+
Title for welcome data.
|
|
637
|
+
.TP
|
|
638
|
+
.B --wd-description
|
|
639
|
+
Description for welcome data.
|
|
640
|
+
.TP
|
|
641
|
+
.B --wd-feature
|
|
642
|
+
Feature in JSON format (e.g., \fB'{"title": "feature", "description": "Feature desc"}'\fR).
|
|
643
|
+
.TP
|
|
644
|
+
.B --wd-example-prompt
|
|
645
|
+
Example prompt in JSON format (e.g., \fB'{"title": "prompt", "description": "Prompt desc", "prompt_text": "Text"}'\fR).
|
|
646
|
+
.RE
|
|
647
|
+
.TP
|
|
648
|
+
.B update-assistant
|
|
649
|
+
Update an existing RAG assistant.
|
|
650
|
+
.RS
|
|
651
|
+
.TP
|
|
652
|
+
.B --name, -n
|
|
653
|
+
RAG assistant name (required).
|
|
654
|
+
.TP
|
|
655
|
+
.B --status
|
|
656
|
+
Status: \fB1\fR (enabled), \fB0\fR (disabled, default: \fB1\fR).
|
|
657
|
+
.TP
|
|
658
|
+
.B --description, -d
|
|
659
|
+
Description of the RAG assistant.
|
|
660
|
+
.TP
|
|
661
|
+
.B --template, --tpl
|
|
662
|
+
Name of an existing RAG to base configuration (optional).
|
|
663
|
+
.TP
|
|
664
|
+
.B --history-count, --hc
|
|
665
|
+
History count (integer).
|
|
666
|
+
.TP
|
|
667
|
+
.B --cache, -c
|
|
668
|
+
Cache (boolean).
|
|
669
|
+
.TP
|
|
670
|
+
.B --frequency-penalty, --fp
|
|
671
|
+
Frequency penalty (decimal).
|
|
672
|
+
.TP
|
|
673
|
+
.B --max-tokens, --mt
|
|
674
|
+
Maximum tokens (integer).
|
|
675
|
+
.TP
|
|
676
|
+
.B --model-name, -m
|
|
677
|
+
Model name.
|
|
678
|
+
.TP
|
|
679
|
+
.B -n
|
|
680
|
+
Number (integer).
|
|
681
|
+
.TP
|
|
682
|
+
.B --presence-penalty, --pp
|
|
683
|
+
Presence penalty (decimal).
|
|
684
|
+
.TP
|
|
685
|
+
.B --provider, -p
|
|
686
|
+
Provider.
|
|
687
|
+
.TP
|
|
688
|
+
.B --stream
|
|
689
|
+
Stream (boolean).
|
|
690
|
+
.TP
|
|
691
|
+
.B --temperature, --temp, -t
|
|
692
|
+
Temperature (decimal).
|
|
693
|
+
.TP
|
|
694
|
+
.B --top-p
|
|
695
|
+
Top P (decimal).
|
|
696
|
+
.TP
|
|
697
|
+
.B --llm-type
|
|
698
|
+
LLM type: empty (default) or \fBjson_object\fR.
|
|
699
|
+
.TP
|
|
700
|
+
.B --verbose, -v
|
|
701
|
+
Verbose (boolean).
|
|
702
|
+
.TP
|
|
703
|
+
.B -k
|
|
704
|
+
K (integer).
|
|
705
|
+
.TP
|
|
706
|
+
.B --search-type
|
|
707
|
+
Search type: \fBsimilarity\fR (default) or \fBmmr\fR.
|
|
708
|
+
.TP
|
|
709
|
+
.B --fetch-k, --fk
|
|
710
|
+
Fetch K (number, valid for \fBmmr\fR).
|
|
711
|
+
.TP
|
|
712
|
+
.B --lambda, -l
|
|
713
|
+
Lambda (decimal, valid for \fBmmr\fR).
|
|
714
|
+
.TP
|
|
715
|
+
.B --search-prompt, --sp
|
|
716
|
+
Prompt.
|
|
717
|
+
.TP
|
|
718
|
+
.B --return-source-documents, --rsd
|
|
719
|
+
Return source documents (boolean).
|
|
720
|
+
.TP
|
|
721
|
+
.B --score-threshold, --st
|
|
722
|
+
Score threshold (decimal).
|
|
723
|
+
.TP
|
|
724
|
+
.B --search-template, --stpl
|
|
725
|
+
Template.
|
|
726
|
+
.TP
|
|
727
|
+
.B --retriever-type
|
|
728
|
+
Retriever type: \fBvectorStore\fR, \fBmultiQuery\fR, \fBselfQuery\fR, \fBhyde\fR, \fBcontextualCompression\fR.
|
|
729
|
+
.TP
|
|
730
|
+
.B --retriever-search-type
|
|
731
|
+
Search type: \fBsimilarity\fR, \fBsimilarity_hybrid\fR, \fBsemantic_hybrid\fR.
|
|
732
|
+
.TP
|
|
733
|
+
.B --step
|
|
734
|
+
Step: \fBall\fR (default) or \fBdocuments\fR.
|
|
735
|
+
.TP
|
|
736
|
+
.B --retriever-prompt, --rp
|
|
737
|
+
Prompt (not needed for \fBvectorStore\fR).
|
|
738
|
+
.TP
|
|
739
|
+
.B --wd-title
|
|
740
|
+
Title for welcome data.
|
|
741
|
+
.TP
|
|
742
|
+
.B --wd-description
|
|
743
|
+
Description for welcome data.
|
|
744
|
+
.TP
|
|
745
|
+
.B --wd-feature
|
|
746
|
+
Feature in JSON format (e.g., \fB'{"title": "feature", "description": "Feature desc"}'\fR).
|
|
747
|
+
.TP
|
|
748
|
+
.B --wd-example-prompt
|
|
749
|
+
Example prompt in JSON format (e.g., \fB'{"title": "prompt", "description": "Prompt desc", "prompt_text": "Text"}'\fR).
|
|
750
|
+
.RE
|
|
751
|
+
.TP
|
|
752
|
+
.B delete-assistant
|
|
753
|
+
Delete an existing RAG assistant.
|
|
754
|
+
.RS
|
|
755
|
+
.TP
|
|
756
|
+
.B --name, -n
|
|
757
|
+
RAG assistant name (required).
|
|
758
|
+
.RE
|
|
759
|
+
.TP
|
|
760
|
+
.B list-documents
|
|
761
|
+
List documents for a RAG assistant.
|
|
762
|
+
.RS
|
|
763
|
+
.TP
|
|
764
|
+
.B --name, -n
|
|
765
|
+
RAG assistant name (required).
|
|
766
|
+
.TP
|
|
767
|
+
.B --skip, -s
|
|
768
|
+
Number of documents to skip.
|
|
769
|
+
.TP
|
|
770
|
+
.B --count, -c
|
|
771
|
+
Number of documents to return (default: 10).
|
|
772
|
+
.RE
|
|
773
|
+
.TP
|
|
774
|
+
.B delete-all-documents, del-docs
|
|
775
|
+
Delete all documents for a RAG assistant.
|
|
776
|
+
.RS
|
|
777
|
+
.TP
|
|
778
|
+
.B --name, -n
|
|
779
|
+
RAG assistant name (required).
|
|
780
|
+
.RE
|
|
781
|
+
.TP
|
|
782
|
+
.B get-document, get-doc
|
|
783
|
+
Get a document for a RAG assistant.
|
|
784
|
+
.RS
|
|
785
|
+
.TP
|
|
786
|
+
.B --name, -n
|
|
787
|
+
RAG assistant name (required).
|
|
788
|
+
.TP
|
|
789
|
+
.B --document-id, --id
|
|
790
|
+
Document ID (required).
|
|
791
|
+
.RE
|
|
792
|
+
.TP
|
|
793
|
+
.B upload-document, up-doc
|
|
794
|
+
Upload a document for a RAG assistant.
|
|
795
|
+
.RS
|
|
796
|
+
.TP
|
|
797
|
+
.B --name, -n
|
|
798
|
+
RAG assistant name (required).
|
|
799
|
+
.TP
|
|
800
|
+
.B --file-path, -f
|
|
801
|
+
Path to the document file (required).
|
|
802
|
+
.TP
|
|
803
|
+
.B --upload-type, -t
|
|
804
|
+
Upload type: \fBbinary\fR or \fBmultipart\fR (default: \fBmultipart\fR).
|
|
805
|
+
.TP
|
|
806
|
+
.B --metadata, -m
|
|
807
|
+
Document metadata (JSON or file path, for \fBmultipart\fR).
|
|
808
|
+
.TP
|
|
809
|
+
.B --content-type, --ct
|
|
810
|
+
Document content type.
|
|
811
|
+
.RE
|
|
812
|
+
.TP
|
|
813
|
+
.B delete-document, del-doc
|
|
814
|
+
Delete a document by ID for a RAG assistant.
|
|
815
|
+
.RS
|
|
816
|
+
.TP
|
|
817
|
+
.B --name, -n
|
|
818
|
+
RAG assistant name (required).
|
|
819
|
+
.TP
|
|
820
|
+
.B --document-id, --id
|
|
821
|
+
Document ID (required).
|
|
822
|
+
.RE
|
|
823
|
+
.SS Examples
|
|
824
|
+
.TP
|
|
825
|
+
.B geai rag create-assistant --name "MyRAG" --description "RAG for docs" --model-name "gpt-4o"
|
|
826
|
+
Create a new RAG assistant named "MyRAG".
|
|
827
|
+
.TP
|
|
828
|
+
.B geai rag upload-document --name "MyRAG" --file-path "/path/to/doc.pdf"
|
|
829
|
+
Upload a document to "MyRAG".
|
|
830
|
+
.SH CHAT COMMANDS
|
|
831
|
+
.SS Synopsis
|
|
832
|
+
.B geai chat
|
|
833
|
+
.I subcommand
|
|
834
|
+
.RI [ --flag ]
|
|
835
|
+
.RI [ flag-arg ]
|
|
836
|
+
.SS Description
|
|
837
|
+
Chat with assistants in GEAI.
|
|
838
|
+
.SS Subcommands
|
|
839
|
+
.TP
|
|
840
|
+
.B help, h
|
|
841
|
+
Display help text.
|
|
842
|
+
.TP
|
|
843
|
+
.B completion, comp
|
|
844
|
+
Get chat completion.
|
|
845
|
+
.RS
|
|
846
|
+
.TP
|
|
847
|
+
.B --model, -m
|
|
848
|
+
Model format: \fBsaia:<assistant_type>:<assistant_name>|<bot_id>\fR.
|
|
849
|
+
.TP
|
|
850
|
+
.B --messages, --msg
|
|
851
|
+
Messages in JSON format (e.g., \fB'[{"role": "user", "content": "Hello"}]'\fR).
|
|
852
|
+
.TP
|
|
853
|
+
.B --stream
|
|
854
|
+
Stream response: \fB0\fR (OFF), \fB1\fR (ON).
|
|
855
|
+
.TP
|
|
856
|
+
.B --temperature, --temp
|
|
857
|
+
Volatility (float, 0-2).
|
|
858
|
+
.TP
|
|
859
|
+
.B --max-tokens
|
|
860
|
+
Maximum tokens (integer).
|
|
861
|
+
.TP
|
|
862
|
+
.B --thread-id
|
|
863
|
+
Conversation UUID (optional).
|
|
864
|
+
.TP
|
|
865
|
+
.B --frequency-penalty
|
|
866
|
+
Penalize token frequency (-2.0 to 2.0, optional).
|
|
867
|
+
.TP
|
|
868
|
+
.B --presence-penalty
|
|
869
|
+
Penalize new tokens (-2.0 to 2.0, optional).
|
|
870
|
+
.TP
|
|
871
|
+
.B --top-p
|
|
872
|
+
Nucleus sampling (float, 0-1, optional).
|
|
873
|
+
.TP
|
|
874
|
+
.B --stop
|
|
875
|
+
Stop sequences (string or JSON array, up to 4, optional).
|
|
876
|
+
.TP
|
|
877
|
+
.B --response-format
|
|
878
|
+
Output format (JSON, optional).
|
|
879
|
+
.TP
|
|
880
|
+
.B --tools
|
|
881
|
+
Tools in JSON array (optional).
|
|
882
|
+
.TP
|
|
883
|
+
.B --tool-choice
|
|
884
|
+
Tool control: \fBnone\fR, \fBauto\fR, or JSON (optional).
|
|
885
|
+
.TP
|
|
886
|
+
.B --logprobs
|
|
887
|
+
Return log probabilities: \fB0\fR (OFF), \fB1\fR (ON, optional).
|
|
888
|
+
.TP
|
|
889
|
+
.B --top-logprobs
|
|
890
|
+
Number of likely tokens (0-20, optional).
|
|
891
|
+
.TP
|
|
892
|
+
.B --seed
|
|
893
|
+
Deterministic sampling seed (integer, optional, in Beta).
|
|
894
|
+
.TP
|
|
895
|
+
.B --stream-options
|
|
896
|
+
Streaming options (JSON, optional).
|
|
897
|
+
.TP
|
|
898
|
+
.B --store
|
|
899
|
+
Store output: \fB0\fR (OFF), \fB1\fR (ON, optional).
|
|
900
|
+
.TP
|
|
901
|
+
.B --metadata
|
|
902
|
+
Metadata (JSON, up to 16 key-value pairs, optional).
|
|
903
|
+
.TP
|
|
904
|
+
.B --user
|
|
905
|
+
End-user identifier (optional).
|
|
906
|
+
.RE
|
|
907
|
+
.TP
|
|
908
|
+
.B iris
|
|
909
|
+
Interactive chat with Iris.
|
|
910
|
+
.TP
|
|
911
|
+
.B agent
|
|
912
|
+
Interactive chat with an agent.
|
|
913
|
+
.RS
|
|
914
|
+
.TP
|
|
915
|
+
.B --agent-name, --name, -n
|
|
916
|
+
Agent name or ID.
|
|
917
|
+
.TP
|
|
918
|
+
.B --gui, -g
|
|
919
|
+
Launch Streamlit GUI: \fB0\fR (OFF), \fB1\fR (ON).
|
|
920
|
+
.RE
|
|
921
|
+
.SS Examples
|
|
922
|
+
.TP
|
|
923
|
+
.B geai chat completion --model "saia:chat:MyAssistant" --messages '[{"role": "user", "content": "Hello"}]'
|
|
924
|
+
Get a chat completion from "MyAssistant".
|
|
925
|
+
.TP
|
|
926
|
+
.B geai chat agent --name "MyAgent" --gui 1
|
|
927
|
+
Launch a GUI chat with "MyAgent".
|
|
928
|
+
.SH ADMIN COMMANDS
|
|
929
|
+
.SS Synopsis
|
|
930
|
+
.B geai admin
|
|
931
|
+
.I subcommand
|
|
932
|
+
.RI [ --flag ]
|
|
933
|
+
.RI [ flag-arg ]
|
|
934
|
+
.SS Description
|
|
935
|
+
Manage internal admin operations in GEAI.
|
|
936
|
+
.SS Subcommands
|
|
937
|
+
.TP
|
|
938
|
+
.B help, h
|
|
939
|
+
Display help text.
|
|
940
|
+
.TP
|
|
941
|
+
.B validate-token, vt
|
|
942
|
+
Validate an API token and retrieve organization/project information.
|
|
943
|
+
.TP
|
|
944
|
+
.B list-authorized-organizations, auth-org
|
|
945
|
+
List organizations a user can access.
|
|
946
|
+
.TP
|
|
947
|
+
.B list-authorized-projects, auth-proj
|
|
948
|
+
List projects a user can access in an organization.
|
|
949
|
+
.RS
|
|
950
|
+
.TP
|
|
951
|
+
.B --organization, --org, -o
|
|
952
|
+
Organization ID.
|
|
953
|
+
.RE
|
|
954
|
+
.TP
|
|
955
|
+
.B project-visibility, pv
|
|
956
|
+
Check if a GAM user has project visibility.
|
|
957
|
+
.RS
|
|
958
|
+
.TP
|
|
959
|
+
.B --organization, --org, -o
|
|
960
|
+
Organization ID.
|
|
961
|
+
.TP
|
|
962
|
+
.B --project, -p
|
|
963
|
+
Project ID.
|
|
964
|
+
.TP
|
|
965
|
+
.B --access-token, --token, --at
|
|
966
|
+
GAM access token.
|
|
967
|
+
.RE
|
|
968
|
+
.TP
|
|
969
|
+
.B project-token, pt
|
|
970
|
+
Get a project's API token.
|
|
971
|
+
.RS
|
|
972
|
+
.TP
|
|
973
|
+
.B --organization, --org, -o
|
|
974
|
+
Organization ID.
|
|
975
|
+
.TP
|
|
976
|
+
.B --project, -p
|
|
977
|
+
Project ID.
|
|
978
|
+
.TP
|
|
979
|
+
.B --access-token, --token, --at
|
|
980
|
+
GAM access token.
|
|
981
|
+
.RE
|
|
982
|
+
.SS Examples
|
|
983
|
+
.TP
|
|
984
|
+
.B geai admin validate-token
|
|
985
|
+
Validate the configured API token.
|
|
986
|
+
.TP
|
|
987
|
+
.B geai admin project-token --organization "org-id" --project "proj-id" --access-token "token"
|
|
988
|
+
Get the API token for a project.
|
|
989
|
+
.SH LLM COMMANDS
|
|
990
|
+
.SS Synopsis
|
|
991
|
+
.B geai llm
|
|
992
|
+
.I subcommand
|
|
993
|
+
.RI [ --flag ]
|
|
994
|
+
.RI [ flag-arg ]
|
|
995
|
+
.SS Description
|
|
996
|
+
Retrieve information about available models and providers in GEAI.
|
|
997
|
+
.SS Subcommands
|
|
998
|
+
.TP
|
|
999
|
+
.B help, h
|
|
1000
|
+
Display help text.
|
|
1001
|
+
.TP
|
|
1002
|
+
.B list-providers, lp
|
|
1003
|
+
Retrieve the list of providers.
|
|
1004
|
+
.TP
|
|
1005
|
+
.B get-provider, gp
|
|
1006
|
+
Retrieve provider data.
|
|
1007
|
+
.RS
|
|
1008
|
+
.TP
|
|
1009
|
+
.B --provider-name, --pn
|
|
1010
|
+
LLM provider name (required).
|
|
1011
|
+
.RE
|
|
1012
|
+
.TP
|
|
1013
|
+
.B list-models, lm
|
|
1014
|
+
Retrieve provider models.
|
|
1015
|
+
.RS
|
|
1016
|
+
.TP
|
|
1017
|
+
.B --provider-name, --pn
|
|
1018
|
+
LLM provider name (required).
|
|
1019
|
+
.RE
|
|
1020
|
+
.TP
|
|
1021
|
+
.B get-model, gm
|
|
1022
|
+
Retrieve model data.
|
|
1023
|
+
.RS
|
|
1024
|
+
.TP
|
|
1025
|
+
.B --provider-name, --pn
|
|
1026
|
+
LLM provider name (required).
|
|
1027
|
+
.TP
|
|
1028
|
+
.B --model-name, --mn
|
|
1029
|
+
LLM model name.
|
|
1030
|
+
.TP
|
|
1031
|
+
.B --model-id, --mid
|
|
1032
|
+
LLM model ID.
|
|
1033
|
+
.RE
|
|
1034
|
+
.SS Examples
|
|
1035
|
+
.TP
|
|
1036
|
+
.B geai llm list-providers
|
|
1037
|
+
List all available LLM providers.
|
|
1038
|
+
.TP
|
|
1039
|
+
.B geai llm get-model --provider-name "openai" --model-name "gpt-4o"
|
|
1040
|
+
Get details for the "gpt-4o" model from OpenAI.
|
|
1041
|
+
.SH FILES COMMANDS
|
|
1042
|
+
.SS Synopsis
|
|
1043
|
+
.B geai files
|
|
1044
|
+
.I subcommand
|
|
1045
|
+
.RI [ --flag ]
|
|
1046
|
+
.RI [ flag-arg ]
|
|
1047
|
+
.SS Description
|
|
1048
|
+
Manage files in GEAI.
|
|
1049
|
+
.SS Subcommands
|
|
1050
|
+
.TP
|
|
1051
|
+
.B help, h
|
|
1052
|
+
Display help text.
|
|
1053
|
+
.TP
|
|
1054
|
+
.B upload-file, uf
|
|
1055
|
+
Upload a file.
|
|
1056
|
+
.RS
|
|
1057
|
+
.TP
|
|
1058
|
+
.B --organization, --org, -o
|
|
1059
|
+
Organization ID (required).
|
|
1060
|
+
.TP
|
|
1061
|
+
.B --project, --proj, -p
|
|
1062
|
+
Project ID (required).
|
|
1063
|
+
.TP
|
|
1064
|
+
.B --file-name, --fn
|
|
1065
|
+
File name (optional, defaults to uploaded file name).
|
|
1066
|
+
.TP
|
|
1067
|
+
.B --file-path, --fp
|
|
1068
|
+
File path (required).
|
|
1069
|
+
.TP
|
|
1070
|
+
.B --folder, -f
|
|
1071
|
+
Destination folder (optional, defaults to temporary storage).
|
|
1072
|
+
.RE
|
|
1073
|
+
.TP
|
|
1074
|
+
.B get-file, gf
|
|
1075
|
+
Get file data.
|
|
1076
|
+
.RS
|
|
1077
|
+
.TP
|
|
1078
|
+
.B --organization, --org, -o
|
|
1079
|
+
Organization ID (required).
|
|
1080
|
+
.TP
|
|
1081
|
+
.B --project, --proj, -p
|
|
1082
|
+
Project ID (required).
|
|
1083
|
+
.TP
|
|
1084
|
+
.B --file-id, --fid
|
|
1085
|
+
File ID (required).
|
|
1086
|
+
.RE
|
|
1087
|
+
.TP
|
|
1088
|
+
.B delete-file, df
|
|
1089
|
+
Delete file data.
|
|
1090
|
+
.RS
|
|
1091
|
+
.TP
|
|
1092
|
+
.B --organization, --org, -o
|
|
1093
|
+
Organization ID (required).
|
|
1094
|
+
.TP
|
|
1095
|
+
.B --project, --proj, -p
|
|
1096
|
+
Project ID (required).
|
|
1097
|
+
.TP
|
|
1098
|
+
.B --file-id, --fid
|
|
1099
|
+
File ID (required).
|
|
1100
|
+
.RE
|
|
1101
|
+
.TP
|
|
1102
|
+
.B get-file-content, gfc
|
|
1103
|
+
Get file content.
|
|
1104
|
+
.RS
|
|
1105
|
+
.TP
|
|
1106
|
+
.B --organization, --org, -o
|
|
1107
|
+
Organization ID (required).
|
|
1108
|
+
.TP
|
|
1109
|
+
.B --project, --proj, -p
|
|
1110
|
+
Project ID (required).
|
|
1111
|
+
.TP
|
|
1112
|
+
.B --file-id, --fid
|
|
1113
|
+
File ID (required).
|
|
1114
|
+
.RE
|
|
1115
|
+
.TP
|
|
1116
|
+
.B list-files, lf
|
|
1117
|
+
Retrieve file list.
|
|
1118
|
+
.RS
|
|
1119
|
+
.TP
|
|
1120
|
+
.B --organization, --org, -o
|
|
1121
|
+
Organization ID (required).
|
|
1122
|
+
.TP
|
|
1123
|
+
.B --project, --proj, -p
|
|
1124
|
+
Project ID (required).
|
|
1125
|
+
.RE
|
|
1126
|
+
.SS Examples
|
|
1127
|
+
.TP
|
|
1128
|
+
.B geai files upload-file --organization "org-id" --project "proj-id" --file-path "/path/to/file.txt"
|
|
1129
|
+
Upload a file to a project.
|
|
1130
|
+
.TP
|
|
1131
|
+
.B geai files list-files --organization "org-id" --project "proj-id"
|
|
1132
|
+
List all files in a project.
|
|
1133
|
+
.SH USAGE LIMIT COMMANDS
|
|
1134
|
+
.SS Synopsis
|
|
1135
|
+
.B geai usage-limit
|
|
1136
|
+
.I subcommand
|
|
1137
|
+
.RI [ --flag ]
|
|
1138
|
+
.RI [ flag-arg ]
|
|
1139
|
+
.SS Description
|
|
1140
|
+
Manage usage limits for organizations and projects in GEAI.
|
|
1141
|
+
.SS Subcommands
|
|
1142
|
+
.TP
|
|
1143
|
+
.B help, h
|
|
1144
|
+
Display help text.
|
|
1145
|
+
.TP
|
|
1146
|
+
.B set-organization-limit, set-org-lim
|
|
1147
|
+
Set organization usage limit.
|
|
1148
|
+
.RS
|
|
1149
|
+
.TP
|
|
1150
|
+
.B --organization, --org, -o
|
|
1151
|
+
Organization ID (required).
|
|
1152
|
+
.TP
|
|
1153
|
+
.B --subscription-type
|
|
1154
|
+
Subscription type: \fBFreemium\fR, \fBDaily\fR, \fBWeekly\fR, \fBMonthly\fR.
|
|
1155
|
+
.TP
|
|
1156
|
+
.B --usage-unit
|
|
1157
|
+
Usage unit: \fBRequests\fR, \fBCost\fR.
|
|
1158
|
+
.TP
|
|
1159
|
+
.B --soft-limit
|
|
1160
|
+
Soft limit for usage (lower threshold).
|
|
1161
|
+
.TP
|
|
1162
|
+
.B --hard-limit
|
|
1163
|
+
Hard limit for usage (upper threshold, must be >= \fBsoft-limit\fR).
|
|
1164
|
+
.TP
|
|
1165
|
+
.B --renewal-status
|
|
1166
|
+
Renewal status: \fBRenewable\fR, \fBNonRenewable\fR. Must be \fBNonRenewable\fR if \fBsubscription-type\fR is \fBFreemium\fR.
|
|
1167
|
+
.RE
|
|
1168
|
+
.TP
|
|
1169
|
+
.B get-latest-organization-limit, get-latest-org-lim
|
|
1170
|
+
Get the latest organization usage limit.
|
|
1171
|
+
.RS
|
|
1172
|
+
.TP
|
|
1173
|
+
.B --organization, --org, -o
|
|
1174
|
+
Organization ID (required).
|
|
1175
|
+
.RE
|
|
1176
|
+
.TP
|
|
1177
|
+
.B get-all-organization-limit, get-all-org-lim
|
|
1178
|
+
Get all organization usage limits.
|
|
1179
|
+
.RS
|
|
1180
|
+
.TP
|
|
1181
|
+
.B --organization, --org, -o
|
|
1182
|
+
Organization ID (required).
|
|
1183
|
+
.RE
|
|
1184
|
+
.TP
|
|
1185
|
+
.B delete-organization-limit, del-org-lim
|
|
1186
|
+
Delete an organization usage limit.
|
|
1187
|
+
.RS
|
|
1188
|
+
.TP
|
|
1189
|
+
.B --organization, --org, -o
|
|
1190
|
+
Organization ID (required).
|
|
1191
|
+
.TP
|
|
1192
|
+
.B --limit-id, --lid
|
|
1193
|
+
Usage limit ID (required).
|
|
1194
|
+
.RE
|
|
1195
|
+
.TP
|
|
1196
|
+
.B update-organization-limit, up-org-lim
|
|
1197
|
+
Update an organization usage limit.
|
|
1198
|
+
.RS
|
|
1199
|
+
.TP
|
|
1200
|
+
.B --organization, --org, -o
|
|
1201
|
+
Organization ID (required).
|
|
1202
|
+
.TP
|
|
1203
|
+
.B --limit-id, --lid
|
|
1204
|
+
Usage limit ID (required).
|
|
1205
|
+
.TP
|
|
1206
|
+
.B --hard-limit
|
|
1207
|
+
Hard limit for usage (upper threshold, must be >= \fBsoft-limit\fR).
|
|
1208
|
+
.TP
|
|
1209
|
+
.B --soft-limit
|
|
1210
|
+
Soft limit for usage (lower threshold).
|
|
1211
|
+
.TP
|
|
1212
|
+
.B --renewal-status
|
|
1213
|
+
Renewal status: \fBRenewable\fR, \fBNonRenewable\fR.
|
|
1214
|
+
.RE
|
|
1215
|
+
.TP
|
|
1216
|
+
.B set-project-limit, set-proj-lim
|
|
1217
|
+
Set project usage limit.
|
|
1218
|
+
.RS
|
|
1219
|
+
.TP
|
|
1220
|
+
.B --organization, --org, -o
|
|
1221
|
+
Organization ID (required).
|
|
1222
|
+
.TP
|
|
1223
|
+
.B --project, --proj, -p
|
|
1224
|
+
Project ID (required).
|
|
1225
|
+
.TP
|
|
1226
|
+
.B --subscription-type
|
|
1227
|
+
Subscription type: \fBFreemium\fR, \fBDaily\fR, \fBWeekly\fR, \fBMonthly\fR.
|
|
1228
|
+
.TP
|
|
1229
|
+
.B --usage-unit
|
|
1230
|
+
Usage unit: \fBRequests\fR, \fBCost\fR.
|
|
1231
|
+
.TP
|
|
1232
|
+
.B --soft-limit
|
|
1233
|
+
Soft limit for usage (lower threshold).
|
|
1234
|
+
.TP
|
|
1235
|
+
.B --hard-limit
|
|
1236
|
+
Hard limit for usage (upper threshold, must be >= \fBsoft-limit\fR).
|
|
1237
|
+
.TP
|
|
1238
|
+
.B --renewal-status
|
|
1239
|
+
Renewal status: \fBRenewable\fR, \fBNonRenewable\fR. Must be \fBNonRenewable\fR if \fBsubscription-type\fR is \fBFreemium\fR.
|
|
1240
|
+
.RE
|
|
1241
|
+
.TP
|
|
1242
|
+
.B get-all-project-limit, get-all-proj-lim
|
|
1243
|
+
Get all usage limits for a project.
|
|
1244
|
+
.RS
|
|
1245
|
+
.TP
|
|
1246
|
+
.B --organization, --org, -o
|
|
1247
|
+
Organization ID (required).
|
|
1248
|
+
.TP
|
|
1249
|
+
.B --project, --proj, -p
|
|
1250
|
+
Project ID (required).
|
|
1251
|
+
.RE
|
|
1252
|
+
.TP
|
|
1253
|
+
.B get-latest-project-limit, get-latest-proj-lim
|
|
1254
|
+
Get the latest usage limit for a project.
|
|
1255
|
+
.RS
|
|
1256
|
+
.TP
|
|
1257
|
+
.B --organization, --org, -o
|
|
1258
|
+
Organization ID (required).
|
|
1259
|
+
.TP
|
|
1260
|
+
.B --project, --proj, -p
|
|
1261
|
+
Project ID (required).
|
|
1262
|
+
.RE
|
|
1263
|
+
.TP
|
|
1264
|
+
.B get-active-project-limit, get-active-proj-lim
|
|
1265
|
+
Get the active usage limit for a project.
|
|
1266
|
+
.RS
|
|
1267
|
+
.TP
|
|
1268
|
+
.B --organization, --org, -o
|
|
1269
|
+
Organization ID (required).
|
|
1270
|
+
.TP
|
|
1271
|
+
.B --project, --proj, -p
|
|
1272
|
+
Project ID (required).
|
|
1273
|
+
.RE
|
|
1274
|
+
.TP
|
|
1275
|
+
.B delete-project-limit, del-proj-lim
|
|
1276
|
+
Delete a project usage limit.
|
|
1277
|
+
.RS
|
|
1278
|
+
.TP
|
|
1279
|
+
.B --organization, --org, -o
|
|
1280
|
+
Organization ID (required).
|
|
1281
|
+
.TP
|
|
1282
|
+
.B --project, --proj, -p
|
|
1283
|
+
Project ID (required).
|
|
1284
|
+
.TP
|
|
1285
|
+
.B --limit-id, --lid
|
|
1286
|
+
Usage limit ID (required).
|
|
1287
|
+
.RE
|
|
1288
|
+
.TP
|
|
1289
|
+
.B update-project-limit, up-proj-lim
|
|
1290
|
+
Update a project usage limit.
|
|
1291
|
+
.RS
|
|
1292
|
+
.TP
|
|
1293
|
+
.B --organization, --org, -o
|
|
1294
|
+
Organization ID (required).
|
|
1295
|
+
.TP
|
|
1296
|
+
.B --project, --proj, -p
|
|
1297
|
+
Project ID (required).
|
|
1298
|
+
.TP
|
|
1299
|
+
.B --limit-id, --lid
|
|
1300
|
+
Usage limit ID (required).
|
|
1301
|
+
.TP
|
|
1302
|
+
.B --hard-limit
|
|
1303
|
+
Hard limit for usage (upper threshold, must be >= \fBsoft-limit\fR).
|
|
1304
|
+
.TP
|
|
1305
|
+
.B --soft-limit
|
|
1306
|
+
Soft limit for usage (lower threshold).
|
|
1307
|
+
.TP
|
|
1308
|
+
.B --renewal-status
|
|
1309
|
+
Renewal status: \fBRenewable\fR, \fBNonRenewable\fR.
|
|
1310
|
+
.RE
|
|
1311
|
+
.SS Examples
|
|
1312
|
+
.TP
|
|
1313
|
+
.B geai usage-limit set-project-limit --organization "org-id" --project "proj-id" --subscription-type Monthly --usage-unit Requests --soft-limit 1000 --hard-limit 2000
|
|
1314
|
+
Set a project usage limit.
|
|
1315
|
+
.TP
|
|
1316
|
+
.B geai usage-limit get-latest-organization-limit --organization "org-id"
|
|
1317
|
+
Get the latest usage limit for an organization.
|
|
1318
|
+
.SH EMBEDDINGS COMMANDS
|
|
1319
|
+
.SS Synopsis
|
|
1320
|
+
.B geai embeddings
|
|
1321
|
+
.I subcommand
|
|
1322
|
+
.RI [ --flag ]
|
|
1323
|
+
.RI [ flag-arg ]
|
|
1324
|
+
.SS Description
|
|
1325
|
+
Generate embeddings in GEAI.
|
|
1326
|
+
.SS Subcommands
|
|
1327
|
+
.TP
|
|
1328
|
+
.B help, h
|
|
1329
|
+
Display help text.
|
|
1330
|
+
.TP
|
|
1331
|
+
.B generate, gen
|
|
1332
|
+
Generate embeddings.
|
|
1333
|
+
.RS
|
|
1334
|
+
.TP
|
|
1335
|
+
.B --input, -i
|
|
1336
|
+
Input to embed (string, multiple inputs allowed).
|
|
1337
|
+
.TP
|
|
1338
|
+
.B --model, -m
|
|
1339
|
+
Provider/model ID.
|
|
1340
|
+
.TP
|
|
1341
|
+
.B --encoding-format, --enc-for
|
|
1342
|
+
Format: \fBfloat\fR (default) or \fBbase64\fR.
|
|
1343
|
+
.TP
|
|
1344
|
+
.B --dimensions, --dim
|
|
1345
|
+
Number of dimensions (integer, optional).
|
|
1346
|
+
.TP
|
|
1347
|
+
.B --user, -u
|
|
1348
|
+
End-user identifier.
|
|
1349
|
+
.TP
|
|
1350
|
+
.B --input-type, --it
|
|
1351
|
+
Input data usage type (optional).
|
|
1352
|
+
.TP
|
|
1353
|
+
.B --timeout, -t
|
|
1354
|
+
API response timeout (seconds, default: 600).
|
|
1355
|
+
.TP
|
|
1356
|
+
.B --cache
|
|
1357
|
+
Cache embeddings: \fB0\fR (False, default), \fB1\fR (True).
|
|
1358
|
+
.RE
|
|
1359
|
+
.SS Examples
|
|
1360
|
+
.TP
|
|
1361
|
+
.B geai embeddings generate --input "Sample text" --model "openai/text-embedding-3"
|
|
1362
|
+
Generate embeddings for "Sample text".
|
|
1363
|
+
.TP
|
|
1364
|
+
.B geai embeddings generate --input "Text one" --input "Text two" --model "openai/text-embedding-3"
|
|
1365
|
+
Generate embeddings for multiple inputs.
|
|
1366
|
+
.SH FEEDBACK COMMANDS
|
|
1367
|
+
.SS Synopsis
|
|
1368
|
+
.B geai feedback
|
|
1369
|
+
.I subcommand
|
|
1370
|
+
.RI [ --flag ]
|
|
1371
|
+
.RI [ flag-arg ]
|
|
1372
|
+
.SS Description
|
|
1373
|
+
Send feedback on assistant responses.
|
|
1374
|
+
.SS Subcommands
|
|
1375
|
+
.TP
|
|
1376
|
+
.B help, h
|
|
1377
|
+
Display help text.
|
|
1378
|
+
.TP
|
|
1379
|
+
.B send, sf
|
|
1380
|
+
Send feedback.
|
|
1381
|
+
.RS
|
|
1382
|
+
.TP
|
|
1383
|
+
.B --request-id, --rid
|
|
1384
|
+
Request ID (integer).
|
|
1385
|
+
.TP
|
|
1386
|
+
.B --origin
|
|
1387
|
+
Feedback origin (default: \fBuser-feedback\fR).
|
|
1388
|
+
.TP
|
|
1389
|
+
.B --answer-score, --ans-score, --score
|
|
1390
|
+
Feedback score: \fB1\fR (good), \fB2\fR (bad).
|
|
1391
|
+
.TP
|
|
1392
|
+
.B --comments
|
|
1393
|
+
Feedback comment (optional).
|
|
1394
|
+
.RE
|
|
1395
|
+
.SS Examples
|
|
1396
|
+
.TP
|
|
1397
|
+
.B geai feedback send --request-id 123 --answer-score 1 --comments "Great response!"
|
|
1398
|
+
Send positive feedback for a request.
|
|
1399
|
+
.TP
|
|
1400
|
+
.B geai feedback send --request-id 124 --answer-score 2
|
|
1401
|
+
Send negative feedback for a request.
|
|
1402
|
+
.SH RERANK COMMANDS
|
|
1403
|
+
.SS Synopsis
|
|
1404
|
+
.B geai rerank
|
|
1405
|
+
.I subcommand
|
|
1406
|
+
.RI [ --flag ]
|
|
1407
|
+
.RI [ flag-arg ]
|
|
1408
|
+
.SS Description
|
|
1409
|
+
Rerank document chunks based on a query in GEAI.
|
|
1410
|
+
.SS Subcommands
|
|
1411
|
+
.TP
|
|
1412
|
+
.B help, h
|
|
1413
|
+
Display help text.
|
|
1414
|
+
.TP
|
|
1415
|
+
.B rerank-chunks, chunks, rc
|
|
1416
|
+
Rerank chunks based on a query.
|
|
1417
|
+
.RS
|
|
1418
|
+
.TP
|
|
1419
|
+
.B --query, -q
|
|
1420
|
+
Input query (string).
|
|
1421
|
+
.TP
|
|
1422
|
+
.B --model, -m
|
|
1423
|
+
Reranker model: \fBcohere/rerank-v3.5\fR, \fBawsbedrock/cohere.rerank-v3.5\fR, \fBawsbedrock/amazon.rerank-v1\fR.
|
|
1424
|
+
.TP
|
|
1425
|
+
.B --documents, --doc, -d
|
|
1426
|
+
Text chunks (string or array).
|
|
1427
|
+
.TP
|
|
1428
|
+
.B --top-n
|
|
1429
|
+
Number of top results to return (string).
|
|
1430
|
+
.RE
|
|
1431
|
+
.SS Examples
|
|
1432
|
+
.TP
|
|
1433
|
+
.B geai rerank rerank-chunks --query "What is AI?" --model "cohere/rerank-v3.5" --documents '["Text 1", "Text 2"]' --top-n 2
|
|
1434
|
+
Rerank two document chunks for the query.
|
|
1435
|
+
.SH EVALUATION COMMANDS
|
|
1436
|
+
.SS Synopsis
|
|
1437
|
+
.B geai evaluation
|
|
1438
|
+
.I subcommand
|
|
1439
|
+
.RI [ --flag ]
|
|
1440
|
+
.RI [ flag-arg ]
|
|
1441
|
+
.SS Description
|
|
1442
|
+
Interact with dataset, plan, and result APIs in the GEAI evaluation module. Dataset rows have the structure:
|
|
1443
|
+
.PP
|
|
1444
|
+
.nf
|
|
1445
|
+
{
|
|
1446
|
+
"dataSetRowExpectedAnswer": "string",
|
|
1447
|
+
"dataSetRowInput": "string",
|
|
1448
|
+
"dataSetRowContextDocument": "string",
|
|
1449
|
+
"expectedSources": [
|
|
1450
|
+
{
|
|
1451
|
+
"dataSetExpectedSourceId": "UUID",
|
|
1452
|
+
"dataSetExpectedSourceName": "string",
|
|
1453
|
+
"dataSetExpectedSourceValue": "string",
|
|
1454
|
+
"dataSetexpectedSourceExtention": "string"
|
|
1455
|
+
}
|
|
1456
|
+
],
|
|
1457
|
+
"filterVariables": [
|
|
1458
|
+
{
|
|
1459
|
+
"dataSetMetadataType": "string",
|
|
1460
|
+
"dataSetRowFilterKey": "string",
|
|
1461
|
+
"dataSetRowFilterOperator": "string",
|
|
1462
|
+
"dataSetRowFilterValue": "string",
|
|
1463
|
+
"dataSetRowFilterVarId": "UUID"
|
|
1464
|
+
}
|
|
1465
|
+
]
|
|
1466
|
+
}
|
|
1467
|
+
.fi
|
|
1468
|
+
.SS Subcommands
|
|
1469
|
+
.TP
|
|
1470
|
+
.B help, h
|
|
1471
|
+
Display help text.
|
|
1472
|
+
.TP
|
|
1473
|
+
.B list-datasets, ld
|
|
1474
|
+
List all datasets.
|
|
1475
|
+
.TP
|
|
1476
|
+
.B create-dataset, cd
|
|
1477
|
+
Create a dataset.
|
|
1478
|
+
.RS
|
|
1479
|
+
.TP
|
|
1480
|
+
.B --dataset-name, --dn
|
|
1481
|
+
Dataset name (string).
|
|
1482
|
+
.TP
|
|
1483
|
+
.B --dataset-description, --dd
|
|
1484
|
+
Dataset description (string).
|
|
1485
|
+
.TP
|
|
1486
|
+
.B --dataset-type, --dt
|
|
1487
|
+
Dataset type (e.g., \fBT\fR for test).
|
|
1488
|
+
.TP
|
|
1489
|
+
.B --dataset-active, --da
|
|
1490
|
+
Dataset active: \fB0\fR (False), \fB1\fR (True).
|
|
1491
|
+
.TP
|
|
1492
|
+
.B --row, -r
|
|
1493
|
+
Row data (JSON).
|
|
1494
|
+
.TP
|
|
1495
|
+
.B --dataset-file, --df
|
|
1496
|
+
JSON file with dataset structure.
|
|
1497
|
+
.RE
|
|
1498
|
+
.TP
|
|
1499
|
+
.B get-dataset, gd
|
|
1500
|
+
Get a dataset by ID.
|
|
1501
|
+
.RS
|
|
1502
|
+
.TP
|
|
1503
|
+
.B --dataset-id, --did
|
|
1504
|
+
Dataset UUID.
|
|
1505
|
+
.RE
|
|
1506
|
+
.TP
|
|
1507
|
+
.B update-dataset, ud
|
|
1508
|
+
Update a dataset by ID.
|
|
1509
|
+
.RS
|
|
1510
|
+
.TP
|
|
1511
|
+
.B --dataset-id, --did
|
|
1512
|
+
Dataset UUID.
|
|
1513
|
+
.TP
|
|
1514
|
+
.B --dataset-name, --dn
|
|
1515
|
+
Dataset name (string).
|
|
1516
|
+
.TP
|
|
1517
|
+
.B --dataset-description, --dd
|
|
1518
|
+
Dataset description (string).
|
|
1519
|
+
.TP
|
|
1520
|
+
.B --dataset-type, --dt
|
|
1521
|
+
Dataset type (e.g., \fBT\fR for test).
|
|
1522
|
+
.TP
|
|
1523
|
+
.B --dataset-active, --da
|
|
1524
|
+
Dataset active: \fB0\fR (False), \fB1\fR (True).
|
|
1525
|
+
.TP
|
|
1526
|
+
.B --row, -r
|
|
1527
|
+
Row data (JSON).
|
|
1528
|
+
.RE
|
|
1529
|
+
.TP
|
|
1530
|
+
.B delete-dataset, dd
|
|
1531
|
+
Delete a dataset by ID.
|
|
1532
|
+
.RS
|
|
1533
|
+
.TP
|
|
1534
|
+
.B --dataset-id, --did
|
|
1535
|
+
Dataset UUID.
|
|
1536
|
+
.RE
|
|
1537
|
+
.TP
|
|
1538
|
+
.B create-dataset-row, cdr
|
|
1539
|
+
Create a dataset row.
|
|
1540
|
+
.RS
|
|
1541
|
+
.TP
|
|
1542
|
+
.B --dataset-id, --did
|
|
1543
|
+
Dataset UUID.
|
|
1544
|
+
.TP
|
|
1545
|
+
.B --row, -r
|
|
1546
|
+
Row data (JSON).
|
|
1547
|
+
.RE
|
|
1548
|
+
.TP
|
|
1549
|
+
.B list-dataset-rows, ldr
|
|
1550
|
+
List dataset rows.
|
|
1551
|
+
.RS
|
|
1552
|
+
.TP
|
|
1553
|
+
.B --dataset-id, --did
|
|
1554
|
+
Dataset UUID.
|
|
1555
|
+
.RE
|
|
1556
|
+
.TP
|
|
1557
|
+
.B get-dataset-row, gdr
|
|
1558
|
+
Get a dataset row.
|
|
1559
|
+
.RS
|
|
1560
|
+
.TP
|
|
1561
|
+
.B --dataset-id, --did
|
|
1562
|
+
Dataset UUID.
|
|
1563
|
+
.TP
|
|
1564
|
+
.B --row-id, --rid
|
|
1565
|
+
Row UUID.
|
|
1566
|
+
.RE
|
|
1567
|
+
.TP
|
|
1568
|
+
.B update-dataset-row, udr
|
|
1569
|
+
Update a dataset row.
|
|
1570
|
+
.RS
|
|
1571
|
+
.TP
|
|
1572
|
+
.B --dataset-id, --did
|
|
1573
|
+
Dataset UUID.
|
|
1574
|
+
.TP
|
|
1575
|
+
.B --row-id, --rid
|
|
1576
|
+
Row UUID.
|
|
1577
|
+
.TP
|
|
1578
|
+
.B --row, -r
|
|
1579
|
+
Row data (JSON).
|
|
1580
|
+
.RE
|
|
1581
|
+
.TP
|
|
1582
|
+
.B delete-dataset-row, ddr
|
|
1583
|
+
Delete a dataset row.
|
|
1584
|
+
.RS
|
|
1585
|
+
.TP
|
|
1586
|
+
.B --dataset-id, --did
|
|
1587
|
+
Dataset UUID.
|
|
1588
|
+
.TP
|
|
1589
|
+
.B --row-id, --rid
|
|
1590
|
+
Row UUID.
|
|
1591
|
+
.RE
|
|
1592
|
+
.TP
|
|
1593
|
+
.B create-expected-source, ces
|
|
1594
|
+
Create a dataset row expected source.
|
|
1595
|
+
.RS
|
|
1596
|
+
.TP
|
|
1597
|
+
.B --dataset-id, --did
|
|
1598
|
+
Dataset UUID.
|
|
1599
|
+
.TP
|
|
1600
|
+
.B --row-id, --rid
|
|
1601
|
+
Row UUID.
|
|
1602
|
+
.TP
|
|
1603
|
+
.B --name, -n
|
|
1604
|
+
Source name (string).
|
|
1605
|
+
.TP
|
|
1606
|
+
.B --value, -v
|
|
1607
|
+
Source value (string).
|
|
1608
|
+
.TP
|
|
1609
|
+
.B --extension, -e
|
|
1610
|
+
Source extension (e.g., \fBtxt\fR, \fBpdf\fR).
|
|
1611
|
+
.RE
|
|
1612
|
+
.TP
|
|
1613
|
+
.B list-expected-sources, les
|
|
1614
|
+
List dataset row expected sources.
|
|
1615
|
+
.RS
|
|
1616
|
+
.TP
|
|
1617
|
+
.B --dataset-id, --did
|
|
1618
|
+
Dataset UUID.
|
|
1619
|
+
.TP
|
|
1620
|
+
.B --row-id, --rid
|
|
1621
|
+
Row UUID.
|
|
1622
|
+
.RE
|
|
1623
|
+
.TP
|
|
1624
|
+
.B get-expected-source, ges
|
|
1625
|
+
Get a dataset row expected source.
|
|
1626
|
+
.RS
|
|
1627
|
+
.TP
|
|
1628
|
+
.B --dataset-id, --did
|
|
1629
|
+
Dataset UUID.
|
|
1630
|
+
.TP
|
|
1631
|
+
.B --row-id, --rid
|
|
1632
|
+
Row UUID.
|
|
1633
|
+
.TP
|
|
1634
|
+
.B --expected-source-id, --esid
|
|
1635
|
+
Expected source UUID.
|
|
1636
|
+
.RE
|
|
1637
|
+
.TP
|
|
1638
|
+
.B update-expected-source, ues
|
|
1639
|
+
Update a dataset row expected source.
|
|
1640
|
+
.RS
|
|
1641
|
+
.TP
|
|
1642
|
+
.B --dataset-id, --did
|
|
1643
|
+
Dataset UUID.
|
|
1644
|
+
.TP
|
|
1645
|
+
.B --row-id, --rid
|
|
1646
|
+
Row UUID.
|
|
1647
|
+
.TP
|
|
1648
|
+
.B --expected-source-id, --esid
|
|
1649
|
+
Expected source UUID.
|
|
1650
|
+
.TP
|
|
1651
|
+
.B --name, -n
|
|
1652
|
+
Source name (string).
|
|
1653
|
+
.TP
|
|
1654
|
+
.B --value, -v
|
|
1655
|
+
Source value (string).
|
|
1656
|
+
.TP
|
|
1657
|
+
.B --extension, -e
|
|
1658
|
+
Source extension (e.g., \fBtxt\fR, \fBpdf\fR).
|
|
1659
|
+
.RE
|
|
1660
|
+
.TP
|
|
1661
|
+
.B delete-expected-source, des
|
|
1662
|
+
Delete a dataset row expected source.
|
|
1663
|
+
.RS
|
|
1664
|
+
.TP
|
|
1665
|
+
.B --dataset-id, --did
|
|
1666
|
+
Dataset UUID.
|
|
1667
|
+
.TP
|
|
1668
|
+
.B --row-id, --rid
|
|
1669
|
+
Row UUID.
|
|
1670
|
+
.TP
|
|
1671
|
+
.B --expected-source-id, --esid
|
|
1672
|
+
Expected source UUID.
|
|
1673
|
+
.RE
|
|
1674
|
+
.TP
|
|
1675
|
+
.B create-filter-variable, cfv
|
|
1676
|
+
Create a dataset row filter variable.
|
|
1677
|
+
.RS
|
|
1678
|
+
.TP
|
|
1679
|
+
.B --dataset-id, --did
|
|
1680
|
+
Dataset UUID.
|
|
1681
|
+
.TP
|
|
1682
|
+
.B --row-id, --rid
|
|
1683
|
+
Row UUID.
|
|
1684
|
+
.TP
|
|
1685
|
+
.B --metadata-type, --mt
|
|
1686
|
+
Metadata type (e.g., \fBV\fR for variable).
|
|
1687
|
+
.TP
|
|
1688
|
+
.B --key, -k
|
|
1689
|
+
Filter key (string).
|
|
1690
|
+
.TP
|
|
1691
|
+
.B --value, -v
|
|
1692
|
+
Filter value (string).
|
|
1693
|
+
.TP
|
|
1694
|
+
.B --operator, -o
|
|
1695
|
+
Filter operator (e.g., \fB=\fR, \fB!=\fR, \fBcontains\fR).
|
|
1696
|
+
.RE
|
|
1697
|
+
.TP
|
|
1698
|
+
.B list-filter-variables, lfv
|
|
1699
|
+
List dataset row filter variables.
|
|
1700
|
+
.RS
|
|
1701
|
+
.TP
|
|
1702
|
+
.B --dataset-id, --did
|
|
1703
|
+
Dataset UUID.
|
|
1704
|
+
.TP
|
|
1705
|
+
.B --row-id, --rid
|
|
1706
|
+
Row UUID.
|
|
1707
|
+
.RE
|
|
1708
|
+
.TP
|
|
1709
|
+
.B get-filter-variable, gfv
|
|
1710
|
+
Get a dataset row filter variable.
|
|
1711
|
+
.RS
|
|
1712
|
+
.TP
|
|
1713
|
+
.B --dataset-id, --did
|
|
1714
|
+
Dataset UUID.
|
|
1715
|
+
.TP
|
|
1716
|
+
.B --row-id, --rid
|
|
1717
|
+
Row UUID.
|
|
1718
|
+
.TP
|
|
1719
|
+
.B --filter-variable-id, --fvid
|
|
1720
|
+
Filter variable UUID.
|
|
1721
|
+
.RE
|
|
1722
|
+
.TP
|
|
1723
|
+
.B update-filter-variable, ufv
|
|
1724
|
+
Update a dataset row filter variable.
|
|
1725
|
+
.RS
|
|
1726
|
+
.TP
|
|
1727
|
+
.B --dataset-id, --did
|
|
1728
|
+
Dataset UUID.
|
|
1729
|
+
.TP
|
|
1730
|
+
.B --row-id, --rid
|
|
1731
|
+
Row UUID.
|
|
1732
|
+
.TP
|
|
1733
|
+
.B --filter-variable-id, --fvid
|
|
1734
|
+
Filter variable UUID.
|
|
1735
|
+
.TP
|
|
1736
|
+
.B --metadata-type, --mt
|
|
1737
|
+
Metadata type (e.g., \fBV\fR for variable).
|
|
1738
|
+
.TP
|
|
1739
|
+
.B --key, -k
|
|
1740
|
+
Filter key (string).
|
|
1741
|
+
.TP
|
|
1742
|
+
.B --value, -v
|
|
1743
|
+
Filter value (string).
|
|
1744
|
+
.TP
|
|
1745
|
+
.B --operator, -o
|
|
1746
|
+
Filter operator (e.g., \fB=\fR, \fB!=\fR, \fBcontains\fR).
|
|
1747
|
+
.RE
|
|
1748
|
+
.TP
|
|
1749
|
+
.B delete-filter-variable, dfv
|
|
1750
|
+
Delete a dataset row filter variable.
|
|
1751
|
+
.RS
|
|
1752
|
+
.TP
|
|
1753
|
+
.B --dataset-id, --did
|
|
1754
|
+
Dataset UUID.
|
|
1755
|
+
.TP
|
|
1756
|
+
.B --row-id, --rid
|
|
1757
|
+
Row UUID.
|
|
1758
|
+
.TP
|
|
1759
|
+
.B --filter-variable-id, --fvid
|
|
1760
|
+
Filter variable UUID.
|
|
1761
|
+
.RE
|
|
1762
|
+
.TP
|
|
1763
|
+
.B upload-dataset-rows, udrf
|
|
1764
|
+
Upload dataset rows from a file.
|
|
1765
|
+
.RS
|
|
1766
|
+
.TP
|
|
1767
|
+
.B --dataset-id, --did
|
|
1768
|
+
Dataset UUID.
|
|
1769
|
+
.TP
|
|
1770
|
+
.B --rows-file, --rf
|
|
1771
|
+
JSON file with dataset rows.
|
|
1772
|
+
.RE
|
|
1773
|
+
.TP
|
|
1774
|
+
.B list-evaluation-plans, lep
|
|
1775
|
+
List all evaluation plans.
|
|
1776
|
+
.TP
|
|
1777
|
+
.B create-evaluation-plan, cep
|
|
1778
|
+
Create an evaluation plan.
|
|
1779
|
+
.RS
|
|
1780
|
+
.TP
|
|
1781
|
+
.B --name, --epn
|
|
1782
|
+
Evaluation plan name.
|
|
1783
|
+
.TP
|
|
1784
|
+
.B --assistant-type, --epat
|
|
1785
|
+
Assistant type (e.g., \fBTextPromptAssistant\fR, \fBRAG Assistant\fR).
|
|
1786
|
+
.TP
|
|
1787
|
+
.B --assistant-id, --epai
|
|
1788
|
+
Assistant UUID (optional, required for \fBTextPromptAssistant\fR).
|
|
1789
|
+
.TP
|
|
1790
|
+
.B --assistant-name, --epan
|
|
1791
|
+
Assistant name (optional, required for \fBTextPromptAssistant\fR).
|
|
1792
|
+
.TP
|
|
1793
|
+
.B --assistant-revision, --epar
|
|
1794
|
+
Assistant revision (optional, required for \fBTextPromptAssistant\fR).
|
|
1795
|
+
.TP
|
|
1796
|
+
.B --profile-name, --eppn
|
|
1797
|
+
RAG profile name (optional, required for \fBRAG Assistant\fR).
|
|
1798
|
+
.TP
|
|
1799
|
+
.B --dataset-id, --did
|
|
1800
|
+
Dataset ID (optional).
|
|
1801
|
+
.TP
|
|
1802
|
+
.B --system-metrics, --sm
|
|
1803
|
+
System metrics (JSON array with \fBsystemMetricId\fR and \fBsystemMetricWeight\fR).
|
|
1804
|
+
.RE
|
|
1805
|
+
.TP
|
|
1806
|
+
.B get-evaluation-plan, gep
|
|
1807
|
+
Retrieve an evaluation plan by ID.
|
|
1808
|
+
.RS
|
|
1809
|
+
.TP
|
|
1810
|
+
.B --evaluation-plan-id, --epid
|
|
1811
|
+
Evaluation plan UUID.
|
|
1812
|
+
.RE
|
|
1813
|
+
.TP
|
|
1814
|
+
.B update-evaluation-plan, uep
|
|
1815
|
+
Update an evaluation plan by ID.
|
|
1816
|
+
.RS
|
|
1817
|
+
.TP
|
|
1818
|
+
.B --evaluation-plan-id, --epid
|
|
1819
|
+
Evaluation plan UUID.
|
|
1820
|
+
.TP
|
|
1821
|
+
.B --name, --epn
|
|
1822
|
+
Evaluation plan name.
|
|
1823
|
+
.TP
|
|
1824
|
+
.B --assistant-type, --epat
|
|
1825
|
+
Assistant type (e.g., \fBTextPromptAssistant\fR, \fBRAG Assistant\fR).
|
|
1826
|
+
.TP
|
|
1827
|
+
.B --assistant-id, --epai
|
|
1828
|
+
Assistant UUID (optional, required for \fBTextPromptAssistant\fR).
|
|
1829
|
+
.TP
|
|
1830
|
+
.B --assistant-name, --epan
|
|
1831
|
+
Assistant name (optional, required for \fBTextPromptAssistant\fR).
|
|
1832
|
+
.TP
|
|
1833
|
+
.B --assistant-revision, --epar
|
|
1834
|
+
Assistant revision (optional, required for \fBTextPromptAssistant\fR).
|
|
1835
|
+
.TP
|
|
1836
|
+
.B --profile-name, --eppn
|
|
1837
|
+
RAG profile name (optional, required for \fBRAG Assistant\fR).
|
|
1838
|
+
.TP
|
|
1839
|
+
.B --dataset-id, --did
|
|
1840
|
+
Dataset ID (optional).
|
|
1841
|
+
.TP
|
|
1842
|
+
.B --system-metrics, --sm
|
|
1843
|
+
System metrics (JSON array with \fBsystemMetricId\fR and \fBsystemMetricWeight\fR).
|
|
1844
|
+
.RE
|
|
1845
|
+
.TP
|
|
1846
|
+
.B delete-evaluation-plan, dep
|
|
1847
|
+
Delete an evaluation plan by ID.
|
|
1848
|
+
.RS
|
|
1849
|
+
.TP
|
|
1850
|
+
.B --evaluation-plan-id, --epid
|
|
1851
|
+
Evaluation plan UUID.
|
|
1852
|
+
.RE
|
|
1853
|
+
.TP
|
|
1854
|
+
.B list-evaluation-plan-system-metrics, lepsm
|
|
1855
|
+
List system metrics for an evaluation plan.
|
|
1856
|
+
.RS
|
|
1857
|
+
.TP
|
|
1858
|
+
.B --evaluation-plan-id, --epid
|
|
1859
|
+
Evaluation plan UUID.
|
|
1860
|
+
.RE
|
|
1861
|
+
.TP
|
|
1862
|
+
.B add-evaluation-plan-system-metric, aepsm
|
|
1863
|
+
Add a system metric to an evaluation plan.
|
|
1864
|
+
.RS
|
|
1865
|
+
.TP
|
|
1866
|
+
.B --evaluation-plan-id, --epid
|
|
1867
|
+
Evaluation plan UUID.
|
|
1868
|
+
.TP
|
|
1869
|
+
.B --system-metric-id, --smid
|
|
1870
|
+
System metric ID.
|
|
1871
|
+
.TP
|
|
1872
|
+
.B --system-metric-weight, --smw
|
|
1873
|
+
Metric weight (0-1).
|
|
1874
|
+
.RE
|
|
1875
|
+
.TP
|
|
1876
|
+
.B get-evaluation-plan-system-metric, gepsm
|
|
1877
|
+
Retrieve a system metric from an evaluation plan.
|
|
1878
|
+
.RS
|
|
1879
|
+
.TP
|
|
1880
|
+
.B --evaluation-plan-id, --epid
|
|
1881
|
+
Evaluation plan UUID.
|
|
1882
|
+
.TP
|
|
1883
|
+
.B --system-metric-id, --smid
|
|
1884
|
+
System metric ID.
|
|
1885
|
+
.RE
|
|
1886
|
+
.TP
|
|
1887
|
+
.B update-evaluation-plan-system-metric, uepsm
|
|
1888
|
+
Update a system metric in an evaluation plan.
|
|
1889
|
+
.RS
|
|
1890
|
+
.TP
|
|
1891
|
+
.B --evaluation-plan-id, --epid
|
|
1892
|
+
Evaluation plan UUID.
|
|
1893
|
+
.TP
|
|
1894
|
+
.B --system-metric-id, --smid
|
|
1895
|
+
System metric ID.
|
|
1896
|
+
.TP
|
|
1897
|
+
.B --system-metric-weight, --smw
|
|
1898
|
+
Metric weight (0-1).
|
|
1899
|
+
.RE
|
|
1900
|
+
.TP
|
|
1901
|
+
.B delete-evaluation-plan-system-metric, depsm
|
|
1902
|
+
Delete a system metric from an evaluation plan.
|
|
1903
|
+
.RS
|
|
1904
|
+
.TP
|
|
1905
|
+
.B --evaluation-plan-id, --epid
|
|
1906
|
+
Evaluation plan UUID.
|
|
1907
|
+
.TP
|
|
1908
|
+
.B --system-metric-id, --smid
|
|
1909
|
+
System metric ID.
|
|
1910
|
+
.RE
|
|
1911
|
+
.TP
|
|
1912
|
+
.B list-available-system-metrics, lsm
|
|
1913
|
+
List all available system metrics.
|
|
1914
|
+
.TP
|
|
1915
|
+
.B get-system-metrics, gsm
|
|
1916
|
+
Retrieve a system metric by ID.
|
|
1917
|
+
.RS
|
|
1918
|
+
.TP
|
|
1919
|
+
.B --system-metric-id, --smid
|
|
1920
|
+
System metric ID.
|
|
1921
|
+
.RE
|
|
1922
|
+
.TP
|
|
1923
|
+
.B execute-evaluation-plan, xep
|
|
1924
|
+
Execute an evaluation plan.
|
|
1925
|
+
.RS
|
|
1926
|
+
.TP
|
|
1927
|
+
.B --evaluation-plan-id, --epid
|
|
1928
|
+
Evaluation plan UUID.
|
|
1929
|
+
.RE
|
|
1930
|
+
.TP
|
|
1931
|
+
.B list-evaluation-results, ler
|
|
1932
|
+
List evaluation results for a plan.
|
|
1933
|
+
.RS
|
|
1934
|
+
.TP
|
|
1935
|
+
.B --evaluation-plan-id, --epid
|
|
1936
|
+
Evaluation plan UUID.
|
|
1937
|
+
.RE
|
|
1938
|
+
.TP
|
|
1939
|
+
.B get-evaluation-result, ger
|
|
1940
|
+
Retrieve an evaluation result by ID.
|
|
1941
|
+
.RS
|
|
1942
|
+
.TP
|
|
1943
|
+
.B --evaluation-result-id, --erid
|
|
1944
|
+
Evaluation result UUID.
|
|
1945
|
+
.RE
|
|
1946
|
+
.SS Examples
|
|
1947
|
+
.TP
|
|
1948
|
+
.B geai evaluation create-dataset --dataset-name "MyNewDataset" --dataset-description "A dataset for testing" --dataset-type "T" --dataset-active 1 --row '[{"dataSetRowExpectedAnswer": "This is the expected answer", "dataSetRowInput": "What is the capital of France?", "dataSetRowContextDocument": ""}]'
|
|
1949
|
+
Create a dataset with one row.
|
|
1950
|
+
.TP
|
|
1951
|
+
.B geai evaluation execute-evaluation-plan --evaluation-plan-id "plan-uuid"
|
|
1952
|
+
Execute an evaluation plan.
|
|
1953
|
+
.SH GAM COMMANDS
|
|
1954
|
+
.SS Synopsis
|
|
1955
|
+
.B geai gam
|
|
1956
|
+
.I subcommand
|
|
1957
|
+
.RI [ --flag ]
|
|
1958
|
+
.RI [ flag-arg ]
|
|
1959
|
+
.SS Description
|
|
1960
|
+
Manage GAM authentication mechanisms in GEAI.
|
|
1961
|
+
.SS Subcommands
|
|
1962
|
+
.TP
|
|
1963
|
+
.B help, h
|
|
1964
|
+
Display help text.
|
|
1965
|
+
.TP
|
|
1966
|
+
.B get-access-token, gat
|
|
1967
|
+
Get an access token.
|
|
1968
|
+
.RS
|
|
1969
|
+
.TP
|
|
1970
|
+
.B --client-id, --cid
|
|
1971
|
+
Application client ID.
|
|
1972
|
+
.TP
|
|
1973
|
+
.B --client-secret, --cs
|
|
1974
|
+
Application client secret.
|
|
1975
|
+
.TP
|
|
1976
|
+
.B --grant-type, --gt
|
|
1977
|
+
Grant type (default: \fBpassword\fR).
|
|
1978
|
+
.TP
|
|
1979
|
+
.B --authentication-type-name, --atn
|
|
1980
|
+
Authentication type (default: \fBlocal\fR).
|
|
1981
|
+
.TP
|
|
1982
|
+
.B --scope, -s
|
|
1983
|
+
Scope: \fBgam_user_data+gam_user_roles\fR (default: \fBgam_user_data\fR).
|
|
1984
|
+
.TP
|
|
1985
|
+
.B --username, -u
|
|
1986
|
+
Username.
|
|
1987
|
+
.TP
|
|
1988
|
+
.B --password, -p
|
|
1989
|
+
Password.
|
|
1990
|
+
.TP
|
|
1991
|
+
.B --initial-properties, --ip
|
|
1992
|
+
User custom properties (array).
|
|
1993
|
+
.TP
|
|
1994
|
+
.B --repository, -r
|
|
1995
|
+
IDP repository (for multitenant).
|
|
1996
|
+
.TP
|
|
1997
|
+
.B --request-token-type, --rtt
|
|
1998
|
+
Token type: \fBOAuth\fR (default).
|
|
1999
|
+
.RE
|
|
2000
|
+
.TP
|
|
2001
|
+
.B get-user-info, gui
|
|
2002
|
+
Get user information.
|
|
2003
|
+
.RS
|
|
2004
|
+
.TP
|
|
2005
|
+
.B --access-token, --at
|
|
2006
|
+
Access token.
|
|
2007
|
+
.RE
|
|
2008
|
+
.TP
|
|
2009
|
+
.B refresh-access-token, rat
|
|
2010
|
+
Refresh an access token.
|
|
2011
|
+
.RS
|
|
2012
|
+
.TP
|
|
2013
|
+
.B --client-id, --cid
|
|
2014
|
+
Application client ID.
|
|
2015
|
+
.TP
|
|
2016
|
+
.B --client-secret, --cs
|
|
2017
|
+
Application client secret.
|
|
2018
|
+
.TP
|
|
2019
|
+
.B --grant-type, --gt
|
|
2020
|
+
Grant type: \fBrefresh_token\fR.
|
|
2021
|
+
.TP
|
|
2022
|
+
.B --refresh-token, --rt
|
|
2023
|
+
Refresh token.
|
|
2024
|
+
.RE
|
|
2025
|
+
.SS Examples
|
|
2026
|
+
.TP
|
|
2027
|
+
.B geai gam get-access-token --client-id "client-id" --client-secret "secret" --username "user" --password "pass"
|
|
2028
|
+
Obtain an access token.
|
|
2029
|
+
.TP
|
|
2030
|
+
.B geai gam get-user-info --access-token "token"
|
|
2031
|
+
Get user information using an access token.
|
|
2032
|
+
.SH SECRETS COMMANDS
|
|
2033
|
+
.SS Synopsis
|
|
2034
|
+
.B geai secrets
|
|
2035
|
+
.I subcommand
|
|
2036
|
+
.RI [ --flag ]
|
|
2037
|
+
.RI [ flag-arg ]
|
|
2038
|
+
.SS Description
|
|
2039
|
+
Handle secrets in GEAI.
|
|
2040
|
+
.SS Subcommands
|
|
2041
|
+
.TP
|
|
2042
|
+
.B help, h
|
|
2043
|
+
Display help text.
|
|
2044
|
+
.TP
|
|
2045
|
+
.B get-secret, gs
|
|
2046
|
+
Retrieve a secret by ID.
|
|
2047
|
+
.RS
|
|
2048
|
+
.TP
|
|
2049
|
+
.B --secret-id, --sid
|
|
2050
|
+
Secret ID (required).
|
|
2051
|
+
.RE
|
|
2052
|
+
.TP
|
|
2053
|
+
.B create-secret, cs
|
|
2054
|
+
Create a new secret.
|
|
2055
|
+
.RS
|
|
2056
|
+
.TP
|
|
2057
|
+
.B --name, -n
|
|
2058
|
+
Secret name (required).
|
|
2059
|
+
.TP
|
|
2060
|
+
.B --secret-string, -ss
|
|
2061
|
+
Secret value (required).
|
|
2062
|
+
.TP
|
|
2063
|
+
.B --description, -d
|
|
2064
|
+
Secret description (optional).
|
|
2065
|
+
.RE
|
|
2066
|
+
.TP
|
|
2067
|
+
.B update-secret, us
|
|
2068
|
+
Update an existing secret.
|
|
2069
|
+
.RS
|
|
2070
|
+
.TP
|
|
2071
|
+
.B --secret-id, --sid
|
|
2072
|
+
Secret ID (required).
|
|
2073
|
+
.TP
|
|
2074
|
+
.B --name, -n
|
|
2075
|
+
Secret name (required).
|
|
2076
|
+
.TP
|
|
2077
|
+
.B --secret-string, -ss
|
|
2078
|
+
Secret value (required).
|
|
2079
|
+
.TP
|
|
2080
|
+
.B --description, -d
|
|
2081
|
+
Secret description (optional).
|
|
2082
|
+
.RE
|
|
2083
|
+
.TP
|
|
2084
|
+
.B list-secrets, ls
|
|
2085
|
+
List secrets with filtering and pagination.
|
|
2086
|
+
.RS
|
|
2087
|
+
.TP
|
|
2088
|
+
.B --name, -n
|
|
2089
|
+
Filter by name (optional).
|
|
2090
|
+
.TP
|
|
2091
|
+
.B --id
|
|
2092
|
+
Filter by ID (optional).
|
|
2093
|
+
.TP
|
|
2094
|
+
.B --start
|
|
2095
|
+
Starting index (integer, default: 0).
|
|
2096
|
+
.TP
|
|
2097
|
+
.B --count
|
|
2098
|
+
Number of secrets to return (integer, default: 10).
|
|
2099
|
+
.RE
|
|
2100
|
+
.SS Examples
|
|
2101
|
+
.TP
|
|
2102
|
+
.B geai secrets create-secret --name "my-secret" --secret-string "value"
|
|
2103
|
+
Create a new secret.
|
|
2104
|
+
.TP
|
|
2105
|
+
.B geai secrets list-secrets --count 20
|
|
2106
|
+
List up to 20 secrets.
|
|
2107
|
+
.SH AI LAB COMMANDS
|
|
2108
|
+
.SS Synopsis
|
|
2109
|
+
.B geai ai-lab
|
|
2110
|
+
.I subcommand
|
|
2111
|
+
.RI [ --flag ]
|
|
2112
|
+
.RI [ flag-arg ]
|
|
2113
|
+
.SS Description
|
|
2114
|
+
Interact with AI Lab components in GEAI.
|
|
2115
|
+
.SS Subcommands
|
|
2116
|
+
.TP
|
|
2117
|
+
.B help, h
|
|
2118
|
+
Display help text.
|
|
2119
|
+
.TP
|
|
2120
|
+
.B list-agents, la
|
|
2121
|
+
List agents.
|
|
2122
|
+
.RS
|
|
2123
|
+
.TP
|
|
2124
|
+
.B --project-id, --pid
|
|
2125
|
+
Project ID.
|
|
2126
|
+
.TP
|
|
2127
|
+
.B --status
|
|
2128
|
+
Agent status (optional).
|
|
2129
|
+
.TP
|
|
2130
|
+
.B --start
|
|
2131
|
+
Starting index (optional).
|
|
2132
|
+
.TP
|
|
2133
|
+
.B --count
|
|
2134
|
+
Number of agents (optional).
|
|
2135
|
+
.TP
|
|
2136
|
+
.B --access-scope
|
|
2137
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBpublic\fR).
|
|
2138
|
+
.TP
|
|
2139
|
+
.B --allow-drafts
|
|
2140
|
+
Include drafts: \fB0\fR (False), \fB1\fR (True, default).
|
|
2141
|
+
.TP
|
|
2142
|
+
.B --allow-external
|
|
2143
|
+
Include external agents: \fB0\fR (False, default), \fB1\fR (True).
|
|
2144
|
+
.RE
|
|
2145
|
+
.TP
|
|
2146
|
+
.B create-agent, ca
|
|
2147
|
+
Create an agent.
|
|
2148
|
+
.RS
|
|
2149
|
+
.TP
|
|
2150
|
+
.B --project-id, --pid
|
|
2151
|
+
Project ID.
|
|
2152
|
+
.TP
|
|
2153
|
+
.B --name, -n
|
|
2154
|
+
Agent name (unique, no \fB:\fR or \fB/\fR).
|
|
2155
|
+
.TP
|
|
2156
|
+
.B --access-scope, --as
|
|
2157
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBprivate\fR).
|
|
2158
|
+
.TP
|
|
2159
|
+
.B --public-name, --pn
|
|
2160
|
+
Public name (required for \fBpublic\fR scope).
|
|
2161
|
+
.TP
|
|
2162
|
+
.B --job-description, --jd
|
|
2163
|
+
Agent role description.
|
|
2164
|
+
.TP
|
|
2165
|
+
.B --avatar-image, --aimg
|
|
2166
|
+
Avatar image URL.
|
|
2167
|
+
.TP
|
|
2168
|
+
.B --description, -d
|
|
2169
|
+
Agent purpose description.
|
|
2170
|
+
.TP
|
|
2171
|
+
.B --agent-data-prompt-instructions, --adp-inst
|
|
2172
|
+
Agent instructions.
|
|
2173
|
+
.TP
|
|
2174
|
+
.B --agent-data-prompt-input, --adp-input
|
|
2175
|
+
Prompt input (list of strings).
|
|
2176
|
+
.TP
|
|
2177
|
+
.B --agent-data-prompt-output, --adp-out
|
|
2178
|
+
Prompt output (JSON).
|
|
2179
|
+
.TP
|
|
2180
|
+
.B --agent-data-prompt-example, --adp-ex
|
|
2181
|
+
Prompt example (JSON).
|
|
2182
|
+
.TP
|
|
2183
|
+
.B --agent-data-llm-max-tokens, --adl-max-tokens
|
|
2184
|
+
Max tokens for LLM.
|
|
2185
|
+
.TP
|
|
2186
|
+
.B --agent-data-llm-timeout, --adl-timeout
|
|
2187
|
+
LLM response timeout (seconds).
|
|
2188
|
+
.TP
|
|
2189
|
+
.B --agent-data-llm-temperature, --adl-temperature
|
|
2190
|
+
LLM sampling temperature (0.0-1.0).
|
|
2191
|
+
.TP
|
|
2192
|
+
.B --agent-data-llm-top-k, --adl-top-k
|
|
2193
|
+
Top K sampling (unused).
|
|
2194
|
+
.TP
|
|
2195
|
+
.B --agent-data-llm-top-p, --adl-top-p
|
|
2196
|
+
Top P sampling (unused).
|
|
2197
|
+
.TP
|
|
2198
|
+
.B --agent-data-model-name, --adm-name
|
|
2199
|
+
LLM model name.
|
|
2200
|
+
.TP
|
|
2201
|
+
.B --agent-data-resource-pools, --adr-pools
|
|
2202
|
+
Resource pools (JSON).
|
|
2203
|
+
.TP
|
|
2204
|
+
.B --automatic-publish, --ap
|
|
2205
|
+
Publish after creation: \fB0\fR (draft), \fB1\fR (publish).
|
|
2206
|
+
.RE
|
|
2207
|
+
.TP
|
|
2208
|
+
.B get-agent, ga
|
|
2209
|
+
Get an agent.
|
|
2210
|
+
.RS
|
|
2211
|
+
.TP
|
|
2212
|
+
.B --project-id, --pid
|
|
2213
|
+
Project ID.
|
|
2214
|
+
.TP
|
|
2215
|
+
.B --agent-id, --aid
|
|
2216
|
+
Agent ID.
|
|
2217
|
+
.TP
|
|
2218
|
+
.B --revision, -r
|
|
2219
|
+
Agent revision.
|
|
2220
|
+
.TP
|
|
2221
|
+
.B --version, -v
|
|
2222
|
+
Agent version.
|
|
2223
|
+
.TP
|
|
2224
|
+
.B --allow-drafts
|
|
2225
|
+
Include drafts: \fB0\fR (False), \fB1\fR (True, default).
|
|
2226
|
+
.RE
|
|
2227
|
+
.TP
|
|
2228
|
+
.B create-sharing-link, csl
|
|
2229
|
+
Create a sharing link for an agent.
|
|
2230
|
+
.RS
|
|
2231
|
+
.TP
|
|
2232
|
+
.B --project-id, --pid
|
|
2233
|
+
Project ID.
|
|
2234
|
+
.TP
|
|
2235
|
+
.B --agent-id, --aid
|
|
2236
|
+
Agent ID.
|
|
2237
|
+
.RE
|
|
2238
|
+
.TP
|
|
2239
|
+
.B publish-agent-revision, par
|
|
2240
|
+
Publish an agent revision.
|
|
2241
|
+
.RS
|
|
2242
|
+
.TP
|
|
2243
|
+
.B --project-id, --pid
|
|
2244
|
+
Project ID.
|
|
2245
|
+
.TP
|
|
2246
|
+
.B --agent-id, --aid
|
|
2247
|
+
Agent ID.
|
|
2248
|
+
.TP
|
|
2249
|
+
.B --revision, -r
|
|
2250
|
+
Agent revision.
|
|
2251
|
+
.RE
|
|
2252
|
+
.TP
|
|
2253
|
+
.B delete-agent, da
|
|
2254
|
+
Delete an agent.
|
|
2255
|
+
.RS
|
|
2256
|
+
.TP
|
|
2257
|
+
.B --project-id, --pid
|
|
2258
|
+
Project ID.
|
|
2259
|
+
.TP
|
|
2260
|
+
.B --agent-id, --aid
|
|
2261
|
+
Agent ID.
|
|
2262
|
+
.RE
|
|
2263
|
+
.TP
|
|
2264
|
+
.B update-agent, ua
|
|
2265
|
+
Update an agent.
|
|
2266
|
+
.RS
|
|
2267
|
+
.TP
|
|
2268
|
+
.B --project-id, --pid
|
|
2269
|
+
Project ID.
|
|
2270
|
+
.TP
|
|
2271
|
+
.B --agent-id, --aid
|
|
2272
|
+
Agent ID.
|
|
2273
|
+
.TP
|
|
2274
|
+
.B --name, -n
|
|
2275
|
+
Agent name (optional).
|
|
2276
|
+
.TP
|
|
2277
|
+
.B --access-scope, --as
|
|
2278
|
+
Access scope: \fBpublic\fR, \fBprivate\fR.
|
|
2279
|
+
.TP
|
|
2280
|
+
.B --public-name, --pn
|
|
2281
|
+
Public name (required for \fBpublic\fR scope).
|
|
2282
|
+
.TP
|
|
2283
|
+
.B --job-description, --jd
|
|
2284
|
+
Agent role description.
|
|
2285
|
+
.TP
|
|
2286
|
+
.B --avatar-image, --aimg
|
|
2287
|
+
Avatar image URL.
|
|
2288
|
+
.TP
|
|
2289
|
+
.B --description, -d
|
|
2290
|
+
Agent purpose description.
|
|
2291
|
+
.TP
|
|
2292
|
+
.B --agent-data-prompt-instructions, --adp-inst
|
|
2293
|
+
Agent instructions.
|
|
2294
|
+
.TP
|
|
2295
|
+
.B --agent-data-prompt-input, --adp-input
|
|
2296
|
+
Prompt input (list of strings).
|
|
2297
|
+
.TP
|
|
2298
|
+
.B --agent-data-prompt-output, --adp-out
|
|
2299
|
+
Prompt output (JSON).
|
|
2300
|
+
.TP
|
|
2301
|
+
.B --agent-data-prompt-example, --adp-ex
|
|
2302
|
+
Prompt example (JSON).
|
|
2303
|
+
.TP
|
|
2304
|
+
.B --agent-data-llm-max-tokens, --adl-max-tokens
|
|
2305
|
+
Max tokens for LLM.
|
|
2306
|
+
.TP
|
|
2307
|
+
.B --agent-data-llm-timeout, --adl-timeout
|
|
2308
|
+
LLM response timeout (seconds).
|
|
2309
|
+
.TP
|
|
2310
|
+
.B --agent-data-llm-temperature, --adl-temperature
|
|
2311
|
+
LLM sampling temperature (0.0-1.0).
|
|
2312
|
+
.TP
|
|
2313
|
+
.B --agent-data-llm-top-k, --adl-top-k
|
|
2314
|
+
Top K sampling (unused).
|
|
2315
|
+
.TP
|
|
2316
|
+
.B --agent-data-llm-top-p, --adl-top-p
|
|
2317
|
+
Top P sampling (unused).
|
|
2318
|
+
.TP
|
|
2319
|
+
.B --agent-data-model-name, --adm-name
|
|
2320
|
+
LLM model name.
|
|
2321
|
+
.TP
|
|
2322
|
+
.B --agent-data-resource-pools, --adr-pools
|
|
2323
|
+
Resource pools (JSON).
|
|
2324
|
+
.TP
|
|
2325
|
+
.B --automatic-publish, --ap
|
|
2326
|
+
Publish after update: \fB0\fR (draft), \fB1\fR (publish).
|
|
2327
|
+
.TP
|
|
2328
|
+
.B --upsert
|
|
2329
|
+
Create if not exists: \fB0\fR (update only), \fB1\fR (insert).
|
|
2330
|
+
.RE
|
|
2331
|
+
.TP
|
|
2332
|
+
.B create-tool, ct
|
|
2333
|
+
Create a tool.
|
|
2334
|
+
.RS
|
|
2335
|
+
.TP
|
|
2336
|
+
.B --project-id, --pid
|
|
2337
|
+
Project ID.
|
|
2338
|
+
.TP
|
|
2339
|
+
.B --name, -n
|
|
2340
|
+
Tool name (unique, no \fB:\fR or \fB/\fR).
|
|
2341
|
+
.TP
|
|
2342
|
+
.B --description, -d
|
|
2343
|
+
Tool purpose description.
|
|
2344
|
+
.TP
|
|
2345
|
+
.B --scope, -s
|
|
2346
|
+
Tool scope: \fBbuiltin\fR, \fBexternal\fR, \fBapi\fR.
|
|
2347
|
+
.TP
|
|
2348
|
+
.B --access-scope, --as
|
|
2349
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBprivate\fR).
|
|
2350
|
+
.TP
|
|
2351
|
+
.B --public-name, --pn
|
|
2352
|
+
Public name (required for \fBpublic\fR scope).
|
|
2353
|
+
.TP
|
|
2354
|
+
.B --icon, -i
|
|
2355
|
+
Tool icon URL.
|
|
2356
|
+
.TP
|
|
2357
|
+
.B --open-api, --oa
|
|
2358
|
+
OpenAPI specification URL (for \fBapi\fR scope).
|
|
2359
|
+
.TP
|
|
2360
|
+
.B --open-api-json, --oaj
|
|
2361
|
+
OpenAPI specification (JSON, for \fBapi\fR scope).
|
|
2362
|
+
.TP
|
|
2363
|
+
.B --report-events, --re
|
|
2364
|
+
Event reporting: \fBNone\fR, \fBAll\fR, \fBStart\fR, \fBFinish\fR, \fBProgress\fR (default: \fBNone\fR).
|
|
2365
|
+
.TP
|
|
2366
|
+
.B --parameter, -p
|
|
2367
|
+
Tool parameter (JSON).
|
|
2368
|
+
.TP
|
|
2369
|
+
.B --automatic-publish, --ap
|
|
2370
|
+
Publish after creation: \fB0\fR (draft), \fB1\fR (publish).
|
|
2371
|
+
.RE
|
|
2372
|
+
.TP
|
|
2373
|
+
.B list-tools, lt
|
|
2374
|
+
List tools.
|
|
2375
|
+
.RS
|
|
2376
|
+
.TP
|
|
2377
|
+
.B --project-id, --pid
|
|
2378
|
+
Project ID.
|
|
2379
|
+
.TP
|
|
2380
|
+
.B --id
|
|
2381
|
+
Tool ID (optional).
|
|
2382
|
+
.TP
|
|
2383
|
+
.B --count
|
|
2384
|
+
Number of tools (default: 100).
|
|
2385
|
+
.TP
|
|
2386
|
+
.B --access-scope
|
|
2387
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBpublic\fR).
|
|
2388
|
+
.TP
|
|
2389
|
+
.B --allow-drafts
|
|
2390
|
+
Include drafts: \fB0\fR (False), \fB1\fR (True, default).
|
|
2391
|
+
.TP
|
|
2392
|
+
.B --scope
|
|
2393
|
+
Tool scope: \fBbuiltin\fR, \fBexternal\fR, \fBapi\fR (default: \fBapi\fR).
|
|
2394
|
+
.TP
|
|
2395
|
+
.B --allow-external
|
|
2396
|
+
Include external tools: \fB0\fR (False), \fB1\fR (True, default).
|
|
2397
|
+
.RE
|
|
2398
|
+
.TP
|
|
2399
|
+
.B get-tool, gt
|
|
2400
|
+
Get a tool.
|
|
2401
|
+
.RS
|
|
2402
|
+
.TP
|
|
2403
|
+
.B --project-id, --pid
|
|
2404
|
+
Project ID.
|
|
2405
|
+
.TP
|
|
2406
|
+
.B --tool-id, --tid
|
|
2407
|
+
Tool ID.
|
|
2408
|
+
.TP
|
|
2409
|
+
.B --revision, -r
|
|
2410
|
+
Tool revision.
|
|
2411
|
+
.TP
|
|
2412
|
+
.B --version, -v
|
|
2413
|
+
Tool version.
|
|
2414
|
+
.TP
|
|
2415
|
+
.B --allow-drafts
|
|
2416
|
+
Include drafts: \fB0\fR (False), \fB1\fR (True, default).
|
|
2417
|
+
.RE
|
|
2418
|
+
.TP
|
|
2419
|
+
.B delete-tool, dt
|
|
2420
|
+
Delete a tool.
|
|
2421
|
+
.RS
|
|
2422
|
+
.TP
|
|
2423
|
+
.B --project-id, --pid
|
|
2424
|
+
Project ID.
|
|
2425
|
+
.TP
|
|
2426
|
+
.B --tool-id, --tid
|
|
2427
|
+
Tool ID.
|
|
2428
|
+
.TP
|
|
2429
|
+
.B --tool-name, --tname
|
|
2430
|
+
Tool name.
|
|
2431
|
+
.RE
|
|
2432
|
+
.TP
|
|
2433
|
+
.B update-tool, ut
|
|
2434
|
+
Update a tool.
|
|
2435
|
+
.RS
|
|
2436
|
+
.TP
|
|
2437
|
+
.B --project-id, --pid
|
|
2438
|
+
Project ID.
|
|
2439
|
+
.TP
|
|
2440
|
+
.B --tool-id, --tid
|
|
2441
|
+
Tool ID.
|
|
2442
|
+
.TP
|
|
2443
|
+
.B --name, -n
|
|
2444
|
+
Tool name (optional).
|
|
2445
|
+
.TP
|
|
2446
|
+
.B --description, -d
|
|
2447
|
+
Tool description.
|
|
2448
|
+
.TP
|
|
2449
|
+
.B --scope, -s
|
|
2450
|
+
Tool scope: \fBbuiltin\fR, \fBexternal\fR, \fBapi\fR.
|
|
2451
|
+
.TP
|
|
2452
|
+
.B --access-scope, --as
|
|
2453
|
+
Access scope: \fBpublic\fR, \fBprivate\fR.
|
|
2454
|
+
.TP
|
|
2455
|
+
.B --public-name, --pn
|
|
2456
|
+
Public name (for \fBpublic\fR scope).
|
|
2457
|
+
.TP
|
|
2458
|
+
.B --icon, -i
|
|
2459
|
+
Tool icon URL.
|
|
2460
|
+
.TP
|
|
2461
|
+
.B --open-api, --oa
|
|
2462
|
+
OpenAPI specification URL.
|
|
2463
|
+
.TP
|
|
2464
|
+
.B --open-api-json, --oaj
|
|
2465
|
+
OpenAPI specification (JSON).
|
|
2466
|
+
.TP
|
|
2467
|
+
.B --report-events, --re
|
|
2468
|
+
Event reporting: \fBNone\fR, \fBAll\fR, \fBStart\fR, \fBFinish\fR, \fBProgress\fR.
|
|
2469
|
+
.TP
|
|
2470
|
+
.B --parameter, -p
|
|
2471
|
+
Tool parameter (JSON).
|
|
2472
|
+
.TP
|
|
2473
|
+
.B --automatic-publish, --ap
|
|
2474
|
+
Publish after update: \fB0\fR (draft), \fB1\fR (publish).
|
|
2475
|
+
.TP
|
|
2476
|
+
.B --upsert
|
|
2477
|
+
Create if not exists: \fB0\fR (update only), \fB1\fR (insert).
|
|
2478
|
+
.RE
|
|
2479
|
+
.TP
|
|
2480
|
+
.B publish-tool-revision, ptr
|
|
2481
|
+
Publish a tool revision.
|
|
2482
|
+
.RS
|
|
2483
|
+
.TP
|
|
2484
|
+
.B --project-id, --pid
|
|
2485
|
+
Project ID.
|
|
2486
|
+
.TP
|
|
2487
|
+
.B --tool-id, --tid
|
|
2488
|
+
Tool ID.
|
|
2489
|
+
.TP
|
|
2490
|
+
.B --revision, -r
|
|
2491
|
+
Tool revision (0 for latest).
|
|
2492
|
+
.RE
|
|
2493
|
+
.TP
|
|
2494
|
+
.B get-parameter, gp
|
|
2495
|
+
Get a tool parameter.
|
|
2496
|
+
.RS
|
|
2497
|
+
.TP
|
|
2498
|
+
.B --project-id, --pid
|
|
2499
|
+
Project ID.
|
|
2500
|
+
.TP
|
|
2501
|
+
.B --tool-id, --tid
|
|
2502
|
+
Tool ID.
|
|
2503
|
+
.TP
|
|
2504
|
+
.B --tool-public-name, --tpn
|
|
2505
|
+
Tool public name.
|
|
2506
|
+
.TP
|
|
2507
|
+
.B --revision, -r
|
|
2508
|
+
Parameter revision (0 for latest).
|
|
2509
|
+
.TP
|
|
2510
|
+
.B --version, -v
|
|
2511
|
+
Parameter version (0 for latest).
|
|
2512
|
+
.TP
|
|
2513
|
+
.B --allow-drafts
|
|
2514
|
+
Include drafts: \fB0\fR (False), \fB1\fR (True, default).
|
|
2515
|
+
.RE
|
|
2516
|
+
.TP
|
|
2517
|
+
.B set-parameter, sp
|
|
2518
|
+
Set a tool parameter.
|
|
2519
|
+
.RS
|
|
2520
|
+
.TP
|
|
2521
|
+
.B --project-id, --pid
|
|
2522
|
+
Project ID.
|
|
2523
|
+
.TP
|
|
2524
|
+
.B --tool-id, --tid
|
|
2525
|
+
Tool ID.
|
|
2526
|
+
.TP
|
|
2527
|
+
.B --tool-public-name, --tpn
|
|
2528
|
+
Tool public name.
|
|
2529
|
+
.TP
|
|
2530
|
+
.B --parameter, -p
|
|
2531
|
+
Tool parameter (JSON).
|
|
2532
|
+
.RE
|
|
2533
|
+
.TP
|
|
2534
|
+
.B list-reasoning-strategies, lrs
|
|
2535
|
+
List reasoning strategies.
|
|
2536
|
+
.RS
|
|
2537
|
+
.TP
|
|
2538
|
+
.B --name, -n
|
|
2539
|
+
Strategy name (optional).
|
|
2540
|
+
.TP
|
|
2541
|
+
.B --start
|
|
2542
|
+
Starting index (default: 0).
|
|
2543
|
+
.TP
|
|
2544
|
+
.B --count
|
|
2545
|
+
Number of strategies (default: 100).
|
|
2546
|
+
.TP
|
|
2547
|
+
.B --allow-external
|
|
2548
|
+
Include external strategies: \fB0\fR (False), \fB1\fR (True, default).
|
|
2549
|
+
.TP
|
|
2550
|
+
.B --access-scope
|
|
2551
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBpublic\fR).
|
|
2552
|
+
.RE
|
|
2553
|
+
.TP
|
|
2554
|
+
.B create-reasoning-strategy, crs
|
|
2555
|
+
Create a reasoning strategy.
|
|
2556
|
+
.RS
|
|
2557
|
+
.TP
|
|
2558
|
+
.B --project-id, --pid
|
|
2559
|
+
Project ID.
|
|
2560
|
+
.TP
|
|
2561
|
+
.B --name, -n
|
|
2562
|
+
Strategy name.
|
|
2563
|
+
.TP
|
|
2564
|
+
.B --system-prompt, --sp
|
|
2565
|
+
System prompt.
|
|
2566
|
+
.TP
|
|
2567
|
+
.B --access-scope, --as
|
|
2568
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (default: \fBpublic\fR).
|
|
2569
|
+
.TP
|
|
2570
|
+
.B --type, -t
|
|
2571
|
+
Strategy type: \fBaddendum\fR (default).
|
|
2572
|
+
.TP
|
|
2573
|
+
.B --localized-description, --ld
|
|
2574
|
+
Localized description (JSON).
|
|
2575
|
+
.TP
|
|
2576
|
+
.B --automatic-publish, --ap
|
|
2577
|
+
Publish after creation: \fB0\fR (draft), \fB1\fR (publish).
|
|
2578
|
+
.RE
|
|
2579
|
+
.TP
|
|
2580
|
+
.B update-reasoning-strategy, urs
|
|
2581
|
+
Update a reasoning strategy.
|
|
2582
|
+
.RS
|
|
2583
|
+
.TP
|
|
2584
|
+
.B --project-id, --pid
|
|
2585
|
+
Project ID.
|
|
2586
|
+
.TP
|
|
2587
|
+
.B --reasoning-strategy-id, --rsid
|
|
2588
|
+
Strategy ID.
|
|
2589
|
+
.TP
|
|
2590
|
+
.B --name, -n
|
|
2591
|
+
Strategy name (optional).
|
|
2592
|
+
.TP
|
|
2593
|
+
.B --system-prompt, --sp
|
|
2594
|
+
System prompt (optional).
|
|
2595
|
+
.TP
|
|
2596
|
+
.B --access-scope, --as
|
|
2597
|
+
Access scope: \fBpublic\fR, \fBprivate\fR (optional).
|
|
2598
|
+
.TP
|
|
2599
|
+
.B --type, -t
|
|
2600
|
+
Strategy type: \fBaddendum\fR (optional).
|
|
2601
|
+
.TP
|
|
2602
|
+
.B --localized-description, --ld
|
|
2603
|
+
Localized description (JSON, optional).
|
|
2604
|
+
.TP
|
|
2605
|
+
.B --automatic-publish, --ap
|
|
2606
|
+
Publish after update: \fB0\fR (draft), \fB1\fR (publish).
|
|
2607
|
+
.RE
|
|
2608
|
+
.TP
|
|
2609
|
+
.SH SEE ALSO
|
|
2610
|
+
.BR pygeai (1)
|
|
2611
|
+
.SH AUTHOR
|
|
2612
|
+
Written by the GEAI development team.
|
|
2613
|
+
.SH COPYRIGHT
|
|
2614
|
+
Copyright \(co 2025 GEAI development team.
|
|
2615
|
+
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|