From 03079a23469f4c68f1f192721b7bea18a3713995 Mon Sep 17 00:00:00 2001 From: whiterabbit1983 Date: Fri, 17 May 2024 10:26:29 +0300 Subject: [PATCH] chore: Update SDKs (#333) --- .../agents_api/autogen/openapi_model.py | 12 +- agents-api/poetry.lock | 489 ++-- docs/js-sdk-docs/README.md | 50 +- .../classes/api.BaseHttpRequest.md | 75 - .../api_JulepApiClient.JulepApiClient.md | 14 +- ...Error.md => api_core_ApiError.ApiError.md} | 50 +- ..._core_AxiosHttpRequest.AxiosHttpRequest.md | 103 + ...pi_core_BaseHttpRequest.BaseHttpRequest.md | 81 + ...api_core_CancelablePromise.CancelError.md} | 28 +- ...re_CancelablePromise.CancelablePromise.md} | 66 +- ...services_DefaultService.DefaultService.md} | 338 +-- docs/js-sdk-docs/classes/client.Client.md | 177 ++ .../classes/managers_agent.AgentsManager.md | 48 +- .../classes/managers_base.BaseManager.md | 6 +- .../classes/managers_doc.DocsManager.md | 28 +- .../managers_memory.MemoriesManager.md | 12 +- .../managers_session.SessionsManager.md | 54 +- .../classes/managers_tool.ToolsManager.md | 30 +- .../classes/managers_user.UsersManager.md | 44 +- ...ls_requestConstructor.CustomHttpRequest.md | 38 +- .../api_core_CancelablePromise.OnCancel.md | 63 + .../managers_session.CreateSessionPayload.md | 12 +- docs/js-sdk-docs/modules.md | 110 +- docs/js-sdk-docs/modules/api.md | 2342 +++-------------- .../js-sdk-docs/modules/api_JulepApiClient.md | 2 +- docs/js-sdk-docs/modules/api_core_ApiError.md | 9 + .../modules/api_core_ApiRequestOptions.md | 35 + .../js-sdk-docs/modules/api_core_ApiResult.md | 29 + .../modules/api_core_AxiosHttpRequest.md | 9 + .../modules/api_core_BaseHttpRequest.md | 9 + .../modules/api_core_CancelablePromise.md | 14 + docs/js-sdk-docs/modules/api_core_OpenAPI.md | 47 + docs/js-sdk-docs/modules/api_core_request.md | 411 +++ docs/js-sdk-docs/modules/api_models_Agent.md | 33 + .../api_models_AgentDefaultSettings.md | 32 + .../modules/api_models_ChatInput.md | 19 + .../modules/api_models_ChatInputData.md | 27 + .../modules/api_models_ChatMLMessage.md | 29 + .../modules/api_models_ChatResponse.md | 32 + .../modules/api_models_ChatSettings.md | 41 + .../modules/api_models_CompletionUsage.md | 29 + .../modules/api_models_CreateAgentRequest.md | 34 + .../modules/api_models_CreateDoc.md | 27 + .../api_models_CreateSessionRequest.md | 31 + .../modules/api_models_CreateToolRequest.md | 26 + .../modules/api_models_CreateUserRequest.md | 30 + docs/js-sdk-docs/modules/api_models_Doc.md | 29 + docs/js-sdk-docs/modules/api_models_DocIds.md | 26 + .../modules/api_models_FunctionCallOption.md | 27 + .../modules/api_models_FunctionDef.md | 27 + .../modules/api_models_FunctionParameters.md | 21 + .../modules/api_models_InputChatMLMessage.md | 28 + .../modules/api_models_JobStatus.md | 32 + docs/js-sdk-docs/modules/api_models_Memory.md | 33 + .../modules/api_models_MemoryAccessOptions.md | 27 + .../modules/api_models_NamedToolChoice.md | 29 + .../modules/api_models_PartialFunctionDef.md | 27 + .../modules/api_models_PatchAgentRequest.md | 32 + .../modules/api_models_PatchSessionRequest.md | 28 + .../modules/api_models_PatchToolRequest.md | 25 + .../modules/api_models_PatchUserRequest.md | 29 + .../api_models_ResourceCreatedResponse.md | 27 + .../api_models_ResourceDeletedResponse.md | 27 + .../api_models_ResourceUpdatedResponse.md | 27 + .../js-sdk-docs/modules/api_models_Session.md | 33 + .../modules/api_models_Suggestion.md | 29 + docs/js-sdk-docs/modules/api_models_Tool.md | 27 + .../modules/api_models_ToolChoiceOption.md | 26 + .../modules/api_models_UpdateAgentRequest.md | 32 + .../api_models_UpdateSessionRequest.md | 28 + .../modules/api_models_UpdateToolRequest.md | 25 + .../modules/api_models_UpdateUserRequest.md | 29 + docs/js-sdk-docs/modules/api_models_User.md | 30 + .../modules/api_models_agent_id.md | 19 + docs/js-sdk-docs/modules/api_models_doc_id.md | 19 + docs/js-sdk-docs/modules/api_models_job_id.md | 19 + .../modules/api_models_memory_id.md | 19 + .../modules/api_models_message_id.md | 19 + .../modules/api_models_session_id.md | 19 + .../js-sdk-docs/modules/api_models_tool_id.md | 19 + .../js-sdk-docs/modules/api_models_user_id.md | 19 + .../js-sdk-docs/modules/api_schemas__Agent.md | 59 + .../api_schemas__AgentDefaultSettings.md | 64 + .../modules/api_schemas__ChatInput.md | 26 + .../modules/api_schemas__ChatInputData.md | 40 + .../modules/api_schemas__ChatMLMessage.md | 45 + .../modules/api_schemas__ChatResponse.md | 52 + .../modules/api_schemas__ChatSettings.md | 101 + .../modules/api_schemas__CompletionUsage.md | 38 + .../api_schemas__CreateAgentRequest.md | 54 + .../modules/api_schemas__CreateDoc.md | 37 + .../api_schemas__CreateSessionRequest.md | 44 + .../modules/api_schemas__CreateToolRequest.md | 33 + .../modules/api_schemas__CreateUserRequest.md | 39 + docs/js-sdk-docs/modules/api_schemas__Doc.md | 47 + .../modules/api_schemas__DocIds.md | 35 + .../api_schemas__FunctionCallOption.md | 30 + .../modules/api_schemas__FunctionDef.md | 36 + .../api_schemas__FunctionParameters.md | 27 + .../api_schemas__InputChatMLMessage.md | 38 + .../modules/api_schemas__JobStatus.md | 56 + .../modules/api_schemas__Memory.md | 67 + .../api_schemas__MemoryAccessOptions.md | 34 + .../modules/api_schemas__NamedToolChoice.md | 36 + .../api_schemas__PartialFunctionDef.md | 34 + .../modules/api_schemas__PatchAgentRequest.md | 45 + .../api_schemas__PatchSessionRequest.md | 32 + .../modules/api_schemas__PatchToolRequest.md | 29 + .../modules/api_schemas__PatchUserRequest.md | 35 + .../api_schemas__ResourceCreatedResponse.md | 38 + .../api_schemas__ResourceDeletedResponse.md | 38 + .../api_schemas__ResourceUpdatedResponse.md | 38 + .../modules/api_schemas__Session.md | 59 + .../modules/api_schemas__Suggestion.md | 46 + docs/js-sdk-docs/modules/api_schemas__Tool.md | 38 + .../modules/api_schemas__ToolChoiceOption.md | 27 + .../api_schemas__UpdateAgentRequest.md | 47 + .../api_schemas__UpdateSessionRequest.md | 33 + .../modules/api_schemas__UpdateToolRequest.md | 29 + .../modules/api_schemas__UpdateUserRequest.md | 37 + docs/js-sdk-docs/modules/api_schemas__User.md | 47 + .../modules/api_schemas__agent_id.md | 26 + .../modules/api_schemas__doc_id.md | 26 + .../modules/api_schemas__job_id.md | 26 + .../modules/api_schemas__memory_id.md | 26 + .../modules/api_schemas__message_id.md | 26 + .../modules/api_schemas__session_id.md | 26 + .../modules/api_schemas__tool_id.md | 26 + .../modules/api_schemas__user_id.md | 26 + .../modules/api_services_DefaultService.md | 9 + docs/js-sdk-docs/modules/client.md | 9 + docs/js-sdk-docs/modules/env.md | 30 + docs/js-sdk-docs/modules/index.md | 15 + docs/js-sdk-docs/modules/managers_agent.md | 2 +- docs/js-sdk-docs/modules/managers_base.md | 2 +- docs/js-sdk-docs/modules/managers_doc.md | 2 +- docs/js-sdk-docs/modules/managers_memory.md | 2 +- docs/js-sdk-docs/modules/managers_session.md | 2 +- docs/js-sdk-docs/modules/managers_tool.md | 2 +- docs/js-sdk-docs/modules/managers_user.md | 2 +- docs/js-sdk-docs/modules/utils_invariant.md | 4 +- .../js-sdk-docs/modules/utils_isValidUuid4.md | 4 +- docs/js-sdk-docs/modules/utils_openaiPatch.md | 4 +- .../modules/utils_requestConstructor.md | 2 +- docs/js-sdk-docs/modules/utils_xor.md | 4 +- docs/python-sdk-docs/README.md | 7 + docs/python-sdk-docs/julep/api/client.md | 196 +- docs/python-sdk-docs/julep/api/types/agent.md | 6 +- .../julep/api/types/agent_instructions.md | 6 + .../julep/api/types/chat_ml_message.md | 4 +- .../julep/api/types/chat_ml_message_role.md | 2 +- .../julep/api/types/chat_response.md | 6 +- .../create_agent_request_instructions.md | 6 + .../julep/api/types/create_doc.md | 6 +- .../julep/api/types/create_doc_content.md | 6 + docs/python-sdk-docs/julep/api/types/doc.md | 6 +- .../julep/api/types/doc_content.md | 6 + .../julep/api/types/doc_ids.md | 38 + docs/python-sdk-docs/julep/api/types/index.md | 7 + .../julep/api/types/input_chat_ml_message.md | 4 +- .../api/types/input_chat_ml_message_role.md | 5 +- .../types/patch_agent_request_instructions.md | 6 + .../update_agent_request_instructions.md | 6 + docs/python-sdk-docs/julep/managers/doc.md | 28 +- .../python-sdk-docs/julep/managers/session.md | 64 +- docs/python-sdk-docs/julep/managers/tool.md | 38 +- mock_openapi.yaml | 245 +- openapi.yaml | 9 +- sdks/postman/collection.json | 14 +- sdks/python/julep/api/__init__.py | 6 + sdks/python/julep/api/client.py | 4 - sdks/python/julep/api/types/__init__.py | 6 + sdks/python/julep/api/types/chat_response.py | 2 + sdks/python/julep/api/types/create_doc.py | 3 +- .../julep/api/types/create_doc_content.py | 5 + sdks/python/julep/api/types/doc.py | 3 +- sdks/python/julep/api/types/doc_content.py | 5 + sdks/python/julep/api/types/doc_ids.py | 37 + sdks/python/poetry.lock | 478 ++-- sdks/python/pyproject.toml | 2 +- sdks/ts/package-lock.json | 4 +- sdks/ts/package.json | 4 +- sdks/ts/src/api/index.ts | 2 + sdks/ts/src/api/models/ChatResponse.ts | 2 + sdks/ts/src/api/models/CreateDoc.ts | 2 +- sdks/ts/src/api/models/Doc.ts | 2 +- sdks/ts/src/api/models/DocIds.ts | 8 + sdks/ts/src/api/schemas/$ChatResponse.ts | 4 + sdks/ts/src/api/schemas/$CreateDoc.ts | 15 +- sdks/ts/src/api/schemas/$Doc.ts | 15 +- sdks/ts/src/api/schemas/$DocIds.ts | 22 + 191 files changed, 6198 insertions(+), 3284 deletions(-) delete mode 100644 docs/js-sdk-docs/classes/api.BaseHttpRequest.md rename docs/js-sdk-docs/classes/{api.ApiError.md => api_core_ApiError.ApiError.md} (63%) create mode 100644 docs/js-sdk-docs/classes/api_core_AxiosHttpRequest.AxiosHttpRequest.md create mode 100644 docs/js-sdk-docs/classes/api_core_BaseHttpRequest.BaseHttpRequest.md rename docs/js-sdk-docs/classes/{api.CancelError.md => api_core_CancelablePromise.CancelError.md} (67%) rename docs/js-sdk-docs/classes/{api.CancelablePromise.md => api_core_CancelablePromise.CancelablePromise.md} (66%) rename docs/js-sdk-docs/classes/{api.DefaultService.md => api_services_DefaultService.DefaultService.md} (52%) create mode 100644 docs/js-sdk-docs/classes/client.Client.md create mode 100644 docs/js-sdk-docs/interfaces/api_core_CancelablePromise.OnCancel.md create mode 100644 docs/js-sdk-docs/modules/api_core_ApiError.md create mode 100644 docs/js-sdk-docs/modules/api_core_ApiRequestOptions.md create mode 100644 docs/js-sdk-docs/modules/api_core_ApiResult.md create mode 100644 docs/js-sdk-docs/modules/api_core_AxiosHttpRequest.md create mode 100644 docs/js-sdk-docs/modules/api_core_BaseHttpRequest.md create mode 100644 docs/js-sdk-docs/modules/api_core_CancelablePromise.md create mode 100644 docs/js-sdk-docs/modules/api_core_OpenAPI.md create mode 100644 docs/js-sdk-docs/modules/api_core_request.md create mode 100644 docs/js-sdk-docs/modules/api_models_Agent.md create mode 100644 docs/js-sdk-docs/modules/api_models_AgentDefaultSettings.md create mode 100644 docs/js-sdk-docs/modules/api_models_ChatInput.md create mode 100644 docs/js-sdk-docs/modules/api_models_ChatInputData.md create mode 100644 docs/js-sdk-docs/modules/api_models_ChatMLMessage.md create mode 100644 docs/js-sdk-docs/modules/api_models_ChatResponse.md create mode 100644 docs/js-sdk-docs/modules/api_models_ChatSettings.md create mode 100644 docs/js-sdk-docs/modules/api_models_CompletionUsage.md create mode 100644 docs/js-sdk-docs/modules/api_models_CreateAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_CreateDoc.md create mode 100644 docs/js-sdk-docs/modules/api_models_CreateSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_CreateToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_CreateUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_Doc.md create mode 100644 docs/js-sdk-docs/modules/api_models_DocIds.md create mode 100644 docs/js-sdk-docs/modules/api_models_FunctionCallOption.md create mode 100644 docs/js-sdk-docs/modules/api_models_FunctionDef.md create mode 100644 docs/js-sdk-docs/modules/api_models_FunctionParameters.md create mode 100644 docs/js-sdk-docs/modules/api_models_InputChatMLMessage.md create mode 100644 docs/js-sdk-docs/modules/api_models_JobStatus.md create mode 100644 docs/js-sdk-docs/modules/api_models_Memory.md create mode 100644 docs/js-sdk-docs/modules/api_models_MemoryAccessOptions.md create mode 100644 docs/js-sdk-docs/modules/api_models_NamedToolChoice.md create mode 100644 docs/js-sdk-docs/modules/api_models_PartialFunctionDef.md create mode 100644 docs/js-sdk-docs/modules/api_models_PatchAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_PatchSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_PatchToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_PatchUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_ResourceCreatedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_models_ResourceDeletedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_models_ResourceUpdatedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_models_Session.md create mode 100644 docs/js-sdk-docs/modules/api_models_Suggestion.md create mode 100644 docs/js-sdk-docs/modules/api_models_Tool.md create mode 100644 docs/js-sdk-docs/modules/api_models_ToolChoiceOption.md create mode 100644 docs/js-sdk-docs/modules/api_models_UpdateAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_UpdateSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_UpdateToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_UpdateUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_models_User.md create mode 100644 docs/js-sdk-docs/modules/api_models_agent_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_doc_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_job_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_memory_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_message_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_session_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_tool_id.md create mode 100644 docs/js-sdk-docs/modules/api_models_user_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Agent.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__AgentDefaultSettings.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ChatInput.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ChatInputData.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ChatMLMessage.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ChatResponse.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ChatSettings.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CompletionUsage.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CreateAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CreateDoc.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CreateSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CreateToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__CreateUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Doc.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__DocIds.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__FunctionCallOption.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__FunctionDef.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__FunctionParameters.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__InputChatMLMessage.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__JobStatus.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Memory.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__MemoryAccessOptions.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__NamedToolChoice.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__PartialFunctionDef.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__PatchAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__PatchSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__PatchToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__PatchUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ResourceCreatedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ResourceDeletedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ResourceUpdatedResponse.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Session.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Suggestion.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__Tool.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__ToolChoiceOption.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__UpdateAgentRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__UpdateSessionRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__UpdateToolRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__UpdateUserRequest.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__User.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__agent_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__doc_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__job_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__memory_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__message_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__session_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__tool_id.md create mode 100644 docs/js-sdk-docs/modules/api_schemas__user_id.md create mode 100644 docs/js-sdk-docs/modules/api_services_DefaultService.md create mode 100644 docs/js-sdk-docs/modules/client.md create mode 100644 docs/js-sdk-docs/modules/env.md create mode 100644 docs/js-sdk-docs/modules/index.md create mode 100644 docs/python-sdk-docs/julep/api/types/agent_instructions.md create mode 100644 docs/python-sdk-docs/julep/api/types/create_agent_request_instructions.md create mode 100644 docs/python-sdk-docs/julep/api/types/create_doc_content.md create mode 100644 docs/python-sdk-docs/julep/api/types/doc_content.md create mode 100644 docs/python-sdk-docs/julep/api/types/doc_ids.md create mode 100644 docs/python-sdk-docs/julep/api/types/patch_agent_request_instructions.md create mode 100644 docs/python-sdk-docs/julep/api/types/update_agent_request_instructions.md create mode 100644 sdks/python/julep/api/types/create_doc_content.py create mode 100644 sdks/python/julep/api/types/doc_content.py create mode 100644 sdks/python/julep/api/types/doc_ids.py create mode 100644 sdks/ts/src/api/models/DocIds.ts create mode 100644 sdks/ts/src/api/schemas/$DocIds.ts diff --git a/agents-api/agents_api/autogen/openapi_model.py b/agents-api/agents_api/autogen/openapi_model.py index 786aba3d3..3dad60a2e 100644 --- a/agents-api/agents_api/autogen/openapi_model.py +++ b/agents-api/agents_api/autogen/openapi_model.py @@ -1,6 +1,6 @@ # generated by datamodel-codegen: # filename: openapi.yaml -# timestamp: 2024-05-09T11:41:12+00:00 +# timestamp: 2024-05-16T13:06:33+00:00 from __future__ import annotations @@ -585,12 +585,16 @@ class AgentDefaultSettings(BaseModel): """ +class ContentItem(RootModel[str]): + root: Annotated[str, Field(min_length=1)] + + class Doc(BaseModel): title: str """ Title describing what this bit of information contains """ - content: str + content: List[ContentItem] | str """ Information content """ @@ -608,10 +612,6 @@ class Doc(BaseModel): """ -class ContentItem(RootModel[str]): - root: Annotated[str, Field(min_length=1)] - - class CreateDoc(BaseModel): title: str """ diff --git a/agents-api/poetry.lock b/agents-api/poetry.lock index 19652e4a6..e11669da7 100644 --- a/agents-api/poetry.lock +++ b/agents-api/poetry.lock @@ -812,13 +812,13 @@ files = [ [[package]] name = "fsspec" -version = "2024.3.1" +version = "2024.5.0" description = "File-system specification" optional = false python-versions = ">=3.8" files = [ - {file = "fsspec-2024.3.1-py3-none-any.whl", hash = "sha256:918d18d41bf73f0e2b261824baeb1b124bcf771767e3a26425cd7dec3332f512"}, - {file = "fsspec-2024.3.1.tar.gz", hash = "sha256:f39780e282d7d117ffb42bb96992f8a90795e4d0fb0f661a70ca39fe9c43ded9"}, + {file = "fsspec-2024.5.0-py3-none-any.whl", hash = "sha256:e0fdbc446d67e182f49a70b82cf7889028a63588fde6b222521f10937b2b670c"}, + {file = "fsspec-2024.5.0.tar.gz", hash = "sha256:1d021b0b0f933e3b3029ed808eb400c08ba101ca2de4b3483fbc9ca23fcee94a"}, ] [package.extras] @@ -826,7 +826,7 @@ abfs = ["adlfs"] adl = ["adlfs"] arrow = ["pyarrow (>=1)"] dask = ["dask", "distributed"] -devel = ["pytest", "pytest-cov"] +dev = ["pre-commit", "ruff"] dropbox = ["dropbox", "dropboxdrivefs", "requests"] full = ["adlfs", "aiohttp (!=4.0.0a0,!=4.0.0a1)", "dask", "distributed", "dropbox", "dropboxdrivefs", "fusepy", "gcsfs", "libarchive-c", "ocifs", "panel", "paramiko", "pyarrow (>=1)", "pygit2", "requests", "s3fs", "smbprotocol", "tqdm"] fuse = ["fusepy"] @@ -843,16 +843,20 @@ s3 = ["s3fs"] sftp = ["paramiko"] smb = ["smbprotocol"] ssh = ["paramiko"] +test = ["aiohttp (!=4.0.0a0,!=4.0.0a1)", "numpy", "pytest", "pytest-asyncio (!=0.22.0)", "pytest-benchmark", "pytest-cov", "pytest-mock", "pytest-recording", "pytest-rerunfailures", "requests"] +test-downstream = ["aiobotocore (>=2.5.4,<3.0.0)", "dask-expr", "dask[dataframe,test]", "moto[server] (>4,<5)", "pytest-timeout", "xarray"] +test-full = ["adlfs", "aiohttp (!=4.0.0a0,!=4.0.0a1)", "cloudpickle", "dask", "distributed", "dropbox", "dropboxdrivefs", "fastparquet", "fusepy", "gcsfs", "jinja2", "kerchunk", "libarchive-c", "lz4", "notebook", "numpy", "ocifs", "pandas", "panel", "paramiko", "pyarrow", "pyarrow (>=1)", "pyftpdlib", "pygit2", "pytest", "pytest-asyncio (!=0.22.0)", "pytest-benchmark", "pytest-cov", "pytest-mock", "pytest-recording", "pytest-rerunfailures", "python-snappy", "requests", "smbprotocol", "tqdm", "urllib3", "zarr", "zstandard"] tqdm = ["tqdm"] [[package]] name = "genson" -version = "1.2.2" +version = "1.3.0" description = "GenSON is a powerful, user-friendly JSON Schema generator." optional = false python-versions = "*" files = [ - {file = "genson-1.2.2.tar.gz", hash = "sha256:8caf69aa10af7aee0e1a1351d1d06801f4696e005f06cedef438635384346a16"}, + {file = "genson-1.3.0-py3-none-any.whl", hash = "sha256:468feccd00274cc7e4c09e84b08704270ba8d95232aa280f65b986139cec67f7"}, + {file = "genson-1.3.0.tar.gz", hash = "sha256:e02db9ac2e3fd29e65b5286f7135762e2cd8a986537c075b06fc5f1517308e37"}, ] [[package]] @@ -905,13 +909,13 @@ requests = ["requests (>=2.20.0,<3.0.0.dev0)"] [[package]] name = "google-cloud-aiplatform" -version = "1.49.0" +version = "1.51.0" description = "Vertex AI API client library" optional = false python-versions = ">=3.8" files = [ - {file = "google-cloud-aiplatform-1.49.0.tar.gz", hash = "sha256:e6e6d01079bb5def49e4be4db4d12b13c624b5c661079c869c13c855e5807429"}, - {file = "google_cloud_aiplatform-1.49.0-py2.py3-none-any.whl", hash = "sha256:8072d9e0c18d8942c704233d1a93b8d6312fc7b278786a283247950e28ae98df"}, + {file = "google-cloud-aiplatform-1.51.0.tar.gz", hash = "sha256:901993b4d14392452699c14cf23d72c01c5488ee36a7e00b23195e64d7d2f5ec"}, + {file = "google_cloud_aiplatform-1.51.0-py2.py3-none-any.whl", hash = "sha256:f2d3ff231454fe397f02fce1358680dea76ed7c74fc42e6c7e1aa1acb1648df3"}, ] [package.dependencies] @@ -933,8 +937,8 @@ cloud-profiler = ["tensorboard-plugin-profile (>=2.4.0,<3.0.0dev)", "tensorflow datasets = ["pyarrow (>=10.0.1)", "pyarrow (>=14.0.0)", "pyarrow (>=3.0.0,<8.0dev)"] endpoint = ["requests (>=2.28.1)"] full = ["cloudpickle (<3.0)", "docker (>=5.0.3)", "explainable-ai-sdk (>=1.0.0)", "fastapi (>=0.71.0,<=0.109.1)", "google-cloud-bigquery", "google-cloud-bigquery-storage", "google-cloud-logging (<4.0)", "google-vizier (>=0.1.6)", "httpx (>=0.23.0,<0.25.0)", "immutabledict", "lit-nlp (==0.4.0)", "mlflow (>=1.27.0,<=2.1.1)", "nest-asyncio (>=1.0.0,<1.6.0)", "numpy (>=1.15.0)", "pandas (>=1.0.0)", "pandas (>=1.0.0,<2.2.0)", "pyarrow (>=10.0.1)", "pyarrow (>=14.0.0)", "pyarrow (>=3.0.0,<8.0dev)", "pyarrow (>=6.0.1)", "pydantic (<2)", "pyyaml (>=5.3.1,<7)", "ray[default] (>=2.4,<2.5.dev0 || >2.9.0,!=2.9.1,!=2.9.2,<=2.9.3)", "ray[default] (>=2.5,<=2.9.3)", "requests (>=2.28.1)", "starlette (>=0.17.1)", "tensorflow (>=2.3.0,<3.0.0dev)", "tensorflow (>=2.3.0,<3.0.0dev)", "urllib3 (>=1.21.1,<1.27)", "uvicorn[standard] (>=0.16.0)"] -langchain = ["langchain (>=0.1.13,<0.2)", "langchain-core (<0.2)", "langchain-google-vertexai (<0.2)"] -langchain-testing = ["absl-py", "cloudpickle (>=2.2.1,<3.0)", "langchain (>=0.1.13,<0.2)", "langchain-core (<0.2)", "langchain-google-vertexai (<0.2)", "pydantic (>=2.6.3,<3)", "pytest-xdist"] +langchain = ["langchain (>=0.1.16,<0.2)", "langchain-core (<0.2)", "langchain-google-vertexai (<2)"] +langchain-testing = ["absl-py", "cloudpickle (>=2.2.1,<3.0)", "langchain (>=0.1.16,<0.2)", "langchain-core (<0.2)", "langchain-google-vertexai (<2)", "pydantic (>=2.6.3,<3)", "pytest-xdist"] lit = ["explainable-ai-sdk (>=1.0.0)", "lit-nlp (==0.4.0)", "pandas (>=1.0.0)", "tensorflow (>=2.3.0,<3.0.0dev)"] metadata = ["numpy (>=1.15.0)", "pandas (>=1.0.0)"] pipelines = ["pyyaml (>=5.3.1,<7)"] @@ -952,13 +956,13 @@ xai = ["tensorflow (>=2.3.0,<3.0.0dev)"] [[package]] name = "google-cloud-bigquery" -version = "3.21.0" +version = "3.22.0" description = "Google BigQuery API client library" optional = false python-versions = ">=3.7" files = [ - {file = "google-cloud-bigquery-3.21.0.tar.gz", hash = "sha256:6265c39f9d5bdf50f11cb81a9c2a0605d285df34ac139de0d2333b1250add0ff"}, - {file = "google_cloud_bigquery-3.21.0-py2.py3-none-any.whl", hash = "sha256:83a090aae16b3a687ef22e7b0a1b551e18da615b1c4855c5f312f198959e7739"}, + {file = "google-cloud-bigquery-3.22.0.tar.gz", hash = "sha256:957591e6f948d7cb4aa0f7a8e4e47b4617cd7f0269e28a71c37953c39b6e8a4c"}, + {file = "google_cloud_bigquery-3.22.0-py2.py3-none-any.whl", hash = "sha256:80c8e31a23b68b7d3ae5d138c9a9edff69d100ee812db73a5e63c79a13a5063d"}, ] [package.dependencies] @@ -1303,13 +1307,13 @@ socks = ["socksio (==1.*)"] [[package]] name = "huggingface-hub" -version = "0.22.2" +version = "0.23.0" description = "Client library to download and publish models, datasets and other repos on the huggingface.co hub" optional = false python-versions = ">=3.8.0" files = [ - {file = "huggingface_hub-0.22.2-py3-none-any.whl", hash = "sha256:3429e25f38ccb834d310804a3b711e7e4953db5a9e420cc147a5e194ca90fd17"}, - {file = "huggingface_hub-0.22.2.tar.gz", hash = "sha256:32e9a9a6843c92f253ff9ca16b9985def4d80a93fb357af5353f770ef74a81be"}, + {file = "huggingface_hub-0.23.0-py3-none-any.whl", hash = "sha256:075c30d48ee7db2bba779190dc526d2c11d422aed6f9044c5e2fdc2c432fdb91"}, + {file = "huggingface_hub-0.23.0.tar.gz", hash = "sha256:7126dedd10a4c6fac796ced4d87a8cf004efc722a5125c2c09299017fa366fa9"}, ] [package.dependencies] @@ -1322,16 +1326,16 @@ tqdm = ">=4.42.1" typing-extensions = ">=3.7.4.3" [package.extras] -all = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "gradio", "jedi", "minijinja (>=1.0)", "mypy (==1.5.1)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "ruff (>=0.3.0)", "soundfile", "types-PyYAML", "types-requests", "types-simplejson", "types-toml", "types-tqdm", "types-urllib3", "typing-extensions (>=4.8.0)", "urllib3 (<2.0)"] +all = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "fastapi", "gradio", "jedi", "minijinja (>=1.0)", "mypy (==1.5.1)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "ruff (>=0.3.0)", "soundfile", "types-PyYAML", "types-requests", "types-simplejson", "types-toml", "types-tqdm", "types-urllib3", "typing-extensions (>=4.8.0)", "urllib3 (<2.0)"] cli = ["InquirerPy (==0.3.4)"] -dev = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "gradio", "jedi", "minijinja (>=1.0)", "mypy (==1.5.1)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "ruff (>=0.3.0)", "soundfile", "types-PyYAML", "types-requests", "types-simplejson", "types-toml", "types-tqdm", "types-urllib3", "typing-extensions (>=4.8.0)", "urllib3 (<2.0)"] +dev = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "fastapi", "gradio", "jedi", "minijinja (>=1.0)", "mypy (==1.5.1)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "ruff (>=0.3.0)", "soundfile", "types-PyYAML", "types-requests", "types-simplejson", "types-toml", "types-tqdm", "types-urllib3", "typing-extensions (>=4.8.0)", "urllib3 (<2.0)"] fastai = ["fastai (>=2.4)", "fastcore (>=1.3.27)", "toml"] hf-transfer = ["hf-transfer (>=0.1.4)"] inference = ["aiohttp", "minijinja (>=1.0)"] quality = ["mypy (==1.5.1)", "ruff (>=0.3.0)"] tensorflow = ["graphviz", "pydot", "tensorflow"] tensorflow-testing = ["keras (<3.0)", "tensorflow"] -testing = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "gradio", "jedi", "minijinja (>=1.0)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "soundfile", "urllib3 (<2.0)"] +testing = ["InquirerPy (==0.3.4)", "Jinja2", "Pillow", "aiohttp", "fastapi", "gradio", "jedi", "minijinja (>=1.0)", "numpy", "pytest", "pytest-asyncio", "pytest-cov", "pytest-env", "pytest-rerunfailures", "pytest-vcr", "pytest-xdist", "soundfile", "urllib3 (<2.0)"] torch = ["safetensors", "torch"] typing = ["types-PyYAML", "types-requests", "types-simplejson", "types-toml", "types-tqdm", "types-urllib3", "typing-extensions (>=4.8.0)"] @@ -1478,13 +1482,13 @@ testing = ["Django", "attrs", "colorama", "docopt", "pytest (<7.0.0)"] [[package]] name = "jinja2" -version = "3.1.3" +version = "3.1.4" description = "A very fast and expressive template engine." optional = false python-versions = ">=3.7" files = [ - {file = "Jinja2-3.1.3-py3-none-any.whl", hash = "sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa"}, - {file = "Jinja2-3.1.3.tar.gz", hash = "sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90"}, + {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"}, + {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"}, ] [package.dependencies] @@ -1602,13 +1606,13 @@ dev = ["Sphinx (>=5.1.1)", "black (==23.12.1)", "build (>=0.10.0)", "coverage (> [[package]] name = "litellm" -version = "1.37.3" +version = "1.37.12" description = "Library to easily interface with LLM API providers" optional = false python-versions = "!=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3.8" files = [ - {file = "litellm-1.37.3-py3-none-any.whl", hash = "sha256:d90148c9e49afedb5fb6cd76b3bf125847b4ff732270ef8af723c9a8b13c58f9"}, - {file = "litellm-1.37.3.tar.gz", hash = "sha256:93f0c849ca8f658da1f37c3aa337f39d3193fbef1de6300fc2ffb410ea3f6c93"}, + {file = "litellm-1.37.12-py3-none-any.whl", hash = "sha256:5b42b3c98e329a24f48112f488dd1c5e4c635fb5b1a098b50c2cab789cb08172"}, + {file = "litellm-1.37.12.tar.gz", hash = "sha256:2188991e9aa903c9adcec9a265b58ad3b6d9acbe0b0f194b3321d69fa4102729"}, ] [package.dependencies] @@ -1624,7 +1628,7 @@ tokenizers = "*" [package.extras] extra-proxy = ["azure-identity (>=1.15.0,<2.0.0)", "azure-keyvault-secrets (>=4.8.0,<5.0.0)", "google-cloud-kms (>=2.21.3,<3.0.0)", "prisma (==0.11.0)", "resend (>=0.8.0,<0.9.0)"] -proxy = ["PyJWT (>=2.8.0,<3.0.0)", "apscheduler (>=3.10.4,<4.0.0)", "backoff", "cryptography (>=42.0.5,<43.0.0)", "fastapi (>=0.109.1,<0.110.0)", "fastapi-sso (>=0.10.0,<0.11.0)", "gunicorn (>=22.0.0,<23.0.0)", "orjson (>=3.9.7,<4.0.0)", "python-multipart (>=0.0.9,<0.0.10)", "pyyaml (>=6.0.1,<7.0.0)", "rq", "uvicorn (>=0.22.0,<0.23.0)"] +proxy = ["PyJWT (>=2.8.0,<3.0.0)", "apscheduler (>=3.10.4,<4.0.0)", "backoff", "cryptography (>=42.0.5,<43.0.0)", "fastapi (>=0.111.0,<0.112.0)", "fastapi-sso (>=0.10.0,<0.11.0)", "gunicorn (>=22.0.0,<23.0.0)", "orjson (>=3.9.7,<4.0.0)", "python-multipart (>=0.0.9,<0.0.10)", "pyyaml (>=6.0.1,<7.0.0)", "rq", "uvicorn (>=0.22.0,<0.23.0)"] [[package]] name = "markdown-it-py" @@ -1721,13 +1725,13 @@ files = [ [[package]] name = "marshmallow" -version = "3.21.1" +version = "3.21.2" description = "A lightweight library for converting complex datatypes to and from native Python datatypes." optional = false python-versions = ">=3.8" files = [ - {file = "marshmallow-3.21.1-py3-none-any.whl", hash = "sha256:f085493f79efb0644f270a9bf2892843142d80d7174bbbd2f3713f2a589dc633"}, - {file = "marshmallow-3.21.1.tar.gz", hash = "sha256:4e65e9e0d80fc9e609574b9983cf32579f305c718afb30d7233ab818571768c3"}, + {file = "marshmallow-3.21.2-py3-none-any.whl", hash = "sha256:70b54a6282f4704d12c0a41599682c5c5450e843b9ec406308653b47c59648a1"}, + {file = "marshmallow-3.21.2.tar.gz", hash = "sha256:82408deadd8b33d56338d2182d455db632c6313aa2af61916672146bb32edc56"}, ] [package.dependencies] @@ -1735,7 +1739,7 @@ packaging = ">=17.0" [package.extras] dev = ["marshmallow[tests]", "pre-commit (>=3.5,<4.0)", "tox"] -docs = ["alabaster (==0.7.16)", "autodocsumm (==0.2.12)", "sphinx (==7.2.6)", "sphinx-issues (==4.0.0)", "sphinx-version-warning (==1.1.2)"] +docs = ["alabaster (==0.7.16)", "autodocsumm (==0.2.12)", "sphinx (==7.3.7)", "sphinx-issues (==4.1.0)", "sphinx-version-warning (==1.1.2)"] tests = ["pytest", "pytz", "simplejson"] [[package]] @@ -2017,13 +2021,13 @@ files = [ [[package]] name = "openai" -version = "1.25.0" +version = "1.30.1" description = "The official Python library for the openai API" optional = false python-versions = ">=3.7.1" files = [ - {file = "openai-1.25.0-py3-none-any.whl", hash = "sha256:d0cfdf6afb31a5dabf3b95966cb31f3c757a0edaf3228715409cb404b9933de0"}, - {file = "openai-1.25.0.tar.gz", hash = "sha256:22c35b26b8281cd2759b1a4c05ac99e2f2b26a9df71f90a0b4ddb75aa27adc81"}, + {file = "openai-1.30.1-py3-none-any.whl", hash = "sha256:c9fb3c3545c118bbce8deb824397b9433a66d0d0ede6a96f7009c95b76de4a46"}, + {file = "openai-1.30.1.tar.gz", hash = "sha256:4f85190e577cba0b066e1950b8eb9b11d25bc7ebcc43a86b326ce1bfa564ec74"}, ] [package.dependencies] @@ -2171,13 +2175,13 @@ ptyprocess = ">=0.5" [[package]] name = "platformdirs" -version = "4.2.1" +version = "4.2.2" description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`." optional = false python-versions = ">=3.8" files = [ - {file = "platformdirs-4.2.1-py3-none-any.whl", hash = "sha256:17d5a1161b3fd67b390023cb2d3b026bbd40abde6fdb052dfbd3a29c3ba22ee1"}, - {file = "platformdirs-4.2.1.tar.gz", hash = "sha256:031cd18d4ec63ec53e82dceaac0417d218a6863f7745dfcc9efe7793b7039bdf"}, + {file = "platformdirs-4.2.2-py3-none-any.whl", hash = "sha256:2d7a1657e36a80ea911db832a8a6ece5ee53d8de21edd5cc5879af6530b1bfee"}, + {file = "platformdirs-4.2.2.tar.gz", hash = "sha256:38b7b51f512eed9e84a22788b4bce1de17c0adb134d6becb09836e37d8654cd3"}, ] [package.extras] @@ -2492,17 +2496,16 @@ tests = ["black", "chardet", "tox"] [[package]] name = "pygments" -version = "2.17.2" +version = "2.18.0" description = "Pygments is a syntax highlighting package written in Python." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, - {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, + {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"}, + {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"}, ] [package.extras] -plugins = ["importlib-metadata"] windows-terminal = ["colorama (>=0.4.6)"] [[package]] @@ -2674,13 +2677,13 @@ files = [ [[package]] name = "referencing" -version = "0.35.0" +version = "0.35.1" description = "JSON Referencing + Python" optional = false python-versions = ">=3.8" files = [ - {file = "referencing-0.35.0-py3-none-any.whl", hash = "sha256:8080727b30e364e5783152903672df9b6b091c926a146a759080b62ca3126cd6"}, - {file = "referencing-0.35.0.tar.gz", hash = "sha256:191e936b0c696d0af17ad7430a3dc68e88bc11be6514f4757dc890f04ab05889"}, + {file = "referencing-0.35.1-py3-none-any.whl", hash = "sha256:eda6d3234d62814d1c64e305c1331c9a3a6132da475ab6382eaa997b21ee75de"}, + {file = "referencing-0.35.1.tar.gz", hash = "sha256:25b42124a6c8b632a425174f24087783efb348a6f1e0008e63cd4466fedf703c"}, ] [package.dependencies] @@ -2689,90 +2692,90 @@ rpds-py = ">=0.7.0" [[package]] name = "regex" -version = "2024.4.28" +version = "2024.5.15" description = "Alternative regular expression module, to replace re." optional = false python-versions = ">=3.8" files = [ - {file = "regex-2024.4.28-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:cd196d056b40af073d95a2879678585f0b74ad35190fac04ca67954c582c6b61"}, - {file = "regex-2024.4.28-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:8bb381f777351bd534462f63e1c6afb10a7caa9fa2a421ae22c26e796fe31b1f"}, - {file = "regex-2024.4.28-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:47af45b6153522733aa6e92543938e97a70ce0900649ba626cf5aad290b737b6"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:99d6a550425cc51c656331af0e2b1651e90eaaa23fb4acde577cf15068e2e20f"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bf29304a8011feb58913c382902fde3395957a47645bf848eea695839aa101b7"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:92da587eee39a52c91aebea8b850e4e4f095fe5928d415cb7ed656b3460ae79a"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6277d426e2f31bdbacb377d17a7475e32b2d7d1f02faaecc48d8e370c6a3ff31"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:28e1f28d07220c0f3da0e8fcd5a115bbb53f8b55cecf9bec0c946eb9a059a94c"}, - {file = "regex-2024.4.28-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:aaa179975a64790c1f2701ac562b5eeb733946eeb036b5bcca05c8d928a62f10"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:6f435946b7bf7a1b438b4e6b149b947c837cb23c704e780c19ba3e6855dbbdd3"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:19d6c11bf35a6ad077eb23852827f91c804eeb71ecb85db4ee1386825b9dc4db"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:fdae0120cddc839eb8e3c15faa8ad541cc6d906d3eb24d82fb041cfe2807bc1e"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:e672cf9caaf669053121f1766d659a8813bd547edef6e009205378faf45c67b8"}, - {file = "regex-2024.4.28-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:f57515750d07e14743db55d59759893fdb21d2668f39e549a7d6cad5d70f9fea"}, - {file = "regex-2024.4.28-cp310-cp310-win32.whl", hash = "sha256:a1409c4eccb6981c7baabc8888d3550df518add6e06fe74fa1d9312c1838652d"}, - {file = "regex-2024.4.28-cp310-cp310-win_amd64.whl", hash = "sha256:1f687a28640f763f23f8a9801fe9e1b37338bb1ca5d564ddd41619458f1f22d1"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:84077821c85f222362b72fdc44f7a3a13587a013a45cf14534df1cbbdc9a6796"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b45d4503de8f4f3dc02f1d28a9b039e5504a02cc18906cfe744c11def942e9eb"}, - {file = "regex-2024.4.28-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:457c2cd5a646dd4ed536c92b535d73548fb8e216ebee602aa9f48e068fc393f3"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2b51739ddfd013c6f657b55a508de8b9ea78b56d22b236052c3a85a675102dc6"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:459226445c7d7454981c4c0ce0ad1a72e1e751c3e417f305722bbcee6697e06a"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:670fa596984b08a4a769491cbdf22350431970d0112e03d7e4eeaecaafcd0fec"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fe00f4fe11c8a521b173e6324d862ee7ee3412bf7107570c9b564fe1119b56fb"}, - {file = "regex-2024.4.28-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:36f392dc7763fe7924575475736bddf9ab9f7a66b920932d0ea50c2ded2f5636"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:23a412b7b1a7063f81a742463f38821097b6a37ce1e5b89dd8e871d14dbfd86b"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:f1d6e4b7b2ae3a6a9df53efbf199e4bfcff0959dbdb5fd9ced34d4407348e39a"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:499334ad139557de97cbc4347ee921c0e2b5e9c0f009859e74f3f77918339257"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:0940038bec2fe9e26b203d636c44d31dd8766abc1fe66262da6484bd82461ccf"}, - {file = "regex-2024.4.28-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:66372c2a01782c5fe8e04bff4a2a0121a9897e19223d9eab30c54c50b2ebeb7f"}, - {file = "regex-2024.4.28-cp311-cp311-win32.whl", hash = "sha256:c77d10ec3c1cf328b2f501ca32583625987ea0f23a0c2a49b37a39ee5c4c4630"}, - {file = "regex-2024.4.28-cp311-cp311-win_amd64.whl", hash = "sha256:fc0916c4295c64d6890a46e02d4482bb5ccf33bf1a824c0eaa9e83b148291f90"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:08a1749f04fee2811c7617fdd46d2e46d09106fa8f475c884b65c01326eb15c5"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b8eb28995771c087a73338f695a08c9abfdf723d185e57b97f6175c5051ff1ae"}, - {file = "regex-2024.4.28-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:dd7ef715ccb8040954d44cfeff17e6b8e9f79c8019daae2fd30a8806ef5435c0"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb0315a2b26fde4005a7c401707c5352df274460f2f85b209cf6024271373013"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f2fc053228a6bd3a17a9b0a3f15c3ab3cf95727b00557e92e1cfe094b88cc662"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7fe9739a686dc44733d52d6e4f7b9c77b285e49edf8570754b322bca6b85b4cc"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a74fcf77d979364f9b69fcf8200849ca29a374973dc193a7317698aa37d8b01c"}, - {file = "regex-2024.4.28-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:965fd0cf4694d76f6564896b422724ec7b959ef927a7cb187fc6b3f4e4f59833"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:2fef0b38c34ae675fcbb1b5db760d40c3fc3612cfa186e9e50df5782cac02bcd"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bc365ce25f6c7c5ed70e4bc674f9137f52b7dd6a125037f9132a7be52b8a252f"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:ac69b394764bb857429b031d29d9604842bc4cbfd964d764b1af1868eeebc4f0"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:144a1fc54765f5c5c36d6d4b073299832aa1ec6a746a6452c3ee7b46b3d3b11d"}, - {file = "regex-2024.4.28-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2630ca4e152c221072fd4a56d4622b5ada876f668ecd24d5ab62544ae6793ed6"}, - {file = "regex-2024.4.28-cp312-cp312-win32.whl", hash = "sha256:7f3502f03b4da52bbe8ba962621daa846f38489cae5c4a7b5d738f15f6443d17"}, - {file = "regex-2024.4.28-cp312-cp312-win_amd64.whl", hash = "sha256:0dd3f69098511e71880fb00f5815db9ed0ef62c05775395968299cb400aeab82"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:374f690e1dd0dbdcddea4a5c9bdd97632cf656c69113f7cd6a361f2a67221cb6"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:25f87ae6b96374db20f180eab083aafe419b194e96e4f282c40191e71980c666"}, - {file = "regex-2024.4.28-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:5dbc1bcc7413eebe5f18196e22804a3be1bfdfc7e2afd415e12c068624d48247"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f85151ec5a232335f1be022b09fbbe459042ea1951d8a48fef251223fc67eee1"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:57ba112e5530530fd175ed550373eb263db4ca98b5f00694d73b18b9a02e7185"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:224803b74aab56aa7be313f92a8d9911dcade37e5f167db62a738d0c85fdac4b"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a54a047b607fd2d2d52a05e6ad294602f1e0dec2291152b745870afc47c1397"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a2a512d623f1f2d01d881513af9fc6a7c46e5cfffb7dc50c38ce959f9246c94"}, - {file = "regex-2024.4.28-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:c06bf3f38f0707592898428636cbb75d0a846651b053a1cf748763e3063a6925"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:1031a5e7b048ee371ab3653aad3030ecfad6ee9ecdc85f0242c57751a05b0ac4"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d7a353ebfa7154c871a35caca7bfd8f9e18666829a1dc187115b80e35a29393e"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:7e76b9cfbf5ced1aca15a0e5b6f229344d9b3123439ffce552b11faab0114a02"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:5ce479ecc068bc2a74cb98dd8dba99e070d1b2f4a8371a7dfe631f85db70fe6e"}, - {file = "regex-2024.4.28-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:7d77b6f63f806578c604dca209280e4c54f0fa9a8128bb8d2cc5fb6f99da4150"}, - {file = "regex-2024.4.28-cp38-cp38-win32.whl", hash = "sha256:d84308f097d7a513359757c69707ad339da799e53b7393819ec2ea36bc4beb58"}, - {file = "regex-2024.4.28-cp38-cp38-win_amd64.whl", hash = "sha256:2cc1b87bba1dd1a898e664a31012725e48af826bf3971e786c53e32e02adae6c"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7413167c507a768eafb5424413c5b2f515c606be5bb4ef8c5dee43925aa5718b"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:108e2dcf0b53a7c4ab8986842a8edcb8ab2e59919a74ff51c296772e8e74d0ae"}, - {file = "regex-2024.4.28-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f1c5742c31ba7d72f2dedf7968998730664b45e38827637e0f04a2ac7de2f5f1"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ecc6148228c9ae25ce403eade13a0961de1cb016bdb35c6eafd8e7b87ad028b1"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b7d893c8cf0e2429b823ef1a1d360a25950ed11f0e2a9df2b5198821832e1947"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4290035b169578ffbbfa50d904d26bec16a94526071ebec3dadbebf67a26b25e"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:44a22ae1cfd82e4ffa2066eb3390777dc79468f866f0625261a93e44cdf6482b"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fd24fd140b69f0b0bcc9165c397e9b2e89ecbeda83303abf2a072609f60239e2"}, - {file = "regex-2024.4.28-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:39fb166d2196413bead229cd64a2ffd6ec78ebab83fff7d2701103cf9f4dfd26"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:9301cc6db4d83d2c0719f7fcda37229691745168bf6ae849bea2e85fc769175d"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7c3d389e8d76a49923683123730c33e9553063d9041658f23897f0b396b2386f"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:99ef6289b62042500d581170d06e17f5353b111a15aa6b25b05b91c6886df8fc"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:b91d529b47798c016d4b4c1d06cc826ac40d196da54f0de3c519f5a297c5076a"}, - {file = "regex-2024.4.28-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:43548ad74ea50456e1c68d3c67fff3de64c6edb85bcd511d1136f9b5376fc9d1"}, - {file = "regex-2024.4.28-cp39-cp39-win32.whl", hash = "sha256:05d9b6578a22db7dedb4df81451f360395828b04f4513980b6bd7a1412c679cc"}, - {file = "regex-2024.4.28-cp39-cp39-win_amd64.whl", hash = "sha256:3986217ec830c2109875be740531feb8ddafe0dfa49767cdcd072ed7e8927962"}, - {file = "regex-2024.4.28.tar.gz", hash = "sha256:83ab366777ea45d58f72593adf35d36ca911ea8bd838483c1823b883a121b0e4"}, + {file = "regex-2024.5.15-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a81e3cfbae20378d75185171587cbf756015ccb14840702944f014e0d93ea09f"}, + {file = "regex-2024.5.15-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7b59138b219ffa8979013be7bc85bb60c6f7b7575df3d56dc1e403a438c7a3f6"}, + {file = "regex-2024.5.15-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a0bd000c6e266927cb7a1bc39d55be95c4b4f65c5be53e659537537e019232b1"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5eaa7ddaf517aa095fa8da0b5015c44d03da83f5bd49c87961e3c997daed0de7"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ba68168daedb2c0bab7fd7e00ced5ba90aebf91024dea3c88ad5063c2a562cca"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6e8d717bca3a6e2064fc3a08df5cbe366369f4b052dcd21b7416e6d71620dca1"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1337b7dbef9b2f71121cdbf1e97e40de33ff114801263b275aafd75303bd62b5"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f9ebd0a36102fcad2f03696e8af4ae682793a5d30b46c647eaf280d6cfb32796"}, + {file = "regex-2024.5.15-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:9efa1a32ad3a3ea112224897cdaeb6aa00381627f567179c0314f7b65d354c62"}, + {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:1595f2d10dff3d805e054ebdc41c124753631b6a471b976963c7b28543cf13b0"}, + {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:b802512f3e1f480f41ab5f2cfc0e2f761f08a1f41092d6718868082fc0d27143"}, + {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:a0981022dccabca811e8171f913de05720590c915b033b7e601f35ce4ea7019f"}, + {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:19068a6a79cf99a19ccefa44610491e9ca02c2be3305c7760d3831d38a467a6f"}, + {file = "regex-2024.5.15-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:1b5269484f6126eee5e687785e83c6b60aad7663dafe842b34691157e5083e53"}, + {file = "regex-2024.5.15-cp310-cp310-win32.whl", hash = "sha256:ada150c5adfa8fbcbf321c30c751dc67d2f12f15bd183ffe4ec7cde351d945b3"}, + {file = "regex-2024.5.15-cp310-cp310-win_amd64.whl", hash = "sha256:ac394ff680fc46b97487941f5e6ae49a9f30ea41c6c6804832063f14b2a5a145"}, + {file = "regex-2024.5.15-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:f5b1dff3ad008dccf18e652283f5e5339d70bf8ba7c98bf848ac33db10f7bc7a"}, + {file = "regex-2024.5.15-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c6a2b494a76983df8e3d3feea9b9ffdd558b247e60b92f877f93a1ff43d26656"}, + {file = "regex-2024.5.15-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a32b96f15c8ab2e7d27655969a23895eb799de3665fa94349f3b2fbfd547236f"}, + {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:10002e86e6068d9e1c91eae8295ef690f02f913c57db120b58fdd35a6bb1af35"}, + {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ec54d5afa89c19c6dd8541a133be51ee1017a38b412b1321ccb8d6ddbeb4cf7d"}, + {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:10e4ce0dca9ae7a66e6089bb29355d4432caed736acae36fef0fdd7879f0b0cb"}, + {file = "regex-2024.5.15-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3e507ff1e74373c4d3038195fdd2af30d297b4f0950eeda6f515ae3d84a1770f"}, + {file = "regex-2024.5.15-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d1f059a4d795e646e1c37665b9d06062c62d0e8cc3c511fe01315973a6542e40"}, + {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:0721931ad5fe0dda45d07f9820b90b2148ccdd8e45bb9e9b42a146cb4f695649"}, + {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:833616ddc75ad595dee848ad984d067f2f31be645d603e4d158bba656bbf516c"}, + {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:287eb7f54fc81546346207c533ad3c2c51a8d61075127d7f6d79aaf96cdee890"}, + {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:19dfb1c504781a136a80ecd1fff9f16dddf5bb43cec6871778c8a907a085bb3d"}, + {file = "regex-2024.5.15-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:119af6e56dce35e8dfb5222573b50c89e5508d94d55713c75126b753f834de68"}, + {file = "regex-2024.5.15-cp311-cp311-win32.whl", hash = "sha256:1c1c174d6ec38d6c8a7504087358ce9213d4332f6293a94fbf5249992ba54efa"}, + {file = "regex-2024.5.15-cp311-cp311-win_amd64.whl", hash = "sha256:9e717956dcfd656f5055cc70996ee2cc82ac5149517fc8e1b60261b907740201"}, + {file = "regex-2024.5.15-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:632b01153e5248c134007209b5c6348a544ce96c46005d8456de1d552455b014"}, + {file = "regex-2024.5.15-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:e64198f6b856d48192bf921421fdd8ad8eb35e179086e99e99f711957ffedd6e"}, + {file = "regex-2024.5.15-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:68811ab14087b2f6e0fc0c2bae9ad689ea3584cad6917fc57be6a48bbd012c49"}, + {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8ec0c2fea1e886a19c3bee0cd19d862b3aa75dcdfb42ebe8ed30708df64687a"}, + {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d0c0c0003c10f54a591d220997dd27d953cd9ccc1a7294b40a4be5312be8797b"}, + {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2431b9e263af1953c55abbd3e2efca67ca80a3de8a0437cb58e2421f8184717a"}, + {file = "regex-2024.5.15-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4a605586358893b483976cffc1723fb0f83e526e8f14c6e6614e75919d9862cf"}, + {file = "regex-2024.5.15-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:391d7f7f1e409d192dba8bcd42d3e4cf9e598f3979cdaed6ab11288da88cb9f2"}, + {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9ff11639a8d98969c863d4617595eb5425fd12f7c5ef6621a4b74b71ed8726d5"}, + {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:4eee78a04e6c67e8391edd4dad3279828dd66ac4b79570ec998e2155d2e59fd5"}, + {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:8fe45aa3f4aa57faabbc9cb46a93363edd6197cbc43523daea044e9ff2fea83e"}, + {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:d0a3d8d6acf0c78a1fff0e210d224b821081330b8524e3e2bc5a68ef6ab5803d"}, + {file = "regex-2024.5.15-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c486b4106066d502495b3025a0a7251bf37ea9540433940a23419461ab9f2a80"}, + {file = "regex-2024.5.15-cp312-cp312-win32.whl", hash = "sha256:c49e15eac7c149f3670b3e27f1f28a2c1ddeccd3a2812cba953e01be2ab9b5fe"}, + {file = "regex-2024.5.15-cp312-cp312-win_amd64.whl", hash = "sha256:673b5a6da4557b975c6c90198588181029c60793835ce02f497ea817ff647cb2"}, + {file = "regex-2024.5.15-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:87e2a9c29e672fc65523fb47a90d429b70ef72b901b4e4b1bd42387caf0d6835"}, + {file = "regex-2024.5.15-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:c3bea0ba8b73b71b37ac833a7f3fd53825924165da6a924aec78c13032f20850"}, + {file = "regex-2024.5.15-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:bfc4f82cabe54f1e7f206fd3d30fda143f84a63fe7d64a81558d6e5f2e5aaba9"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e5bb9425fe881d578aeca0b2b4b3d314ec88738706f66f219c194d67179337cb"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:64c65783e96e563103d641760664125e91bd85d8e49566ee560ded4da0d3e704"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cf2430df4148b08fb4324b848672514b1385ae3807651f3567871f130a728cc3"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5397de3219a8b08ae9540c48f602996aa6b0b65d5a61683e233af8605c42b0f2"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:455705d34b4154a80ead722f4f185b04c4237e8e8e33f265cd0798d0e44825fa"}, + {file = "regex-2024.5.15-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:b2b6f1b3bb6f640c1a92be3bbfbcb18657b125b99ecf141fb3310b5282c7d4ed"}, + {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:3ad070b823ca5890cab606c940522d05d3d22395d432f4aaaf9d5b1653e47ced"}, + {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:5b5467acbfc153847d5adb21e21e29847bcb5870e65c94c9206d20eb4e99a384"}, + {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:e6662686aeb633ad65be2a42b4cb00178b3fbf7b91878f9446075c404ada552f"}, + {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:2b4c884767504c0e2401babe8b5b7aea9148680d2e157fa28f01529d1f7fcf67"}, + {file = "regex-2024.5.15-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:3cd7874d57f13bf70078f1ff02b8b0aa48d5b9ed25fc48547516c6aba36f5741"}, + {file = "regex-2024.5.15-cp38-cp38-win32.whl", hash = "sha256:e4682f5ba31f475d58884045c1a97a860a007d44938c4c0895f41d64481edbc9"}, + {file = "regex-2024.5.15-cp38-cp38-win_amd64.whl", hash = "sha256:d99ceffa25ac45d150e30bd9ed14ec6039f2aad0ffa6bb87a5936f5782fc1569"}, + {file = "regex-2024.5.15-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:13cdaf31bed30a1e1c2453ef6015aa0983e1366fad2667657dbcac7b02f67133"}, + {file = "regex-2024.5.15-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:cac27dcaa821ca271855a32188aa61d12decb6fe45ffe3e722401fe61e323cd1"}, + {file = "regex-2024.5.15-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7dbe2467273b875ea2de38ded4eba86cbcbc9a1a6d0aa11dcf7bd2e67859c435"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:64f18a9a3513a99c4bef0e3efd4c4a5b11228b48aa80743be822b71e132ae4f5"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d347a741ea871c2e278fde6c48f85136c96b8659b632fb57a7d1ce1872547600"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1878b8301ed011704aea4c806a3cadbd76f84dece1ec09cc9e4dc934cfa5d4da"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4babf07ad476aaf7830d77000874d7611704a7fcf68c9c2ad151f5d94ae4bfc4"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:35cb514e137cb3488bce23352af3e12fb0dbedd1ee6e60da053c69fb1b29cc6c"}, + {file = "regex-2024.5.15-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:cdd09d47c0b2efee9378679f8510ee6955d329424c659ab3c5e3a6edea696294"}, + {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:72d7a99cd6b8f958e85fc6ca5b37c4303294954eac1376535b03c2a43eb72629"}, + {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:a094801d379ab20c2135529948cb84d417a2169b9bdceda2a36f5f10977ebc16"}, + {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:c0c18345010870e58238790a6779a1219b4d97bd2e77e1140e8ee5d14df071aa"}, + {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:16093f563098448ff6b1fa68170e4acbef94e6b6a4e25e10eae8598bb1694b5d"}, + {file = "regex-2024.5.15-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:e38a7d4e8f633a33b4c7350fbd8bad3b70bf81439ac67ac38916c4a86b465456"}, + {file = "regex-2024.5.15-cp39-cp39-win32.whl", hash = "sha256:71a455a3c584a88f654b64feccc1e25876066c4f5ef26cd6dd711308aa538694"}, + {file = "regex-2024.5.15-cp39-cp39-win_amd64.whl", hash = "sha256:cab12877a9bdafde5500206d1020a584355a97884dfd388af3699e9137bf7388"}, + {file = "regex-2024.5.15.tar.gz", hash = "sha256:d3ee02d9e5f482cc8309134a91eeaacbdd2261ba111b0fef3748eeb4913e6a2c"}, ] [[package]] @@ -2816,110 +2819,110 @@ jupyter = ["ipywidgets (>=7.5.1,<9)"] [[package]] name = "rpds-py" -version = "0.18.0" +version = "0.18.1" description = "Python bindings to Rust's persistent data structures (rpds)" optional = false python-versions = ">=3.8" files = [ - {file = "rpds_py-0.18.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:5b4e7d8d6c9b2e8ee2d55c90b59c707ca59bc30058269b3db7b1f8df5763557e"}, - {file = "rpds_py-0.18.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c463ed05f9dfb9baebef68048aed8dcdc94411e4bf3d33a39ba97e271624f8f7"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:01e36a39af54a30f28b73096dd39b6802eddd04c90dbe161c1b8dbe22353189f"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d62dec4976954a23d7f91f2f4530852b0c7608116c257833922a896101336c51"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dd18772815d5f008fa03d2b9a681ae38d5ae9f0e599f7dda233c439fcaa00d40"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:923d39efa3cfb7279a0327e337a7958bff00cc447fd07a25cddb0a1cc9a6d2da"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:39514da80f971362f9267c600b6d459bfbbc549cffc2cef8e47474fddc9b45b1"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a34d557a42aa28bd5c48a023c570219ba2593bcbbb8dc1b98d8cf5d529ab1434"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:93df1de2f7f7239dc9cc5a4a12408ee1598725036bd2dedadc14d94525192fc3"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:34b18ba135c687f4dac449aa5157d36e2cbb7c03cbea4ddbd88604e076aa836e"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:c0b5dcf9193625afd8ecc92312d6ed78781c46ecbf39af9ad4681fc9f464af88"}, - {file = "rpds_py-0.18.0-cp310-none-win32.whl", hash = "sha256:c4325ff0442a12113a6379af66978c3fe562f846763287ef66bdc1d57925d337"}, - {file = "rpds_py-0.18.0-cp310-none-win_amd64.whl", hash = "sha256:7223a2a5fe0d217e60a60cdae28d6949140dde9c3bcc714063c5b463065e3d66"}, - {file = "rpds_py-0.18.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:3a96e0c6a41dcdba3a0a581bbf6c44bb863f27c541547fb4b9711fd8cf0ffad4"}, - {file = "rpds_py-0.18.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:30f43887bbae0d49113cbaab729a112251a940e9b274536613097ab8b4899cf6"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fcb25daa9219b4cf3a0ab24b0eb9a5cc8949ed4dc72acb8fa16b7e1681aa3c58"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d68c93e381010662ab873fea609bf6c0f428b6d0bb00f2c6939782e0818d37bf"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b34b7aa8b261c1dbf7720b5d6f01f38243e9b9daf7e6b8bc1fd4657000062f2c"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e6d75ab12b0bbab7215e5d40f1e5b738aa539598db27ef83b2ec46747df90e1"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b8612cd233543a3781bc659c731b9d607de65890085098986dfd573fc2befe5"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aec493917dd45e3c69d00a8874e7cbed844efd935595ef78a0f25f14312e33c6"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:661d25cbffaf8cc42e971dd570d87cb29a665f49f4abe1f9e76be9a5182c4688"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:1df3659d26f539ac74fb3b0c481cdf9d725386e3552c6fa2974f4d33d78e544b"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a1ce3ba137ed54f83e56fb983a5859a27d43a40188ba798993812fed73c70836"}, - {file = "rpds_py-0.18.0-cp311-none-win32.whl", hash = "sha256:69e64831e22a6b377772e7fb337533c365085b31619005802a79242fee620bc1"}, - {file = "rpds_py-0.18.0-cp311-none-win_amd64.whl", hash = "sha256:998e33ad22dc7ec7e030b3df701c43630b5bc0d8fbc2267653577e3fec279afa"}, - {file = "rpds_py-0.18.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:7f2facbd386dd60cbbf1a794181e6aa0bd429bd78bfdf775436020172e2a23f0"}, - {file = "rpds_py-0.18.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1d9a5be316c15ffb2b3c405c4ff14448c36b4435be062a7f578ccd8b01f0c4d8"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cd5bf1af8efe569654bbef5a3e0a56eca45f87cfcffab31dd8dde70da5982475"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5417558f6887e9b6b65b4527232553c139b57ec42c64570569b155262ac0754f"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:56a737287efecafc16f6d067c2ea0117abadcd078d58721f967952db329a3e5c"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8f03bccbd8586e9dd37219bce4d4e0d3ab492e6b3b533e973fa08a112cb2ffc9"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4457a94da0d5c53dc4b3e4de1158bdab077db23c53232f37a3cb7afdb053a4e3"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0ab39c1ba9023914297dd88ec3b3b3c3f33671baeb6acf82ad7ce883f6e8e157"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9d54553c1136b50fd12cc17e5b11ad07374c316df307e4cfd6441bea5fb68496"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0af039631b6de0397ab2ba16eaf2872e9f8fca391b44d3d8cac317860a700a3f"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:84ffab12db93b5f6bad84c712c92060a2d321b35c3c9960b43d08d0f639d60d7"}, - {file = "rpds_py-0.18.0-cp312-none-win32.whl", hash = "sha256:685537e07897f173abcf67258bee3c05c374fa6fff89d4c7e42fb391b0605e98"}, - {file = "rpds_py-0.18.0-cp312-none-win_amd64.whl", hash = "sha256:e003b002ec72c8d5a3e3da2989c7d6065b47d9eaa70cd8808b5384fbb970f4ec"}, - {file = "rpds_py-0.18.0-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:08f9ad53c3f31dfb4baa00da22f1e862900f45908383c062c27628754af2e88e"}, - {file = "rpds_py-0.18.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:c0013fe6b46aa496a6749c77e00a3eb07952832ad6166bd481c74bda0dcb6d58"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e32a92116d4f2a80b629778280103d2a510a5b3f6314ceccd6e38006b5e92dcb"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e541ec6f2ec456934fd279a3120f856cd0aedd209fc3852eca563f81738f6861"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bed88b9a458e354014d662d47e7a5baafd7ff81c780fd91584a10d6ec842cb73"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2644e47de560eb7bd55c20fc59f6daa04682655c58d08185a9b95c1970fa1e07"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8e8916ae4c720529e18afa0b879473049e95949bf97042e938530e072fde061d"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:465a3eb5659338cf2a9243e50ad9b2296fa15061736d6e26240e713522b6235c"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:ea7d4a99f3b38c37eac212dbd6ec42b7a5ec51e2c74b5d3223e43c811609e65f"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:67071a6171e92b6da534b8ae326505f7c18022c6f19072a81dcf40db2638767c"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:41ef53e7c58aa4ef281da975f62c258950f54b76ec8e45941e93a3d1d8580594"}, - {file = "rpds_py-0.18.0-cp38-none-win32.whl", hash = "sha256:fdea4952db2793c4ad0bdccd27c1d8fdd1423a92f04598bc39425bcc2b8ee46e"}, - {file = "rpds_py-0.18.0-cp38-none-win_amd64.whl", hash = "sha256:7cd863afe7336c62ec78d7d1349a2f34c007a3cc6c2369d667c65aeec412a5b1"}, - {file = "rpds_py-0.18.0-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:5307def11a35f5ae4581a0b658b0af8178c65c530e94893345bebf41cc139d33"}, - {file = "rpds_py-0.18.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:77f195baa60a54ef9d2de16fbbfd3ff8b04edc0c0140a761b56c267ac11aa467"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39f5441553f1c2aed4de4377178ad8ff8f9d733723d6c66d983d75341de265ab"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:9a00312dea9310d4cb7dbd7787e722d2e86a95c2db92fbd7d0155f97127bcb40"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8f2fc11e8fe034ee3c34d316d0ad8808f45bc3b9ce5857ff29d513f3ff2923a1"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:586f8204935b9ec884500498ccc91aa869fc652c40c093bd9e1471fbcc25c022"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ddc2f4dfd396c7bfa18e6ce371cba60e4cf9d2e5cdb71376aa2da264605b60b9"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5ddcba87675b6d509139d1b521e0c8250e967e63b5909a7e8f8944d0f90ff36f"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:7bd339195d84439cbe5771546fe8a4e8a7a045417d8f9de9a368c434e42a721e"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:d7c36232a90d4755b720fbd76739d8891732b18cf240a9c645d75f00639a9024"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:6b0817e34942b2ca527b0e9298373e7cc75f429e8da2055607f4931fded23e20"}, - {file = "rpds_py-0.18.0-cp39-none-win32.whl", hash = "sha256:99f70b740dc04d09e6b2699b675874367885217a2e9f782bdf5395632ac663b7"}, - {file = "rpds_py-0.18.0-cp39-none-win_amd64.whl", hash = "sha256:6ef687afab047554a2d366e112dd187b62d261d49eb79b77e386f94644363294"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:ad36cfb355e24f1bd37cac88c112cd7730873f20fb0bdaf8ba59eedf8216079f"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:36b3ee798c58ace201289024b52788161e1ea133e4ac93fba7d49da5fec0ef9e"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8a2f084546cc59ea99fda8e070be2fd140c3092dc11524a71aa8f0f3d5a55ca"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e4461d0f003a0aa9be2bdd1b798a041f177189c1a0f7619fe8c95ad08d9a45d7"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8db715ebe3bb7d86d77ac1826f7d67ec11a70dbd2376b7cc214199360517b641"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:793968759cd0d96cac1e367afd70c235867831983f876a53389ad869b043c948"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:66e6a3af5a75363d2c9a48b07cb27c4ea542938b1a2e93b15a503cdfa8490795"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6ef0befbb5d79cf32d0266f5cff01545602344eda89480e1dd88aca964260b18"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d4acf42190d449d5e89654d5c1ed3a4f17925eec71f05e2a41414689cda02d1"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:a5f446dd5055667aabaee78487f2b5ab72e244f9bc0b2ffebfeec79051679984"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:9dbbeb27f4e70bfd9eec1be5477517365afe05a9b2c441a0b21929ee61048124"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:22806714311a69fd0af9b35b7be97c18a0fc2826e6827dbb3a8c94eac6cf7eeb"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:b34ae4636dfc4e76a438ab826a0d1eed2589ca7d9a1b2d5bb546978ac6485461"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c8370641f1a7f0e0669ddccca22f1da893cef7628396431eb445d46d893e5cd"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c8362467a0fdeccd47935f22c256bec5e6abe543bf0d66e3d3d57a8fb5731863"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:11a8c85ef4a07a7638180bf04fe189d12757c696eb41f310d2426895356dcf05"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b316144e85316da2723f9d8dc75bada12fa58489a527091fa1d5a612643d1a0e"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cf1ea2e34868f6fbf070e1af291c8180480310173de0b0c43fc38a02929fc0e3"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:e546e768d08ad55b20b11dbb78a745151acbd938f8f00d0cfbabe8b0199b9880"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:4901165d170a5fde6f589acb90a6b33629ad1ec976d4529e769c6f3d885e3e80"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:618a3d6cae6ef8ec88bb76dd80b83cfe415ad4f1d942ca2a903bf6b6ff97a2da"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:ed4eb745efbff0a8e9587d22a84be94a5eb7d2d99c02dacf7bd0911713ed14dd"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c81e5f372cd0dc5dc4809553d34f832f60a46034a5f187756d9b90586c2c307"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:43fbac5f22e25bee1d482c97474f930a353542855f05c1161fd804c9dc74a09d"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6d7faa6f14017c0b1e69f5e2c357b998731ea75a442ab3841c0dbbbfe902d2c4"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:08231ac30a842bd04daabc4d71fddd7e6d26189406d5a69535638e4dcb88fe76"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:044a3e61a7c2dafacae99d1e722cc2d4c05280790ec5a05031b3876809d89a5c"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3f26b5bd1079acdb0c7a5645e350fe54d16b17bfc5e71f371c449383d3342e17"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:482103aed1dfe2f3b71a58eff35ba105289b8d862551ea576bd15479aba01f66"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1374f4129f9bcca53a1bba0bb86bf78325a0374577cf7e9e4cd046b1e6f20e24"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:635dc434ff724b178cb192c70016cc0ad25a275228f749ee0daf0eddbc8183b1"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:bc362ee4e314870a70f4ae88772d72d877246537d9f8cb8f7eacf10884862432"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:4832d7d380477521a8c1644bbab6588dfedea5e30a7d967b5fb75977c45fd77f"}, - {file = "rpds_py-0.18.0.tar.gz", hash = "sha256:42821446ee7a76f5d9f71f9e33a4fb2ffd724bb3e7f93386150b61a43115788d"}, + {file = "rpds_py-0.18.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:d31dea506d718693b6b2cffc0648a8929bdc51c70a311b2770f09611caa10d53"}, + {file = "rpds_py-0.18.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:732672fbc449bab754e0b15356c077cc31566df874964d4801ab14f71951ea80"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a98a1f0552b5f227a3d6422dbd61bc6f30db170939bd87ed14f3c339aa6c7c9"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7f1944ce16401aad1e3f7d312247b3d5de7981f634dc9dfe90da72b87d37887d"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:38e14fb4e370885c4ecd734f093a2225ee52dc384b86fa55fe3f74638b2cfb09"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:08d74b184f9ab6289b87b19fe6a6d1a97fbfea84b8a3e745e87a5de3029bf944"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d70129cef4a8d979caa37e7fe957202e7eee8ea02c5e16455bc9808a59c6b2f0"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ce0bb20e3a11bd04461324a6a798af34d503f8d6f1aa3d2aa8901ceaf039176d"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:81c5196a790032e0fc2464c0b4ab95f8610f96f1f2fa3d4deacce6a79852da60"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:f3027be483868c99b4985fda802a57a67fdf30c5d9a50338d9db646d590198da"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d44607f98caa2961bab4fa3c4309724b185b464cdc3ba6f3d7340bac3ec97cc1"}, + {file = "rpds_py-0.18.1-cp310-none-win32.whl", hash = "sha256:c273e795e7a0f1fddd46e1e3cb8be15634c29ae8ff31c196debb620e1edb9333"}, + {file = "rpds_py-0.18.1-cp310-none-win_amd64.whl", hash = "sha256:8352f48d511de5f973e4f2f9412736d7dea76c69faa6d36bcf885b50c758ab9a"}, + {file = "rpds_py-0.18.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:6b5ff7e1d63a8281654b5e2896d7f08799378e594f09cf3674e832ecaf396ce8"}, + {file = "rpds_py-0.18.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8927638a4d4137a289e41d0fd631551e89fa346d6dbcfc31ad627557d03ceb6d"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:154bf5c93d79558b44e5b50cc354aa0459e518e83677791e6adb0b039b7aa6a7"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:07f2139741e5deb2c5154a7b9629bc5aa48c766b643c1a6750d16f865a82c5fc"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8c7672e9fba7425f79019db9945b16e308ed8bc89348c23d955c8c0540da0a07"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:489bdfe1abd0406eba6b3bb4fdc87c7fa40f1031de073d0cfb744634cc8fa261"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3c20f05e8e3d4fc76875fc9cb8cf24b90a63f5a1b4c5b9273f0e8225e169b100"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:967342e045564cef76dfcf1edb700b1e20838d83b1aa02ab313e6a497cf923b8"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:2cc7c1a47f3a63282ab0f422d90ddac4aa3034e39fc66a559ab93041e6505da7"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:f7afbfee1157e0f9376c00bb232e80a60e59ed716e3211a80cb8506550671e6e"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:9e6934d70dc50f9f8ea47081ceafdec09245fd9f6032669c3b45705dea096b88"}, + {file = "rpds_py-0.18.1-cp311-none-win32.whl", hash = "sha256:c69882964516dc143083d3795cb508e806b09fc3800fd0d4cddc1df6c36e76bb"}, + {file = "rpds_py-0.18.1-cp311-none-win_amd64.whl", hash = "sha256:70a838f7754483bcdc830444952fd89645569e7452e3226de4a613a4c1793fb2"}, + {file = "rpds_py-0.18.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3dd3cd86e1db5aadd334e011eba4e29d37a104b403e8ca24dcd6703c68ca55b3"}, + {file = "rpds_py-0.18.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:05f3d615099bd9b13ecf2fc9cf2d839ad3f20239c678f461c753e93755d629ee"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:35b2b771b13eee8729a5049c976197ff58a27a3829c018a04341bcf1ae409b2b"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ee17cd26b97d537af8f33635ef38be873073d516fd425e80559f4585a7b90c43"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b646bf655b135ccf4522ed43d6902af37d3f5dbcf0da66c769a2b3938b9d8184"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19ba472b9606c36716062c023afa2484d1e4220548751bda14f725a7de17b4f6"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e30ac5e329098903262dc5bdd7e2086e0256aa762cc8b744f9e7bf2a427d3f8"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d58ad6317d188c43750cb76e9deacf6051d0f884d87dc6518e0280438648a9ac"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e1735502458621921cee039c47318cb90b51d532c2766593be6207eec53e5c4c"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:f5bab211605d91db0e2995a17b5c6ee5edec1270e46223e513eaa20da20076ac"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:2fc24a329a717f9e2448f8cd1f960f9dac4e45b6224d60734edeb67499bab03a"}, + {file = "rpds_py-0.18.1-cp312-none-win32.whl", hash = "sha256:1805d5901779662d599d0e2e4159d8a82c0b05faa86ef9222bf974572286b2b6"}, + {file = "rpds_py-0.18.1-cp312-none-win_amd64.whl", hash = "sha256:720edcb916df872d80f80a1cc5ea9058300b97721efda8651efcd938a9c70a72"}, + {file = "rpds_py-0.18.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:c827576e2fa017a081346dce87d532a5310241648eb3700af9a571a6e9fc7e74"}, + {file = "rpds_py-0.18.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:aa3679e751408d75a0b4d8d26d6647b6d9326f5e35c00a7ccd82b78ef64f65f8"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0abeee75434e2ee2d142d650d1e54ac1f8b01e6e6abdde8ffd6eeac6e9c38e20"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ed402d6153c5d519a0faf1bb69898e97fb31613b49da27a84a13935ea9164dfc"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:338dee44b0cef8b70fd2ef54b4e09bb1b97fc6c3a58fea5db6cc083fd9fc2724"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7750569d9526199c5b97e5a9f8d96a13300950d910cf04a861d96f4273d5b104"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:607345bd5912aacc0c5a63d45a1f73fef29e697884f7e861094e443187c02be5"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:207c82978115baa1fd8d706d720b4a4d2b0913df1c78c85ba73fe6c5804505f0"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:6d1e42d2735d437e7e80bab4d78eb2e459af48c0a46e686ea35f690b93db792d"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:5463c47c08630007dc0fe99fb480ea4f34a89712410592380425a9b4e1611d8e"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:06d218939e1bf2ca50e6b0ec700ffe755e5216a8230ab3e87c059ebb4ea06afc"}, + {file = "rpds_py-0.18.1-cp38-none-win32.whl", hash = "sha256:312fe69b4fe1ffbe76520a7676b1e5ac06ddf7826d764cc10265c3b53f96dbe9"}, + {file = "rpds_py-0.18.1-cp38-none-win_amd64.whl", hash = "sha256:9437ca26784120a279f3137ee080b0e717012c42921eb07861b412340f85bae2"}, + {file = "rpds_py-0.18.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:19e515b78c3fc1039dd7da0a33c28c3154458f947f4dc198d3c72db2b6b5dc93"}, + {file = "rpds_py-0.18.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a7b28c5b066bca9a4eb4e2f2663012debe680f097979d880657f00e1c30875a0"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:673fdbbf668dd958eff750e500495ef3f611e2ecc209464f661bc82e9838991e"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d960de62227635d2e61068f42a6cb6aae91a7fe00fca0e3aeed17667c8a34611"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:352a88dc7892f1da66b6027af06a2e7e5d53fe05924cc2cfc56495b586a10b72"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4e0ee01ad8260184db21468a6e1c37afa0529acc12c3a697ee498d3c2c4dcaf3"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4c39ad2f512b4041343ea3c7894339e4ca7839ac38ca83d68a832fc8b3748ab"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aaa71ee43a703c321906813bb252f69524f02aa05bf4eec85f0c41d5d62d0f4c"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:6cd8098517c64a85e790657e7b1e509b9fe07487fd358e19431cb120f7d96338"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:4adec039b8e2928983f885c53b7cc4cda8965b62b6596501a0308d2703f8af1b"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:32b7daaa3e9389db3695964ce8e566e3413b0c43e3394c05e4b243a4cd7bef26"}, + {file = "rpds_py-0.18.1-cp39-none-win32.whl", hash = "sha256:2625f03b105328729f9450c8badda34d5243231eef6535f80064d57035738360"}, + {file = "rpds_py-0.18.1-cp39-none-win_amd64.whl", hash = "sha256:bf18932d0003c8c4d51a39f244231986ab23ee057d235a12b2684ea26a353590"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:cbfbea39ba64f5e53ae2915de36f130588bba71245b418060ec3330ebf85678e"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:a3d456ff2a6a4d2adcdf3c1c960a36f4fd2fec6e3b4902a42a384d17cf4e7a65"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7700936ef9d006b7ef605dc53aa364da2de5a3aa65516a1f3ce73bf82ecfc7ae"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:51584acc5916212e1bf45edd17f3a6b05fe0cbb40482d25e619f824dccb679de"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:942695a206a58d2575033ff1e42b12b2aece98d6003c6bc739fbf33d1773b12f"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b906b5f58892813e5ba5c6056d6a5ad08f358ba49f046d910ad992196ea61397"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6f8e3fecca256fefc91bb6765a693d96692459d7d4c644660a9fff32e517843"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:7732770412bab81c5a9f6d20aeb60ae943a9b36dcd990d876a773526468e7163"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:bd1105b50ede37461c1d51b9698c4f4be6e13e69a908ab7751e3807985fc0346"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:618916f5535784960f3ecf8111581f4ad31d347c3de66d02e728de460a46303c"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:17c6d2155e2423f7e79e3bb18151c686d40db42d8645e7977442170c360194d4"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c4c4c3f878df21faf5fac86eda32671c27889e13570645a9eea0a1abdd50922"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:fab6ce90574645a0d6c58890e9bcaac8d94dff54fb51c69e5522a7358b80ab64"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:531796fb842b53f2695e94dc338929e9f9dbf473b64710c28af5a160b2a8927d"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:740884bc62a5e2bbb31e584f5d23b32320fd75d79f916f15a788d527a5e83644"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:998125738de0158f088aef3cb264a34251908dd2e5d9966774fdab7402edfab7"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e2be6e9dd4111d5b31ba3b74d17da54a8319d8168890fbaea4b9e5c3de630ae5"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d0cee71bc618cd93716f3c1bf56653740d2d13ddbd47673efa8bf41435a60daa"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2c3caec4ec5cd1d18e5dd6ae5194d24ed12785212a90b37f5f7f06b8bedd7139"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:27bba383e8c5231cd559affe169ca0b96ec78d39909ffd817f28b166d7ddd4d8"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:a888e8bdb45916234b99da2d859566f1e8a1d2275a801bb8e4a9644e3c7e7909"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:6031b25fb1b06327b43d841f33842b383beba399884f8228a6bb3df3088485ff"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:48c2faaa8adfacefcbfdb5f2e2e7bdad081e5ace8d182e5f4ade971f128e6bb3"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:d85164315bd68c0806768dc6bb0429c6f95c354f87485ee3593c4f6b14def2bd"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6afd80f6c79893cfc0574956f78a0add8c76e3696f2d6a15bca2c66c415cf2d4"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa242ac1ff583e4ec7771141606aafc92b361cd90a05c30d93e343a0c2d82a89"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d21be4770ff4e08698e1e8e0bce06edb6ea0626e7c8f560bc08222880aca6a6f"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5c45a639e93a0c5d4b788b2613bd637468edd62f8f95ebc6fcc303d58ab3f0a8"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:910e71711d1055b2768181efa0a17537b2622afeb0424116619817007f8a2b10"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b9bb1f182a97880f6078283b3505a707057c42bf55d8fca604f70dedfdc0772a"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d54f74f40b1f7aaa595a02ff42ef38ca654b1469bef7d52867da474243cc633"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:8d2e182c9ee01135e11e9676e9a62dfad791a7a467738f06726872374a83db49"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:636a15acc588f70fda1661234761f9ed9ad79ebed3f2125d44be0862708b666e"}, + {file = "rpds_py-0.18.1.tar.gz", hash = "sha256:dc48b479d540770c811fbd1eb9ba2bb66951863e448efec2e2c102625328e92f"}, ] [[package]] @@ -3274,17 +3277,17 @@ widechars = ["wcwidth"] [[package]] name = "temporalio" -version = "1.5.1" +version = "1.6.0" description = "Temporal.io Python SDK" optional = false -python-versions = ">=3.8,<4.0" +python-versions = "<4.0,>=3.8" files = [ - {file = "temporalio-1.5.1-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:cd1f8930787c728e30ca2fecf86175cafd1781d97e3ee7cdf6e41915c566a835"}, - {file = "temporalio-1.5.1-cp38-abi3-macosx_11_0_arm64.whl", hash = "sha256:2b3765e0b6b0ef0b670cf39720a80280fd35be2444633c715b741d2b5428ceb6"}, - {file = "temporalio-1.5.1-cp38-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:47149204b6430c8553d5dd6dfe2fbc6830bf6fd8ab08463ee4c97885c68f3082"}, - {file = "temporalio-1.5.1-cp38-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:1167f6fc31355170cdb4f5f7b89f0f7e36c54d0aecb0ee9aa611f73e32db7d78"}, - {file = "temporalio-1.5.1-cp38-abi3-win_amd64.whl", hash = "sha256:15d36d2038b0ac33511163619bea7ead6f10aca3db5bad4b9d464d3fa0f4ff48"}, - {file = "temporalio-1.5.1.tar.gz", hash = "sha256:4c7bbc8a3e8df1ffc0c7d213bdcad26ae055bdd615567ce1ca4bfa9f28f831b8"}, + {file = "temporalio-1.6.0-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:50207806c5b9d701226ed2aed1fce44c688225ab9a370b014b06e51872b98ea7"}, + {file = "temporalio-1.6.0-cp38-abi3-macosx_11_0_arm64.whl", hash = "sha256:499253385dd3ca1827d34a05ae61350d54040e0d6a11502f04cbafa7b35be114"}, + {file = "temporalio-1.6.0-cp38-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl", hash = "sha256:8fb097b97f833483cd500af2460a0996f812e8019327d893844a21b1c7cd9868"}, + {file = "temporalio-1.6.0-cp38-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:6b25d451170ecdf8443f1ed09f75ea708e8679c26636e7aa326bc89bd6bd0c84"}, + {file = "temporalio-1.6.0-cp38-abi3-win_amd64.whl", hash = "sha256:b5ae0bea0665a0bc87d80e7d18870b32eec631694abc0610ee39235e99cc304b"}, + {file = "temporalio-1.6.0.tar.gz", hash = "sha256:a6f24ea91eb1dd1345c68f4ceb21dd2a11a84cda0d6d963d6e570a0c156a80f0"}, ] [package.dependencies] @@ -3504,13 +3507,13 @@ files = [ [[package]] name = "tqdm" -version = "4.66.2" +version = "4.66.4" description = "Fast, Extensible Progress Meter" optional = false python-versions = ">=3.7" files = [ - {file = "tqdm-4.66.2-py3-none-any.whl", hash = "sha256:1ee4f8a893eb9bef51c6e35730cebf234d5d0b6bd112b0271e10ed7c24a02bd9"}, - {file = "tqdm-4.66.2.tar.gz", hash = "sha256:6cd52cdf0fef0e0f543299cfc96fec90d7b8a7e88745f411ec33eb44d5ed3531"}, + {file = "tqdm-4.66.4-py3-none-any.whl", hash = "sha256:b75ca56b413b030bc3f00af51fd2c1a1a5eac6a0c1cca83cbb37a5c52abce644"}, + {file = "tqdm-4.66.4.tar.gz", hash = "sha256:e4d936c9de8727928f3be6079590e97d9abfe8d39a590be678eb5919ffc186bb"}, ] [package.dependencies] @@ -3539,13 +3542,13 @@ test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0, [[package]] name = "transformers" -version = "4.40.1" +version = "4.40.2" description = "State-of-the-art Machine Learning for JAX, PyTorch and TensorFlow" optional = false python-versions = ">=3.8.0" files = [ - {file = "transformers-4.40.1-py3-none-any.whl", hash = "sha256:9d5ee0c8142a60501faf9e49a0b42f8e9cb8611823bce4f195a9325a6816337e"}, - {file = "transformers-4.40.1.tar.gz", hash = "sha256:55e1697e6f18b58273e7117bb469cdffc11be28995462d8d5e422fef38d2de36"}, + {file = "transformers-4.40.2-py3-none-any.whl", hash = "sha256:71cb94301ec211a2e1d4b8c8d18dcfaa902dfa00a089dceca167a8aa265d6f2d"}, + {file = "transformers-4.40.2.tar.gz", hash = "sha256:657b6054a2097671398d976ad46e60836e7e15f9ea9551631a96e33cb9240649"}, ] [package.dependencies] @@ -3839,18 +3842,18 @@ multidict = ">=4.0" [[package]] name = "zipp" -version = "3.18.1" +version = "3.18.2" description = "Backport of pathlib-compatible object wrapper for zip files" optional = false python-versions = ">=3.8" files = [ - {file = "zipp-3.18.1-py3-none-any.whl", hash = "sha256:206f5a15f2af3dbaee80769fb7dc6f249695e940acca08dfb2a4769fe61e538b"}, - {file = "zipp-3.18.1.tar.gz", hash = "sha256:2884ed22e7d8961de1c9a05142eb69a247f120291bc0206a00a7642f09b5b715"}, + {file = "zipp-3.18.2-py3-none-any.whl", hash = "sha256:dce197b859eb796242b0622af1b8beb0a722d52aa2f57133ead08edd5bf5374e"}, + {file = "zipp-3.18.2.tar.gz", hash = "sha256:6278d9ddbcfb1f1089a88fde84481528b07b0e10474e09dcfe53dad4069fa059"}, ] [package.extras] docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] +testing = ["big-O", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] [metadata] lock-version = "2.0" diff --git a/docs/js-sdk-docs/README.md b/docs/js-sdk-docs/README.md index 54fb6feb8..9a736bebd 100644 --- a/docs/js-sdk-docs/README.md +++ b/docs/js-sdk-docs/README.md @@ -1,4 +1,4 @@ -@julep/sdk / [Modules](modules.md) +@julep/sdk / [Exports](modules.md)
julep @@ -39,34 +39,32 @@ Start your project with conversation history, support for any LLM, agentic workf --- ## Why Julep? -We've built a lot of AI apps and understand how difficult it is to evaluate hundreds of tools, techniques, and models, and then make them work well together. +We've built a lot of AI apps and understand how difficult it is to evaluate hundreds of tools, techniques, and models, and then make them work well together. -**The Problem** +**The Problems** +1. The barrier to making LLM apps with memory, knowledge & tools is too high. +2. Agentic behaviour is hard to control when done through multi-agent frameworks. -Even for simple apps you have to: -- pick the right language model for your use case -- pick the right framework -- pick the right embedding model -- choose the vector store and RAG pipeline -- build integrations -- tweak all of the parameters (temp, penalty, max tokens, similarity thresholds, chunk size, and so on) -- write and iterate on prompts for them to work - -**The Solution**: -Julep eases the burden and time taken to get up and running with any AI app. - -- **Statefulness By Design**: Build AI apps without needing to write code to embed, save and retrieve conversation history. Deals with context windows by using CozoDB; a transactional, relational-graph-vector database. -- **Use and switch between any LLMs anytime**: Switch and use different LLMs, providers and models, self-hosted or otherwise by changing only *one line of code* -- **Automatic Function Calling**: No need to handle function calling manually. Julep deals with calling the function, parsing the response, retrying in case of failures and passing the response into the context. +**The Solution**: +- **Statefulness By Design**: Manages context by default. Uses [CozoDB](https://cozodb.org/) to save & retrieve conversation history, OpenAPI specification tools & documents. +- **Support for Users & Agents**: Allows creating different user <-> agent interactions like `One Agent <-> Many Users`; `Many Agents <-> One User` etc. Read more: https://docs.julep.ai/concepts/ +- **Use and switch between any LLMs anytime**: Switch and use different LLMs, providers and models, self-hosted or otherwise. - **Production-ready**: Julep comes ready to be deployed to production using Docker Compose. Support for k8s coming soon! - **90+ tools built-in**: Connect your AI app to 150+ third-party applications using [Composio](https://docs.composio.dev/framework/julep/) natively. -- ***GitHub Actions-like workflows for task**: Define agentic workflows to be executed asynchronously without worrying about timeouts. -> (*) Features coming soon! +- ***GitHub Actions-like workflows for tasks**: Define agentic workflows to be executed asynchronously with one ore more without worrying about timeouts or multiplying hallucinations. + +> (*) Coming soon! ## Quickstart -### Option 1: Install and run Julep locally +### Option 1: Use the Julep Cloud +Our hosted platform is in Beta! + +To get access: +[Join our Discord](https://discord.com/invite/JTSBGRZrzj) or Drop a "Hey" over at sid@julep.ai! + +### Option 2: Install and run Julep locally - Download the `docker-compose.yml` file along with the `.env` file for configuration to run the Julep platform locally ```bash @@ -81,21 +79,13 @@ docker compose up -d ``` - The API would now be available at: `http://0.0.0.0:8080` -- Next, add your OpenAI API Key to the `.env` +- Next, add your OpenAI/Anthropic API Key to the `.env` - Set your environment variables ```bash export JULEP_API_KEY=myauthkey export JULEP_API_URL=http://0.0.0.0:8080 ``` -### Option 2: Use the Julep Cloud -- Generate an API key from https://platform.julep.ai -- Set your environment variables - -```bash -export JULEP_API_KEY=your_julep_api_key -export JULEP_API_URL=https://api-alpha.julep.ai -``` ### Installation diff --git a/docs/js-sdk-docs/classes/api.BaseHttpRequest.md b/docs/js-sdk-docs/classes/api.BaseHttpRequest.md deleted file mode 100644 index 6f823446f..000000000 --- a/docs/js-sdk-docs/classes/api.BaseHttpRequest.md +++ /dev/null @@ -1,75 +0,0 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api](../modules/api.md) / BaseHttpRequest - -# Class: BaseHttpRequest - -[api](../modules/api.md).BaseHttpRequest - -## Table of contents - -### Constructors - -- [constructor](api.BaseHttpRequest.md#constructor) - -### Properties - -- [config](api.BaseHttpRequest.md#config) - -### Methods - -- [request](api.BaseHttpRequest.md#request) - -## Constructors - -### constructor - -• **new BaseHttpRequest**(`config`): [`BaseHttpRequest`](api.BaseHttpRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`OpenAPIConfig`](../modules/api.md#openapiconfig) | - -#### Returns - -[`BaseHttpRequest`](api.BaseHttpRequest.md) - -#### Defined in - -[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) - -## Properties - -### config - -• `Readonly` **config**: [`OpenAPIConfig`](../modules/api.md#openapiconfig) - -#### Defined in - -[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) - -## Methods - -### request - -▸ **request**\<`T`\>(`options`): [`CancelablePromise`](api.CancelablePromise.md)\<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `ApiRequestOptions` | - -#### Returns - -[`CancelablePromise`](api.CancelablePromise.md)\<`T`\> - -#### Defined in - -[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/BaseHttpRequest.ts#L12) diff --git a/docs/js-sdk-docs/classes/api_JulepApiClient.JulepApiClient.md b/docs/js-sdk-docs/classes/api_JulepApiClient.JulepApiClient.md index 26dfacc60..d5afd1c10 100644 --- a/docs/js-sdk-docs/classes/api_JulepApiClient.JulepApiClient.md +++ b/docs/js-sdk-docs/classes/api_JulepApiClient.JulepApiClient.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api/JulepApiClient](../modules/api_JulepApiClient.md) / JulepApiClient +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/JulepApiClient](../modules/api_JulepApiClient.md) / JulepApiClient # Class: JulepApiClient @@ -25,7 +25,7 @@ | Name | Type | Default value | | :------ | :------ | :------ | -| `config?` | `Partial`\<[`OpenAPIConfig`](../modules/api.md#openapiconfig)\> | `undefined` | +| `config?` | `Partial`\<[`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig)\> | `undefined` | | `HttpRequest` | `HttpRequestConstructor` | `AxiosHttpRequest` | #### Returns @@ -34,24 +34,24 @@ #### Defined in -[src/api/JulepApiClient.ts:13](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/JulepApiClient.ts#L13) +[src/api/JulepApiClient.ts:13](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/JulepApiClient.ts#L13) ## Properties ### default -• `Readonly` **default**: [`DefaultService`](api.DefaultService.md) +• `Readonly` **default**: [`DefaultService`](api_services_DefaultService.DefaultService.md) #### Defined in -[src/api/JulepApiClient.ts:11](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/JulepApiClient.ts#L11) +[src/api/JulepApiClient.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/JulepApiClient.ts#L11) ___ ### request -• `Readonly` **request**: [`BaseHttpRequest`](api.BaseHttpRequest.md) +• `Readonly` **request**: [`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) #### Defined in -[src/api/JulepApiClient.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/JulepApiClient.ts#L12) +[src/api/JulepApiClient.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/JulepApiClient.ts#L12) diff --git a/docs/js-sdk-docs/classes/api.ApiError.md b/docs/js-sdk-docs/classes/api_core_ApiError.ApiError.md similarity index 63% rename from docs/js-sdk-docs/classes/api.ApiError.md rename to docs/js-sdk-docs/classes/api_core_ApiError.ApiError.md index 8051303ad..80db86a77 100644 --- a/docs/js-sdk-docs/classes/api.ApiError.md +++ b/docs/js-sdk-docs/classes/api_core_ApiError.ApiError.md @@ -1,8 +1,8 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api](../modules/api.md) / ApiError +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/ApiError](../modules/api_core_ApiError.md) / ApiError # Class: ApiError -[api](../modules/api.md).ApiError +[api/core/ApiError](../modules/api_core_ApiError.md).ApiError ## Hierarchy @@ -14,42 +14,42 @@ ### Constructors -- [constructor](api.ApiError.md#constructor) +- [constructor](api_core_ApiError.ApiError.md#constructor) ### Properties -- [body](api.ApiError.md#body) -- [message](api.ApiError.md#message) -- [name](api.ApiError.md#name) -- [request](api.ApiError.md#request) -- [stack](api.ApiError.md#stack) -- [status](api.ApiError.md#status) -- [statusText](api.ApiError.md#statustext) -- [url](api.ApiError.md#url) -- [prepareStackTrace](api.ApiError.md#preparestacktrace) -- [stackTraceLimit](api.ApiError.md#stacktracelimit) +- [body](api_core_ApiError.ApiError.md#body) +- [message](api_core_ApiError.ApiError.md#message) +- [name](api_core_ApiError.ApiError.md#name) +- [request](api_core_ApiError.ApiError.md#request) +- [stack](api_core_ApiError.ApiError.md#stack) +- [status](api_core_ApiError.ApiError.md#status) +- [statusText](api_core_ApiError.ApiError.md#statustext) +- [url](api_core_ApiError.ApiError.md#url) +- [prepareStackTrace](api_core_ApiError.ApiError.md#preparestacktrace) +- [stackTraceLimit](api_core_ApiError.ApiError.md#stacktracelimit) ### Methods -- [captureStackTrace](api.ApiError.md#capturestacktrace) +- [captureStackTrace](api_core_ApiError.ApiError.md#capturestacktrace) ## Constructors ### constructor -• **new ApiError**(`request`, `response`, `message`): [`ApiError`](api.ApiError.md) +• **new ApiError**(`request`, `response`, `message`): [`ApiError`](api_core_ApiError.ApiError.md) #### Parameters | Name | Type | | :------ | :------ | -| `request` | `ApiRequestOptions` | -| `response` | `ApiResult` | +| `request` | [`ApiRequestOptions`](../modules/api_core_ApiRequestOptions.md#apirequestoptions) | +| `response` | [`ApiResult`](../modules/api_core_ApiResult.md#apiresult) | | `message` | `string` | #### Returns -[`ApiError`](api.ApiError.md) +[`ApiError`](api_core_ApiError.ApiError.md) #### Overrides @@ -57,7 +57,7 @@ Error.constructor #### Defined in -[src/api/core/ApiError.ts:15](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L15) +[src/api/core/ApiError.ts:15](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L15) ## Properties @@ -67,7 +67,7 @@ Error.constructor #### Defined in -[src/api/core/ApiError.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L12) +[src/api/core/ApiError.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L12) ___ @@ -101,11 +101,11 @@ ___ ### request -• `Readonly` **request**: `ApiRequestOptions` +• `Readonly` **request**: [`ApiRequestOptions`](../modules/api_core_ApiRequestOptions.md#apirequestoptions) #### Defined in -[src/api/core/ApiError.ts:13](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L13) +[src/api/core/ApiError.ts:13](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L13) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[src/api/core/ApiError.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L10) +[src/api/core/ApiError.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L10) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[src/api/core/ApiError.ts:11](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L11) +[src/api/core/ApiError.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L11) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[src/api/core/ApiError.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/ApiError.ts#L9) +[src/api/core/ApiError.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiError.ts#L9) ___ diff --git a/docs/js-sdk-docs/classes/api_core_AxiosHttpRequest.AxiosHttpRequest.md b/docs/js-sdk-docs/classes/api_core_AxiosHttpRequest.AxiosHttpRequest.md new file mode 100644 index 000000000..5e13c6097 --- /dev/null +++ b/docs/js-sdk-docs/classes/api_core_AxiosHttpRequest.AxiosHttpRequest.md @@ -0,0 +1,103 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/AxiosHttpRequest](../modules/api_core_AxiosHttpRequest.md) / AxiosHttpRequest + +# Class: AxiosHttpRequest + +[api/core/AxiosHttpRequest](../modules/api_core_AxiosHttpRequest.md).AxiosHttpRequest + +## Hierarchy + +- [`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) + + ↳ **`AxiosHttpRequest`** + + ↳↳ [`CustomHttpRequest`](utils_requestConstructor.CustomHttpRequest.md) + +## Table of contents + +### Constructors + +- [constructor](api_core_AxiosHttpRequest.AxiosHttpRequest.md#constructor) + +### Properties + +- [config](api_core_AxiosHttpRequest.AxiosHttpRequest.md#config) + +### Methods + +- [request](api_core_AxiosHttpRequest.AxiosHttpRequest.md#request) + +## Constructors + +### constructor + +• **new AxiosHttpRequest**(`config`): [`AxiosHttpRequest`](api_core_AxiosHttpRequest.AxiosHttpRequest.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) | + +#### Returns + +[`AxiosHttpRequest`](api_core_AxiosHttpRequest.AxiosHttpRequest.md) + +#### Overrides + +[BaseHttpRequest](api_core_BaseHttpRequest.BaseHttpRequest.md).[constructor](api_core_BaseHttpRequest.BaseHttpRequest.md#constructor) + +#### Defined in + +[src/api/core/AxiosHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/AxiosHttpRequest.ts#L12) + +## Properties + +### config + +• `Readonly` **config**: [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) + +#### Inherited from + +[BaseHttpRequest](api_core_BaseHttpRequest.BaseHttpRequest.md).[config](api_core_BaseHttpRequest.BaseHttpRequest.md#config) + +#### Defined in + +[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) + +## Methods + +### request + +▸ **request**\<`T`\>(`options`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +Request method + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`ApiRequestOptions`](../modules/api_core_ApiRequestOptions.md#apirequestoptions) | The request options from the service | + +#### Returns + +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +CancelablePromise + +**`Throws`** + +ApiError + +#### Overrides + +[BaseHttpRequest](api_core_BaseHttpRequest.BaseHttpRequest.md).[request](api_core_BaseHttpRequest.BaseHttpRequest.md#request) + +#### Defined in + +[src/api/core/AxiosHttpRequest.ts:22](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/AxiosHttpRequest.ts#L22) diff --git a/docs/js-sdk-docs/classes/api_core_BaseHttpRequest.BaseHttpRequest.md b/docs/js-sdk-docs/classes/api_core_BaseHttpRequest.BaseHttpRequest.md new file mode 100644 index 000000000..c0fbab76d --- /dev/null +++ b/docs/js-sdk-docs/classes/api_core_BaseHttpRequest.BaseHttpRequest.md @@ -0,0 +1,81 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/BaseHttpRequest](../modules/api_core_BaseHttpRequest.md) / BaseHttpRequest + +# Class: BaseHttpRequest + +[api/core/BaseHttpRequest](../modules/api_core_BaseHttpRequest.md).BaseHttpRequest + +## Hierarchy + +- **`BaseHttpRequest`** + + ↳ [`AxiosHttpRequest`](api_core_AxiosHttpRequest.AxiosHttpRequest.md) + +## Table of contents + +### Constructors + +- [constructor](api_core_BaseHttpRequest.BaseHttpRequest.md#constructor) + +### Properties + +- [config](api_core_BaseHttpRequest.BaseHttpRequest.md#config) + +### Methods + +- [request](api_core_BaseHttpRequest.BaseHttpRequest.md#request) + +## Constructors + +### constructor + +• **new BaseHttpRequest**(`config`): [`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) | + +#### Returns + +[`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) + +#### Defined in + +[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) + +## Properties + +### config + +• `Readonly` **config**: [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) + +#### Defined in + +[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) + +## Methods + +### request + +▸ **request**\<`T`\>(`options`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ApiRequestOptions`](../modules/api_core_ApiRequestOptions.md#apirequestoptions) | + +#### Returns + +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +#### Defined in + +[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/BaseHttpRequest.ts#L12) diff --git a/docs/js-sdk-docs/classes/api.CancelError.md b/docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelError.md similarity index 67% rename from docs/js-sdk-docs/classes/api.CancelError.md rename to docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelError.md index 45cc30bc6..58dd7a33f 100644 --- a/docs/js-sdk-docs/classes/api.CancelError.md +++ b/docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelError.md @@ -1,8 +1,8 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api](../modules/api.md) / CancelError +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/CancelablePromise](../modules/api_core_CancelablePromise.md) / CancelError # Class: CancelError -[api](../modules/api.md).CancelError +[api/core/CancelablePromise](../modules/api_core_CancelablePromise.md).CancelError ## Hierarchy @@ -14,29 +14,29 @@ ### Constructors -- [constructor](api.CancelError.md#constructor) +- [constructor](api_core_CancelablePromise.CancelError.md#constructor) ### Properties -- [message](api.CancelError.md#message) -- [name](api.CancelError.md#name) -- [stack](api.CancelError.md#stack) -- [prepareStackTrace](api.CancelError.md#preparestacktrace) -- [stackTraceLimit](api.CancelError.md#stacktracelimit) +- [message](api_core_CancelablePromise.CancelError.md#message) +- [name](api_core_CancelablePromise.CancelError.md#name) +- [stack](api_core_CancelablePromise.CancelError.md#stack) +- [prepareStackTrace](api_core_CancelablePromise.CancelError.md#preparestacktrace) +- [stackTraceLimit](api_core_CancelablePromise.CancelError.md#stacktracelimit) ### Accessors -- [isCancelled](api.CancelError.md#iscancelled) +- [isCancelled](api_core_CancelablePromise.CancelError.md#iscancelled) ### Methods -- [captureStackTrace](api.CancelError.md#capturestacktrace) +- [captureStackTrace](api_core_CancelablePromise.CancelError.md#capturestacktrace) ## Constructors ### constructor -• **new CancelError**(`message`): [`CancelError`](api.CancelError.md) +• **new CancelError**(`message`): [`CancelError`](api_core_CancelablePromise.CancelError.md) #### Parameters @@ -46,7 +46,7 @@ #### Returns -[`CancelError`](api.CancelError.md) +[`CancelError`](api_core_CancelablePromise.CancelError.md) #### Overrides @@ -54,7 +54,7 @@ Error.constructor #### Defined in -[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L6) +[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L6) ## Properties @@ -159,7 +159,7 @@ node_modules/@types/node/globals.d.ts:30 #### Defined in -[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L11) +[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L11) ## Methods diff --git a/docs/js-sdk-docs/classes/api.CancelablePromise.md b/docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelablePromise.md similarity index 66% rename from docs/js-sdk-docs/classes/api.CancelablePromise.md rename to docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelablePromise.md index 2c7f1e55f..eface7820 100644 --- a/docs/js-sdk-docs/classes/api.CancelablePromise.md +++ b/docs/js-sdk-docs/classes/api_core_CancelablePromise.CancelablePromise.md @@ -1,8 +1,8 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api](../modules/api.md) / CancelablePromise +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/CancelablePromise](../modules/api_core_CancelablePromise.md) / CancelablePromise # Class: CancelablePromise\ -[api](../modules/api.md).CancelablePromise +[api/core/CancelablePromise](../modules/api_core_CancelablePromise.md).CancelablePromise ## Type parameters @@ -18,35 +18,35 @@ ### Constructors -- [constructor](api.CancelablePromise.md#constructor) +- [constructor](api_core_CancelablePromise.CancelablePromise.md#constructor) ### Properties -- [#cancelHandlers](api.CancelablePromise.md##cancelhandlers) -- [#isCancelled](api.CancelablePromise.md##iscancelled) -- [#isRejected](api.CancelablePromise.md##isrejected) -- [#isResolved](api.CancelablePromise.md##isresolved) -- [#promise](api.CancelablePromise.md##promise) -- [#reject](api.CancelablePromise.md##reject) -- [#resolve](api.CancelablePromise.md##resolve) +- [#cancelHandlers](api_core_CancelablePromise.CancelablePromise.md##cancelhandlers) +- [#isCancelled](api_core_CancelablePromise.CancelablePromise.md##iscancelled) +- [#isRejected](api_core_CancelablePromise.CancelablePromise.md##isrejected) +- [#isResolved](api_core_CancelablePromise.CancelablePromise.md##isresolved) +- [#promise](api_core_CancelablePromise.CancelablePromise.md##promise) +- [#reject](api_core_CancelablePromise.CancelablePromise.md##reject) +- [#resolve](api_core_CancelablePromise.CancelablePromise.md##resolve) ### Accessors -- [[toStringTag]](api.CancelablePromise.md#[tostringtag]) -- [isCancelled](api.CancelablePromise.md#iscancelled) +- [[toStringTag]](api_core_CancelablePromise.CancelablePromise.md#[tostringtag]) +- [isCancelled](api_core_CancelablePromise.CancelablePromise.md#iscancelled) ### Methods -- [cancel](api.CancelablePromise.md#cancel) -- [catch](api.CancelablePromise.md#catch) -- [finally](api.CancelablePromise.md#finally) -- [then](api.CancelablePromise.md#then) +- [cancel](api_core_CancelablePromise.CancelablePromise.md#cancel) +- [catch](api_core_CancelablePromise.CancelablePromise.md#catch) +- [finally](api_core_CancelablePromise.CancelablePromise.md#finally) +- [then](api_core_CancelablePromise.CancelablePromise.md#then) ## Constructors ### constructor -• **new CancelablePromise**\<`T`\>(`executor`): [`CancelablePromise`](api.CancelablePromise.md)\<`T`\> +• **new CancelablePromise**\<`T`\>(`executor`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> #### Type parameters @@ -58,15 +58,15 @@ | Name | Type | | :------ | :------ | -| `executor` | (`resolve`: (`value`: `T` \| `PromiseLike`\<`T`\>) => `void`, `reject`: (`reason?`: `any`) => `void`, `onCancel`: `OnCancel`) => `void` | +| `executor` | (`resolve`: (`value`: `T` \| `PromiseLike`\<`T`\>) => `void`, `reject`: (`reason?`: `any`) => `void`, `onCancel`: [`OnCancel`](../interfaces/api_core_CancelablePromise.OnCancel.md)) => `void` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<`T`\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> #### Defined in -[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L33) +[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L33) ## Properties @@ -76,7 +76,7 @@ #### Defined in -[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L28) +[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L27) +[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L27) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L26) +[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L26) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L25) +[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L25) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L29) +[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L29) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L31) +[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L31) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L30) +[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L30) ## Accessors @@ -182,7 +182,7 @@ Promise.[toStringTag] #### Defined in -[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L87) +[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L87) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L127) +[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L127) ## Methods @@ -210,7 +210,7 @@ ___ #### Defined in -[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L108) +[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L108) ___ @@ -240,7 +240,7 @@ Promise.catch #### Defined in -[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L98) +[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L98) ___ @@ -264,7 +264,7 @@ Promise.finally #### Defined in -[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L104) +[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L104) ___ @@ -296,4 +296,4 @@ Promise.then #### Defined in -[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/CancelablePromise.ts#L91) +[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L91) diff --git a/docs/js-sdk-docs/classes/api.DefaultService.md b/docs/js-sdk-docs/classes/api_services_DefaultService.DefaultService.md similarity index 52% rename from docs/js-sdk-docs/classes/api.DefaultService.md rename to docs/js-sdk-docs/classes/api_services_DefaultService.DefaultService.md index 9d123fbfe..83c10a33e 100644 --- a/docs/js-sdk-docs/classes/api.DefaultService.md +++ b/docs/js-sdk-docs/classes/api_services_DefaultService.DefaultService.md @@ -1,93 +1,93 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [api](../modules/api.md) / DefaultService +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/services/DefaultService](../modules/api_services_DefaultService.md) / DefaultService # Class: DefaultService -[api](../modules/api.md).DefaultService +[api/services/DefaultService](../modules/api_services_DefaultService.md).DefaultService ## Table of contents ### Constructors -- [constructor](api.DefaultService.md#constructor) +- [constructor](api_services_DefaultService.DefaultService.md#constructor) ### Properties -- [httpRequest](api.DefaultService.md#httprequest) +- [httpRequest](api_services_DefaultService.DefaultService.md#httprequest) ### Methods -- [chat](api.DefaultService.md#chat) -- [createAgent](api.DefaultService.md#createagent) -- [createAgentDoc](api.DefaultService.md#createagentdoc) -- [createAgentTool](api.DefaultService.md#createagenttool) -- [createSession](api.DefaultService.md#createsession) -- [createUser](api.DefaultService.md#createuser) -- [createUserDoc](api.DefaultService.md#createuserdoc) -- [deleteAgent](api.DefaultService.md#deleteagent) -- [deleteAgentDoc](api.DefaultService.md#deleteagentdoc) -- [deleteAgentMemory](api.DefaultService.md#deleteagentmemory) -- [deleteAgentTool](api.DefaultService.md#deleteagenttool) -- [deleteSession](api.DefaultService.md#deletesession) -- [deleteSessionHistory](api.DefaultService.md#deletesessionhistory) -- [deleteUser](api.DefaultService.md#deleteuser) -- [deleteUserDoc](api.DefaultService.md#deleteuserdoc) -- [getAgent](api.DefaultService.md#getagent) -- [getAgentDocs](api.DefaultService.md#getagentdocs) -- [getAgentMemories](api.DefaultService.md#getagentmemories) -- [getAgentTools](api.DefaultService.md#getagenttools) -- [getHistory](api.DefaultService.md#gethistory) -- [getJobStatus](api.DefaultService.md#getjobstatus) -- [getSession](api.DefaultService.md#getsession) -- [getSuggestions](api.DefaultService.md#getsuggestions) -- [getUser](api.DefaultService.md#getuser) -- [getUserDocs](api.DefaultService.md#getuserdocs) -- [listAgents](api.DefaultService.md#listagents) -- [listSessions](api.DefaultService.md#listsessions) -- [listUsers](api.DefaultService.md#listusers) -- [patchAgent](api.DefaultService.md#patchagent) -- [patchAgentTool](api.DefaultService.md#patchagenttool) -- [patchSession](api.DefaultService.md#patchsession) -- [patchUser](api.DefaultService.md#patchuser) -- [updateAgent](api.DefaultService.md#updateagent) -- [updateAgentTool](api.DefaultService.md#updateagenttool) -- [updateSession](api.DefaultService.md#updatesession) -- [updateUser](api.DefaultService.md#updateuser) +- [chat](api_services_DefaultService.DefaultService.md#chat) +- [createAgent](api_services_DefaultService.DefaultService.md#createagent) +- [createAgentDoc](api_services_DefaultService.DefaultService.md#createagentdoc) +- [createAgentTool](api_services_DefaultService.DefaultService.md#createagenttool) +- [createSession](api_services_DefaultService.DefaultService.md#createsession) +- [createUser](api_services_DefaultService.DefaultService.md#createuser) +- [createUserDoc](api_services_DefaultService.DefaultService.md#createuserdoc) +- [deleteAgent](api_services_DefaultService.DefaultService.md#deleteagent) +- [deleteAgentDoc](api_services_DefaultService.DefaultService.md#deleteagentdoc) +- [deleteAgentMemory](api_services_DefaultService.DefaultService.md#deleteagentmemory) +- [deleteAgentTool](api_services_DefaultService.DefaultService.md#deleteagenttool) +- [deleteSession](api_services_DefaultService.DefaultService.md#deletesession) +- [deleteSessionHistory](api_services_DefaultService.DefaultService.md#deletesessionhistory) +- [deleteUser](api_services_DefaultService.DefaultService.md#deleteuser) +- [deleteUserDoc](api_services_DefaultService.DefaultService.md#deleteuserdoc) +- [getAgent](api_services_DefaultService.DefaultService.md#getagent) +- [getAgentDocs](api_services_DefaultService.DefaultService.md#getagentdocs) +- [getAgentMemories](api_services_DefaultService.DefaultService.md#getagentmemories) +- [getAgentTools](api_services_DefaultService.DefaultService.md#getagenttools) +- [getHistory](api_services_DefaultService.DefaultService.md#gethistory) +- [getJobStatus](api_services_DefaultService.DefaultService.md#getjobstatus) +- [getSession](api_services_DefaultService.DefaultService.md#getsession) +- [getSuggestions](api_services_DefaultService.DefaultService.md#getsuggestions) +- [getUser](api_services_DefaultService.DefaultService.md#getuser) +- [getUserDocs](api_services_DefaultService.DefaultService.md#getuserdocs) +- [listAgents](api_services_DefaultService.DefaultService.md#listagents) +- [listSessions](api_services_DefaultService.DefaultService.md#listsessions) +- [listUsers](api_services_DefaultService.DefaultService.md#listusers) +- [patchAgent](api_services_DefaultService.DefaultService.md#patchagent) +- [patchAgentTool](api_services_DefaultService.DefaultService.md#patchagenttool) +- [patchSession](api_services_DefaultService.DefaultService.md#patchsession) +- [patchUser](api_services_DefaultService.DefaultService.md#patchuser) +- [updateAgent](api_services_DefaultService.DefaultService.md#updateagent) +- [updateAgentTool](api_services_DefaultService.DefaultService.md#updateagenttool) +- [updateSession](api_services_DefaultService.DefaultService.md#updatesession) +- [updateUser](api_services_DefaultService.DefaultService.md#updateuser) ## Constructors ### constructor -• **new DefaultService**(`httpRequest`): [`DefaultService`](api.DefaultService.md) +• **new DefaultService**(`httpRequest`): [`DefaultService`](api_services_DefaultService.DefaultService.md) #### Parameters | Name | Type | | :------ | :------ | -| `httpRequest` | [`BaseHttpRequest`](api.BaseHttpRequest.md) | +| `httpRequest` | [`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) | #### Returns -[`DefaultService`](api.DefaultService.md) +[`DefaultService`](api_services_DefaultService.DefaultService.md) #### Defined in -[src/api/services/DefaultService.ts:35](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L35) +[src/api/services/DefaultService.ts:35](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L35) ## Properties ### httpRequest -• `Readonly` **httpRequest**: [`BaseHttpRequest`](api.BaseHttpRequest.md) +• `Readonly` **httpRequest**: [`BaseHttpRequest`](api_core_BaseHttpRequest.BaseHttpRequest.md) #### Defined in -[src/api/services/DefaultService.ts:35](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L35) +[src/api/services/DefaultService.ts:35](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L35) ## Methods ### chat -▸ **chat**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ChatResponse`](../modules/api.md#chatresponse)\> +▸ **chat**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ChatResponse`](../modules/api_models_ChatResponse.md#chatresponse)\> Interact with the session @@ -97,12 +97,12 @@ Interact with the session | :------ | :------ | :------ | | `«destructured»` | `Object` | `undefined` | | › `accept?` | ``"application/json"`` \| ``"text/event-stream"`` | `"application/json"` | -| › `requestBody?` | [`ChatInput`](../modules/api.md#chatinput) | `undefined` | +| › `requestBody?` | [`ChatInput`](../modules/api_models_ChatInput.md#chatinput) | `undefined` | | › `sessionId` | `string` | `undefined` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ChatResponse`](../modules/api.md#chatresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ChatResponse`](../modules/api_models_ChatResponse.md#chatresponse)\> ChatResponse @@ -112,13 +112,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:404](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L404) +[src/api/services/DefaultService.ts:404](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L404) ___ ### createAgent -▸ **createAgent**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createAgent**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create a new agent Create a new agent @@ -128,11 +128,11 @@ Create a new agent | Name | Type | Description | | :------ | :------ | :------ | | `«destructured»` | `Object` | - | -| › `requestBody?` | [`CreateAgentRequest`](../modules/api.md#createagentrequest) | Agent create options | +| › `requestBody?` | [`CreateAgentRequest`](../modules/api_models_CreateAgentRequest.md#createagentrequest) | Agent create options | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse Agent successfully created @@ -142,13 +142,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:180](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L180) +[src/api/services/DefaultService.ts:180](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L180) ___ ### createAgentDoc -▸ **createAgentDoc**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createAgentDoc**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create doc of the agent @@ -158,11 +158,11 @@ Create doc of the agent | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`CreateDoc`](../modules/api.md#createdoc) | +| › `requestBody?` | [`CreateDoc`](../modules/api_models_CreateDoc.md#createdoc) | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse @@ -172,13 +172,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:668](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L668) +[src/api/services/DefaultService.ts:668](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L668) ___ ### createAgentTool -▸ **createAgentTool**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createAgentTool**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create tool for the agent @@ -188,11 +188,11 @@ Create tool for the agent | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`CreateToolRequest`](../modules/api.md#createtoolrequest) | +| › `requestBody?` | [`CreateToolRequest`](../modules/api_models_CreateToolRequest.md#createtoolrequest) | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse @@ -202,13 +202,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:857](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L857) +[src/api/services/DefaultService.ts:857](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L857) ___ ### createSession -▸ **createSession**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createSession**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create a new session Create a session between an agent and a user @@ -218,11 +218,11 @@ Create a session between an agent and a user | Name | Type | Description | | :------ | :------ | :------ | | `«destructured»` | `Object` | - | -| › `requestBody?` | [`CreateSessionRequest`](../modules/api.md#createsessionrequest) | Session initialization options | +| › `requestBody?` | [`CreateSessionRequest`](../modules/api_models_CreateSessionRequest.md#createsessionrequest) | Session initialization options | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse Session successfully created @@ -232,13 +232,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:42](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L42) +[src/api/services/DefaultService.ts:42](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L42) ___ ### createUser -▸ **createUser**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createUser**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create a new user Create a new user @@ -248,11 +248,11 @@ Create a new user | Name | Type | Description | | :------ | :------ | :------ | | `«destructured»` | `Object` | - | -| › `requestBody?` | [`CreateUserRequest`](../modules/api.md#createuserrequest) | User create options | +| › `requestBody?` | [`CreateUserRequest`](../modules/api_models_CreateUserRequest.md#createuserrequest) | User create options | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse User successfully created @@ -262,13 +262,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:111](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L111) +[src/api/services/DefaultService.ts:111](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L111) ___ ### createUserDoc -▸ **createUserDoc**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **createUserDoc**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> Create doc of the user @@ -277,12 +277,12 @@ Create doc of the user | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | -| › `requestBody?` | [`CreateDoc`](../modules/api.md#createdoc) | +| › `requestBody?` | [`CreateDoc`](../modules/api_models_CreateDoc.md#createdoc) | | › `userId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> ResourceCreatedResponse @@ -292,13 +292,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:740](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L740) +[src/api/services/DefaultService.ts:740](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L740) ___ ### deleteAgent -▸ **deleteAgent**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteAgent**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete agent @@ -311,7 +311,7 @@ Delete agent #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -321,13 +321,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:556](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L556) +[src/api/services/DefaultService.ts:556](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L556) ___ ### deleteAgentDoc -▸ **deleteAgentDoc**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteAgentDoc**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete doc by id @@ -341,7 +341,7 @@ Delete doc by id #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -351,13 +351,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:783](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L783) +[src/api/services/DefaultService.ts:783](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L783) ___ ### deleteAgentMemory -▸ **deleteAgentMemory**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteAgentMemory**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete memory of the agent by id @@ -371,7 +371,7 @@ Delete memory of the agent by id #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -381,13 +381,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:804](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L804) +[src/api/services/DefaultService.ts:804](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L804) ___ ### deleteAgentTool -▸ **deleteAgentTool**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteAgentTool**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete tool by id @@ -401,7 +401,7 @@ Delete tool by id #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -411,13 +411,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:879](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L879) +[src/api/services/DefaultService.ts:879](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L879) ___ ### deleteSession -▸ **deleteSession**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteSession**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete session @@ -430,7 +430,7 @@ Delete session #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -440,13 +440,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:266](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L266) +[src/api/services/DefaultService.ts:266](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L266) ___ ### deleteSessionHistory -▸ **deleteSessionHistory**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteSessionHistory**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete session history (does NOT delete related memories) @@ -459,7 +459,7 @@ Delete session history (does NOT delete related memories) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -469,13 +469,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:386](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L386) +[src/api/services/DefaultService.ts:386](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L386) ___ ### deleteUser -▸ **deleteUser**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteUser**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete user @@ -488,7 +488,7 @@ Delete user #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -498,13 +498,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:480](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L480) +[src/api/services/DefaultService.ts:480](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L480) ___ ### deleteUserDoc -▸ **deleteUserDoc**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +▸ **deleteUserDoc**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> Delete doc by id @@ -518,7 +518,7 @@ Delete doc by id #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api.md#resourcedeletedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceDeletedResponse`](../modules/api_models_ResourceDeletedResponse.md#resourcedeletedresponse)\> ResourceDeletedResponse @@ -528,13 +528,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:762](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L762) +[src/api/services/DefaultService.ts:762](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L762) ___ ### getAgent -▸ **getAgent**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`Agent`](../modules/api.md#agent)\> +▸ **getAgent**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`Agent`](../modules/api_models_Agent.md#agent)\> Get details of the agent @@ -547,7 +547,7 @@ Get details of the agent #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`Agent`](../modules/api.md#agent)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`Agent`](../modules/api_models_Agent.md#agent)\> Agent @@ -557,13 +557,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:542](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L542) +[src/api/services/DefaultService.ts:542](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L542) ___ ### getAgentDocs -▸ **getAgentDocs**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +▸ **getAgentDocs**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> Get docs of the agent Sorted (created_at descending) @@ -583,7 +583,7 @@ Sorted (created_at descending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> any @@ -593,13 +593,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:619](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L619) +[src/api/services/DefaultService.ts:619](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L619) ___ ### getAgentMemories -▸ **getAgentMemories**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Memory`](../modules/api.md#memory)[] }\> +▸ **getAgentMemories**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Memory`](../modules/api_models_Memory.md#memory)[] }\> Get memories of the agent Sorted (created_at descending) @@ -617,7 +617,7 @@ Sorted (created_at descending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Memory`](../modules/api.md#memory)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Memory`](../modules/api_models_Memory.md#memory)[] }\> any @@ -627,13 +627,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:432](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L432) +[src/api/services/DefaultService.ts:432](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L432) ___ ### getAgentTools -▸ **getAgentTools**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Tool`](../modules/api.md#tool)[] }\> +▸ **getAgentTools**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Tool`](../modules/api_models_Tool.md#tool)[] }\> Get tools of the agent Sorted (created_at descending) @@ -650,7 +650,7 @@ Sorted (created_at descending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Tool`](../modules/api.md#tool)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Tool`](../modules/api_models_Tool.md#tool)[] }\> any @@ -660,13 +660,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:826](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L826) +[src/api/services/DefaultService.ts:826](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L826) ___ ### getHistory -▸ **getHistory**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`ChatMLMessage`](../modules/api.md#chatmlmessage)[] }\> +▸ **getHistory**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`ChatMLMessage`](../modules/api_models_ChatMLMessage.md#chatmlmessage)[] }\> Get all messages in a session Sorted (created_at ascending) @@ -682,7 +682,7 @@ Sorted (created_at ascending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`ChatMLMessage`](../modules/api.md#chatmlmessage)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`ChatMLMessage`](../modules/api_models_ChatMLMessage.md#chatmlmessage)[] }\> any @@ -692,13 +692,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:358](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L358) +[src/api/services/DefaultService.ts:358](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L358) ___ ### getJobStatus -▸ **getJobStatus**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`JobStatus`](../modules/api.md#jobstatus)\> +▸ **getJobStatus**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`JobStatus`](../modules/api_models_JobStatus.md#jobstatus)\> Get status of the job @@ -711,7 +711,7 @@ Get status of the job #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`JobStatus`](../modules/api.md#jobstatus)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`JobStatus`](../modules/api_models_JobStatus.md#jobstatus)\> JobStatus @@ -721,13 +721,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:950](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L950) +[src/api/services/DefaultService.ts:950](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L950) ___ ### getSession -▸ **getSession**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`Session`](../modules/api.md#session)\> +▸ **getSession**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`Session`](../modules/api_models_Session.md#session)\> Get details of the session @@ -740,7 +740,7 @@ Get details of the session #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`Session`](../modules/api.md#session)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`Session`](../modules/api_models_Session.md#session)\> Session @@ -750,13 +750,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:248](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L248) +[src/api/services/DefaultService.ts:248](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L248) ___ ### getSuggestions -▸ **getSuggestions**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Suggestion`](../modules/api.md#suggestion)[] }\> +▸ **getSuggestions**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Suggestion`](../modules/api_models_Suggestion.md#suggestion)[] }\> Get autogenerated suggestions for session user and agent Sorted (created_at descending) @@ -772,7 +772,7 @@ Sorted (created_at descending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Suggestion`](../modules/api.md#suggestion)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Suggestion`](../modules/api_models_Suggestion.md#suggestion)[] }\> any @@ -782,13 +782,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:329](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L329) +[src/api/services/DefaultService.ts:329](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L329) ___ ### getUser -▸ **getUser**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`User`](../modules/api.md#user)\> +▸ **getUser**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`User`](../modules/api_models_User.md#user)\> Get details of the user @@ -801,7 +801,7 @@ Get details of the user #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`User`](../modules/api.md#user)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`User`](../modules/api_models_User.md#user)\> User @@ -811,13 +811,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:466](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L466) +[src/api/services/DefaultService.ts:466](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L466) ___ ### getUserDocs -▸ **getUserDocs**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +▸ **getUserDocs**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> Get docs of the user Sorted (created_at descending) @@ -837,7 +837,7 @@ Sorted (created_at descending) #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> any @@ -847,13 +847,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:691](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L691) +[src/api/services/DefaultService.ts:691](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L691) ___ ### listAgents -▸ **listAgents**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`Agent`](../modules/api.md#agent)[] }\> +▸ **listAgents**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`Agent`](../modules/api_models_Agent.md#agent)[] }\> List agents List agents created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -871,7 +871,7 @@ List agents created (use limit/offset pagination to get large number of sessions #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`Agent`](../modules/api.md#agent)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`Agent`](../modules/api_models_Agent.md#agent)[] }\> any List of agents (sorted created_at descending order) with limit+offset pagination @@ -881,13 +881,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:201](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L201) +[src/api/services/DefaultService.ts:201](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L201) ___ ### listSessions -▸ **listSessions**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`Session`](../modules/api.md#session)[] }\> +▸ **listSessions**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`Session`](../modules/api_models_Session.md#session)[] }\> List sessions List sessions created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -905,7 +905,7 @@ List sessions created (use limit/offset pagination to get large number of sessio #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`Session`](../modules/api.md#session)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`Session`](../modules/api_models_Session.md#session)[] }\> any List of sessions (sorted created_at descending order) with limit+offset pagination @@ -915,13 +915,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:63](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L63) +[src/api/services/DefaultService.ts:63](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L63) ___ ### listUsers -▸ **listUsers**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`User`](../modules/api.md#user)[] }\> +▸ **listUsers**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`User`](../modules/api_models_User.md#user)[] }\> List users List users created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -939,7 +939,7 @@ List users created (use limit/offset pagination to get large number of sessions; #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<\{ `items`: [`User`](../modules/api.md#user)[] }\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<\{ `items`: [`User`](../modules/api_models_User.md#user)[] }\> any List of users (sorted created_at descending order) with limit+offset pagination @@ -949,13 +949,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:132](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L132) +[src/api/services/DefaultService.ts:132](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L132) ___ ### patchAgent -▸ **patchAgent**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **patchAgent**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Patch Agent parameters (merge instead of replace) @@ -965,11 +965,11 @@ Patch Agent parameters (merge instead of replace) | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`PatchAgentRequest`](../modules/api.md#patchagentrequest) | +| › `requestBody?` | [`PatchAgentRequest`](../modules/api_models_PatchAgentRequest.md#patchagentrequest) | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -979,13 +979,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:596](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L596) +[src/api/services/DefaultService.ts:596](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L596) ___ ### patchAgentTool -▸ **patchAgentTool**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **patchAgentTool**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Patch Agent tool parameters (merge instead of replace) @@ -995,12 +995,12 @@ Patch Agent tool parameters (merge instead of replace) | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`PatchToolRequest`](../modules/api.md#patchtoolrequest) | +| › `requestBody?` | [`PatchToolRequest`](../modules/api_models_PatchToolRequest.md#patchtoolrequest) | | › `toolId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1010,13 +1010,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:925](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L925) +[src/api/services/DefaultService.ts:925](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L925) ___ ### patchSession -▸ **patchSession**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **patchSession**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Patch Session parameters (merge instead of replace) @@ -1025,12 +1025,12 @@ Patch Session parameters (merge instead of replace) | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | -| › `requestBody?` | [`PatchSessionRequest`](../modules/api.md#patchsessionrequest) | +| › `requestBody?` | [`PatchSessionRequest`](../modules/api_models_PatchSessionRequest.md#patchsessionrequest) | | › `sessionId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1040,13 +1040,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:306](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L306) +[src/api/services/DefaultService.ts:306](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L306) ___ ### patchUser -▸ **patchUser**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **patchUser**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Patch User parameters (merge instead of replace) @@ -1055,12 +1055,12 @@ Patch User parameters (merge instead of replace) | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | -| › `requestBody?` | [`PatchUserRequest`](../modules/api.md#patchuserrequest) | +| › `requestBody?` | [`PatchUserRequest`](../modules/api_models_PatchUserRequest.md#patchuserrequest) | | › `userId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1070,13 +1070,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:520](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L520) +[src/api/services/DefaultService.ts:520](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L520) ___ ### updateAgent -▸ **updateAgent**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **updateAgent**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Update agent parameters @@ -1086,11 +1086,11 @@ Update agent parameters | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`UpdateAgentRequest`](../modules/api.md#updateagentrequest) | +| › `requestBody?` | [`UpdateAgentRequest`](../modules/api_models_UpdateAgentRequest.md#updateagentrequest) | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1100,13 +1100,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:574](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L574) +[src/api/services/DefaultService.ts:574](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L574) ___ ### updateAgentTool -▸ **updateAgentTool**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **updateAgentTool**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Update agent tool definition @@ -1116,12 +1116,12 @@ Update agent tool definition | :------ | :------ | | `«destructured»` | `Object` | | › `agentId` | `string` | -| › `requestBody?` | [`UpdateToolRequest`](../modules/api.md#updatetoolrequest) | +| › `requestBody?` | [`UpdateToolRequest`](../modules/api_models_UpdateToolRequest.md#updatetoolrequest) | | › `toolId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1131,13 +1131,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:900](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L900) +[src/api/services/DefaultService.ts:900](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L900) ___ ### updateSession -▸ **updateSession**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **updateSession**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Update session parameters @@ -1146,12 +1146,12 @@ Update session parameters | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | -| › `requestBody?` | [`UpdateSessionRequest`](../modules/api.md#updatesessionrequest) | +| › `requestBody?` | [`UpdateSessionRequest`](../modules/api_models_UpdateSessionRequest.md#updatesessionrequest) | | › `sessionId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1161,13 +1161,13 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:284](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L284) +[src/api/services/DefaultService.ts:284](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L284) ___ ### updateUser -▸ **updateUser**(`«destructured»`): [`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **updateUser**(`«destructured»`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> Update user parameters @@ -1176,12 +1176,12 @@ Update user parameters | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | -| › `requestBody?` | [`UpdateUserRequest`](../modules/api.md#updateuserrequest) | +| › `requestBody?` | [`UpdateUserRequest`](../modules/api_models_UpdateUserRequest.md#updateuserrequest) | | › `userId` | `string` | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> ResourceUpdatedResponse @@ -1191,4 +1191,4 @@ ApiError #### Defined in -[src/api/services/DefaultService.ts:498](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/services/DefaultService.ts#L498) +[src/api/services/DefaultService.ts:498](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/services/DefaultService.ts#L498) diff --git a/docs/js-sdk-docs/classes/client.Client.md b/docs/js-sdk-docs/classes/client.Client.md new file mode 100644 index 000000000..2615184cb --- /dev/null +++ b/docs/js-sdk-docs/classes/client.Client.md @@ -0,0 +1,177 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / [client](../modules/client.md) / Client + +# Class: Client + +[client](../modules/client.md).Client + +Client for interacting with the Julep API and OpenAI. + +## Table of contents + +### Constructors + +- [constructor](client.Client.md#constructor) + +### Properties + +- [\_apiClient](client.Client.md#_apiclient) +- [\_openaiClient](client.Client.md#_openaiclient) +- [agents](client.Client.md#agents) +- [chat](client.Client.md#chat) +- [completions](client.Client.md#completions) +- [docs](client.Client.md#docs) +- [memories](client.Client.md#memories) +- [sessions](client.Client.md#sessions) +- [tools](client.Client.md#tools) +- [users](client.Client.md#users) + +## Constructors + +### constructor + +• **new Client**(`options?`): [`Client`](client.Client.md) + +Creates an instance of Client. +Initializes the client with the provided or default API key and base URL. If neither are provided nor set as environment variables, an error is thrown. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `ClientOptions` | Configuration options for the client. | + +#### Returns + +[`Client`](client.Client.md) + +**`Throws`** + +Throws an error if both apiKey and baseUrl are not provided and not set as environment variables. + +#### Defined in + +[src/client.ts:33](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L33) + +## Properties + +### \_apiClient + +• `Private` **\_apiClient**: [`JulepApiClient`](api_JulepApiClient.JulepApiClient.md) + +#### Defined in + +[src/client.ts:22](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L22) + +___ + +### \_openaiClient + +• `Private` **\_openaiClient**: `OpenAI` + +#### Defined in + +[src/client.ts:23](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L23) + +___ + +### agents + +• **agents**: [`AgentsManager`](managers_agent.AgentsManager.md) + +Manager for interacting with agents. +Provides methods to manage and interact with agents within the Julep API. + +#### Defined in + +[src/client.ts:72](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L72) + +___ + +### chat + +• **chat**: `Chat` + +OpenAI Chat API. +This is patched to enhance functionality and ensure compatibility with Julep API. + +#### Defined in + +[src/client.ts:108](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L108) + +___ + +### completions + +• **completions**: `Completions` + +OpenAI Completions API. +Enhanced with custom patches for improved integration and usage within Julep. + +#### Defined in + +[src/client.ts:114](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L114) + +___ + +### docs + +• **docs**: [`DocsManager`](managers_doc.DocsManager.md) + +Manager for interacting with documents. +Enables document management including creation, update, and deletion. + +#### Defined in + +[src/client.ts:90](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L90) + +___ + +### memories + +• **memories**: [`MemoriesManager`](managers_memory.MemoriesManager.md) + +Manager for interacting with memories. +Allows for storing and retrieving user-specific data and preferences. + +#### Defined in + +[src/client.ts:96](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L96) + +___ + +### sessions + +• **sessions**: [`SessionsManager`](managers_session.SessionsManager.md) + +Manager for interacting with sessions. +Facilitates the creation, management, and retrieval of user sessions. + +#### Defined in + +[src/client.ts:84](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L84) + +___ + +### tools + +• **tools**: [`ToolsManager`](managers_tool.ToolsManager.md) + +Manager for interacting with tools. +Provides access to various utility tools and functionalities. + +#### Defined in + +[src/client.ts:102](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L102) + +___ + +### users + +• **users**: [`UsersManager`](managers_user.UsersManager.md) + +Manager for interacting with users. +Offers functionalities to handle user accounts and their data. + +#### Defined in + +[src/client.ts:78](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/client.ts#L78) diff --git a/docs/js-sdk-docs/classes/managers_agent.AgentsManager.md b/docs/js-sdk-docs/classes/managers_agent.AgentsManager.md index 24f961242..a6bc645d9 100644 --- a/docs/js-sdk-docs/classes/managers_agent.AgentsManager.md +++ b/docs/js-sdk-docs/classes/managers_agent.AgentsManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/agent](../modules/managers_agent.md) / AgentsManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/agent](../modules/managers_agent.md) / AgentsManager # Class: AgentsManager @@ -55,7 +55,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -71,13 +71,13 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### create -▸ **create**(`«destructured»`): `Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +▸ **create**(`«destructured»`): `Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Parameters @@ -85,20 +85,20 @@ The JulepApiClient instance used for API interactions. | :------ | :------ | :------ | | `«destructured»` | `Object` | `undefined` | | › `about` | `string` | `undefined` | -| › `default_settings?` | [`AgentDefaultSettings`](../modules/api.md#agentdefaultsettings) | `undefined` | -| › `docs?` | [`Doc`](../modules/api.md#doc)[] | `[]` | +| › `default_settings?` | [`AgentDefaultSettings`](../modules/api_models_AgentDefaultSettings.md#agentdefaultsettings) | `undefined` | +| › `docs?` | [`Doc`](../modules/api_models_Doc.md#doc)[] | `[]` | | › `instructions` | `string` \| `string`[] | `[]` | | › `model?` | `string` | `"julep-ai/samantha-1-turbo"` | | › `name` | `string` | `undefined` | -| › `tools?` | [`CreateToolRequest`](../modules/api.md#createtoolrequest)[] | `undefined` | +| › `tools?` | [`CreateToolRequest`](../modules/api_models_CreateToolRequest.md#createtoolrequest)[] | `undefined` | #### Returns -`Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +`Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Defined in -[src/managers/agent.ts:24](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L24) +[src/managers/agent.ts:24](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L24) ___ @@ -118,13 +118,13 @@ ___ #### Defined in -[src/managers/agent.ts:85](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L85) +[src/managers/agent.ts:85](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L85) ___ ### get -▸ **get**(`agentId`): `Promise`\<[`Agent`](../modules/api.md#agent)\> +▸ **get**(`agentId`): `Promise`\<[`Agent`](../modules/api_models_Agent.md#agent)\> #### Parameters @@ -134,17 +134,17 @@ ___ #### Returns -`Promise`\<[`Agent`](../modules/api.md#agent)\> +`Promise`\<[`Agent`](../modules/api_models_Agent.md#agent)\> #### Defined in -[src/managers/agent.ts:18](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L18) +[src/managers/agent.ts:18](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L18) ___ ### list -▸ **list**(`«destructured»?`): `Promise`\<[`Agent`](../modules/api.md#agent)[]\> +▸ **list**(`«destructured»?`): `Promise`\<[`Agent`](../modules/api_models_Agent.md#agent)[]\> #### Parameters @@ -157,48 +157,48 @@ ___ #### Returns -`Promise`\<[`Agent`](../modules/api.md#agent)[]\> +`Promise`\<[`Agent`](../modules/api_models_Agent.md#agent)[]\> #### Defined in -[src/managers/agent.ts:65](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L65) +[src/managers/agent.ts:65](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L65) ___ ### update -▸ **update**(`agentId`, `request`, `overwrite?`): `Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +▸ **update**(`agentId`, `request`, `overwrite?`): `Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Parameters | Name | Type | | :------ | :------ | | `agentId` | `string` | -| `request` | [`PatchAgentRequest`](../modules/api.md#patchagentrequest) | +| `request` | [`PatchAgentRequest`](../modules/api_models_PatchAgentRequest.md#patchagentrequest) | | `overwrite?` | ``false`` | #### Returns -`Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +`Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Defined in -[src/managers/agent.ts:92](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L92) +[src/managers/agent.ts:92](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L92) -▸ **update**(`agentId`, `request`, `overwrite`): `Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +▸ **update**(`agentId`, `request`, `overwrite`): `Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Parameters | Name | Type | | :------ | :------ | | `agentId` | `string` | -| `request` | [`UpdateAgentRequest`](../modules/api.md#updateagentrequest) | +| `request` | [`UpdateAgentRequest`](../modules/api_models_UpdateAgentRequest.md#updateagentrequest) | | `overwrite` | ``true`` | #### Returns -`Promise`\<`Partial`\<[`Agent`](../modules/api.md#agent)\> & \{ `id`: `string` }\> +`Promise`\<`Partial`\<[`Agent`](../modules/api_models_Agent.md#agent)\> & \{ `id`: `string` }\> #### Defined in -[src/managers/agent.ts:98](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/agent.ts#L98) +[src/managers/agent.ts:98](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/agent.ts#L98) diff --git a/docs/js-sdk-docs/classes/managers_base.BaseManager.md b/docs/js-sdk-docs/classes/managers_base.BaseManager.md index 0996b3ea5..1a3020388 100644 --- a/docs/js-sdk-docs/classes/managers_base.BaseManager.md +++ b/docs/js-sdk-docs/classes/managers_base.BaseManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/base](../modules/managers_base.md) / BaseManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/base](../modules/managers_base.md) / BaseManager # Class: BaseManager @@ -53,7 +53,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -65,4 +65,4 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) diff --git a/docs/js-sdk-docs/classes/managers_doc.DocsManager.md b/docs/js-sdk-docs/classes/managers_doc.DocsManager.md index 0385991dc..3e2d98191 100644 --- a/docs/js-sdk-docs/classes/managers_doc.DocsManager.md +++ b/docs/js-sdk-docs/classes/managers_doc.DocsManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/doc](../modules/managers_doc.md) / DocsManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/doc](../modules/managers_doc.md) / DocsManager # Class: DocsManager @@ -54,7 +54,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -70,13 +70,13 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### create -▸ **create**(`params`): `Promise`\<[`Doc`](../modules/api.md#doc)\> +▸ **create**(`params`): `Promise`\<[`Doc`](../modules/api_models_Doc.md#doc)\> Creates a document based on the provided agentId or userId. Ensures that only one of agentId or userId is provided using xor function. @@ -88,12 +88,12 @@ Validates the provided agentId or userId using isValidUuid4. | :------ | :------ | :------ | | `params` | `Object` | The parameters for creating a document. | | `params.agentId?` | `string` | The agent's unique identifier, if creating for an agent. | -| `params.doc` | [`CreateDoc`](../modules/api.md#createdoc) | The document to be created. | +| `params.doc` | [`CreateDoc`](../modules/api_models_CreateDoc.md#createdoc) | The document to be created. | | `params.userId?` | `string` | The user's unique identifier, if creating for a user. | #### Returns -`Promise`\<[`Doc`](../modules/api.md#doc)\> +`Promise`\<[`Doc`](../modules/api_models_Doc.md#doc)\> The created document. @@ -103,7 +103,7 @@ If neither agentId nor userId is provided. #### Defined in -[src/managers/doc.ts:133](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/doc.ts#L133) +[src/managers/doc.ts:133](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/doc.ts#L133) ___ @@ -136,13 +136,13 @@ If neither agentId nor userId is provided. #### Defined in -[src/managers/doc.ts:186](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/doc.ts#L186) +[src/managers/doc.ts:186](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/doc.ts#L186) ___ ### get -▸ **get**(`params`): `Promise`\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +▸ **get**(`params`): `Promise`\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> Retrieves documents based on the provided agentId or userId. Ensures that only one of agentId or userId is provided using xor function. @@ -160,7 +160,7 @@ Validates the provided agentId or userId using isValidUuid4. #### Returns -`Promise`\<\{ `items?`: [`Doc`](../modules/api.md#doc)[] }\> +`Promise`\<\{ `items?`: [`Doc`](../modules/api_models_Doc.md#doc)[] }\> The retrieved documents. @@ -170,13 +170,13 @@ If neither agentId nor userId is provided. #### Defined in -[src/managers/doc.ts:22](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/doc.ts#L22) +[src/managers/doc.ts:22](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/doc.ts#L22) ___ ### list -▸ **list**(`params?`): `Promise`\<[`Doc`](../modules/api.md#doc)[]\> +▸ **list**(`params?`): `Promise`\<[`Doc`](../modules/api_models_Doc.md#doc)[]\> Lists documents based on the provided agentId or userId, with optional metadata filtering. Ensures that only one of agentId or userId is provided using xor function. @@ -196,7 +196,7 @@ Allows for filtering based on metadata. #### Returns -`Promise`\<[`Doc`](../modules/api.md#doc)[]\> +`Promise`\<[`Doc`](../modules/api_models_Doc.md#doc)[]\> The list of filtered documents. @@ -206,4 +206,4 @@ If neither agentId nor userId is provided. #### Defined in -[src/managers/doc.ts:74](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/doc.ts#L74) +[src/managers/doc.ts:74](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/doc.ts#L74) diff --git a/docs/js-sdk-docs/classes/managers_memory.MemoriesManager.md b/docs/js-sdk-docs/classes/managers_memory.MemoriesManager.md index 7e3aa9945..e1718479f 100644 --- a/docs/js-sdk-docs/classes/managers_memory.MemoriesManager.md +++ b/docs/js-sdk-docs/classes/managers_memory.MemoriesManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/memory](../modules/managers_memory.md) / MemoriesManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/memory](../modules/managers_memory.md) / MemoriesManager # Class: MemoriesManager @@ -51,7 +51,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -67,13 +67,13 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### list -▸ **list**(`«destructured»`): `Promise`\<[`Memory`](../modules/api.md#memory)[]\> +▸ **list**(`«destructured»`): `Promise`\<[`Memory`](../modules/api_models_Memory.md#memory)[]\> Lists memories based on the provided parameters. @@ -90,10 +90,10 @@ Lists memories based on the provided parameters. #### Returns -`Promise`\<[`Memory`](../modules/api.md#memory)[]\> +`Promise`\<[`Memory`](../modules/api_models_Memory.md#memory)[]\> A promise that resolves to an array of Memory objects. #### Defined in -[src/managers/memory.ts:21](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/memory.ts#L21) +[src/managers/memory.ts:21](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/memory.ts#L21) diff --git a/docs/js-sdk-docs/classes/managers_session.SessionsManager.md b/docs/js-sdk-docs/classes/managers_session.SessionsManager.md index 8462e23cb..5266ab7b8 100644 --- a/docs/js-sdk-docs/classes/managers_session.SessionsManager.md +++ b/docs/js-sdk-docs/classes/managers_session.SessionsManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/session](../modules/managers_session.md) / SessionsManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/session](../modules/managers_session.md) / SessionsManager # Class: SessionsManager @@ -59,7 +59,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -75,34 +75,34 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### chat -▸ **chat**(`sessionId`, `«destructured»`): `Promise`\<[`ChatResponse`](../modules/api.md#chatresponse)\> +▸ **chat**(`sessionId`, `«destructured»`): `Promise`\<[`ChatResponse`](../modules/api_models_ChatResponse.md#chatresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `sessionId` | `string` | -| `«destructured»` | [`ChatInput`](../modules/api.md#chatinput) | +| `«destructured»` | [`ChatInput`](../modules/api_models_ChatInput.md#chatinput) | #### Returns -`Promise`\<[`ChatResponse`](../modules/api.md#chatresponse)\> +`Promise`\<[`ChatResponse`](../modules/api_models_ChatResponse.md#chatresponse)\> #### Defined in -[src/managers/session.ts:104](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L104) +[src/managers/session.ts:104](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L104) ___ ### create -▸ **create**(`«destructured»`): `Promise`\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +▸ **create**(`«destructured»`): `Promise`\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> #### Parameters @@ -112,11 +112,11 @@ ___ #### Returns -`Promise`\<[`ResourceCreatedResponse`](../modules/api.md#resourcecreatedresponse)\> +`Promise`\<[`ResourceCreatedResponse`](../modules/api_models_ResourceCreatedResponse.md#resourcecreatedresponse)\> #### Defined in -[src/managers/session.ts:33](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L33) +[src/managers/session.ts:33](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L33) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[src/managers/session.ts:83](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L83) +[src/managers/session.ts:83](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L83) ___ @@ -156,13 +156,13 @@ ___ #### Defined in -[src/managers/session.ts:188](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L188) +[src/managers/session.ts:188](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L188) ___ ### get -▸ **get**(`sessionId`): `Promise`\<[`Session`](../modules/api.md#session)\> +▸ **get**(`sessionId`): `Promise`\<[`Session`](../modules/api_models_Session.md#session)\> Retrieves a session by its ID. @@ -174,19 +174,19 @@ Retrieves a session by its ID. #### Returns -`Promise`\<[`Session`](../modules/api.md#session)\> +`Promise`\<[`Session`](../modules/api_models_Session.md#session)\> A promise that resolves with the session object. #### Defined in -[src/managers/session.ts:29](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L29) +[src/managers/session.ts:29](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L29) ___ ### history -▸ **history**(`sessionId`, `«destructured»?`): `Promise`\<[`ChatMLMessage`](../modules/api.md#chatmlmessage)[]\> +▸ **history**(`sessionId`, `«destructured»?`): `Promise`\<[`ChatMLMessage`](../modules/api_models_ChatMLMessage.md#chatmlmessage)[]\> #### Parameters @@ -199,17 +199,17 @@ ___ #### Returns -`Promise`\<[`ChatMLMessage`](../modules/api.md#chatmlmessage)[]\> +`Promise`\<[`ChatMLMessage`](../modules/api_models_ChatMLMessage.md#chatmlmessage)[]\> #### Defined in -[src/managers/session.ts:173](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L173) +[src/managers/session.ts:173](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L173) ___ ### list -▸ **list**(`«destructured»?`): `Promise`\<[`Session`](../modules/api.md#session)[]\> +▸ **list**(`«destructured»?`): `Promise`\<[`Session`](../modules/api_models_Session.md#session)[]\> #### Parameters @@ -222,17 +222,17 @@ ___ #### Returns -`Promise`\<[`Session`](../modules/api.md#session)[]\> +`Promise`\<[`Session`](../modules/api_models_Session.md#session)[]\> #### Defined in -[src/managers/session.ts:63](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L63) +[src/managers/session.ts:63](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L63) ___ ### suggestions -▸ **suggestions**(`sessionId`, `«destructured»?`): `Promise`\<[`Suggestion`](../modules/api.md#suggestion)[]\> +▸ **suggestions**(`sessionId`, `«destructured»?`): `Promise`\<[`Suggestion`](../modules/api_models_Suggestion.md#suggestion)[]\> #### Parameters @@ -245,17 +245,17 @@ ___ #### Returns -`Promise`\<[`Suggestion`](../modules/api.md#suggestion)[]\> +`Promise`\<[`Suggestion`](../modules/api_models_Suggestion.md#suggestion)[]\> #### Defined in -[src/managers/session.ts:158](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L158) +[src/managers/session.ts:158](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L158) ___ ### update -▸ **update**(`sessionId`, `«destructured»`, `overwrite?`): `Promise`\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +▸ **update**(`sessionId`, `«destructured»`, `overwrite?`): `Promise`\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> #### Parameters @@ -269,8 +269,8 @@ ___ #### Returns -`Promise`\<[`ResourceUpdatedResponse`](../modules/api.md#resourceupdatedresponse)\> +`Promise`\<[`ResourceUpdatedResponse`](../modules/api_models_ResourceUpdatedResponse.md#resourceupdatedresponse)\> #### Defined in -[src/managers/session.ts:89](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L89) +[src/managers/session.ts:89](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L89) diff --git a/docs/js-sdk-docs/classes/managers_tool.ToolsManager.md b/docs/js-sdk-docs/classes/managers_tool.ToolsManager.md index 2207952e0..334f6c50c 100644 --- a/docs/js-sdk-docs/classes/managers_tool.ToolsManager.md +++ b/docs/js-sdk-docs/classes/managers_tool.ToolsManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/tool](../modules/managers_tool.md) / ToolsManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/tool](../modules/managers_tool.md) / ToolsManager # Class: ToolsManager @@ -54,7 +54,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -70,13 +70,13 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### create -▸ **create**(`«destructured»`): `Promise`\<[`Tool`](../modules/api.md#tool)\> +▸ **create**(`«destructured»`): `Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)\> #### Parameters @@ -85,16 +85,16 @@ The JulepApiClient instance used for API interactions. | `«destructured»` | `Object` | | › `agentId` | `string` | | › `tool` | `Object` | -| › `tool.function` | [`FunctionDef`](../modules/api.md#functiondef) | +| › `tool.function` | [`FunctionDef`](../modules/api_models_FunctionDef.md#functiondef) | | › `tool.type` | ``"function"`` \| ``"webhook"`` | #### Returns -`Promise`\<[`Tool`](../modules/api.md#tool)\> +`Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)\> #### Defined in -[src/managers/tool.ts:32](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/tool.ts#L32) +[src/managers/tool.ts:32](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/tool.ts#L32) ___ @@ -116,13 +116,13 @@ ___ #### Defined in -[src/managers/tool.ts:86](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/tool.ts#L86) +[src/managers/tool.ts:86](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/tool.ts#L86) ___ ### list -▸ **list**(`agentId`, `«destructured»?`): `Promise`\<[`Tool`](../modules/api.md#tool)[]\> +▸ **list**(`agentId`, `«destructured»?`): `Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)[]\> #### Parameters @@ -135,17 +135,17 @@ ___ #### Returns -`Promise`\<[`Tool`](../modules/api.md#tool)[]\> +`Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)[]\> #### Defined in -[src/managers/tool.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/tool.ts#L12) +[src/managers/tool.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/tool.ts#L12) ___ ### update -▸ **update**(`«destructured»`, `overwrite?`): `Promise`\<[`Tool`](../modules/api.md#tool)\> +▸ **update**(`«destructured»`, `overwrite?`): `Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)\> #### Parameters @@ -153,14 +153,14 @@ ___ | :------ | :------ | :------ | | `«destructured»` | `Object` | `undefined` | | › `agentId` | `string` | `undefined` | -| › `tool` | [`UpdateToolRequest`](../modules/api.md#updatetoolrequest) | `undefined` | +| › `tool` | [`UpdateToolRequest`](../modules/api_models_UpdateToolRequest.md#updatetoolrequest) | `undefined` | | › `toolId` | `string` | `undefined` | | `overwrite` | `boolean` | `false` | #### Returns -`Promise`\<[`Tool`](../modules/api.md#tool)\> +`Promise`\<[`Tool`](../modules/api_models_Tool.md#tool)\> #### Defined in -[src/managers/tool.ts:54](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/tool.ts#L54) +[src/managers/tool.ts:54](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/tool.ts#L54) diff --git a/docs/js-sdk-docs/classes/managers_user.UsersManager.md b/docs/js-sdk-docs/classes/managers_user.UsersManager.md index ebe5d8b2d..222b33b00 100644 --- a/docs/js-sdk-docs/classes/managers_user.UsersManager.md +++ b/docs/js-sdk-docs/classes/managers_user.UsersManager.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/user](../modules/managers_user.md) / UsersManager +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/user](../modules/managers_user.md) / UsersManager # Class: UsersManager @@ -55,7 +55,7 @@ Constructs a new instance of BaseManager. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Properties @@ -71,27 +71,27 @@ The JulepApiClient instance used for API interactions. #### Defined in -[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/base.ts#L12) +[src/managers/base.ts:12](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/base.ts#L12) ## Methods ### create -▸ **create**(`«destructured»?`): `Promise`\<[`User`](../modules/api.md#user)\> +▸ **create**(`«destructured»?`): `Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Parameters | Name | Type | | :------ | :------ | -| `«destructured»` | [`CreateUserRequest`](../modules/api.md#createuserrequest) | +| `«destructured»` | [`CreateUserRequest`](../modules/api_models_CreateUserRequest.md#createuserrequest) | #### Returns -`Promise`\<[`User`](../modules/api.md#user)\> +`Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Defined in -[src/managers/user.ts:27](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L27) +[src/managers/user.ts:27](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L27) ___ @@ -111,13 +111,13 @@ ___ #### Defined in -[src/managers/user.ts:63](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L63) +[src/managers/user.ts:63](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L63) ___ ### get -▸ **get**(`userId`): `Promise`\<[`User`](../modules/api.md#user)\> +▸ **get**(`userId`): `Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Parameters @@ -127,17 +127,17 @@ ___ #### Returns -`Promise`\<[`User`](../modules/api.md#user)\> +`Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Defined in -[src/managers/user.ts:15](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L15) +[src/managers/user.ts:15](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L15) ___ ### list -▸ **list**(`«destructured»?`): `Promise`\<[`User`](../modules/api.md#user)[]\> +▸ **list**(`«destructured»?`): `Promise`\<[`User`](../modules/api_models_User.md#user)[]\> #### Parameters @@ -150,48 +150,48 @@ ___ #### Returns -`Promise`\<[`User`](../modules/api.md#user)[]\> +`Promise`\<[`User`](../modules/api_models_User.md#user)[]\> #### Defined in -[src/managers/user.ts:44](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L44) +[src/managers/user.ts:44](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L44) ___ ### update -▸ **update**(`userId`, `request`, `overwrite`): `Promise`\<[`User`](../modules/api.md#user)\> +▸ **update**(`userId`, `request`, `overwrite`): `Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Parameters | Name | Type | | :------ | :------ | | `userId` | `string` | -| `request` | [`UpdateUserRequest`](../modules/api.md#updateuserrequest) | +| `request` | [`UpdateUserRequest`](../modules/api_models_UpdateUserRequest.md#updateuserrequest) | | `overwrite` | ``true`` | #### Returns -`Promise`\<[`User`](../modules/api.md#user)\> +`Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Defined in -[src/managers/user.ts:73](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L73) +[src/managers/user.ts:73](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L73) -▸ **update**(`userId`, `request`, `overwrite?`): `Promise`\<[`User`](../modules/api.md#user)\> +▸ **update**(`userId`, `request`, `overwrite?`): `Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Parameters | Name | Type | | :------ | :------ | | `userId` | `string` | -| `request` | [`PatchUserRequest`](../modules/api.md#patchuserrequest) | +| `request` | [`PatchUserRequest`](../modules/api_models_PatchUserRequest.md#patchuserrequest) | | `overwrite?` | ``false`` | #### Returns -`Promise`\<[`User`](../modules/api.md#user)\> +`Promise`\<[`User`](../modules/api_models_User.md#user)\> #### Defined in -[src/managers/user.ts:79](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/user.ts#L79) +[src/managers/user.ts:79](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/user.ts#L79) diff --git a/docs/js-sdk-docs/classes/utils_requestConstructor.CustomHttpRequest.md b/docs/js-sdk-docs/classes/utils_requestConstructor.CustomHttpRequest.md index 6f6a2f0d7..84d0101df 100644 --- a/docs/js-sdk-docs/classes/utils_requestConstructor.CustomHttpRequest.md +++ b/docs/js-sdk-docs/classes/utils_requestConstructor.CustomHttpRequest.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [utils/requestConstructor](../modules/utils_requestConstructor.md) / CustomHttpRequest +[@julep/sdk](../README.md) / [Exports](../modules.md) / [utils/requestConstructor](../modules/utils_requestConstructor.md) / CustomHttpRequest # Class: CustomHttpRequest @@ -6,7 +6,7 @@ ## Hierarchy -- `AxiosHttpRequest` +- [`AxiosHttpRequest`](api_core_AxiosHttpRequest.AxiosHttpRequest.md) ↳ **`CustomHttpRequest`** @@ -34,7 +34,7 @@ | Name | Type | | :------ | :------ | -| `config` | [`OpenAPIConfig`](../modules/api.md#openapiconfig) | +| `config` | [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) | #### Returns @@ -42,31 +42,33 @@ #### Overrides -AxiosHttpRequest.constructor +[AxiosHttpRequest](api_core_AxiosHttpRequest.AxiosHttpRequest.md).[constructor](api_core_AxiosHttpRequest.AxiosHttpRequest.md#constructor) #### Defined in -[src/utils/requestConstructor.ts:16](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/requestConstructor.ts#L16) +[src/utils/requestConstructor.ts:16](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/requestConstructor.ts#L16) ## Properties ### config -• `Readonly` **config**: [`OpenAPIConfig`](../modules/api.md#openapiconfig) +• `Readonly` **config**: [`OpenAPIConfig`](../modules/api_core_OpenAPI.md#openapiconfig) #### Inherited from -AxiosHttpRequest.config +[AxiosHttpRequest](api_core_AxiosHttpRequest.AxiosHttpRequest.md).[config](api_core_AxiosHttpRequest.AxiosHttpRequest.md#config) #### Defined in -[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) +[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/BaseHttpRequest.ts#L10) ## Methods ### request -▸ **request**\<`T`\>(`options`): [`CancelablePromise`](api.CancelablePromise.md)\<`T`\> +▸ **request**\<`T`\>(`options`): [`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +Request method #### Type parameters @@ -76,18 +78,24 @@ AxiosHttpRequest.config #### Parameters -| Name | Type | -| :------ | :------ | -| `options` | `ApiRequestOptions` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`ApiRequestOptions`](../modules/api_core_ApiRequestOptions.md#apirequestoptions) | The request options from the service | #### Returns -[`CancelablePromise`](api.CancelablePromise.md)\<`T`\> +[`CancelablePromise`](api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +CancelablePromise + +**`Throws`** + +ApiError #### Overrides -AxiosHttpRequest.request +[AxiosHttpRequest](api_core_AxiosHttpRequest.AxiosHttpRequest.md).[request](api_core_AxiosHttpRequest.AxiosHttpRequest.md#request) #### Defined in -[src/utils/requestConstructor.ts:21](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/requestConstructor.ts#L21) +[src/utils/requestConstructor.ts:21](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/requestConstructor.ts#L21) diff --git a/docs/js-sdk-docs/interfaces/api_core_CancelablePromise.OnCancel.md b/docs/js-sdk-docs/interfaces/api_core_CancelablePromise.OnCancel.md new file mode 100644 index 000000000..179c3fbfc --- /dev/null +++ b/docs/js-sdk-docs/interfaces/api_core_CancelablePromise.OnCancel.md @@ -0,0 +1,63 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / [api/core/CancelablePromise](../modules/api_core_CancelablePromise.md) / OnCancel + +# Interface: OnCancel + +[api/core/CancelablePromise](../modules/api_core_CancelablePromise.md).OnCancel + +## Callable + +### OnCancel + +▸ **OnCancel**(`cancelHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cancelHandler` | () => `void` | + +#### Returns + +`void` + +#### Defined in + +[src/api/core/CancelablePromise.ts:21](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L21) + +## Table of contents + +### Properties + +- [isCancelled](api_core_CancelablePromise.OnCancel.md#iscancelled) +- [isRejected](api_core_CancelablePromise.OnCancel.md#isrejected) +- [isResolved](api_core_CancelablePromise.OnCancel.md#isresolved) + +## Properties + +### isCancelled + +• `Readonly` **isCancelled**: `boolean` + +#### Defined in + +[src/api/core/CancelablePromise.ts:19](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L19) + +___ + +### isRejected + +• `Readonly` **isRejected**: `boolean` + +#### Defined in + +[src/api/core/CancelablePromise.ts:18](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L18) + +___ + +### isResolved + +• `Readonly` **isResolved**: `boolean` + +#### Defined in + +[src/api/core/CancelablePromise.ts:17](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/CancelablePromise.ts#L17) diff --git a/docs/js-sdk-docs/interfaces/managers_session.CreateSessionPayload.md b/docs/js-sdk-docs/interfaces/managers_session.CreateSessionPayload.md index df323916f..e5c1135b8 100644 --- a/docs/js-sdk-docs/interfaces/managers_session.CreateSessionPayload.md +++ b/docs/js-sdk-docs/interfaces/managers_session.CreateSessionPayload.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / [managers/session](../modules/managers_session.md) / CreateSessionPayload +[@julep/sdk](../README.md) / [Exports](../modules.md) / [managers/session](../modules/managers_session.md) / CreateSessionPayload # Interface: CreateSessionPayload @@ -22,7 +22,7 @@ #### Defined in -[src/managers/session.ts:17](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L17) +[src/managers/session.ts:17](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L17) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/managers/session.ts:19](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L19) +[src/managers/session.ts:19](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L19) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/managers/session.ts:20](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L20) +[src/managers/session.ts:20](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L20) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/managers/session.ts:18](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L18) +[src/managers/session.ts:18](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L18) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/managers/session.ts:16](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/managers/session.ts#L16) +[src/managers/session.ts:16](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/managers/session.ts#L16) diff --git a/docs/js-sdk-docs/modules.md b/docs/js-sdk-docs/modules.md index ec445aa16..626acd7d0 100644 --- a/docs/js-sdk-docs/modules.md +++ b/docs/js-sdk-docs/modules.md @@ -1,4 +1,4 @@ -[@julep/sdk](README.md) / Modules +[@julep/sdk](README.md) / Exports # @julep/sdk @@ -8,6 +8,114 @@ - [api](modules/api.md) - [api/JulepApiClient](modules/api_JulepApiClient.md) +- [api/core/ApiError](modules/api_core_ApiError.md) +- [api/core/ApiRequestOptions](modules/api_core_ApiRequestOptions.md) +- [api/core/ApiResult](modules/api_core_ApiResult.md) +- [api/core/AxiosHttpRequest](modules/api_core_AxiosHttpRequest.md) +- [api/core/BaseHttpRequest](modules/api_core_BaseHttpRequest.md) +- [api/core/CancelablePromise](modules/api_core_CancelablePromise.md) +- [api/core/OpenAPI](modules/api_core_OpenAPI.md) +- [api/core/request](modules/api_core_request.md) +- [api/models/Agent](modules/api_models_Agent.md) +- [api/models/AgentDefaultSettings](modules/api_models_AgentDefaultSettings.md) +- [api/models/ChatInput](modules/api_models_ChatInput.md) +- [api/models/ChatInputData](modules/api_models_ChatInputData.md) +- [api/models/ChatMLMessage](modules/api_models_ChatMLMessage.md) +- [api/models/ChatResponse](modules/api_models_ChatResponse.md) +- [api/models/ChatSettings](modules/api_models_ChatSettings.md) +- [api/models/CompletionUsage](modules/api_models_CompletionUsage.md) +- [api/models/CreateAgentRequest](modules/api_models_CreateAgentRequest.md) +- [api/models/CreateDoc](modules/api_models_CreateDoc.md) +- [api/models/CreateSessionRequest](modules/api_models_CreateSessionRequest.md) +- [api/models/CreateToolRequest](modules/api_models_CreateToolRequest.md) +- [api/models/CreateUserRequest](modules/api_models_CreateUserRequest.md) +- [api/models/Doc](modules/api_models_Doc.md) +- [api/models/DocIds](modules/api_models_DocIds.md) +- [api/models/FunctionCallOption](modules/api_models_FunctionCallOption.md) +- [api/models/FunctionDef](modules/api_models_FunctionDef.md) +- [api/models/FunctionParameters](modules/api_models_FunctionParameters.md) +- [api/models/InputChatMLMessage](modules/api_models_InputChatMLMessage.md) +- [api/models/JobStatus](modules/api_models_JobStatus.md) +- [api/models/Memory](modules/api_models_Memory.md) +- [api/models/MemoryAccessOptions](modules/api_models_MemoryAccessOptions.md) +- [api/models/NamedToolChoice](modules/api_models_NamedToolChoice.md) +- [api/models/PartialFunctionDef](modules/api_models_PartialFunctionDef.md) +- [api/models/PatchAgentRequest](modules/api_models_PatchAgentRequest.md) +- [api/models/PatchSessionRequest](modules/api_models_PatchSessionRequest.md) +- [api/models/PatchToolRequest](modules/api_models_PatchToolRequest.md) +- [api/models/PatchUserRequest](modules/api_models_PatchUserRequest.md) +- [api/models/ResourceCreatedResponse](modules/api_models_ResourceCreatedResponse.md) +- [api/models/ResourceDeletedResponse](modules/api_models_ResourceDeletedResponse.md) +- [api/models/ResourceUpdatedResponse](modules/api_models_ResourceUpdatedResponse.md) +- [api/models/Session](modules/api_models_Session.md) +- [api/models/Suggestion](modules/api_models_Suggestion.md) +- [api/models/Tool](modules/api_models_Tool.md) +- [api/models/ToolChoiceOption](modules/api_models_ToolChoiceOption.md) +- [api/models/UpdateAgentRequest](modules/api_models_UpdateAgentRequest.md) +- [api/models/UpdateSessionRequest](modules/api_models_UpdateSessionRequest.md) +- [api/models/UpdateToolRequest](modules/api_models_UpdateToolRequest.md) +- [api/models/UpdateUserRequest](modules/api_models_UpdateUserRequest.md) +- [api/models/User](modules/api_models_User.md) +- [api/models/agent\_id](modules/api_models_agent_id.md) +- [api/models/doc\_id](modules/api_models_doc_id.md) +- [api/models/job\_id](modules/api_models_job_id.md) +- [api/models/memory\_id](modules/api_models_memory_id.md) +- [api/models/message\_id](modules/api_models_message_id.md) +- [api/models/session\_id](modules/api_models_session_id.md) +- [api/models/tool\_id](modules/api_models_tool_id.md) +- [api/models/user\_id](modules/api_models_user_id.md) +- [api/schemas/$Agent](modules/api_schemas__Agent.md) +- [api/schemas/$AgentDefaultSettings](modules/api_schemas__AgentDefaultSettings.md) +- [api/schemas/$ChatInput](modules/api_schemas__ChatInput.md) +- [api/schemas/$ChatInputData](modules/api_schemas__ChatInputData.md) +- [api/schemas/$ChatMLMessage](modules/api_schemas__ChatMLMessage.md) +- [api/schemas/$ChatResponse](modules/api_schemas__ChatResponse.md) +- [api/schemas/$ChatSettings](modules/api_schemas__ChatSettings.md) +- [api/schemas/$CompletionUsage](modules/api_schemas__CompletionUsage.md) +- [api/schemas/$CreateAgentRequest](modules/api_schemas__CreateAgentRequest.md) +- [api/schemas/$CreateDoc](modules/api_schemas__CreateDoc.md) +- [api/schemas/$CreateSessionRequest](modules/api_schemas__CreateSessionRequest.md) +- [api/schemas/$CreateToolRequest](modules/api_schemas__CreateToolRequest.md) +- [api/schemas/$CreateUserRequest](modules/api_schemas__CreateUserRequest.md) +- [api/schemas/$Doc](modules/api_schemas__Doc.md) +- [api/schemas/$DocIds](modules/api_schemas__DocIds.md) +- [api/schemas/$FunctionCallOption](modules/api_schemas__FunctionCallOption.md) +- [api/schemas/$FunctionDef](modules/api_schemas__FunctionDef.md) +- [api/schemas/$FunctionParameters](modules/api_schemas__FunctionParameters.md) +- [api/schemas/$InputChatMLMessage](modules/api_schemas__InputChatMLMessage.md) +- [api/schemas/$JobStatus](modules/api_schemas__JobStatus.md) +- [api/schemas/$Memory](modules/api_schemas__Memory.md) +- [api/schemas/$MemoryAccessOptions](modules/api_schemas__MemoryAccessOptions.md) +- [api/schemas/$NamedToolChoice](modules/api_schemas__NamedToolChoice.md) +- [api/schemas/$PartialFunctionDef](modules/api_schemas__PartialFunctionDef.md) +- [api/schemas/$PatchAgentRequest](modules/api_schemas__PatchAgentRequest.md) +- [api/schemas/$PatchSessionRequest](modules/api_schemas__PatchSessionRequest.md) +- [api/schemas/$PatchToolRequest](modules/api_schemas__PatchToolRequest.md) +- [api/schemas/$PatchUserRequest](modules/api_schemas__PatchUserRequest.md) +- [api/schemas/$ResourceCreatedResponse](modules/api_schemas__ResourceCreatedResponse.md) +- [api/schemas/$ResourceDeletedResponse](modules/api_schemas__ResourceDeletedResponse.md) +- [api/schemas/$ResourceUpdatedResponse](modules/api_schemas__ResourceUpdatedResponse.md) +- [api/schemas/$Session](modules/api_schemas__Session.md) +- [api/schemas/$Suggestion](modules/api_schemas__Suggestion.md) +- [api/schemas/$Tool](modules/api_schemas__Tool.md) +- [api/schemas/$ToolChoiceOption](modules/api_schemas__ToolChoiceOption.md) +- [api/schemas/$UpdateAgentRequest](modules/api_schemas__UpdateAgentRequest.md) +- [api/schemas/$UpdateSessionRequest](modules/api_schemas__UpdateSessionRequest.md) +- [api/schemas/$UpdateToolRequest](modules/api_schemas__UpdateToolRequest.md) +- [api/schemas/$UpdateUserRequest](modules/api_schemas__UpdateUserRequest.md) +- [api/schemas/$User](modules/api_schemas__User.md) +- [api/schemas/$agent\_id](modules/api_schemas__agent_id.md) +- [api/schemas/$doc\_id](modules/api_schemas__doc_id.md) +- [api/schemas/$job\_id](modules/api_schemas__job_id.md) +- [api/schemas/$memory\_id](modules/api_schemas__memory_id.md) +- [api/schemas/$message\_id](modules/api_schemas__message_id.md) +- [api/schemas/$session\_id](modules/api_schemas__session_id.md) +- [api/schemas/$tool\_id](modules/api_schemas__tool_id.md) +- [api/schemas/$user\_id](modules/api_schemas__user_id.md) +- [api/services/DefaultService](modules/api_services_DefaultService.md) +- [client](modules/client.md) +- [env](modules/env.md) +- [index](modules/index.md) - [managers/agent](modules/managers_agent.md) - [managers/base](modules/managers_base.md) - [managers/doc](modules/managers_doc.md) diff --git a/docs/js-sdk-docs/modules/api.md b/docs/js-sdk-docs/modules/api.md index c1ccc945f..3cbc8893b 100644 --- a/docs/js-sdk-docs/modules/api.md +++ b/docs/js-sdk-docs/modules/api.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / api +[@julep/sdk](../README.md) / [Exports](../modules.md) / api # Module: api @@ -6,69 +6,6 @@ ### References -- [JulepApiClient](api.md#julepapiclient) - -### Classes - -- [ApiError](../classes/api.ApiError.md) -- [BaseHttpRequest](../classes/api.BaseHttpRequest.md) -- [CancelError](../classes/api.CancelError.md) -- [CancelablePromise](../classes/api.CancelablePromise.md) -- [DefaultService](../classes/api.DefaultService.md) - -### Type Aliases - -- [Agent](api.md#agent) -- [AgentDefaultSettings](api.md#agentdefaultsettings) -- [ChatInput](api.md#chatinput) -- [ChatInputData](api.md#chatinputdata) -- [ChatMLMessage](api.md#chatmlmessage) -- [ChatResponse](api.md#chatresponse) -- [ChatSettings](api.md#chatsettings) -- [CompletionUsage](api.md#completionusage) -- [CreateAgentRequest](api.md#createagentrequest) -- [CreateDoc](api.md#createdoc) -- [CreateSessionRequest](api.md#createsessionrequest) -- [CreateToolRequest](api.md#createtoolrequest) -- [CreateUserRequest](api.md#createuserrequest) -- [Doc](api.md#doc) -- [FunctionCallOption](api.md#functioncalloption) -- [FunctionDef](api.md#functiondef) -- [FunctionParameters](api.md#functionparameters) -- [InputChatMLMessage](api.md#inputchatmlmessage) -- [JobStatus](api.md#jobstatus) -- [Memory](api.md#memory) -- [MemoryAccessOptions](api.md#memoryaccessoptions) -- [NamedToolChoice](api.md#namedtoolchoice) -- [OpenAPIConfig](api.md#openapiconfig) -- [PartialFunctionDef](api.md#partialfunctiondef) -- [PatchAgentRequest](api.md#patchagentrequest) -- [PatchSessionRequest](api.md#patchsessionrequest) -- [PatchToolRequest](api.md#patchtoolrequest) -- [PatchUserRequest](api.md#patchuserrequest) -- [ResourceCreatedResponse](api.md#resourcecreatedresponse) -- [ResourceDeletedResponse](api.md#resourcedeletedresponse) -- [ResourceUpdatedResponse](api.md#resourceupdatedresponse) -- [Session](api.md#session) -- [Suggestion](api.md#suggestion) -- [Tool](api.md#tool) -- [ToolChoiceOption](api.md#toolchoiceoption) -- [UpdateAgentRequest](api.md#updateagentrequest) -- [UpdateSessionRequest](api.md#updatesessionrequest) -- [UpdateToolRequest](api.md#updatetoolrequest) -- [UpdateUserRequest](api.md#updateuserrequest) -- [User](api.md#user) -- [agent\_id](api.md#agent_id) -- [doc\_id](api.md#doc_id) -- [job\_id](api.md#job_id) -- [memory\_id](api.md#memory_id) -- [message\_id](api.md#message_id) -- [session\_id](api.md#session_id) -- [tool\_id](api.md#tool_id) -- [user\_id](api.md#user_id) - -### Variables - - [$Agent](api.md#$agent) - [$AgentDefaultSettings](api.md#$agentdefaultsettings) - [$ChatInput](api.md#$chatinput) @@ -83,6 +20,7 @@ - [$CreateToolRequest](api.md#$createtoolrequest) - [$CreateUserRequest](api.md#$createuserrequest) - [$Doc](api.md#$doc) +- [$DocIds](api.md#$docids) - [$FunctionCallOption](api.md#$functioncalloption) - [$FunctionDef](api.md#$functiondef) - [$FunctionParameters](api.md#$functionparameters) @@ -116,2331 +54,683 @@ - [$session\_id](api.md#$session_id) - [$tool\_id](api.md#$tool_id) - [$user\_id](api.md#$user_id) +- [Agent](api.md#agent) +- [AgentDefaultSettings](api.md#agentdefaultsettings) +- [ApiError](api.md#apierror) +- [BaseHttpRequest](api.md#basehttprequest) +- [CancelError](api.md#cancelerror) +- [CancelablePromise](api.md#cancelablepromise) +- [ChatInput](api.md#chatinput) +- [ChatInputData](api.md#chatinputdata) +- [ChatMLMessage](api.md#chatmlmessage) +- [ChatResponse](api.md#chatresponse) +- [ChatSettings](api.md#chatsettings) +- [CompletionUsage](api.md#completionusage) +- [CreateAgentRequest](api.md#createagentrequest) +- [CreateDoc](api.md#createdoc) +- [CreateSessionRequest](api.md#createsessionrequest) +- [CreateToolRequest](api.md#createtoolrequest) +- [CreateUserRequest](api.md#createuserrequest) +- [DefaultService](api.md#defaultservice) +- [Doc](api.md#doc) +- [DocIds](api.md#docids) +- [FunctionCallOption](api.md#functioncalloption) +- [FunctionDef](api.md#functiondef) +- [FunctionParameters](api.md#functionparameters) +- [InputChatMLMessage](api.md#inputchatmlmessage) +- [JobStatus](api.md#jobstatus) +- [JulepApiClient](api.md#julepapiclient) +- [Memory](api.md#memory) +- [MemoryAccessOptions](api.md#memoryaccessoptions) +- [NamedToolChoice](api.md#namedtoolchoice) - [OpenAPI](api.md#openapi) +- [OpenAPIConfig](api.md#openapiconfig) +- [PartialFunctionDef](api.md#partialfunctiondef) +- [PatchAgentRequest](api.md#patchagentrequest) +- [PatchSessionRequest](api.md#patchsessionrequest) +- [PatchToolRequest](api.md#patchtoolrequest) +- [PatchUserRequest](api.md#patchuserrequest) +- [ResourceCreatedResponse](api.md#resourcecreatedresponse) +- [ResourceDeletedResponse](api.md#resourcedeletedresponse) +- [ResourceUpdatedResponse](api.md#resourceupdatedresponse) +- [Session](api.md#session) +- [Suggestion](api.md#suggestion) +- [Tool](api.md#tool) +- [ToolChoiceOption](api.md#toolchoiceoption) +- [UpdateAgentRequest](api.md#updateagentrequest) +- [UpdateSessionRequest](api.md#updatesessionrequest) +- [UpdateToolRequest](api.md#updatetoolrequest) +- [UpdateUserRequest](api.md#updateuserrequest) +- [User](api.md#user) +- [agent\_id](api.md#agent_id) +- [doc\_id](api.md#doc_id) +- [job\_id](api.md#job_id) +- [memory\_id](api.md#memory_id) +- [message\_id](api.md#message_id) +- [session\_id](api.md#session_id) +- [tool\_id](api.md#tool_id) +- [user\_id](api.md#user_id) -## References - -### JulepApiClient - -Re-exports [JulepApiClient](../classes/api_JulepApiClient.JulepApiClient.md) - -## Type Aliases - -### Agent - -Ƭ **Agent**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the agent | -| `created_at?` | `string` | Agent created at (RFC-3339 format) | -| `default_settings?` | [`AgentDefaultSettings`](api.md#agentdefaultsettings) | Default settings for all sessions created by this agent | -| `id` | `string` | Agent id (UUID) | -| `instructions?` | `string` \| `string`[] | Instructions for the agent | -| `metadata?` | `any` | Optional metadata | -| `model` | `string` | The model to use with this agent | -| `name` | `string` | Name of the agent | -| `updated_at?` | `string` | Agent updated at (RFC-3339 format) | - -#### Defined in - -[src/api/models/Agent.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Agent.ts#L6) - -___ - -### AgentDefaultSettings - -Ƭ **AgentDefaultSettings**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `frequency_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `length_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. | -| `min_p?` | `number` | Minimum probability compared to leading token to be considered | -| `presence_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `preset?` | ``"problem_solving"`` \| ``"conversational"`` \| ``"fun"`` \| ``"prose"`` \| ``"creative"`` \| ``"business"`` \| ``"deterministic"`` \| ``"code"`` \| ``"multilingual"`` | Generation preset name (one of: problem_solving, conversational, fun, prose, creative, business, deterministic, code, multilingual) | -| `repetition_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `temperature?` | `number` \| ``null`` | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. | -| `top_p?` | `number` \| ``null`` | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. | - -#### Defined in - -[src/api/models/AgentDefaultSettings.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/AgentDefaultSettings.ts#L5) - -___ - -### ChatInput - -Ƭ **ChatInput**: [`ChatInputData`](api.md#chatinputdata) & [`ChatSettings`](api.md#chatsettings) & [`MemoryAccessOptions`](api.md#memoryaccessoptions) - -#### Defined in - -[src/api/models/ChatInput.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ChatInput.ts#L8) - -___ - -### ChatInputData - -Ƭ **ChatInputData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `messages` | [`InputChatMLMessage`](api.md#inputchatmlmessage)[] | A list of new input messages comprising the conversation so far. | -| `tool_choice?` | [`ToolChoiceOption`](api.md#toolchoiceoption) \| [`NamedToolChoice`](api.md#namedtoolchoice) \| ``null`` | Can be one of existing tools given to the agent earlier or the ones included in the request | -| `tools?` | [`Tool`](api.md#tool)[] \| ``null`` | (Advanced) List of tools that are provided in addition to agent's default set of tools. Functions of same name in agent set are overriden | - -#### Defined in - -[src/api/models/ChatInputData.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ChatInputData.ts#L9) - -___ - -### ChatMLMessage - -Ƭ **ChatMLMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `content` | `string` | ChatML content | -| `created_at` | `string` | Message created at (RFC-3339 format) | -| `id` | `string` | Message ID | -| `name?` | `string` | ChatML name | -| `role` | ``"user"`` \| ``"assistant"`` \| ``"system"`` \| ``"function_call"`` \| ``"function"`` | ChatML role (system\|assistant\|user\|function_call\|function) | - -#### Defined in - -[src/api/models/ChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ChatMLMessage.ts#L5) - -___ - -### ChatResponse - -Ƭ **ChatResponse**: `Object` - -Represents a chat completion response returned by model, based on the provided input. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `finish_reason` | ``"stop"`` \| ``"length"`` \| ``"tool_calls"`` \| ``"content_filter"`` \| ``"function_call"`` | The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. | -| `id` | `string` | A unique identifier for the chat completion. | -| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | -| `response` | [`ChatMLMessage`](api.md#chatmlmessage)[][] | A list of chat completion messages produced as a response. | -| `usage` | [`CompletionUsage`](api.md#completionusage) | - | - -#### Defined in - -[src/api/models/ChatResponse.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ChatResponse.ts#L10) - -___ - -### ChatSettings - -Ƭ **ChatSettings**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `frequency_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `length_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. | -| `logit_bias?` | `Record`\<`string`, `number`\> \| ``null`` | Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. | -| `max_tokens?` | `number` \| ``null`` | The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. | -| `min_p?` | `number` | Minimum probability compared to leading token to be considered | -| `presence_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `preset?` | ``"problem_solving"`` \| ``"conversational"`` \| ``"fun"`` \| ``"prose"`` \| ``"creative"`` \| ``"business"`` \| ``"deterministic"`` \| ``"code"`` \| ``"multilingual"`` | Generation preset name (problem_solving\|conversational\|fun\|prose\|creative\|business\|deterministic\|code\|multilingual) | -| `repetition_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | -| `response_format?` | \{ `pattern?`: `string` ; `schema?`: `any` ; `type?`: ``"text"`` \| ``"json_object"`` \| ``"regex"`` } | An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. | -| `response_format.pattern?` | `string` | Regular expression pattern to use if `type` is `"regex"` | -| `response_format.schema?` | `any` | JSON Schema to use if `type` is `"json_object"` | -| `response_format.type?` | ``"text"`` \| ``"json_object"`` \| ``"regex"`` | Must be one of `"text"`, `"regex"` or `"json_object"`. | -| `seed?` | `number` \| ``null`` | This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. | -| `stop?` | `string` \| ``null`` \| `string`[] | Up to 4 sequences where the API will stop generating further tokens. | -| `stream?` | `boolean` \| ``null`` | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). | -| `temperature?` | `number` \| ``null`` | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. | -| `top_p?` | `number` \| ``null`` | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. | - -#### Defined in - -[src/api/models/ChatSettings.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ChatSettings.ts#L5) - -___ - -### CompletionUsage - -Ƭ **CompletionUsage**: `Object` - -Usage statistics for the completion request. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `completion_tokens` | `number` | Number of tokens in the generated completion. | -| `prompt_tokens` | `number` | Number of tokens in the prompt. | -| `total_tokens` | `number` | Total number of tokens used in the request (prompt + completion). | - -#### Defined in - -[src/api/models/CompletionUsage.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CompletionUsage.ts#L8) - -___ - -### CreateAgentRequest - -Ƭ **CreateAgentRequest**: `Object` - -A valid request payload for creating an agent - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the agent | -| `default_settings?` | [`AgentDefaultSettings`](api.md#agentdefaultsettings) | Default model settings to start every session with | -| `docs?` | [`CreateDoc`](api.md#createdoc)[] | List of docs about agent | -| `instructions?` | `string` \| `string`[] | Instructions for the agent | -| `metadata?` | `any` | (Optional) metadata | -| `model?` | `string` | Name of the model that the agent is supposed to use | -| `name` | `string` | Name of the agent | -| `tools?` | [`CreateToolRequest`](api.md#createtoolrequest)[] | A list of tools the model may call. Currently, only `function`s are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | - -#### Defined in - -[src/api/models/CreateAgentRequest.ts:11](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CreateAgentRequest.ts#L11) - -___ - -### CreateDoc - -Ƭ **CreateDoc**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `content` | `string` | Information content | -| `metadata?` | `any` | Optional metadata | -| `title` | `string` | Title describing what this bit of information contains | - -#### Defined in - -[src/api/models/CreateDoc.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CreateDoc.ts#L5) - -___ - -### CreateSessionRequest - -Ƭ **CreateSessionRequest**: `Object` - -A valid request payload for creating a session - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agent_id` | `string` | Agent ID of agent to associate with this session | -| `metadata?` | `any` | Optional metadata | -| `render_templates?` | `boolean` | Render system and assistant message content as jinja templates | -| `situation?` | `string` | A specific situation that sets the background for this session | -| `user_id?` | `string` | (Optional) User ID of user to associate with this session | - -#### Defined in - -[src/api/models/CreateSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CreateSessionRequest.ts#L8) - -___ - -### CreateToolRequest - -Ƭ **CreateToolRequest**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `function` | [`FunctionDef`](api.md#functiondef) | Function definition and parameters | -| `type` | ``"function"`` \| ``"webhook"`` | Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) | - -#### Defined in - -[src/api/models/CreateToolRequest.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CreateToolRequest.ts#L6) - -___ - -### CreateUserRequest - -Ƭ **CreateUserRequest**: `Object` - -A valid request payload for creating a user - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the user | -| `docs?` | [`CreateDoc`](api.md#createdoc)[] | List of docs about user | -| `metadata?` | `any` | (Optional) metadata | -| `name?` | `string` | Name of the user | - -#### Defined in - -[src/api/models/CreateUserRequest.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/CreateUserRequest.ts#L9) - -___ - -### Doc - -Ƭ **Doc**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `content` | `string` | Information content | -| `created_at` | `string` | Doc created at | -| `id` | `string` | ID of doc | -| `metadata?` | `any` | optional metadata | -| `title` | `string` | Title describing what this bit of information contains | - -#### Defined in - -[src/api/models/Doc.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Doc.ts#L5) - -___ - -### FunctionCallOption - -Ƭ **FunctionCallOption**: `Object` - -Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | The name of the function to call. | - -#### Defined in - -[src/api/models/FunctionCallOption.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/FunctionCallOption.ts#L9) - -___ - -### FunctionDef - -Ƭ **FunctionDef**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `description?` | `string` | A description of what the function does, used by the model to choose when and how to call the function. | -| `name` | `string` | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | -| `parameters` | [`FunctionParameters`](api.md#functionparameters) | Parameters accepeted by this function | - -#### Defined in - -[src/api/models/FunctionDef.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/FunctionDef.ts#L6) - -___ - -### FunctionParameters - -Ƭ **FunctionParameters**: `Record`\<`string`, `any`\> - -The parameters the functions accepts, described as a JSON Schema object. - -#### Defined in - -[src/api/models/FunctionParameters.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/FunctionParameters.ts#L8) - -___ - -### InputChatMLMessage - -Ƭ **InputChatMLMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `content` | `string` | ChatML content | -| `continue?` | `boolean` | Whether to continue this message or return a new one | -| `name?` | `string` | ChatML name | -| `role` | ``"user"`` \| ``"assistant"`` \| ``"system"`` \| ``"function_call"`` \| ``"function"`` \| ``"auto"`` | ChatML role (system\|assistant\|user\|function_call\|function\|auto) | - -#### Defined in - -[src/api/models/InputChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/InputChatMLMessage.ts#L5) - -___ - -### JobStatus - -Ƭ **JobStatus**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `created_at` | `string` | Job created at (RFC-3339 format) | -| `has_progress?` | `boolean` | Whether this Job supports progress updates | -| `id` | `string` | Job id (UUID) | -| `name` | `string` | Name of the job | -| `progress?` | `number` | Progress percentage | -| `reason?` | `string` | Reason for current state | -| `state` | ``"pending"`` \| ``"in_progress"`` \| ``"retrying"`` \| ``"succeeded"`` \| ``"aborted"`` \| ``"failed"`` \| ``"unknown"`` | Current state (one of: pending, in_progress, retrying, succeeded, aborted, failed) | -| `updated_at?` | `string` | Job updated at (RFC-3339 format) | - -#### Defined in - -[src/api/models/JobStatus.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/JobStatus.ts#L5) - -___ - -### Memory - -Ƭ **Memory**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agent_id` | `string` | ID of the agent | -| `content` | `string` | Content of the memory | -| `created_at` | `string` | Memory created at (RFC-3339 format) | -| `entities` | `any`[] | List of entities mentioned in the memory | -| `id` | `string` | Memory id (UUID) | -| `last_accessed_at?` | `string` | Memory last accessed at (RFC-3339 format) | -| `sentiment?` | `number` | Sentiment (valence) of the memory on a scale of -1 to 1 | -| `timestamp?` | `string` | Memory happened at (RFC-3339 format) | -| `user_id` | `string` | ID of the user | - -#### Defined in - -[src/api/models/Memory.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Memory.ts#L5) - -___ - -### MemoryAccessOptions - -Ƭ **MemoryAccessOptions**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recall?` | `boolean` | Whether previous memories should be recalled or not | -| `record?` | `boolean` | Whether this interaction should be recorded in history or not | -| `remember?` | `boolean` | Whether this interaction should form memories or not | - -#### Defined in - -[src/api/models/MemoryAccessOptions.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/MemoryAccessOptions.ts#L5) - -___ - -### NamedToolChoice - -Ƭ **NamedToolChoice**: `Object` - -Specifies a tool the model should use. Use to force the model to call a specific function. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `function` | \{ `name`: `string` } | - | -| `function.name` | `string` | The name of the function to call. | -| `type` | ``"function"`` | The type of the tool. Currently, only `function` is supported. | - -#### Defined in - -[src/api/models/NamedToolChoice.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/NamedToolChoice.ts#L8) - -___ - -### OpenAPIConfig - -Ƭ **OpenAPIConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `BASE` | `string` | -| `CREDENTIALS` | ``"include"`` \| ``"omit"`` \| ``"same-origin"`` | -| `ENCODE_PATH?` | (`path`: `string`) => `string` | -| `HEADERS?` | `Headers` \| `Resolver`\<`Headers`\> | -| `PASSWORD?` | `string` \| `Resolver`\<`string`\> | -| `TOKEN?` | `string` \| `Resolver`\<`string`\> | -| `USERNAME?` | `string` \| `Resolver`\<`string`\> | -| `VERSION` | `string` | -| `WITH_CREDENTIALS` | `boolean` | - -#### Defined in - -[src/api/core/OpenAPI.ts:10](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/OpenAPI.ts#L10) - -___ - -### PartialFunctionDef - -Ƭ **PartialFunctionDef**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `description?` | `string` | A description of what the function does, used by the model to choose when and how to call the function. | -| `name?` | `string` | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | -| `parameters?` | [`FunctionParameters`](api.md#functionparameters) | Parameters accepeted by this function | - -#### Defined in - -[src/api/models/PartialFunctionDef.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/PartialFunctionDef.ts#L6) - -___ - -### PatchAgentRequest - -Ƭ **PatchAgentRequest**: `Object` - -A request for patching an agent - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the agent | -| `default_settings?` | [`AgentDefaultSettings`](api.md#agentdefaultsettings) | Default model settings to start every session with | -| `instructions?` | `string` \| `string`[] | Instructions for the agent | -| `metadata?` | `any` | Optional metadata | -| `model?` | `string` | Name of the model that the agent is supposed to use | -| `name?` | `string` | Name of the agent | - -#### Defined in - -[src/api/models/PatchAgentRequest.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/PatchAgentRequest.ts#L9) - -___ - -### PatchSessionRequest - -Ƭ **PatchSessionRequest**: `Object` - -A request for patching a session - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `metadata?` | `any` | Optional metadata | -| `situation?` | `string` | Updated situation for this session | - -#### Defined in - -[src/api/models/PatchSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/PatchSessionRequest.ts#L8) - -___ - -### PatchToolRequest - -Ƭ **PatchToolRequest**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `function` | [`PartialFunctionDef`](api.md#partialfunctiondef) | Function definition and parameters | - -#### Defined in - -[src/api/models/PatchToolRequest.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/PatchToolRequest.ts#L6) - -___ - -### PatchUserRequest - -Ƭ **PatchUserRequest**: `Object` - -A request for patching a user - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the user | -| `metadata?` | `any` | Optional metadata | -| `name?` | `string` | Name of the user | - -#### Defined in - -[src/api/models/PatchUserRequest.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/PatchUserRequest.ts#L8) - -___ - -### ResourceCreatedResponse - -Ƭ **ResourceCreatedResponse**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `created_at` | `string` | - | -| `id` | `string` | - | -| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | - -#### Defined in - -[src/api/models/ResourceCreatedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ResourceCreatedResponse.ts#L5) - -___ - -### ResourceDeletedResponse - -Ƭ **ResourceDeletedResponse**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deleted_at` | `string` | - | -| `id` | `string` | - | -| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | - -#### Defined in - -[src/api/models/ResourceDeletedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ResourceDeletedResponse.ts#L5) - -___ - -### ResourceUpdatedResponse - -Ƭ **ResourceUpdatedResponse**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | - | -| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | -| `updated_at` | `string` | - | - -#### Defined in - -[src/api/models/ResourceUpdatedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ResourceUpdatedResponse.ts#L5) - -___ - -### Session - -Ƭ **Session**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `agent_id` | `string` | Agent ID of agent associated with this session | -| `created_at?` | `string` | Session created at (RFC-3339 format) | -| `id` | `string` | Session id (UUID) | -| `metadata?` | `any` | Optional metadata | -| `render_templates?` | `boolean` | Render system and assistant message content as jinja templates | -| `situation?` | `string` | A specific situation that sets the background for this session | -| `summary?` | `string` | (null at the beginning) - generated automatically after every interaction | -| `updated_at?` | `string` | Session updated at (RFC-3339 format) | -| `user_id?` | `string` | User ID of user associated with this session | - -#### Defined in - -[src/api/models/Session.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Session.ts#L5) - -___ - -### Suggestion - -Ƭ **Suggestion**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `content` | `string` | The content of the suggestion | -| `created_at?` | `string` | Suggestion created at (RFC-3339 format) | -| `message_id` | `string` | The message that produced it | -| `session_id` | `string` | Session this suggestion belongs to | -| `target` | ``"user"`` \| ``"agent"`` | Whether the suggestion is for the `agent` or a `user` | - -#### Defined in - -[src/api/models/Suggestion.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Suggestion.ts#L5) - -___ - -### Tool - -Ƭ **Tool**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `function` | [`FunctionDef`](api.md#functiondef) | Function definition and parameters | -| `id` | `string` | Tool ID | -| `type` | ``"function"`` \| ``"webhook"`` | Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) | - -#### Defined in - -[src/api/models/Tool.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/Tool.ts#L6) - -___ - -### ToolChoiceOption - -Ƭ **ToolChoiceOption**: ``"none"`` \| ``"auto"`` \| [`NamedToolChoice`](api.md#namedtoolchoice) - -Controls which (if any) function is called by the model. -`none` means the model will not call a function and instead generates a message. -`auto` means the model can pick between generating a message or calling a function. -Specifying a particular function via `{"type: "function", "function": {"name": "my_function"}}` forces the model to call that function. - -`none` is the default when no functions are present. `auto` is the default if functions are present. - -#### Defined in - -[src/api/models/ToolChoiceOption.ts:15](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/ToolChoiceOption.ts#L15) - -___ - -### UpdateAgentRequest - -Ƭ **UpdateAgentRequest**: `Object` - -A valid request payload for updating an agent - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `about` | `string` | About the agent | -| `default_settings?` | [`AgentDefaultSettings`](api.md#agentdefaultsettings) | Default model settings to start every session with | -| `instructions?` | `string` \| `string`[] | Instructions for the agent | -| `metadata?` | `any` | Optional metadata | -| `model?` | `string` | Name of the model that the agent is supposed to use | -| `name` | `string` | Name of the agent | - -#### Defined in - -[src/api/models/UpdateAgentRequest.ts:9](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/UpdateAgentRequest.ts#L9) - -___ - -### UpdateSessionRequest - -Ƭ **UpdateSessionRequest**: `Object` +## References -A valid request payload for updating a session +### $Agent -#### Type declaration +Re-exports [$Agent](api_schemas__Agent.md#$agent) -| Name | Type | Description | -| :------ | :------ | :------ | -| `metadata?` | `any` | Optional metadata | -| `situation` | `string` | Updated situation for this session | +___ -#### Defined in +### $AgentDefaultSettings -[src/api/models/UpdateSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/UpdateSessionRequest.ts#L8) +Re-exports [$AgentDefaultSettings](api_schemas__AgentDefaultSettings.md#$agentdefaultsettings) ___ -### UpdateToolRequest - -Ƭ **UpdateToolRequest**: `Object` +### $ChatInput -#### Type declaration +Re-exports [$ChatInput](api_schemas__ChatInput.md#$chatinput) -| Name | Type | Description | -| :------ | :------ | :------ | -| `function` | [`FunctionDef`](api.md#functiondef) | Function definition and parameters | +___ -#### Defined in +### $ChatInputData -[src/api/models/UpdateToolRequest.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/UpdateToolRequest.ts#L6) +Re-exports [$ChatInputData](api_schemas__ChatInputData.md#$chatinputdata) ___ -### UpdateUserRequest - -Ƭ **UpdateUserRequest**: `Object` - -A valid request payload for updating a user +### $ChatMLMessage -#### Type declaration +Re-exports [$ChatMLMessage](api_schemas__ChatMLMessage.md#$chatmlmessage) -| Name | Type | Description | -| :------ | :------ | :------ | -| `about` | `string` | About the user | -| `metadata?` | `any` | Optional metadata | -| `name` | `string` | Name of the user | +___ -#### Defined in +### $ChatResponse -[src/api/models/UpdateUserRequest.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/UpdateUserRequest.ts#L8) +Re-exports [$ChatResponse](api_schemas__ChatResponse.md#$chatresponse) ___ -### User - -Ƭ **User**: `Object` +### $ChatSettings -#### Type declaration +Re-exports [$ChatSettings](api_schemas__ChatSettings.md#$chatsettings) -| Name | Type | Description | -| :------ | :------ | :------ | -| `about?` | `string` | About the user | -| `created_at?` | `string` | User created at (RFC-3339 format) | -| `id` | `string` | User id (UUID) | -| `metadata?` | `any` | (Optional) metadata | -| `name?` | `string` | Name of the user | -| `updated_at?` | `string` | User updated at (RFC-3339 format) | +___ -#### Defined in +### $CompletionUsage -[src/api/models/User.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/User.ts#L5) +Re-exports [$CompletionUsage](api_schemas__CompletionUsage.md#$completionusage) ___ -### agent\_id - -Ƭ **agent\_id**: `string` - -#### Defined in +### $CreateAgentRequest -[src/api/models/agent_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/agent_id.ts#L5) +Re-exports [$CreateAgentRequest](api_schemas__CreateAgentRequest.md#$createagentrequest) ___ -### doc\_id - -Ƭ **doc\_id**: `string` - -#### Defined in +### $CreateDoc -[src/api/models/doc_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/doc_id.ts#L5) +Re-exports [$CreateDoc](api_schemas__CreateDoc.md#$createdoc) ___ -### job\_id - -Ƭ **job\_id**: `string` - -#### Defined in +### $CreateSessionRequest -[src/api/models/job_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/job_id.ts#L5) +Re-exports [$CreateSessionRequest](api_schemas__CreateSessionRequest.md#$createsessionrequest) ___ -### memory\_id - -Ƭ **memory\_id**: `string` - -#### Defined in +### $CreateToolRequest -[src/api/models/memory_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/memory_id.ts#L5) +Re-exports [$CreateToolRequest](api_schemas__CreateToolRequest.md#$createtoolrequest) ___ -### message\_id +### $CreateUserRequest + +Re-exports [$CreateUserRequest](api_schemas__CreateUserRequest.md#$createuserrequest) -Ƭ **message\_id**: `string` +___ -#### Defined in +### $Doc -[src/api/models/message_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/message_id.ts#L5) +Re-exports [$Doc](api_schemas__Doc.md#$doc) ___ -### session\_id +### $DocIds + +Re-exports [$DocIds](api_schemas__DocIds.md#$docids) -Ƭ **session\_id**: `string` +___ -#### Defined in +### $FunctionCallOption -[src/api/models/session_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/session_id.ts#L5) +Re-exports [$FunctionCallOption](api_schemas__FunctionCallOption.md#$functioncalloption) ___ -### tool\_id +### $FunctionDef -Ƭ **tool\_id**: `string` +Re-exports [$FunctionDef](api_schemas__FunctionDef.md#$functiondef) -#### Defined in +___ + +### $FunctionParameters -[src/api/models/tool_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/tool_id.ts#L5) +Re-exports [$FunctionParameters](api_schemas__FunctionParameters.md#$functionparameters) ___ -### user\_id +### $InputChatMLMessage -Ƭ **user\_id**: `string` +Re-exports [$InputChatMLMessage](api_schemas__InputChatMLMessage.md#$inputchatmlmessage) -#### Defined in +___ -[src/api/models/user_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/models/user_id.ts#L5) +### $JobStatus -## Variables +Re-exports [$JobStatus](api_schemas__JobStatus.md#$jobstatus) -### $Agent +___ + +### $Memory -• `Const` **$Agent**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Agent created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default settings for all sessions created by this agent"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `id`: \{ `description`: ``"Agent id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"The model to use with this agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"Agent updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the agent"`` | -| `properties.about.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Agent created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Agent created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.default_settings` | \{ `description`: ``"Default settings for all sessions created by this agent"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | -| `properties.default_settings.description` | ``"Default settings for all sessions created by this agent"`` | -| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | -| `properties.id` | \{ `description`: ``"Agent id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Agent id (UUID)"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | -| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | -| `properties.instructions.description` | ``"Instructions for the agent"`` | -| `properties.instructions.type` | ``"one-of"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.model` | \{ `description`: ``"The model to use with this agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.model.description` | ``"The model to use with this agent"`` | -| `properties.model.isRequired` | ``true`` | -| `properties.model.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the agent"`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | -| `properties.updated_at` | \{ `description`: ``"Agent updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.updated_at.description` | ``"Agent updated at (RFC-3339 format)"`` | -| `properties.updated_at.format` | ``"date-time"`` | -| `properties.updated_at.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$Agent.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Agent.ts#L5) +Re-exports [$Memory](api_schemas__Memory.md#$memory) ___ -### $AgentDefaultSettings +### $MemoryAccessOptions -• `Const` **$AgentDefaultSettings**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `frequency_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `minimum`: ``-2`` = -2; `type`: ``"number"`` = "number" } ; `length_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `min_p`: \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `presence_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `preset`: \{ `type`: ``"Enum"`` = "Enum" } ; `repetition_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `temperature`: \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``3`` = 3; `type`: ``"number"`` = "number" } ; `top_p`: \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } } | -| `properties.frequency_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `minimum`: ``-2`` = -2; `type`: ``"number"`` = "number" } | -| `properties.frequency_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.frequency_penalty.isNullable` | ``true`` | -| `properties.frequency_penalty.maximum` | ``2`` | -| `properties.frequency_penalty.minimum` | ``-2`` | -| `properties.frequency_penalty.type` | ``"number"`` | -| `properties.length_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | -| `properties.length_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` | -| `properties.length_penalty.isNullable` | ``true`` | -| `properties.length_penalty.maximum` | ``2`` | -| `properties.length_penalty.type` | ``"number"`` | -| `properties.min_p` | \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | -| `properties.min_p.description` | ``"Minimum probability compared to leading token to be considered"`` | -| `properties.min_p.exclusiveMaximum` | ``true`` | -| `properties.min_p.maximum` | ``1`` | -| `properties.min_p.type` | ``"number"`` | -| `properties.presence_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | -| `properties.presence_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.presence_penalty.isNullable` | ``true`` | -| `properties.presence_penalty.maximum` | ``1`` | -| `properties.presence_penalty.minimum` | ``-1`` | -| `properties.presence_penalty.type` | ``"number"`` | -| `properties.preset` | \{ `type`: ``"Enum"`` = "Enum" } | -| `properties.preset.type` | ``"Enum"`` | -| `properties.repetition_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | -| `properties.repetition_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.repetition_penalty.isNullable` | ``true`` | -| `properties.repetition_penalty.maximum` | ``2`` | -| `properties.repetition_penalty.type` | ``"number"`` | -| `properties.temperature` | \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``3`` = 3; `type`: ``"number"`` = "number" } | -| `properties.temperature.description` | ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` | -| `properties.temperature.isNullable` | ``true`` | -| `properties.temperature.maximum` | ``3`` | -| `properties.temperature.type` | ``"number"`` | -| `properties.top_p` | \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | -| `properties.top_p.description` | ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` | -| `properties.top_p.isNullable` | ``true`` | -| `properties.top_p.maximum` | ``1`` | -| `properties.top_p.type` | ``"number"`` | - -#### Defined in - -[src/api/schemas/$AgentDefaultSettings.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$AgentDefaultSettings.ts#L5) +Re-exports [$MemoryAccessOptions](api_schemas__MemoryAccessOptions.md#$memoryaccessoptions) ___ -### $ChatInput - -• `Const` **$ChatInput**: `Object` +### $NamedToolChoice -#### Type declaration +Re-exports [$NamedToolChoice](api_schemas__NamedToolChoice.md#$namedtoolchoice) -| Name | Type | -| :------ | :------ | -| `contains` | readonly [\{ `type`: ``"ChatInputData"`` = "ChatInputData" }, \{ `type`: ``"ChatSettings"`` = "ChatSettings" }, \{ `type`: ``"MemoryAccessOptions"`` = "MemoryAccessOptions" }] | -| `type` | ``"all-of"`` | +___ -#### Defined in +### $PartialFunctionDef -[src/api/schemas/$ChatInput.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ChatInput.ts#L5) +Re-exports [$PartialFunctionDef](api_schemas__PartialFunctionDef.md#$partialfunctiondef) ___ -### $ChatInputData - -• `Const` **$ChatInputData**: `Object` +### $PatchAgentRequest -#### Type declaration +Re-exports [$PatchAgentRequest](api_schemas__PatchAgentRequest.md#$patchagentrequest) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `messages`: \{ `contains`: \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `tool_choice`: \{ `contains`: readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] ; `description`: ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` ; `isNullable`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `tools`: \{ `contains`: \{ `type`: ``"Tool"`` = "Tool" } ; `isNullable`: ``true`` = true; `type`: ``"array"`` = "array" } } | -| `properties.messages` | \{ `contains`: \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | -| `properties.messages.contains` | \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } | -| `properties.messages.contains.type` | ``"InputChatMLMessage"`` | -| `properties.messages.isRequired` | ``true`` | -| `properties.messages.type` | ``"array"`` | -| `properties.tool_choice` | \{ `contains`: readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] ; `description`: ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` ; `isNullable`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | -| `properties.tool_choice.contains` | readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] | -| `properties.tool_choice.description` | ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` | -| `properties.tool_choice.isNullable` | ``true`` | -| `properties.tool_choice.type` | ``"one-of"`` | -| `properties.tools` | \{ `contains`: \{ `type`: ``"Tool"`` = "Tool" } ; `isNullable`: ``true`` = true; `type`: ``"array"`` = "array" } | -| `properties.tools.contains` | \{ `type`: ``"Tool"`` = "Tool" } | -| `properties.tools.contains.type` | ``"Tool"`` | -| `properties.tools.isNullable` | ``true`` | -| `properties.tools.type` | ``"array"`` | +___ -#### Defined in +### $PatchSessionRequest -[src/api/schemas/$ChatInputData.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ChatInputData.ts#L5) +Re-exports [$PatchSessionRequest](api_schemas__PatchSessionRequest.md#$patchsessionrequest) ___ -### $ChatMLMessage - -• `Const` **$ChatMLMessage**: `Object` +### $PatchToolRequest -#### Type declaration +Re-exports [$PatchToolRequest](api_schemas__PatchToolRequest.md#$patchtoolrequest) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `content`: \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Message created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"Message ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } ; `role`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.content` | \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"ChatML content"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Message created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Message created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.isRequired` | ``true`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.id` | \{ `description`: ``"Message ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Message ID"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"ChatML name"`` | -| `properties.name.type` | ``"string"`` | -| `properties.role` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.role.isRequired` | ``true`` | -| `properties.role.type` | ``"Enum"`` | +___ -#### Defined in +### $PatchUserRequest -[src/api/schemas/$ChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ChatMLMessage.ts#L5) +Re-exports [$PatchUserRequest](api_schemas__PatchUserRequest.md#$patchuserrequest) ___ -### $ChatResponse +### $ResourceCreatedResponse -• `Const` **$ChatResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `description` | ``"Represents a chat completion response returned by model, based on the provided input."`` | -| `properties` | \{ `finish_reason`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } ; `id`: \{ `description`: ``"A unique identifier for the chat completion."`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } ; `response`: \{ `contains`: \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `usage`: \{ `isRequired`: ``true`` = true; `type`: ``"CompletionUsage"`` = "CompletionUsage" } } | -| `properties.finish_reason` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.finish_reason.isRequired` | ``true`` | -| `properties.finish_reason.type` | ``"Enum"`` | -| `properties.id` | \{ `description`: ``"A unique identifier for the chat completion."`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"A unique identifier for the chat completion."`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | -| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.jobs.contains.format` | ``"uuid"`` | -| `properties.jobs.contains.type` | ``"string"`` | -| `properties.jobs.type` | ``"array"`` | -| `properties.response` | \{ `contains`: \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | -| `properties.response.contains` | \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } | -| `properties.response.contains.contains` | \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } | -| `properties.response.contains.contains.type` | ``"ChatMLMessage"`` | -| `properties.response.contains.type` | ``"array"`` | -| `properties.response.isRequired` | ``true`` | -| `properties.response.type` | ``"array"`` | -| `properties.usage` | \{ `isRequired`: ``true`` = true; `type`: ``"CompletionUsage"`` = "CompletionUsage" } | -| `properties.usage.isRequired` | ``true`` | -| `properties.usage.type` | ``"CompletionUsage"`` | - -#### Defined in - -[src/api/schemas/$ChatResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ChatResponse.ts#L5) +Re-exports [$ResourceCreatedResponse](api_schemas__ResourceCreatedResponse.md#$resourcecreatedresponse) ___ -### $ChatSettings +### $ResourceDeletedResponse -• `Const` **$ChatSettings**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `frequency_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `length_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `logit_bias`: \{ `contains`: \{ `type`: ``"number"`` = "number" } ; `isNullable`: ``true`` = true; `type`: ``"dictionary"`` = "dictionary" } ; `max_tokens`: \{ `description`: ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``16384`` = 16384; `minimum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `min_p`: \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `presence_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `preset`: \{ `type`: ``"Enum"`` = "Enum" } ; `repetition_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `response_format`: \{ `description`: ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` ; `properties`: \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } } ; `seed`: \{ `description`: ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``9999`` = 9999; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `stop`: \{ `contains`: readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` ; `type`: ``"one-of"`` = "one-of" } ; `stream`: \{ `description`: ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` ; `isNullable`: ``true`` = true; `type`: ``"boolean"`` = "boolean" } ; `temperature`: \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `top_p`: \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `exclusiveMinimum`: ``true`` = true; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } } | -| `properties.frequency_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | -| `properties.frequency_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.frequency_penalty.isNullable` | ``true`` | -| `properties.frequency_penalty.maximum` | ``1`` | -| `properties.frequency_penalty.minimum` | ``-1`` | -| `properties.frequency_penalty.type` | ``"number"`` | -| `properties.length_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | -| `properties.length_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` | -| `properties.length_penalty.isNullable` | ``true`` | -| `properties.length_penalty.maximum` | ``2`` | -| `properties.length_penalty.type` | ``"number"`` | -| `properties.logit_bias` | \{ `contains`: \{ `type`: ``"number"`` = "number" } ; `isNullable`: ``true`` = true; `type`: ``"dictionary"`` = "dictionary" } | -| `properties.logit_bias.contains` | \{ `type`: ``"number"`` = "number" } | -| `properties.logit_bias.contains.type` | ``"number"`` | -| `properties.logit_bias.isNullable` | ``true`` | -| `properties.logit_bias.type` | ``"dictionary"`` | -| `properties.max_tokens` | \{ `description`: ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``16384`` = 16384; `minimum`: ``1`` = 1; `type`: ``"number"`` = "number" } | -| `properties.max_tokens.description` | ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` | -| `properties.max_tokens.isNullable` | ``true`` | -| `properties.max_tokens.maximum` | ``16384`` | -| `properties.max_tokens.minimum` | ``1`` | -| `properties.max_tokens.type` | ``"number"`` | -| `properties.min_p` | \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | -| `properties.min_p.description` | ``"Minimum probability compared to leading token to be considered"`` | -| `properties.min_p.exclusiveMaximum` | ``true`` | -| `properties.min_p.maximum` | ``1`` | -| `properties.min_p.type` | ``"number"`` | -| `properties.presence_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | -| `properties.presence_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.presence_penalty.isNullable` | ``true`` | -| `properties.presence_penalty.maximum` | ``1`` | -| `properties.presence_penalty.minimum` | ``-1`` | -| `properties.presence_penalty.type` | ``"number"`` | -| `properties.preset` | \{ `type`: ``"Enum"`` = "Enum" } | -| `properties.preset.type` | ``"Enum"`` | -| `properties.repetition_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | -| `properties.repetition_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | -| `properties.repetition_penalty.isNullable` | ``true`` | -| `properties.repetition_penalty.maximum` | ``2`` | -| `properties.repetition_penalty.type` | ``"number"`` | -| `properties.response_format` | \{ `description`: ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` ; `properties`: \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } } | -| `properties.response_format.description` | ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` | -| `properties.response_format.properties` | \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } | -| `properties.response_format.properties.pattern` | \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } | -| `properties.response_format.properties.pattern.description` | ``"Regular expression pattern to use if `type` is `\"regex\"`"`` | -| `properties.response_format.properties.pattern.type` | ``"string"`` | -| `properties.response_format.properties.schema` | \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } | -| `properties.response_format.properties.schema.description` | ``"JSON Schema to use if `type` is `\"json_object\"`"`` | -| `properties.response_format.properties.schema.properties` | {} | -| `properties.response_format.properties.type` | \{ `type`: ``"Enum"`` = "Enum" } | -| `properties.response_format.properties.type.type` | ``"Enum"`` | -| `properties.seed` | \{ `description`: ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``9999`` = 9999; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | -| `properties.seed.description` | ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` | -| `properties.seed.isNullable` | ``true`` | -| `properties.seed.maximum` | ``9999`` | -| `properties.seed.minimum` | ``-1`` | -| `properties.seed.type` | ``"number"`` | -| `properties.stop` | \{ `contains`: readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` ; `type`: ``"one-of"`` = "one-of" } | -| `properties.stop.contains` | readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | -| `properties.stop.description` | ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` | -| `properties.stop.type` | ``"one-of"`` | -| `properties.stream` | \{ `description`: ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` ; `isNullable`: ``true`` = true; `type`: ``"boolean"`` = "boolean" } | -| `properties.stream.description` | ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` | -| `properties.stream.isNullable` | ``true`` | -| `properties.stream.type` | ``"boolean"`` | -| `properties.temperature` | \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | -| `properties.temperature.description` | ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` | -| `properties.temperature.isNullable` | ``true`` | -| `properties.temperature.maximum` | ``2`` | -| `properties.temperature.type` | ``"number"`` | -| `properties.top_p` | \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `exclusiveMinimum`: ``true`` = true; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | -| `properties.top_p.description` | ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` | -| `properties.top_p.exclusiveMinimum` | ``true`` | -| `properties.top_p.isNullable` | ``true`` | -| `properties.top_p.maximum` | ``1`` | -| `properties.top_p.type` | ``"number"`` | - -#### Defined in - -[src/api/schemas/$ChatSettings.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ChatSettings.ts#L5) +Re-exports [$ResourceDeletedResponse](api_schemas__ResourceDeletedResponse.md#$resourcedeletedresponse) ___ -### $CompletionUsage - -• `Const` **$CompletionUsage**: `Object` +### $ResourceUpdatedResponse -#### Type declaration +Re-exports [$ResourceUpdatedResponse](api_schemas__ResourceUpdatedResponse.md#$resourceupdatedresponse) -| Name | Type | -| :------ | :------ | -| `description` | ``"Usage statistics for the completion request."`` | -| `properties` | \{ `completion_tokens`: \{ `description`: ``"Number of tokens in the generated completion."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } ; `prompt_tokens`: \{ `description`: ``"Number of tokens in the prompt."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } ; `total_tokens`: \{ `description`: ``"Total number of tokens used in the request (prompt + completion)."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } } | -| `properties.completion_tokens` | \{ `description`: ``"Number of tokens in the generated completion."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | -| `properties.completion_tokens.description` | ``"Number of tokens in the generated completion."`` | -| `properties.completion_tokens.isRequired` | ``true`` | -| `properties.completion_tokens.type` | ``"number"`` | -| `properties.prompt_tokens` | \{ `description`: ``"Number of tokens in the prompt."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | -| `properties.prompt_tokens.description` | ``"Number of tokens in the prompt."`` | -| `properties.prompt_tokens.isRequired` | ``true`` | -| `properties.prompt_tokens.type` | ``"number"`` | -| `properties.total_tokens` | \{ `description`: ``"Total number of tokens used in the request (prompt + completion)."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | -| `properties.total_tokens.description` | ``"Total number of tokens used in the request (prompt + completion)."`` | -| `properties.total_tokens.isRequired` | ``true`` | -| `properties.total_tokens.type` | ``"number"`` | +___ -#### Defined in +### $Session -[src/api/schemas/$CompletionUsage.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CompletionUsage.ts#L5) +Re-exports [$Session](api_schemas__Session.md#$session) ___ -### $CreateAgentRequest +### $Suggestion -• `Const` **$CreateAgentRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for creating an agent"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `docs`: \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `tools`: \{ `contains`: \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } ; `type`: ``"array"`` = "array" } } | -| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the agent"`` | -| `properties.about.type` | ``"string"`` | -| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | -| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | -| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | -| `properties.docs` | \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } | -| `properties.docs.contains` | \{ `type`: ``"CreateDoc"`` = "CreateDoc" } | -| `properties.docs.contains.type` | ``"CreateDoc"`` | -| `properties.docs.type` | ``"array"`` | -| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | -| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | -| `properties.instructions.description` | ``"Instructions for the agent"`` | -| `properties.instructions.type` | ``"one-of"`` | -| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"(Optional) metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | -| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | -| `properties.model.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the agent"`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | -| `properties.tools` | \{ `contains`: \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } ; `type`: ``"array"`` = "array" } | -| `properties.tools.contains` | \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } | -| `properties.tools.contains.type` | ``"CreateToolRequest"`` | -| `properties.tools.type` | ``"array"`` | - -#### Defined in - -[src/api/schemas/$CreateAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CreateAgentRequest.ts#L5) +Re-exports [$Suggestion](api_schemas__Suggestion.md#$suggestion) ___ -### $CreateDoc - -• `Const` **$CreateDoc**: `Object` +### $Tool -#### Type declaration +Re-exports [$Tool](api_schemas__Tool.md#$tool) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `content`: \{ `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `title`: \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.content` | \{ `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"Information content"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.title` | \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.title.description` | ``"Title describing what this bit of information contains"`` | -| `properties.title.isRequired` | ``true`` | -| `properties.title.type` | ``"string"`` | +___ -#### Defined in +### $ToolChoiceOption -[src/api/schemas/$CreateDoc.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CreateDoc.ts#L5) +Re-exports [$ToolChoiceOption](api_schemas__ToolChoiceOption.md#$toolchoiceoption) ___ -### $CreateSessionRequest - -• `Const` **$CreateSessionRequest**: `Object` +### $UpdateAgentRequest -#### Type declaration +Re-exports [$UpdateAgentRequest](api_schemas__UpdateAgentRequest.md#$updateagentrequest) -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for creating a session"`` | -| `properties` | \{ `agent_id`: \{ `description`: ``"Agent ID of agent to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `render_templates`: \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } ; `situation`: \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"(Optional) User ID of user to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } } | -| `properties.agent_id` | \{ `description`: ``"Agent ID of agent to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.agent_id.description` | ``"Agent ID of agent to associate with this session"`` | -| `properties.agent_id.format` | ``"uuid"`` | -| `properties.agent_id.isRequired` | ``true`` | -| `properties.agent_id.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.render_templates` | \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.render_templates.description` | ``"Render system and assistant message content as jinja templates"`` | -| `properties.render_templates.type` | ``"boolean"`` | -| `properties.situation` | \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } | -| `properties.situation.description` | ``"A specific situation that sets the background for this session"`` | -| `properties.situation.type` | ``"string"`` | -| `properties.user_id` | \{ `description`: ``"(Optional) User ID of user to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.user_id.description` | ``"(Optional) User ID of user to associate with this session"`` | -| `properties.user_id.format` | ``"uuid"`` | -| `properties.user_id.type` | ``"string"`` | +___ -#### Defined in +### $UpdateSessionRequest -[src/api/schemas/$CreateSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CreateSessionRequest.ts#L5) +Re-exports [$UpdateSessionRequest](api_schemas__UpdateSessionRequest.md#$updatesessionrequest) ___ -### $CreateToolRequest - -• `Const` **$CreateToolRequest**: `Object` +### $UpdateToolRequest -#### Type declaration +Re-exports [$UpdateToolRequest](api_schemas__UpdateToolRequest.md#$updatetoolrequest) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `function`: \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.function` | \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | -| `properties.function.contains` | readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] | -| `properties.function.description` | ``"Function definition and parameters"`` | -| `properties.function.isRequired` | ``true`` | -| `properties.function.type` | ``"one-of"`` | -| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.type.isRequired` | ``true`` | -| `properties.type.type` | ``"Enum"`` | +___ -#### Defined in +### $UpdateUserRequest -[src/api/schemas/$CreateToolRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CreateToolRequest.ts#L5) +Re-exports [$UpdateUserRequest](api_schemas__UpdateUserRequest.md#$updateuserrequest) ___ -### $CreateUserRequest - -• `Const` **$CreateUserRequest**: `Object` +### $User -#### Type declaration +Re-exports [$User](api_schemas__User.md#$user) -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for creating a user"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `docs`: \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the user"`` | -| `properties.about.type` | ``"string"`` | -| `properties.docs` | \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } | -| `properties.docs.contains` | \{ `type`: ``"CreateDoc"`` = "CreateDoc" } | -| `properties.docs.contains.type` | ``"CreateDoc"`` | -| `properties.docs.type` | ``"array"`` | -| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"(Optional) metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the user"`` | -| `properties.name.type` | ``"string"`` | +___ -#### Defined in +### $agent\_id -[src/api/schemas/$CreateUserRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$CreateUserRequest.ts#L5) +Re-exports [$agent_id](api_schemas__agent_id.md#$agent_id) ___ -### $Doc +### $doc\_id -• `Const` **$Doc**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `content`: \{ `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Doc created at"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"ID of doc"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"optional metadata"`` ; `properties`: {} = \{} } ; `title`: \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.content` | \{ `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"Information content"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Doc created at"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Doc created at"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.isRequired` | ``true`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.id` | \{ `description`: ``"ID of doc"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"ID of doc"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.title` | \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.title.description` | ``"Title describing what this bit of information contains"`` | -| `properties.title.isRequired` | ``true`` | -| `properties.title.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$Doc.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Doc.ts#L5) +Re-exports [$doc_id](api_schemas__doc_id.md#$doc_id) ___ -### $FunctionCallOption - -• `Const` **$FunctionCallOption**: `Object` +### $job\_id -#### Type declaration +Re-exports [$job_id](api_schemas__job_id.md#$job_id) -| Name | Type | -| :------ | :------ | -| `description` | ``"Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n "`` | -| `properties` | \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.name` | \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"The name of the function to call."`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | +___ -#### Defined in +### $memory\_id -[src/api/schemas/$FunctionCallOption.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$FunctionCallOption.ts#L5) +Re-exports [$memory_id](api_schemas__memory_id.md#$memory_id) ___ -### $FunctionDef - -• `Const` **$FunctionDef**: `Object` +### $message\_id -#### Type declaration +Re-exports [$message_id](api_schemas__message_id.md#$message_id) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `description`: \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `parameters`: \{ `description`: ``"Parameters accepeted by this function"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionParameters"`` = "FunctionParameters" } } | -| `properties.description` | \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } | -| `properties.description.description` | ``"A description of what the function does, used by the model to choose when and how to call the function."`` | -| `properties.description.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | -| `properties.parameters` | \{ `description`: ``"Parameters accepeted by this function"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionParameters"`` = "FunctionParameters" } | -| `properties.parameters.description` | ``"Parameters accepeted by this function"`` | -| `properties.parameters.isRequired` | ``true`` | -| `properties.parameters.type` | ``"FunctionParameters"`` | +___ -#### Defined in +### $session\_id -[src/api/schemas/$FunctionDef.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$FunctionDef.ts#L5) +Re-exports [$session_id](api_schemas__session_id.md#$session_id) ___ -### $FunctionParameters - -• `Const` **$FunctionParameters**: `Object` +### $tool\_id -#### Type declaration +Re-exports [$tool_id](api_schemas__tool_id.md#$tool_id) -| Name | Type | -| :------ | :------ | -| `contains` | \{ `properties`: {} = \{} } | -| `contains.properties` | {} | -| `type` | ``"dictionary"`` | +___ -#### Defined in +### $user\_id -[src/api/schemas/$FunctionParameters.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$FunctionParameters.ts#L5) +Re-exports [$user_id](api_schemas__user_id.md#$user_id) ___ -### $InputChatMLMessage - -• `Const` **$InputChatMLMessage**: `Object` +### Agent -#### Type declaration +Re-exports [Agent](api_models_Agent.md#agent) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `content`: \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `continue`: \{ `description`: ``"Whether to continue this message or return a new one"`` ; `type`: ``"boolean"`` = "boolean" } ; `name`: \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } ; `role`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.content` | \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"ChatML content"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.continue` | \{ `description`: ``"Whether to continue this message or return a new one"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.continue.description` | ``"Whether to continue this message or return a new one"`` | -| `properties.continue.type` | ``"boolean"`` | -| `properties.name` | \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"ChatML name"`` | -| `properties.name.type` | ``"string"`` | -| `properties.role` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.role.isRequired` | ``true`` | -| `properties.role.type` | ``"Enum"`` | +___ -#### Defined in +### AgentDefaultSettings -[src/api/schemas/$InputChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$InputChatMLMessage.ts#L5) +Re-exports [AgentDefaultSettings](api_models_AgentDefaultSettings.md#agentdefaultsettings) ___ -### $JobStatus +### ApiError -• `Const` **$JobStatus**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `created_at`: \{ `description`: ``"Job created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `has_progress`: \{ `description`: ``"Whether this Job supports progress updates"`` ; `type`: ``"boolean"`` = "boolean" } ; `id`: \{ `description`: ``"Job id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the job"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `progress`: \{ `description`: ``"Progress percentage"`` ; `maximum`: ``100`` = 100; `type`: ``"number"`` = "number" } ; `reason`: \{ `description`: ``"Reason for current state"`` ; `type`: ``"string"`` = "string" } ; `state`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } ; `updated_at`: \{ `description`: ``"Job updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | -| `properties.created_at` | \{ `description`: ``"Job created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Job created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.isRequired` | ``true`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.has_progress` | \{ `description`: ``"Whether this Job supports progress updates"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.has_progress.description` | ``"Whether this Job supports progress updates"`` | -| `properties.has_progress.type` | ``"boolean"`` | -| `properties.id` | \{ `description`: ``"Job id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Job id (UUID)"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"Name of the job"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the job"`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | -| `properties.progress` | \{ `description`: ``"Progress percentage"`` ; `maximum`: ``100`` = 100; `type`: ``"number"`` = "number" } | -| `properties.progress.description` | ``"Progress percentage"`` | -| `properties.progress.maximum` | ``100`` | -| `properties.progress.type` | ``"number"`` | -| `properties.reason` | \{ `description`: ``"Reason for current state"`` ; `type`: ``"string"`` = "string" } | -| `properties.reason.description` | ``"Reason for current state"`` | -| `properties.reason.type` | ``"string"`` | -| `properties.state` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.state.isRequired` | ``true`` | -| `properties.state.type` | ``"Enum"`` | -| `properties.updated_at` | \{ `description`: ``"Job updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.updated_at.description` | ``"Job updated at (RFC-3339 format)"`` | -| `properties.updated_at.format` | ``"date-time"`` | -| `properties.updated_at.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$JobStatus.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$JobStatus.ts#L5) +Re-exports [ApiError](../classes/api_core_ApiError.ApiError.md) ___ -### $Memory +### BaseHttpRequest -• `Const` **$Memory**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `agent_id`: \{ `description`: ``"ID of the agent"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `content`: \{ `description`: ``"Content of the memory"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Memory created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `entities`: \{ `contains`: \{ `properties`: {} = \{} } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `id`: \{ `description`: ``"Memory id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `last_accessed_at`: \{ `description`: ``"Memory last accessed at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `sentiment`: \{ `description`: ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` ; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `timestamp`: \{ `description`: ``"Memory happened at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"ID of the user"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.agent_id` | \{ `description`: ``"ID of the agent"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.agent_id.description` | ``"ID of the agent"`` | -| `properties.agent_id.format` | ``"uuid"`` | -| `properties.agent_id.isRequired` | ``true`` | -| `properties.agent_id.type` | ``"string"`` | -| `properties.content` | \{ `description`: ``"Content of the memory"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"Content of the memory"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Memory created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Memory created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.isRequired` | ``true`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.entities` | \{ `contains`: \{ `properties`: {} = \{} } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | -| `properties.entities.contains` | \{ `properties`: {} = \{} } | -| `properties.entities.contains.properties` | {} | -| `properties.entities.isRequired` | ``true`` | -| `properties.entities.type` | ``"array"`` | -| `properties.id` | \{ `description`: ``"Memory id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Memory id (UUID)"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.last_accessed_at` | \{ `description`: ``"Memory last accessed at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.last_accessed_at.description` | ``"Memory last accessed at (RFC-3339 format)"`` | -| `properties.last_accessed_at.format` | ``"date-time"`` | -| `properties.last_accessed_at.type` | ``"string"`` | -| `properties.sentiment` | \{ `description`: ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` ; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | -| `properties.sentiment.description` | ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` | -| `properties.sentiment.maximum` | ``1`` | -| `properties.sentiment.minimum` | ``-1`` | -| `properties.sentiment.type` | ``"number"`` | -| `properties.timestamp` | \{ `description`: ``"Memory happened at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.timestamp.description` | ``"Memory happened at (RFC-3339 format)"`` | -| `properties.timestamp.format` | ``"date-time"`` | -| `properties.timestamp.type` | ``"string"`` | -| `properties.user_id` | \{ `description`: ``"ID of the user"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.user_id.description` | ``"ID of the user"`` | -| `properties.user_id.format` | ``"uuid"`` | -| `properties.user_id.isRequired` | ``true`` | -| `properties.user_id.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$Memory.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Memory.ts#L5) +Re-exports [BaseHttpRequest](../classes/api_core_BaseHttpRequest.BaseHttpRequest.md) ___ -### $MemoryAccessOptions - -• `Const` **$MemoryAccessOptions**: `Object` +### CancelError -#### Type declaration +Re-exports [CancelError](../classes/api_core_CancelablePromise.CancelError.md) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `recall`: \{ `description`: ``"Whether previous memories should be recalled or not"`` ; `type`: ``"boolean"`` = "boolean" } ; `record`: \{ `description`: ``"Whether this interaction should be recorded in history or not"`` ; `type`: ``"boolean"`` = "boolean" } ; `remember`: \{ `description`: ``"Whether this interaction should form memories or not"`` ; `type`: ``"boolean"`` = "boolean" } } | -| `properties.recall` | \{ `description`: ``"Whether previous memories should be recalled or not"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.recall.description` | ``"Whether previous memories should be recalled or not"`` | -| `properties.recall.type` | ``"boolean"`` | -| `properties.record` | \{ `description`: ``"Whether this interaction should be recorded in history or not"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.record.description` | ``"Whether this interaction should be recorded in history or not"`` | -| `properties.record.type` | ``"boolean"`` | -| `properties.remember` | \{ `description`: ``"Whether this interaction should form memories or not"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.remember.description` | ``"Whether this interaction should form memories or not"`` | -| `properties.remember.type` | ``"boolean"`` | +___ -#### Defined in +### CancelablePromise -[src/api/schemas/$MemoryAccessOptions.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$MemoryAccessOptions.ts#L5) +Re-exports [CancelablePromise](../classes/api_core_CancelablePromise.CancelablePromise.md) ___ -### $NamedToolChoice - -• `Const` **$NamedToolChoice**: `Object` +### ChatInput -#### Type declaration +Re-exports [ChatInput](api_models_ChatInput.md#chatinput) -| Name | Type | -| :------ | :------ | -| `description` | ``"Specifies a tool the model should use. Use to force the model to call a specific function."`` | -| `properties` | \{ `function`: \{ `isRequired`: ``true`` = true; `properties`: \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.function` | \{ `isRequired`: ``true`` = true; `properties`: \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } } | -| `properties.function.isRequired` | ``true`` | -| `properties.function.properties` | \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.function.properties.name` | \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.function.properties.name.description` | ``"The name of the function to call."`` | -| `properties.function.properties.name.isRequired` | ``true`` | -| `properties.function.properties.name.type` | ``"string"`` | -| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.type.isRequired` | ``true`` | -| `properties.type.type` | ``"Enum"`` | +___ -#### Defined in +### ChatInputData -[src/api/schemas/$NamedToolChoice.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$NamedToolChoice.ts#L5) +Re-exports [ChatInputData](api_models_ChatInputData.md#chatinputdata) ___ -### $PartialFunctionDef - -• `Const` **$PartialFunctionDef**: `Object` +### ChatMLMessage -#### Type declaration +Re-exports [ChatMLMessage](api_models_ChatMLMessage.md#chatmlmessage) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `description`: \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `type`: ``"string"`` = "string" } ; `parameters`: \{ `description`: ``"Parameters accepeted by this function"`` ; `type`: ``"FunctionParameters"`` = "FunctionParameters" } } | -| `properties.description` | \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } | -| `properties.description.description` | ``"A description of what the function does, used by the model to choose when and how to call the function."`` | -| `properties.description.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` | -| `properties.name.type` | ``"string"`` | -| `properties.parameters` | \{ `description`: ``"Parameters accepeted by this function"`` ; `type`: ``"FunctionParameters"`` = "FunctionParameters" } | -| `properties.parameters.description` | ``"Parameters accepeted by this function"`` | -| `properties.parameters.type` | ``"FunctionParameters"`` | +___ -#### Defined in +### ChatResponse -[src/api/schemas/$PartialFunctionDef.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$PartialFunctionDef.ts#L5) +Re-exports [ChatResponse](api_models_ChatResponse.md#chatresponse) ___ -### $PatchAgentRequest - -• `Const` **$PatchAgentRequest**: `Object` +### ChatSettings -#### Type declaration +Re-exports [ChatSettings](api_models_ChatSettings.md#chatsettings) -| Name | Type | -| :------ | :------ | -| `description` | ``"A request for patching an agent"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the agent"`` | -| `properties.about.type` | ``"string"`` | -| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | -| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | -| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | -| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | -| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | -| `properties.instructions.description` | ``"Instructions for the agent"`` | -| `properties.instructions.type` | ``"one-of"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | -| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | -| `properties.model.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the agent"`` | -| `properties.name.type` | ``"string"`` | +___ -#### Defined in +### CompletionUsage -[src/api/schemas/$PatchAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$PatchAgentRequest.ts#L5) +Re-exports [CompletionUsage](api_models_CompletionUsage.md#completionusage) ___ -### $PatchSessionRequest - -• `Const` **$PatchSessionRequest**: `Object` +### CreateAgentRequest -#### Type declaration +Re-exports [CreateAgentRequest](api_models_CreateAgentRequest.md#createagentrequest) -| Name | Type | -| :------ | :------ | -| `description` | ``"A request for patching a session"`` | -| `properties` | \{ `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `situation`: \{ `description`: ``"Updated situation for this session"`` ; `type`: ``"string"`` = "string" } } | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.situation` | \{ `description`: ``"Updated situation for this session"`` ; `type`: ``"string"`` = "string" } | -| `properties.situation.description` | ``"Updated situation for this session"`` | -| `properties.situation.type` | ``"string"`` | +___ -#### Defined in +### CreateDoc -[src/api/schemas/$PatchSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$PatchSessionRequest.ts#L5) +Re-exports [CreateDoc](api_models_CreateDoc.md#createdoc) ___ -### $PatchToolRequest - -• `Const` **$PatchToolRequest**: `Object` +### CreateSessionRequest -#### Type declaration +Re-exports [CreateSessionRequest](api_models_CreateSessionRequest.md#createsessionrequest) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `function`: \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"PartialFunctionDef"`` = "PartialFunctionDef" } } | -| `properties.function` | \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"PartialFunctionDef"`` = "PartialFunctionDef" } | -| `properties.function.description` | ``"Function definition and parameters"`` | -| `properties.function.isRequired` | ``true`` | -| `properties.function.type` | ``"PartialFunctionDef"`` | +___ -#### Defined in +### CreateToolRequest -[src/api/schemas/$PatchToolRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$PatchToolRequest.ts#L5) +Re-exports [CreateToolRequest](api_models_CreateToolRequest.md#createtoolrequest) ___ -### $PatchUserRequest - -• `Const` **$PatchUserRequest**: `Object` +### CreateUserRequest -#### Type declaration +Re-exports [CreateUserRequest](api_models_CreateUserRequest.md#createuserrequest) -| Name | Type | -| :------ | :------ | -| `description` | ``"A request for patching a user"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the user"`` | -| `properties.about.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the user"`` | -| `properties.name.type` | ``"string"`` | +___ -#### Defined in +### DefaultService -[src/api/schemas/$PatchUserRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$PatchUserRequest.ts#L5) +Re-exports [DefaultService](../classes/api_services_DefaultService.DefaultService.md) ___ -### $ResourceCreatedResponse - -• `Const` **$ResourceCreatedResponse**: `Object` +### Doc -#### Type declaration +Re-exports [Doc](api_models_Doc.md#doc) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `created_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } } | -| `properties.created_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.isRequired` | ``true`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | -| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.jobs.contains.format` | ``"uuid"`` | -| `properties.jobs.contains.type` | ``"string"`` | -| `properties.jobs.type` | ``"array"`` | +___ -#### Defined in +### DocIds -[src/api/schemas/$ResourceCreatedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ResourceCreatedResponse.ts#L5) +Re-exports [DocIds](api_models_DocIds.md#docids) ___ -### $ResourceDeletedResponse - -• `Const` **$ResourceDeletedResponse**: `Object` +### FunctionCallOption -#### Type declaration +Re-exports [FunctionCallOption](api_models_FunctionCallOption.md#functioncalloption) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `deleted_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } } | -| `properties.deleted_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.deleted_at.format` | ``"date-time"`` | -| `properties.deleted_at.isRequired` | ``true`` | -| `properties.deleted_at.type` | ``"string"`` | -| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | -| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.jobs.contains.format` | ``"uuid"`` | -| `properties.jobs.contains.type` | ``"string"`` | -| `properties.jobs.type` | ``"array"`` | +___ -#### Defined in +### FunctionDef -[src/api/schemas/$ResourceDeletedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ResourceDeletedResponse.ts#L5) +Re-exports [FunctionDef](api_models_FunctionDef.md#functiondef) ___ -### $ResourceUpdatedResponse - -• `Const` **$ResourceUpdatedResponse**: `Object` +### FunctionParameters -#### Type declaration +Re-exports [FunctionParameters](api_models_FunctionParameters.md#functionparameters) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } ; `updated_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | -| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.jobs.contains.format` | ``"uuid"`` | -| `properties.jobs.contains.type` | ``"string"`` | -| `properties.jobs.type` | ``"array"`` | -| `properties.updated_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.updated_at.format` | ``"date-time"`` | -| `properties.updated_at.isRequired` | ``true`` | -| `properties.updated_at.type` | ``"string"`` | +___ -#### Defined in +### InputChatMLMessage -[src/api/schemas/$ResourceUpdatedResponse.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ResourceUpdatedResponse.ts#L5) +Re-exports [InputChatMLMessage](api_models_InputChatMLMessage.md#inputchatmlmessage) ___ -### $Session +### JobStatus -• `Const` **$Session**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `agent_id`: \{ `description`: ``"Agent ID of agent associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Session created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"Session id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `render_templates`: \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } ; `situation`: \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } ; `summary`: \{ `description`: ``"(null at the beginning) - generated automatically after every interaction"`` ; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"Session updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"User ID of user associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } } | -| `properties.agent_id` | \{ `description`: ``"Agent ID of agent associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.agent_id.description` | ``"Agent ID of agent associated with this session"`` | -| `properties.agent_id.format` | ``"uuid"`` | -| `properties.agent_id.isRequired` | ``true`` | -| `properties.agent_id.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Session created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Session created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.id` | \{ `description`: ``"Session id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Session id (UUID)"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.render_templates` | \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } | -| `properties.render_templates.description` | ``"Render system and assistant message content as jinja templates"`` | -| `properties.render_templates.type` | ``"boolean"`` | -| `properties.situation` | \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } | -| `properties.situation.description` | ``"A specific situation that sets the background for this session"`` | -| `properties.situation.type` | ``"string"`` | -| `properties.summary` | \{ `description`: ``"(null at the beginning) - generated automatically after every interaction"`` ; `type`: ``"string"`` = "string" } | -| `properties.summary.description` | ``"(null at the beginning) - generated automatically after every interaction"`` | -| `properties.summary.type` | ``"string"`` | -| `properties.updated_at` | \{ `description`: ``"Session updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.updated_at.description` | ``"Session updated at (RFC-3339 format)"`` | -| `properties.updated_at.format` | ``"date-time"`` | -| `properties.updated_at.type` | ``"string"`` | -| `properties.user_id` | \{ `description`: ``"User ID of user associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | -| `properties.user_id.description` | ``"User ID of user associated with this session"`` | -| `properties.user_id.format` | ``"uuid"`` | -| `properties.user_id.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$Session.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Session.ts#L5) +Re-exports [JobStatus](api_models_JobStatus.md#jobstatus) ___ -### $Suggestion +### JulepApiClient -• `Const` **$Suggestion**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `content`: \{ `description`: ``"The content of the suggestion"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Suggestion created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `message_id`: \{ `description`: ``"The message that produced it"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `session_id`: \{ `description`: ``"Session this suggestion belongs to"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `target`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.content` | \{ `description`: ``"The content of the suggestion"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.content.description` | ``"The content of the suggestion"`` | -| `properties.content.isRequired` | ``true`` | -| `properties.content.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"Suggestion created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"Suggestion created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.message_id` | \{ `description`: ``"The message that produced it"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.message_id.description` | ``"The message that produced it"`` | -| `properties.message_id.format` | ``"uuid"`` | -| `properties.message_id.isRequired` | ``true`` | -| `properties.message_id.type` | ``"string"`` | -| `properties.session_id` | \{ `description`: ``"Session this suggestion belongs to"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.session_id.description` | ``"Session this suggestion belongs to"`` | -| `properties.session_id.format` | ``"uuid"`` | -| `properties.session_id.isRequired` | ``true`` | -| `properties.session_id.type` | ``"string"`` | -| `properties.target` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.target.isRequired` | ``true`` | -| `properties.target.type` | ``"Enum"`` | - -#### Defined in - -[src/api/schemas/$Suggestion.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Suggestion.ts#L5) +Re-exports [JulepApiClient](../classes/api_JulepApiClient.JulepApiClient.md) ___ -### $Tool - -• `Const` **$Tool**: `Object` +### Memory -#### Type declaration +Re-exports [Memory](api_models_Memory.md#memory) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `function`: \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `id`: \{ `description`: ``"Tool ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | -| `properties.function` | \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | -| `properties.function.contains` | readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] | -| `properties.function.description` | ``"Function definition and parameters"`` | -| `properties.function.isRequired` | ``true`` | -| `properties.function.type` | ``"one-of"`` | -| `properties.id` | \{ `description`: ``"Tool ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"Tool ID"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | -| `properties.type.isRequired` | ``true`` | -| `properties.type.type` | ``"Enum"`` | +___ -#### Defined in +### MemoryAccessOptions -[src/api/schemas/$Tool.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$Tool.ts#L5) +Re-exports [MemoryAccessOptions](api_models_MemoryAccessOptions.md#memoryaccessoptions) ___ -### $ToolChoiceOption - -• `Const` **$ToolChoiceOption**: `Object` +### NamedToolChoice -#### Type declaration +Re-exports [NamedToolChoice](api_models_NamedToolChoice.md#namedtoolchoice) -| Name | Type | -| :------ | :------ | -| `contains` | readonly [\{ `type`: ``"Enum"`` = "Enum" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] | -| `description` | ``"Controls which (if any) function is called by the model.\n `none` means the model will not call a function and instead generates a message.\n `auto` means the model can pick between generating a message or calling a function.\n Specifying a particular function via `{\"type: \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.\n `none` is the default when no functions are present. `auto` is the default if functions are present.\n "`` | -| `type` | ``"one-of"`` | +___ -#### Defined in +### OpenAPI -[src/api/schemas/$ToolChoiceOption.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$ToolChoiceOption.ts#L5) +Re-exports [OpenAPI](api_core_OpenAPI.md#openapi) ___ -### $UpdateAgentRequest +### OpenAPIConfig -• `Const` **$UpdateAgentRequest**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for updating an agent"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the agent"`` | -| `properties.about.isRequired` | ``true`` | -| `properties.about.type` | ``"string"`` | -| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | -| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | -| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | -| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | -| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | -| `properties.instructions.description` | ``"Instructions for the agent"`` | -| `properties.instructions.type` | ``"one-of"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | -| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | -| `properties.model.type` | ``"string"`` | -| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the agent"`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$UpdateAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$UpdateAgentRequest.ts#L5) +Re-exports [OpenAPIConfig](api_core_OpenAPI.md#openapiconfig) ___ -### $UpdateSessionRequest - -• `Const` **$UpdateSessionRequest**: `Object` +### PartialFunctionDef -#### Type declaration +Re-exports [PartialFunctionDef](api_models_PartialFunctionDef.md#partialfunctiondef) -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for updating a session"`` | -| `properties` | \{ `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `situation`: \{ `description`: ``"Updated situation for this session"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.situation` | \{ `description`: ``"Updated situation for this session"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.situation.description` | ``"Updated situation for this session"`` | -| `properties.situation.isRequired` | ``true`` | -| `properties.situation.type` | ``"string"`` | +___ -#### Defined in +### PatchAgentRequest -[src/api/schemas/$UpdateSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$UpdateSessionRequest.ts#L5) +Re-exports [PatchAgentRequest](api_models_PatchAgentRequest.md#patchagentrequest) ___ -### $UpdateToolRequest - -• `Const` **$UpdateToolRequest**: `Object` +### PatchSessionRequest -#### Type declaration +Re-exports [PatchSessionRequest](api_models_PatchSessionRequest.md#patchsessionrequest) -| Name | Type | -| :------ | :------ | -| `properties` | \{ `function`: \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionDef"`` = "FunctionDef" } } | -| `properties.function` | \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionDef"`` = "FunctionDef" } | -| `properties.function.description` | ``"Function definition and parameters"`` | -| `properties.function.isRequired` | ``true`` | -| `properties.function.type` | ``"FunctionDef"`` | +___ -#### Defined in +### PatchToolRequest -[src/api/schemas/$UpdateToolRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$UpdateToolRequest.ts#L5) +Re-exports [PatchToolRequest](api_models_PatchToolRequest.md#patchtoolrequest) ___ -### $UpdateUserRequest - -• `Const` **$UpdateUserRequest**: `Object` +### PatchUserRequest -#### Type declaration +Re-exports [PatchUserRequest](api_models_PatchUserRequest.md#patchuserrequest) -| Name | Type | -| :------ | :------ | -| `description` | ``"A valid request payload for updating a user"`` | -| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the user"`` | -| `properties.about.isRequired` | ``true`` | -| `properties.about.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"Optional metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.name` | \{ `description`: ``"Name of the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the user"`` | -| `properties.name.isRequired` | ``true`` | -| `properties.name.type` | ``"string"`` | +___ -#### Defined in +### ResourceCreatedResponse -[src/api/schemas/$UpdateUserRequest.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$UpdateUserRequest.ts#L5) +Re-exports [ResourceCreatedResponse](api_models_ResourceCreatedResponse.md#resourcecreatedresponse) ___ -### $User +### ResourceDeletedResponse -• `Const` **$User**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"User created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"User id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"User updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | -| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.about.description` | ``"About the user"`` | -| `properties.about.type` | ``"string"`` | -| `properties.created_at` | \{ `description`: ``"User created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.created_at.description` | ``"User created at (RFC-3339 format)"`` | -| `properties.created_at.format` | ``"date-time"`` | -| `properties.created_at.type` | ``"string"`` | -| `properties.id` | \{ `description`: ``"User id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | -| `properties.id.description` | ``"User id (UUID)"`` | -| `properties.id.format` | ``"uuid"`` | -| `properties.id.isRequired` | ``true`` | -| `properties.id.type` | ``"string"`` | -| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | -| `properties.metadata.description` | ``"(Optional) metadata"`` | -| `properties.metadata.properties` | {} | -| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | -| `properties.name.description` | ``"Name of the user"`` | -| `properties.name.type` | ``"string"`` | -| `properties.updated_at` | \{ `description`: ``"User updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | -| `properties.updated_at.description` | ``"User updated at (RFC-3339 format)"`` | -| `properties.updated_at.format` | ``"date-time"`` | -| `properties.updated_at.type` | ``"string"`` | - -#### Defined in - -[src/api/schemas/$User.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$User.ts#L5) +Re-exports [ResourceDeletedResponse](api_models_ResourceDeletedResponse.md#resourcedeletedresponse) ___ -### $agent\_id - -• `Const` **$agent\_id**: `Object` +### ResourceUpdatedResponse -#### Type declaration +Re-exports [ResourceUpdatedResponse](api_models_ResourceUpdatedResponse.md#resourceupdatedresponse) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### Session -[src/api/schemas/$agent_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$agent_id.ts#L5) +Re-exports [Session](api_models_Session.md#session) ___ -### $doc\_id - -• `Const` **$doc\_id**: `Object` +### Suggestion -#### Type declaration +Re-exports [Suggestion](api_models_Suggestion.md#suggestion) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### Tool -[src/api/schemas/$doc_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$doc_id.ts#L5) +Re-exports [Tool](api_models_Tool.md#tool) ___ -### $job\_id - -• `Const` **$job\_id**: `Object` +### ToolChoiceOption -#### Type declaration +Re-exports [ToolChoiceOption](api_models_ToolChoiceOption.md#toolchoiceoption) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### UpdateAgentRequest -[src/api/schemas/$job_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$job_id.ts#L5) +Re-exports [UpdateAgentRequest](api_models_UpdateAgentRequest.md#updateagentrequest) ___ -### $memory\_id - -• `Const` **$memory\_id**: `Object` +### UpdateSessionRequest -#### Type declaration +Re-exports [UpdateSessionRequest](api_models_UpdateSessionRequest.md#updatesessionrequest) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### UpdateToolRequest -[src/api/schemas/$memory_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$memory_id.ts#L5) +Re-exports [UpdateToolRequest](api_models_UpdateToolRequest.md#updatetoolrequest) ___ -### $message\_id - -• `Const` **$message\_id**: `Object` +### UpdateUserRequest -#### Type declaration +Re-exports [UpdateUserRequest](api_models_UpdateUserRequest.md#updateuserrequest) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### User -[src/api/schemas/$message_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$message_id.ts#L5) +Re-exports [User](api_models_User.md#user) ___ -### $session\_id - -• `Const` **$session\_id**: `Object` +### agent\_id -#### Type declaration +Re-exports [agent_id](api_models_agent_id.md#agent_id) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### doc\_id -[src/api/schemas/$session_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$session_id.ts#L5) +Re-exports [doc_id](api_models_doc_id.md#doc_id) ___ -### $tool\_id - -• `Const` **$tool\_id**: `Object` +### job\_id -#### Type declaration +Re-exports [job_id](api_models_job_id.md#job_id) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### memory\_id -[src/api/schemas/$tool_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$tool_id.ts#L5) +Re-exports [memory_id](api_models_memory_id.md#memory_id) ___ -### $user\_id - -• `Const` **$user\_id**: `Object` +### message\_id -#### Type declaration +Re-exports [message_id](api_models_message_id.md#message_id) -| Name | Type | -| :------ | :------ | -| `format` | ``"uuid"`` | -| `type` | ``"string"`` | +___ -#### Defined in +### session\_id -[src/api/schemas/$user_id.ts:5](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/schemas/$user_id.ts#L5) +Re-exports [session_id](api_models_session_id.md#session_id) ___ -### OpenAPI +### tool\_id + +Re-exports [tool_id](api_models_tool_id.md#tool_id) -• `Const` **OpenAPI**: [`OpenAPIConfig`](api.md#openapiconfig) +___ -#### Defined in +### user\_id -[src/api/core/OpenAPI.ts:22](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/api/core/OpenAPI.ts#L22) +Re-exports [user_id](api_models_user_id.md#user_id) diff --git a/docs/js-sdk-docs/modules/api_JulepApiClient.md b/docs/js-sdk-docs/modules/api_JulepApiClient.md index 07f3cc365..5ed209f99 100644 --- a/docs/js-sdk-docs/modules/api_JulepApiClient.md +++ b/docs/js-sdk-docs/modules/api_JulepApiClient.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / api/JulepApiClient +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/JulepApiClient # Module: api/JulepApiClient diff --git a/docs/js-sdk-docs/modules/api_core_ApiError.md b/docs/js-sdk-docs/modules/api_core_ApiError.md new file mode 100644 index 000000000..be175c325 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_ApiError.md @@ -0,0 +1,9 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/ApiError + +# Module: api/core/ApiError + +## Table of contents + +### Classes + +- [ApiError](../classes/api_core_ApiError.ApiError.md) diff --git a/docs/js-sdk-docs/modules/api_core_ApiRequestOptions.md b/docs/js-sdk-docs/modules/api_core_ApiRequestOptions.md new file mode 100644 index 000000000..7bd615fba --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_ApiRequestOptions.md @@ -0,0 +1,35 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/ApiRequestOptions + +# Module: api/core/ApiRequestOptions + +## Table of contents + +### Type Aliases + +- [ApiRequestOptions](api_core_ApiRequestOptions.md#apirequestoptions) + +## Type Aliases + +### ApiRequestOptions + +Ƭ **ApiRequestOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `body?` | `any` | +| `cookies?` | `Record`\<`string`, `any`\> | +| `errors?` | `Record`\<`number`, `string`\> | +| `formData?` | `Record`\<`string`, `any`\> | +| `headers?` | `Record`\<`string`, `any`\> | +| `mediaType?` | `string` | +| `method` | ``"GET"`` \| ``"PUT"`` \| ``"POST"`` \| ``"DELETE"`` \| ``"OPTIONS"`` \| ``"HEAD"`` \| ``"PATCH"`` | +| `path?` | `Record`\<`string`, `any`\> | +| `query?` | `Record`\<`string`, `any`\> | +| `responseHeader?` | `string` | +| `url` | `string` | + +#### Defined in + +[src/api/core/ApiRequestOptions.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiRequestOptions.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_core_ApiResult.md b/docs/js-sdk-docs/modules/api_core_ApiResult.md new file mode 100644 index 000000000..9828ec35a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_ApiResult.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/ApiResult + +# Module: api/core/ApiResult + +## Table of contents + +### Type Aliases + +- [ApiResult](api_core_ApiResult.md#apiresult) + +## Type Aliases + +### ApiResult + +Ƭ **ApiResult**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `body` | `any` | +| `ok` | `boolean` | +| `status` | `number` | +| `statusText` | `string` | +| `url` | `string` | + +#### Defined in + +[src/api/core/ApiResult.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/ApiResult.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_core_AxiosHttpRequest.md b/docs/js-sdk-docs/modules/api_core_AxiosHttpRequest.md new file mode 100644 index 000000000..db6b3cb96 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_AxiosHttpRequest.md @@ -0,0 +1,9 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/AxiosHttpRequest + +# Module: api/core/AxiosHttpRequest + +## Table of contents + +### Classes + +- [AxiosHttpRequest](../classes/api_core_AxiosHttpRequest.AxiosHttpRequest.md) diff --git a/docs/js-sdk-docs/modules/api_core_BaseHttpRequest.md b/docs/js-sdk-docs/modules/api_core_BaseHttpRequest.md new file mode 100644 index 000000000..56a370d86 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_BaseHttpRequest.md @@ -0,0 +1,9 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/BaseHttpRequest + +# Module: api/core/BaseHttpRequest + +## Table of contents + +### Classes + +- [BaseHttpRequest](../classes/api_core_BaseHttpRequest.BaseHttpRequest.md) diff --git a/docs/js-sdk-docs/modules/api_core_CancelablePromise.md b/docs/js-sdk-docs/modules/api_core_CancelablePromise.md new file mode 100644 index 000000000..ef7a3ac30 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_CancelablePromise.md @@ -0,0 +1,14 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/CancelablePromise + +# Module: api/core/CancelablePromise + +## Table of contents + +### Classes + +- [CancelError](../classes/api_core_CancelablePromise.CancelError.md) +- [CancelablePromise](../classes/api_core_CancelablePromise.CancelablePromise.md) + +### Interfaces + +- [OnCancel](../interfaces/api_core_CancelablePromise.OnCancel.md) diff --git a/docs/js-sdk-docs/modules/api_core_OpenAPI.md b/docs/js-sdk-docs/modules/api_core_OpenAPI.md new file mode 100644 index 000000000..86428c7e2 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_OpenAPI.md @@ -0,0 +1,47 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/OpenAPI + +# Module: api/core/OpenAPI + +## Table of contents + +### Type Aliases + +- [OpenAPIConfig](api_core_OpenAPI.md#openapiconfig) + +### Variables + +- [OpenAPI](api_core_OpenAPI.md#openapi) + +## Type Aliases + +### OpenAPIConfig + +Ƭ **OpenAPIConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `BASE` | `string` | +| `CREDENTIALS` | ``"include"`` \| ``"omit"`` \| ``"same-origin"`` | +| `ENCODE_PATH?` | (`path`: `string`) => `string` | +| `HEADERS?` | `Headers` \| `Resolver`\<`Headers`\> | +| `PASSWORD?` | `string` \| `Resolver`\<`string`\> | +| `TOKEN?` | `string` \| `Resolver`\<`string`\> | +| `USERNAME?` | `string` \| `Resolver`\<`string`\> | +| `VERSION` | `string` | +| `WITH_CREDENTIALS` | `boolean` | + +#### Defined in + +[src/api/core/OpenAPI.ts:10](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/OpenAPI.ts#L10) + +## Variables + +### OpenAPI + +• `Const` **OpenAPI**: [`OpenAPIConfig`](api_core_OpenAPI.md#openapiconfig) + +#### Defined in + +[src/api/core/OpenAPI.ts:22](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/OpenAPI.ts#L22) diff --git a/docs/js-sdk-docs/modules/api_core_request.md b/docs/js-sdk-docs/modules/api_core_request.md new file mode 100644 index 000000000..d85cb10a5 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_core_request.md @@ -0,0 +1,411 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/core/request + +# Module: api/core/request + +## Table of contents + +### Functions + +- [base64](api_core_request.md#base64) +- [catchErrorCodes](api_core_request.md#catcherrorcodes) +- [getFormData](api_core_request.md#getformdata) +- [getHeaders](api_core_request.md#getheaders) +- [getQueryString](api_core_request.md#getquerystring) +- [getRequestBody](api_core_request.md#getrequestbody) +- [getResponseBody](api_core_request.md#getresponsebody) +- [getResponseHeader](api_core_request.md#getresponseheader) +- [isBlob](api_core_request.md#isblob) +- [isDefined](api_core_request.md#isdefined) +- [isFormData](api_core_request.md#isformdata) +- [isString](api_core_request.md#isstring) +- [isStringWithValue](api_core_request.md#isstringwithvalue) +- [isSuccess](api_core_request.md#issuccess) +- [request](api_core_request.md#request) +- [resolve](api_core_request.md#resolve) +- [sendRequest](api_core_request.md#sendrequest) + +## Functions + +### base64 + +▸ **base64**(`str`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/api/core/request.ts:56](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L56) + +___ + +### catchErrorCodes + +▸ **catchErrorCodes**(`options`, `result`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | +| `result` | [`ApiResult`](api_core_ApiResult.md#apiresult) | + +#### Returns + +`void` + +#### Defined in + +[src/api/core/request.ts:275](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L275) + +___ + +### getFormData + +▸ **getFormData**(`options`): `undefined` \| `FormData` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | + +#### Returns + +`undefined` \| `FormData` + +#### Defined in + +[src/api/core/request.ts:118](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L118) + +___ + +### getHeaders + +▸ **getHeaders**(`config`, `options`, `formData?`): `Promise`\<`Record`\<`string`, `string`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`OpenAPIConfig`](api_core_OpenAPI.md#openapiconfig) | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | +| `formData?` | `FormData` | + +#### Returns + +`Promise`\<`Record`\<`string`, `string`\>\> + +#### Defined in + +[src/api/core/request.ts:159](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L159) + +___ + +### getQueryString + +▸ **getQueryString**(`params`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Record`\<`string`, `any`\> | + +#### Returns + +`string` + +#### Defined in + +[src/api/core/request.ts:65](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L65) + +___ + +### getRequestBody + +▸ **getRequestBody**(`options`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | + +#### Returns + +`any` + +#### Defined in + +[src/api/core/request.ts:214](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L214) + +___ + +### getResponseBody + +▸ **getResponseBody**(`response`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +`any` + +#### Defined in + +[src/api/core/request.ts:268](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L268) + +___ + +### getResponseHeader + +▸ **getResponseHeader**(`response`, `responseHeader?`): `undefined` \| `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | +| `responseHeader?` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[src/api/core/request.ts:255](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L255) + +___ + +### isBlob + +▸ **isBlob**(`value`): value is Blob + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is Blob + +#### Defined in + +[src/api/core/request.ts:35](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L35) + +___ + +### isDefined + +▸ **isDefined**\<`T`\>(`value`): value is Exclude\ + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| ``null`` \| `T` | + +#### Returns + +value is Exclude\ + +#### Defined in + +[src/api/core/request.ts:21](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L21) + +___ + +### isFormData + +▸ **isFormData**(`value`): value is FormData + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is FormData + +#### Defined in + +[src/api/core/request.ts:48](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L48) + +___ + +### isString + +▸ **isString**(`value`): value is string + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is string + +#### Defined in + +[src/api/core/request.ts:27](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L27) + +___ + +### isStringWithValue + +▸ **isStringWithValue**(`value`): value is string + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is string + +#### Defined in + +[src/api/core/request.ts:31](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L31) + +___ + +### isSuccess + +▸ **isSuccess**(`status`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `status` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[src/api/core/request.ts:52](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L52) + +___ + +### request + +▸ **request**\<`T`\>(`config`, `options`, `axiosClient?`): [`CancelablePromise`](../classes/api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +Request method + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `config` | [`OpenAPIConfig`](api_core_OpenAPI.md#openapiconfig) | `undefined` | The OpenAPI configuration object | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | `undefined` | The request options from the service | +| `axiosClient` | `AxiosInstance` | `axios` | The axios client instance to use | + +#### Returns + +[`CancelablePromise`](../classes/api_core_CancelablePromise.CancelablePromise.md)\<`T`\> + +CancelablePromise + +**`Throws`** + +ApiError + +#### Defined in + +[src/api/core/request.ts:322](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L322) + +___ + +### resolve + +▸ **resolve**\<`T`\>(`options`, `resolver?`): `Promise`\<`undefined` \| `T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | +| `resolver?` | `T` \| `Resolver`\<`T`\> | + +#### Returns + +`Promise`\<`undefined` \| `T`\> + +#### Defined in + +[src/api/core/request.ts:149](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L149) + +___ + +### sendRequest + +▸ **sendRequest**\<`T`\>(`config`, `options`, `url`, `body`, `formData`, `headers`, `onCancel`, `axiosClient`): `Promise`\<`AxiosResponse`\<`T`, `any`\>\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`OpenAPIConfig`](api_core_OpenAPI.md#openapiconfig) | +| `options` | [`ApiRequestOptions`](api_core_ApiRequestOptions.md#apirequestoptions) | +| `url` | `string` | +| `body` | `any` | +| `formData` | `undefined` \| `FormData` | +| `headers` | `Record`\<`string`, `string`\> | +| `onCancel` | [`OnCancel`](../interfaces/api_core_CancelablePromise.OnCancel.md) | +| `axiosClient` | `AxiosInstance` | + +#### Returns + +`Promise`\<`AxiosResponse`\<`T`, `any`\>\> + +#### Defined in + +[src/api/core/request.ts:221](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/core/request.ts#L221) diff --git a/docs/js-sdk-docs/modules/api_models_Agent.md b/docs/js-sdk-docs/modules/api_models_Agent.md new file mode 100644 index 000000000..322583986 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Agent.md @@ -0,0 +1,33 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Agent + +# Module: api/models/Agent + +## Table of contents + +### Type Aliases + +- [Agent](api_models_Agent.md#agent) + +## Type Aliases + +### Agent + +Ƭ **Agent**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the agent | +| `created_at?` | `string` | Agent created at (RFC-3339 format) | +| `default_settings?` | [`AgentDefaultSettings`](api_models_AgentDefaultSettings.md#agentdefaultsettings) | Default settings for all sessions created by this agent | +| `id` | `string` | Agent id (UUID) | +| `instructions?` | `string` \| `string`[] | Instructions for the agent | +| `metadata?` | `any` | Optional metadata | +| `model` | `string` | The model to use with this agent | +| `name` | `string` | Name of the agent | +| `updated_at?` | `string` | Agent updated at (RFC-3339 format) | + +#### Defined in + +[src/api/models/Agent.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Agent.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_AgentDefaultSettings.md b/docs/js-sdk-docs/modules/api_models_AgentDefaultSettings.md new file mode 100644 index 000000000..99ea82f5f --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_AgentDefaultSettings.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/AgentDefaultSettings + +# Module: api/models/AgentDefaultSettings + +## Table of contents + +### Type Aliases + +- [AgentDefaultSettings](api_models_AgentDefaultSettings.md#agentdefaultsettings) + +## Type Aliases + +### AgentDefaultSettings + +Ƭ **AgentDefaultSettings**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `frequency_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `length_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. | +| `min_p?` | `number` | Minimum probability compared to leading token to be considered | +| `presence_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `preset?` | ``"problem_solving"`` \| ``"conversational"`` \| ``"fun"`` \| ``"prose"`` \| ``"creative"`` \| ``"business"`` \| ``"deterministic"`` \| ``"code"`` \| ``"multilingual"`` | Generation preset name (one of: problem_solving, conversational, fun, prose, creative, business, deterministic, code, multilingual) | +| `repetition_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `temperature?` | `number` \| ``null`` | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. | +| `top_p?` | `number` \| ``null`` | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. | + +#### Defined in + +[src/api/models/AgentDefaultSettings.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/AgentDefaultSettings.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_ChatInput.md b/docs/js-sdk-docs/modules/api_models_ChatInput.md new file mode 100644 index 000000000..14da51adb --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ChatInput.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ChatInput + +# Module: api/models/ChatInput + +## Table of contents + +### Type Aliases + +- [ChatInput](api_models_ChatInput.md#chatinput) + +## Type Aliases + +### ChatInput + +Ƭ **ChatInput**: [`ChatInputData`](api_models_ChatInputData.md#chatinputdata) & [`ChatSettings`](api_models_ChatSettings.md#chatsettings) & [`MemoryAccessOptions`](api_models_MemoryAccessOptions.md#memoryaccessoptions) + +#### Defined in + +[src/api/models/ChatInput.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ChatInput.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_ChatInputData.md b/docs/js-sdk-docs/modules/api_models_ChatInputData.md new file mode 100644 index 000000000..8823395fb --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ChatInputData.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ChatInputData + +# Module: api/models/ChatInputData + +## Table of contents + +### Type Aliases + +- [ChatInputData](api_models_ChatInputData.md#chatinputdata) + +## Type Aliases + +### ChatInputData + +Ƭ **ChatInputData**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `messages` | [`InputChatMLMessage`](api_models_InputChatMLMessage.md#inputchatmlmessage)[] | A list of new input messages comprising the conversation so far. | +| `tool_choice?` | [`ToolChoiceOption`](api_models_ToolChoiceOption.md#toolchoiceoption) \| [`NamedToolChoice`](api_models_NamedToolChoice.md#namedtoolchoice) \| ``null`` | Can be one of existing tools given to the agent earlier or the ones included in the request | +| `tools?` | [`Tool`](api_models_Tool.md#tool)[] \| ``null`` | (Advanced) List of tools that are provided in addition to agent's default set of tools. Functions of same name in agent set are overriden | + +#### Defined in + +[src/api/models/ChatInputData.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ChatInputData.ts#L9) diff --git a/docs/js-sdk-docs/modules/api_models_ChatMLMessage.md b/docs/js-sdk-docs/modules/api_models_ChatMLMessage.md new file mode 100644 index 000000000..3616ebe77 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ChatMLMessage.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ChatMLMessage + +# Module: api/models/ChatMLMessage + +## Table of contents + +### Type Aliases + +- [ChatMLMessage](api_models_ChatMLMessage.md#chatmlmessage) + +## Type Aliases + +### ChatMLMessage + +Ƭ **ChatMLMessage**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `content` | `string` | ChatML content | +| `created_at` | `string` | Message created at (RFC-3339 format) | +| `id` | `string` | Message ID | +| `name?` | `string` | ChatML name | +| `role` | ``"user"`` \| ``"assistant"`` \| ``"system"`` \| ``"function_call"`` \| ``"function"`` | ChatML role (system\|assistant\|user\|function_call\|function) | + +#### Defined in + +[src/api/models/ChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ChatMLMessage.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_ChatResponse.md b/docs/js-sdk-docs/modules/api_models_ChatResponse.md new file mode 100644 index 000000000..5e10f02c8 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ChatResponse.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ChatResponse + +# Module: api/models/ChatResponse + +## Table of contents + +### Type Aliases + +- [ChatResponse](api_models_ChatResponse.md#chatresponse) + +## Type Aliases + +### ChatResponse + +Ƭ **ChatResponse**: `Object` + +Represents a chat completion response returned by model, based on the provided input. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `doc_ids` | [`DocIds`](api_models_DocIds.md#docids) | - | +| `finish_reason` | ``"stop"`` \| ``"length"`` \| ``"tool_calls"`` \| ``"content_filter"`` \| ``"function_call"`` | The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. | +| `id` | `string` | A unique identifier for the chat completion. | +| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | +| `response` | [`ChatMLMessage`](api_models_ChatMLMessage.md#chatmlmessage)[][] | A list of chat completion messages produced as a response. | +| `usage` | [`CompletionUsage`](api_models_CompletionUsage.md#completionusage) | - | + +#### Defined in + +[src/api/models/ChatResponse.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ChatResponse.ts#L11) diff --git a/docs/js-sdk-docs/modules/api_models_ChatSettings.md b/docs/js-sdk-docs/modules/api_models_ChatSettings.md new file mode 100644 index 000000000..29bf66774 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ChatSettings.md @@ -0,0 +1,41 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ChatSettings + +# Module: api/models/ChatSettings + +## Table of contents + +### Type Aliases + +- [ChatSettings](api_models_ChatSettings.md#chatsettings) + +## Type Aliases + +### ChatSettings + +Ƭ **ChatSettings**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `frequency_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `length_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. | +| `logit_bias?` | `Record`\<`string`, `number`\> \| ``null`` | Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. | +| `max_tokens?` | `number` \| ``null`` | The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. | +| `min_p?` | `number` | Minimum probability compared to leading token to be considered | +| `presence_penalty?` | `number` \| ``null`` | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `preset?` | ``"problem_solving"`` \| ``"conversational"`` \| ``"fun"`` \| ``"prose"`` \| ``"creative"`` \| ``"business"`` \| ``"deterministic"`` \| ``"code"`` \| ``"multilingual"`` | Generation preset name (problem_solving\|conversational\|fun\|prose\|creative\|business\|deterministic\|code\|multilingual) | +| `repetition_penalty?` | `number` \| ``null`` | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | +| `response_format?` | \{ `pattern?`: `string` ; `schema?`: `any` ; `type?`: ``"text"`` \| ``"json_object"`` \| ``"regex"`` } | An object specifying the format that the model must output. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. | +| `response_format.pattern?` | `string` | Regular expression pattern to use if `type` is `"regex"` | +| `response_format.schema?` | `any` | JSON Schema to use if `type` is `"json_object"` | +| `response_format.type?` | ``"text"`` \| ``"json_object"`` \| ``"regex"`` | Must be one of `"text"`, `"regex"` or `"json_object"`. | +| `seed?` | `number` \| ``null`` | This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. | +| `stop?` | `string` \| ``null`` \| `string`[] | Up to 4 sequences where the API will stop generating further tokens. | +| `stream?` | `boolean` \| ``null`` | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). | +| `temperature?` | `number` \| ``null`` | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. | +| `top_p?` | `number` \| ``null`` | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. | + +#### Defined in + +[src/api/models/ChatSettings.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ChatSettings.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_CompletionUsage.md b/docs/js-sdk-docs/modules/api_models_CompletionUsage.md new file mode 100644 index 000000000..ad7044d6c --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CompletionUsage.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CompletionUsage + +# Module: api/models/CompletionUsage + +## Table of contents + +### Type Aliases + +- [CompletionUsage](api_models_CompletionUsage.md#completionusage) + +## Type Aliases + +### CompletionUsage + +Ƭ **CompletionUsage**: `Object` + +Usage statistics for the completion request. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `completion_tokens` | `number` | Number of tokens in the generated completion. | +| `prompt_tokens` | `number` | Number of tokens in the prompt. | +| `total_tokens` | `number` | Total number of tokens used in the request (prompt + completion). | + +#### Defined in + +[src/api/models/CompletionUsage.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CompletionUsage.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_CreateAgentRequest.md b/docs/js-sdk-docs/modules/api_models_CreateAgentRequest.md new file mode 100644 index 000000000..8070b6cce --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CreateAgentRequest.md @@ -0,0 +1,34 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CreateAgentRequest + +# Module: api/models/CreateAgentRequest + +## Table of contents + +### Type Aliases + +- [CreateAgentRequest](api_models_CreateAgentRequest.md#createagentrequest) + +## Type Aliases + +### CreateAgentRequest + +Ƭ **CreateAgentRequest**: `Object` + +A valid request payload for creating an agent + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the agent | +| `default_settings?` | [`AgentDefaultSettings`](api_models_AgentDefaultSettings.md#agentdefaultsettings) | Default model settings to start every session with | +| `docs?` | [`CreateDoc`](api_models_CreateDoc.md#createdoc)[] | List of docs about agent | +| `instructions?` | `string` \| `string`[] | Instructions for the agent | +| `metadata?` | `any` | (Optional) metadata | +| `model?` | `string` | Name of the model that the agent is supposed to use | +| `name` | `string` | Name of the agent | +| `tools?` | [`CreateToolRequest`](api_models_CreateToolRequest.md#createtoolrequest)[] | A list of tools the model may call. Currently, only `function`s are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | + +#### Defined in + +[src/api/models/CreateAgentRequest.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CreateAgentRequest.ts#L11) diff --git a/docs/js-sdk-docs/modules/api_models_CreateDoc.md b/docs/js-sdk-docs/modules/api_models_CreateDoc.md new file mode 100644 index 000000000..f6c362954 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CreateDoc.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CreateDoc + +# Module: api/models/CreateDoc + +## Table of contents + +### Type Aliases + +- [CreateDoc](api_models_CreateDoc.md#createdoc) + +## Type Aliases + +### CreateDoc + +Ƭ **CreateDoc**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `content` | `string`[] \| `string` | Information content | +| `metadata?` | `any` | Optional metadata | +| `title` | `string` | Title describing what this bit of information contains | + +#### Defined in + +[src/api/models/CreateDoc.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CreateDoc.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_CreateSessionRequest.md b/docs/js-sdk-docs/modules/api_models_CreateSessionRequest.md new file mode 100644 index 000000000..b5a9d2eae --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CreateSessionRequest.md @@ -0,0 +1,31 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CreateSessionRequest + +# Module: api/models/CreateSessionRequest + +## Table of contents + +### Type Aliases + +- [CreateSessionRequest](api_models_CreateSessionRequest.md#createsessionrequest) + +## Type Aliases + +### CreateSessionRequest + +Ƭ **CreateSessionRequest**: `Object` + +A valid request payload for creating a session + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `agent_id` | `string` | Agent ID of agent to associate with this session | +| `metadata?` | `any` | Optional metadata | +| `render_templates?` | `boolean` | Render system and assistant message content as jinja templates | +| `situation?` | `string` | A specific situation that sets the background for this session | +| `user_id?` | `string` | (Optional) User ID of user to associate with this session | + +#### Defined in + +[src/api/models/CreateSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CreateSessionRequest.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_CreateToolRequest.md b/docs/js-sdk-docs/modules/api_models_CreateToolRequest.md new file mode 100644 index 000000000..09685507a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CreateToolRequest.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CreateToolRequest + +# Module: api/models/CreateToolRequest + +## Table of contents + +### Type Aliases + +- [CreateToolRequest](api_models_CreateToolRequest.md#createtoolrequest) + +## Type Aliases + +### CreateToolRequest + +Ƭ **CreateToolRequest**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `function` | [`FunctionDef`](api_models_FunctionDef.md#functiondef) | Function definition and parameters | +| `type` | ``"function"`` \| ``"webhook"`` | Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) | + +#### Defined in + +[src/api/models/CreateToolRequest.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CreateToolRequest.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_CreateUserRequest.md b/docs/js-sdk-docs/modules/api_models_CreateUserRequest.md new file mode 100644 index 000000000..85ff4d8f7 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_CreateUserRequest.md @@ -0,0 +1,30 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/CreateUserRequest + +# Module: api/models/CreateUserRequest + +## Table of contents + +### Type Aliases + +- [CreateUserRequest](api_models_CreateUserRequest.md#createuserrequest) + +## Type Aliases + +### CreateUserRequest + +Ƭ **CreateUserRequest**: `Object` + +A valid request payload for creating a user + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the user | +| `docs?` | [`CreateDoc`](api_models_CreateDoc.md#createdoc)[] | List of docs about user | +| `metadata?` | `any` | (Optional) metadata | +| `name?` | `string` | Name of the user | + +#### Defined in + +[src/api/models/CreateUserRequest.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/CreateUserRequest.ts#L9) diff --git a/docs/js-sdk-docs/modules/api_models_Doc.md b/docs/js-sdk-docs/modules/api_models_Doc.md new file mode 100644 index 000000000..f9d58ef99 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Doc.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Doc + +# Module: api/models/Doc + +## Table of contents + +### Type Aliases + +- [Doc](api_models_Doc.md#doc) + +## Type Aliases + +### Doc + +Ƭ **Doc**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `content` | `string`[] \| `string` | Information content | +| `created_at` | `string` | Doc created at | +| `id` | `string` | ID of doc | +| `metadata?` | `any` | optional metadata | +| `title` | `string` | Title describing what this bit of information contains | + +#### Defined in + +[src/api/models/Doc.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Doc.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_DocIds.md b/docs/js-sdk-docs/modules/api_models_DocIds.md new file mode 100644 index 000000000..26b2ee1fa --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_DocIds.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/DocIds + +# Module: api/models/DocIds + +## Table of contents + +### Type Aliases + +- [DocIds](api_models_DocIds.md#docids) + +## Type Aliases + +### DocIds + +Ƭ **DocIds**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `agent_doc_ids` | `string`[] | +| `user_doc_ids` | `string`[] | + +#### Defined in + +[src/api/models/DocIds.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/DocIds.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_FunctionCallOption.md b/docs/js-sdk-docs/modules/api_models_FunctionCallOption.md new file mode 100644 index 000000000..98d36644a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_FunctionCallOption.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/FunctionCallOption + +# Module: api/models/FunctionCallOption + +## Table of contents + +### Type Aliases + +- [FunctionCallOption](api_models_FunctionCallOption.md#functioncalloption) + +## Type Aliases + +### FunctionCallOption + +Ƭ **FunctionCallOption**: `Object` + +Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | The name of the function to call. | + +#### Defined in + +[src/api/models/FunctionCallOption.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/FunctionCallOption.ts#L9) diff --git a/docs/js-sdk-docs/modules/api_models_FunctionDef.md b/docs/js-sdk-docs/modules/api_models_FunctionDef.md new file mode 100644 index 000000000..ebd4b1111 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_FunctionDef.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/FunctionDef + +# Module: api/models/FunctionDef + +## Table of contents + +### Type Aliases + +- [FunctionDef](api_models_FunctionDef.md#functiondef) + +## Type Aliases + +### FunctionDef + +Ƭ **FunctionDef**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `description?` | `string` | A description of what the function does, used by the model to choose when and how to call the function. | +| `name` | `string` | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | +| `parameters` | [`FunctionParameters`](api_models_FunctionParameters.md#functionparameters) | Parameters accepeted by this function | + +#### Defined in + +[src/api/models/FunctionDef.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/FunctionDef.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_FunctionParameters.md b/docs/js-sdk-docs/modules/api_models_FunctionParameters.md new file mode 100644 index 000000000..a472377ab --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_FunctionParameters.md @@ -0,0 +1,21 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/FunctionParameters + +# Module: api/models/FunctionParameters + +## Table of contents + +### Type Aliases + +- [FunctionParameters](api_models_FunctionParameters.md#functionparameters) + +## Type Aliases + +### FunctionParameters + +Ƭ **FunctionParameters**: `Record`\<`string`, `any`\> + +The parameters the functions accepts, described as a JSON Schema object. + +#### Defined in + +[src/api/models/FunctionParameters.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/FunctionParameters.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_InputChatMLMessage.md b/docs/js-sdk-docs/modules/api_models_InputChatMLMessage.md new file mode 100644 index 000000000..256c337e1 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_InputChatMLMessage.md @@ -0,0 +1,28 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/InputChatMLMessage + +# Module: api/models/InputChatMLMessage + +## Table of contents + +### Type Aliases + +- [InputChatMLMessage](api_models_InputChatMLMessage.md#inputchatmlmessage) + +## Type Aliases + +### InputChatMLMessage + +Ƭ **InputChatMLMessage**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `content` | `string` | ChatML content | +| `continue?` | `boolean` | Whether to continue this message or return a new one | +| `name?` | `string` | ChatML name | +| `role` | ``"user"`` \| ``"assistant"`` \| ``"system"`` \| ``"function_call"`` \| ``"function"`` \| ``"auto"`` | ChatML role (system\|assistant\|user\|function_call\|function\|auto) | + +#### Defined in + +[src/api/models/InputChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/InputChatMLMessage.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_JobStatus.md b/docs/js-sdk-docs/modules/api_models_JobStatus.md new file mode 100644 index 000000000..62be3b95e --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_JobStatus.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/JobStatus + +# Module: api/models/JobStatus + +## Table of contents + +### Type Aliases + +- [JobStatus](api_models_JobStatus.md#jobstatus) + +## Type Aliases + +### JobStatus + +Ƭ **JobStatus**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `created_at` | `string` | Job created at (RFC-3339 format) | +| `has_progress?` | `boolean` | Whether this Job supports progress updates | +| `id` | `string` | Job id (UUID) | +| `name` | `string` | Name of the job | +| `progress?` | `number` | Progress percentage | +| `reason?` | `string` | Reason for current state | +| `state` | ``"pending"`` \| ``"in_progress"`` \| ``"retrying"`` \| ``"succeeded"`` \| ``"aborted"`` \| ``"failed"`` \| ``"unknown"`` | Current state (one of: pending, in_progress, retrying, succeeded, aborted, failed) | +| `updated_at?` | `string` | Job updated at (RFC-3339 format) | + +#### Defined in + +[src/api/models/JobStatus.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/JobStatus.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_Memory.md b/docs/js-sdk-docs/modules/api_models_Memory.md new file mode 100644 index 000000000..db32b7f39 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Memory.md @@ -0,0 +1,33 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Memory + +# Module: api/models/Memory + +## Table of contents + +### Type Aliases + +- [Memory](api_models_Memory.md#memory) + +## Type Aliases + +### Memory + +Ƭ **Memory**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `agent_id` | `string` | ID of the agent | +| `content` | `string` | Content of the memory | +| `created_at` | `string` | Memory created at (RFC-3339 format) | +| `entities` | `any`[] | List of entities mentioned in the memory | +| `id` | `string` | Memory id (UUID) | +| `last_accessed_at?` | `string` | Memory last accessed at (RFC-3339 format) | +| `sentiment?` | `number` | Sentiment (valence) of the memory on a scale of -1 to 1 | +| `timestamp?` | `string` | Memory happened at (RFC-3339 format) | +| `user_id` | `string` | ID of the user | + +#### Defined in + +[src/api/models/Memory.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Memory.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_MemoryAccessOptions.md b/docs/js-sdk-docs/modules/api_models_MemoryAccessOptions.md new file mode 100644 index 000000000..959ac29a1 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_MemoryAccessOptions.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/MemoryAccessOptions + +# Module: api/models/MemoryAccessOptions + +## Table of contents + +### Type Aliases + +- [MemoryAccessOptions](api_models_MemoryAccessOptions.md#memoryaccessoptions) + +## Type Aliases + +### MemoryAccessOptions + +Ƭ **MemoryAccessOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `recall?` | `boolean` | Whether previous memories should be recalled or not | +| `record?` | `boolean` | Whether this interaction should be recorded in history or not | +| `remember?` | `boolean` | Whether this interaction should form memories or not | + +#### Defined in + +[src/api/models/MemoryAccessOptions.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/MemoryAccessOptions.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_NamedToolChoice.md b/docs/js-sdk-docs/modules/api_models_NamedToolChoice.md new file mode 100644 index 000000000..db889e9ce --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_NamedToolChoice.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/NamedToolChoice + +# Module: api/models/NamedToolChoice + +## Table of contents + +### Type Aliases + +- [NamedToolChoice](api_models_NamedToolChoice.md#namedtoolchoice) + +## Type Aliases + +### NamedToolChoice + +Ƭ **NamedToolChoice**: `Object` + +Specifies a tool the model should use. Use to force the model to call a specific function. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `function` | \{ `name`: `string` } | - | +| `function.name` | `string` | The name of the function to call. | +| `type` | ``"function"`` | The type of the tool. Currently, only `function` is supported. | + +#### Defined in + +[src/api/models/NamedToolChoice.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/NamedToolChoice.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_PartialFunctionDef.md b/docs/js-sdk-docs/modules/api_models_PartialFunctionDef.md new file mode 100644 index 000000000..2a1da5139 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_PartialFunctionDef.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/PartialFunctionDef + +# Module: api/models/PartialFunctionDef + +## Table of contents + +### Type Aliases + +- [PartialFunctionDef](api_models_PartialFunctionDef.md#partialfunctiondef) + +## Type Aliases + +### PartialFunctionDef + +Ƭ **PartialFunctionDef**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `description?` | `string` | A description of what the function does, used by the model to choose when and how to call the function. | +| `name?` | `string` | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | +| `parameters?` | [`FunctionParameters`](api_models_FunctionParameters.md#functionparameters) | Parameters accepeted by this function | + +#### Defined in + +[src/api/models/PartialFunctionDef.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/PartialFunctionDef.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_PatchAgentRequest.md b/docs/js-sdk-docs/modules/api_models_PatchAgentRequest.md new file mode 100644 index 000000000..8e6f8046b --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_PatchAgentRequest.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/PatchAgentRequest + +# Module: api/models/PatchAgentRequest + +## Table of contents + +### Type Aliases + +- [PatchAgentRequest](api_models_PatchAgentRequest.md#patchagentrequest) + +## Type Aliases + +### PatchAgentRequest + +Ƭ **PatchAgentRequest**: `Object` + +A request for patching an agent + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the agent | +| `default_settings?` | [`AgentDefaultSettings`](api_models_AgentDefaultSettings.md#agentdefaultsettings) | Default model settings to start every session with | +| `instructions?` | `string` \| `string`[] | Instructions for the agent | +| `metadata?` | `any` | Optional metadata | +| `model?` | `string` | Name of the model that the agent is supposed to use | +| `name?` | `string` | Name of the agent | + +#### Defined in + +[src/api/models/PatchAgentRequest.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/PatchAgentRequest.ts#L9) diff --git a/docs/js-sdk-docs/modules/api_models_PatchSessionRequest.md b/docs/js-sdk-docs/modules/api_models_PatchSessionRequest.md new file mode 100644 index 000000000..ae2adfb8a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_PatchSessionRequest.md @@ -0,0 +1,28 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/PatchSessionRequest + +# Module: api/models/PatchSessionRequest + +## Table of contents + +### Type Aliases + +- [PatchSessionRequest](api_models_PatchSessionRequest.md#patchsessionrequest) + +## Type Aliases + +### PatchSessionRequest + +Ƭ **PatchSessionRequest**: `Object` + +A request for patching a session + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata?` | `any` | Optional metadata | +| `situation?` | `string` | Updated situation for this session | + +#### Defined in + +[src/api/models/PatchSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/PatchSessionRequest.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_PatchToolRequest.md b/docs/js-sdk-docs/modules/api_models_PatchToolRequest.md new file mode 100644 index 000000000..c7b9b1d9e --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_PatchToolRequest.md @@ -0,0 +1,25 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/PatchToolRequest + +# Module: api/models/PatchToolRequest + +## Table of contents + +### Type Aliases + +- [PatchToolRequest](api_models_PatchToolRequest.md#patchtoolrequest) + +## Type Aliases + +### PatchToolRequest + +Ƭ **PatchToolRequest**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `function` | [`PartialFunctionDef`](api_models_PartialFunctionDef.md#partialfunctiondef) | Function definition and parameters | + +#### Defined in + +[src/api/models/PatchToolRequest.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/PatchToolRequest.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_PatchUserRequest.md b/docs/js-sdk-docs/modules/api_models_PatchUserRequest.md new file mode 100644 index 000000000..1cd7d73c8 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_PatchUserRequest.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/PatchUserRequest + +# Module: api/models/PatchUserRequest + +## Table of contents + +### Type Aliases + +- [PatchUserRequest](api_models_PatchUserRequest.md#patchuserrequest) + +## Type Aliases + +### PatchUserRequest + +Ƭ **PatchUserRequest**: `Object` + +A request for patching a user + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the user | +| `metadata?` | `any` | Optional metadata | +| `name?` | `string` | Name of the user | + +#### Defined in + +[src/api/models/PatchUserRequest.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/PatchUserRequest.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_ResourceCreatedResponse.md b/docs/js-sdk-docs/modules/api_models_ResourceCreatedResponse.md new file mode 100644 index 000000000..004019833 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ResourceCreatedResponse.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ResourceCreatedResponse + +# Module: api/models/ResourceCreatedResponse + +## Table of contents + +### Type Aliases + +- [ResourceCreatedResponse](api_models_ResourceCreatedResponse.md#resourcecreatedresponse) + +## Type Aliases + +### ResourceCreatedResponse + +Ƭ **ResourceCreatedResponse**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `created_at` | `string` | - | +| `id` | `string` | - | +| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | + +#### Defined in + +[src/api/models/ResourceCreatedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ResourceCreatedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_ResourceDeletedResponse.md b/docs/js-sdk-docs/modules/api_models_ResourceDeletedResponse.md new file mode 100644 index 000000000..e8f0936a8 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ResourceDeletedResponse.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ResourceDeletedResponse + +# Module: api/models/ResourceDeletedResponse + +## Table of contents + +### Type Aliases + +- [ResourceDeletedResponse](api_models_ResourceDeletedResponse.md#resourcedeletedresponse) + +## Type Aliases + +### ResourceDeletedResponse + +Ƭ **ResourceDeletedResponse**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deleted_at` | `string` | - | +| `id` | `string` | - | +| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | + +#### Defined in + +[src/api/models/ResourceDeletedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ResourceDeletedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_ResourceUpdatedResponse.md b/docs/js-sdk-docs/modules/api_models_ResourceUpdatedResponse.md new file mode 100644 index 000000000..fd1dc831c --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ResourceUpdatedResponse.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ResourceUpdatedResponse + +# Module: api/models/ResourceUpdatedResponse + +## Table of contents + +### Type Aliases + +- [ResourceUpdatedResponse](api_models_ResourceUpdatedResponse.md#resourceupdatedresponse) + +## Type Aliases + +### ResourceUpdatedResponse + +Ƭ **ResourceUpdatedResponse**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | - | +| `jobs?` | `string`[] | IDs (if any) of jobs created as part of this request | +| `updated_at` | `string` | - | + +#### Defined in + +[src/api/models/ResourceUpdatedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ResourceUpdatedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_Session.md b/docs/js-sdk-docs/modules/api_models_Session.md new file mode 100644 index 000000000..b7fcabc25 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Session.md @@ -0,0 +1,33 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Session + +# Module: api/models/Session + +## Table of contents + +### Type Aliases + +- [Session](api_models_Session.md#session) + +## Type Aliases + +### Session + +Ƭ **Session**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `agent_id` | `string` | Agent ID of agent associated with this session | +| `created_at?` | `string` | Session created at (RFC-3339 format) | +| `id` | `string` | Session id (UUID) | +| `metadata?` | `any` | Optional metadata | +| `render_templates?` | `boolean` | Render system and assistant message content as jinja templates | +| `situation?` | `string` | A specific situation that sets the background for this session | +| `summary?` | `string` | (null at the beginning) - generated automatically after every interaction | +| `updated_at?` | `string` | Session updated at (RFC-3339 format) | +| `user_id?` | `string` | User ID of user associated with this session | + +#### Defined in + +[src/api/models/Session.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Session.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_Suggestion.md b/docs/js-sdk-docs/modules/api_models_Suggestion.md new file mode 100644 index 000000000..75fc70c27 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Suggestion.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Suggestion + +# Module: api/models/Suggestion + +## Table of contents + +### Type Aliases + +- [Suggestion](api_models_Suggestion.md#suggestion) + +## Type Aliases + +### Suggestion + +Ƭ **Suggestion**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `content` | `string` | The content of the suggestion | +| `created_at?` | `string` | Suggestion created at (RFC-3339 format) | +| `message_id` | `string` | The message that produced it | +| `session_id` | `string` | Session this suggestion belongs to | +| `target` | ``"user"`` \| ``"agent"`` | Whether the suggestion is for the `agent` or a `user` | + +#### Defined in + +[src/api/models/Suggestion.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Suggestion.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_Tool.md b/docs/js-sdk-docs/modules/api_models_Tool.md new file mode 100644 index 000000000..397ee1d87 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_Tool.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/Tool + +# Module: api/models/Tool + +## Table of contents + +### Type Aliases + +- [Tool](api_models_Tool.md#tool) + +## Type Aliases + +### Tool + +Ƭ **Tool**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `function` | [`FunctionDef`](api_models_FunctionDef.md#functiondef) | Function definition and parameters | +| `id` | `string` | Tool ID | +| `type` | ``"function"`` \| ``"webhook"`` | Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) | + +#### Defined in + +[src/api/models/Tool.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/Tool.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_ToolChoiceOption.md b/docs/js-sdk-docs/modules/api_models_ToolChoiceOption.md new file mode 100644 index 000000000..2d533cbbb --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_ToolChoiceOption.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/ToolChoiceOption + +# Module: api/models/ToolChoiceOption + +## Table of contents + +### Type Aliases + +- [ToolChoiceOption](api_models_ToolChoiceOption.md#toolchoiceoption) + +## Type Aliases + +### ToolChoiceOption + +Ƭ **ToolChoiceOption**: ``"none"`` \| ``"auto"`` \| [`NamedToolChoice`](api_models_NamedToolChoice.md#namedtoolchoice) + +Controls which (if any) function is called by the model. +`none` means the model will not call a function and instead generates a message. +`auto` means the model can pick between generating a message or calling a function. +Specifying a particular function via `{"type: "function", "function": {"name": "my_function"}}` forces the model to call that function. + +`none` is the default when no functions are present. `auto` is the default if functions are present. + +#### Defined in + +[src/api/models/ToolChoiceOption.ts:15](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/ToolChoiceOption.ts#L15) diff --git a/docs/js-sdk-docs/modules/api_models_UpdateAgentRequest.md b/docs/js-sdk-docs/modules/api_models_UpdateAgentRequest.md new file mode 100644 index 000000000..a0cf5444e --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_UpdateAgentRequest.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/UpdateAgentRequest + +# Module: api/models/UpdateAgentRequest + +## Table of contents + +### Type Aliases + +- [UpdateAgentRequest](api_models_UpdateAgentRequest.md#updateagentrequest) + +## Type Aliases + +### UpdateAgentRequest + +Ƭ **UpdateAgentRequest**: `Object` + +A valid request payload for updating an agent + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about` | `string` | About the agent | +| `default_settings?` | [`AgentDefaultSettings`](api_models_AgentDefaultSettings.md#agentdefaultsettings) | Default model settings to start every session with | +| `instructions?` | `string` \| `string`[] | Instructions for the agent | +| `metadata?` | `any` | Optional metadata | +| `model?` | `string` | Name of the model that the agent is supposed to use | +| `name` | `string` | Name of the agent | + +#### Defined in + +[src/api/models/UpdateAgentRequest.ts:9](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/UpdateAgentRequest.ts#L9) diff --git a/docs/js-sdk-docs/modules/api_models_UpdateSessionRequest.md b/docs/js-sdk-docs/modules/api_models_UpdateSessionRequest.md new file mode 100644 index 000000000..1c37e86d0 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_UpdateSessionRequest.md @@ -0,0 +1,28 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/UpdateSessionRequest + +# Module: api/models/UpdateSessionRequest + +## Table of contents + +### Type Aliases + +- [UpdateSessionRequest](api_models_UpdateSessionRequest.md#updatesessionrequest) + +## Type Aliases + +### UpdateSessionRequest + +Ƭ **UpdateSessionRequest**: `Object` + +A valid request payload for updating a session + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `metadata?` | `any` | Optional metadata | +| `situation` | `string` | Updated situation for this session | + +#### Defined in + +[src/api/models/UpdateSessionRequest.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/UpdateSessionRequest.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_UpdateToolRequest.md b/docs/js-sdk-docs/modules/api_models_UpdateToolRequest.md new file mode 100644 index 000000000..024b1a1b9 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_UpdateToolRequest.md @@ -0,0 +1,25 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/UpdateToolRequest + +# Module: api/models/UpdateToolRequest + +## Table of contents + +### Type Aliases + +- [UpdateToolRequest](api_models_UpdateToolRequest.md#updatetoolrequest) + +## Type Aliases + +### UpdateToolRequest + +Ƭ **UpdateToolRequest**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `function` | [`FunctionDef`](api_models_FunctionDef.md#functiondef) | Function definition and parameters | + +#### Defined in + +[src/api/models/UpdateToolRequest.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/UpdateToolRequest.ts#L6) diff --git a/docs/js-sdk-docs/modules/api_models_UpdateUserRequest.md b/docs/js-sdk-docs/modules/api_models_UpdateUserRequest.md new file mode 100644 index 000000000..6657145ee --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_UpdateUserRequest.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/UpdateUserRequest + +# Module: api/models/UpdateUserRequest + +## Table of contents + +### Type Aliases + +- [UpdateUserRequest](api_models_UpdateUserRequest.md#updateuserrequest) + +## Type Aliases + +### UpdateUserRequest + +Ƭ **UpdateUserRequest**: `Object` + +A valid request payload for updating a user + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about` | `string` | About the user | +| `metadata?` | `any` | Optional metadata | +| `name` | `string` | Name of the user | + +#### Defined in + +[src/api/models/UpdateUserRequest.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/UpdateUserRequest.ts#L8) diff --git a/docs/js-sdk-docs/modules/api_models_User.md b/docs/js-sdk-docs/modules/api_models_User.md new file mode 100644 index 000000000..d4a0ca055 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_User.md @@ -0,0 +1,30 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/User + +# Module: api/models/User + +## Table of contents + +### Type Aliases + +- [User](api_models_User.md#user) + +## Type Aliases + +### User + +Ƭ **User**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `about?` | `string` | About the user | +| `created_at?` | `string` | User created at (RFC-3339 format) | +| `id` | `string` | User id (UUID) | +| `metadata?` | `any` | (Optional) metadata | +| `name?` | `string` | Name of the user | +| `updated_at?` | `string` | User updated at (RFC-3339 format) | + +#### Defined in + +[src/api/models/User.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/User.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_agent_id.md b/docs/js-sdk-docs/modules/api_models_agent_id.md new file mode 100644 index 000000000..ddcf9f564 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_agent_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/agent\_id + +# Module: api/models/agent\_id + +## Table of contents + +### Type Aliases + +- [agent\_id](api_models_agent_id.md#agent_id) + +## Type Aliases + +### agent\_id + +Ƭ **agent\_id**: `string` + +#### Defined in + +[src/api/models/agent_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/agent_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_doc_id.md b/docs/js-sdk-docs/modules/api_models_doc_id.md new file mode 100644 index 000000000..5dd47229d --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_doc_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/doc\_id + +# Module: api/models/doc\_id + +## Table of contents + +### Type Aliases + +- [doc\_id](api_models_doc_id.md#doc_id) + +## Type Aliases + +### doc\_id + +Ƭ **doc\_id**: `string` + +#### Defined in + +[src/api/models/doc_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/doc_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_job_id.md b/docs/js-sdk-docs/modules/api_models_job_id.md new file mode 100644 index 000000000..088a64ad2 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_job_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/job\_id + +# Module: api/models/job\_id + +## Table of contents + +### Type Aliases + +- [job\_id](api_models_job_id.md#job_id) + +## Type Aliases + +### job\_id + +Ƭ **job\_id**: `string` + +#### Defined in + +[src/api/models/job_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/job_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_memory_id.md b/docs/js-sdk-docs/modules/api_models_memory_id.md new file mode 100644 index 000000000..c5fbfbd85 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_memory_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/memory\_id + +# Module: api/models/memory\_id + +## Table of contents + +### Type Aliases + +- [memory\_id](api_models_memory_id.md#memory_id) + +## Type Aliases + +### memory\_id + +Ƭ **memory\_id**: `string` + +#### Defined in + +[src/api/models/memory_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/memory_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_message_id.md b/docs/js-sdk-docs/modules/api_models_message_id.md new file mode 100644 index 000000000..cd71c4fc0 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_message_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/message\_id + +# Module: api/models/message\_id + +## Table of contents + +### Type Aliases + +- [message\_id](api_models_message_id.md#message_id) + +## Type Aliases + +### message\_id + +Ƭ **message\_id**: `string` + +#### Defined in + +[src/api/models/message_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/message_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_session_id.md b/docs/js-sdk-docs/modules/api_models_session_id.md new file mode 100644 index 000000000..9a8c20956 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_session_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/session\_id + +# Module: api/models/session\_id + +## Table of contents + +### Type Aliases + +- [session\_id](api_models_session_id.md#session_id) + +## Type Aliases + +### session\_id + +Ƭ **session\_id**: `string` + +#### Defined in + +[src/api/models/session_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/session_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_tool_id.md b/docs/js-sdk-docs/modules/api_models_tool_id.md new file mode 100644 index 000000000..def40319e --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_tool_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/tool\_id + +# Module: api/models/tool\_id + +## Table of contents + +### Type Aliases + +- [tool\_id](api_models_tool_id.md#tool_id) + +## Type Aliases + +### tool\_id + +Ƭ **tool\_id**: `string` + +#### Defined in + +[src/api/models/tool_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/tool_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_models_user_id.md b/docs/js-sdk-docs/modules/api_models_user_id.md new file mode 100644 index 000000000..b6ecb3e07 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_models_user_id.md @@ -0,0 +1,19 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/models/user\_id + +# Module: api/models/user\_id + +## Table of contents + +### Type Aliases + +- [user\_id](api_models_user_id.md#user_id) + +## Type Aliases + +### user\_id + +Ƭ **user\_id**: `string` + +#### Defined in + +[src/api/models/user_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/models/user_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Agent.md b/docs/js-sdk-docs/modules/api_schemas__Agent.md new file mode 100644 index 000000000..38d06841d --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Agent.md @@ -0,0 +1,59 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Agent + +# Module: api/schemas/$Agent + +## Table of contents + +### Variables + +- [$Agent](api_schemas__Agent.md#$agent) + +## Variables + +### $Agent + +• `Const` **$Agent**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Agent created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default settings for all sessions created by this agent"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `id`: \{ `description`: ``"Agent id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"The model to use with this agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"Agent updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the agent"`` | +| `properties.about.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"Agent created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Agent created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.default_settings` | \{ `description`: ``"Default settings for all sessions created by this agent"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | +| `properties.default_settings.description` | ``"Default settings for all sessions created by this agent"`` | +| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | +| `properties.id` | \{ `description`: ``"Agent id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Agent id (UUID)"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | +| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | +| `properties.instructions.description` | ``"Instructions for the agent"`` | +| `properties.instructions.type` | ``"one-of"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.model` | \{ `description`: ``"The model to use with this agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.model.description` | ``"The model to use with this agent"`` | +| `properties.model.isRequired` | ``true`` | +| `properties.model.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the agent"`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | +| `properties.updated_at` | \{ `description`: ``"Agent updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.updated_at.description` | ``"Agent updated at (RFC-3339 format)"`` | +| `properties.updated_at.format` | ``"date-time"`` | +| `properties.updated_at.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$Agent.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Agent.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__AgentDefaultSettings.md b/docs/js-sdk-docs/modules/api_schemas__AgentDefaultSettings.md new file mode 100644 index 000000000..4eab4181b --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__AgentDefaultSettings.md @@ -0,0 +1,64 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$AgentDefaultSettings + +# Module: api/schemas/$AgentDefaultSettings + +## Table of contents + +### Variables + +- [$AgentDefaultSettings](api_schemas__AgentDefaultSettings.md#$agentdefaultsettings) + +## Variables + +### $AgentDefaultSettings + +• `Const` **$AgentDefaultSettings**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `frequency_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `minimum`: ``-2`` = -2; `type`: ``"number"`` = "number" } ; `length_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `min_p`: \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `presence_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `preset`: \{ `type`: ``"Enum"`` = "Enum" } ; `repetition_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `temperature`: \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``3`` = 3; `type`: ``"number"`` = "number" } ; `top_p`: \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } } | +| `properties.frequency_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `minimum`: ``-2`` = -2; `type`: ``"number"`` = "number" } | +| `properties.frequency_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.frequency_penalty.isNullable` | ``true`` | +| `properties.frequency_penalty.maximum` | ``2`` | +| `properties.frequency_penalty.minimum` | ``-2`` | +| `properties.frequency_penalty.type` | ``"number"`` | +| `properties.length_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | +| `properties.length_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` | +| `properties.length_penalty.isNullable` | ``true`` | +| `properties.length_penalty.maximum` | ``2`` | +| `properties.length_penalty.type` | ``"number"`` | +| `properties.min_p` | \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | +| `properties.min_p.description` | ``"Minimum probability compared to leading token to be considered"`` | +| `properties.min_p.exclusiveMaximum` | ``true`` | +| `properties.min_p.maximum` | ``1`` | +| `properties.min_p.type` | ``"number"`` | +| `properties.presence_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | +| `properties.presence_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.presence_penalty.isNullable` | ``true`` | +| `properties.presence_penalty.maximum` | ``1`` | +| `properties.presence_penalty.minimum` | ``-1`` | +| `properties.presence_penalty.type` | ``"number"`` | +| `properties.preset` | \{ `type`: ``"Enum"`` = "Enum" } | +| `properties.preset.type` | ``"Enum"`` | +| `properties.repetition_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | +| `properties.repetition_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.repetition_penalty.isNullable` | ``true`` | +| `properties.repetition_penalty.maximum` | ``2`` | +| `properties.repetition_penalty.type` | ``"number"`` | +| `properties.temperature` | \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``3`` = 3; `type`: ``"number"`` = "number" } | +| `properties.temperature.description` | ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` | +| `properties.temperature.isNullable` | ``true`` | +| `properties.temperature.maximum` | ``3`` | +| `properties.temperature.type` | ``"number"`` | +| `properties.top_p` | \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | +| `properties.top_p.description` | ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` | +| `properties.top_p.isNullable` | ``true`` | +| `properties.top_p.maximum` | ``1`` | +| `properties.top_p.type` | ``"number"`` | + +#### Defined in + +[src/api/schemas/$AgentDefaultSettings.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$AgentDefaultSettings.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ChatInput.md b/docs/js-sdk-docs/modules/api_schemas__ChatInput.md new file mode 100644 index 000000000..88414bd96 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ChatInput.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ChatInput + +# Module: api/schemas/$ChatInput + +## Table of contents + +### Variables + +- [$ChatInput](api_schemas__ChatInput.md#$chatinput) + +## Variables + +### $ChatInput + +• `Const` **$ChatInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `contains` | readonly [\{ `type`: ``"ChatInputData"`` = "ChatInputData" }, \{ `type`: ``"ChatSettings"`` = "ChatSettings" }, \{ `type`: ``"MemoryAccessOptions"`` = "MemoryAccessOptions" }] | +| `type` | ``"all-of"`` | + +#### Defined in + +[src/api/schemas/$ChatInput.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ChatInput.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ChatInputData.md b/docs/js-sdk-docs/modules/api_schemas__ChatInputData.md new file mode 100644 index 000000000..dc823515d --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ChatInputData.md @@ -0,0 +1,40 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ChatInputData + +# Module: api/schemas/$ChatInputData + +## Table of contents + +### Variables + +- [$ChatInputData](api_schemas__ChatInputData.md#$chatinputdata) + +## Variables + +### $ChatInputData + +• `Const` **$ChatInputData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `messages`: \{ `contains`: \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `tool_choice`: \{ `contains`: readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] ; `description`: ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` ; `isNullable`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `tools`: \{ `contains`: \{ `type`: ``"Tool"`` = "Tool" } ; `isNullable`: ``true`` = true; `type`: ``"array"`` = "array" } } | +| `properties.messages` | \{ `contains`: \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.messages.contains` | \{ `type`: ``"InputChatMLMessage"`` = "InputChatMLMessage" } | +| `properties.messages.contains.type` | ``"InputChatMLMessage"`` | +| `properties.messages.isRequired` | ``true`` | +| `properties.messages.type` | ``"array"`` | +| `properties.tool_choice` | \{ `contains`: readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] ; `description`: ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` ; `isNullable`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | +| `properties.tool_choice.contains` | readonly [\{ `type`: ``"ToolChoiceOption"`` = "ToolChoiceOption" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] | +| `properties.tool_choice.description` | ``"Can be one of existing tools given to the agent earlier or the ones included in the request"`` | +| `properties.tool_choice.isNullable` | ``true`` | +| `properties.tool_choice.type` | ``"one-of"`` | +| `properties.tools` | \{ `contains`: \{ `type`: ``"Tool"`` = "Tool" } ; `isNullable`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.tools.contains` | \{ `type`: ``"Tool"`` = "Tool" } | +| `properties.tools.contains.type` | ``"Tool"`` | +| `properties.tools.isNullable` | ``true`` | +| `properties.tools.type` | ``"array"`` | + +#### Defined in + +[src/api/schemas/$ChatInputData.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ChatInputData.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ChatMLMessage.md b/docs/js-sdk-docs/modules/api_schemas__ChatMLMessage.md new file mode 100644 index 000000000..2a118c0fe --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ChatMLMessage.md @@ -0,0 +1,45 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ChatMLMessage + +# Module: api/schemas/$ChatMLMessage + +## Table of contents + +### Variables + +- [$ChatMLMessage](api_schemas__ChatMLMessage.md#$chatmlmessage) + +## Variables + +### $ChatMLMessage + +• `Const` **$ChatMLMessage**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `content`: \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Message created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"Message ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } ; `role`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.content` | \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.content.description` | ``"ChatML content"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"Message created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Message created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.isRequired` | ``true`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.id` | \{ `description`: ``"Message ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Message ID"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"ChatML name"`` | +| `properties.name.type` | ``"string"`` | +| `properties.role` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.role.isRequired` | ``true`` | +| `properties.role.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$ChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ChatMLMessage.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ChatResponse.md b/docs/js-sdk-docs/modules/api_schemas__ChatResponse.md new file mode 100644 index 000000000..db694022e --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ChatResponse.md @@ -0,0 +1,52 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ChatResponse + +# Module: api/schemas/$ChatResponse + +## Table of contents + +### Variables + +- [$ChatResponse](api_schemas__ChatResponse.md#$chatresponse) + +## Variables + +### $ChatResponse + +• `Const` **$ChatResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"Represents a chat completion response returned by model, based on the provided input."`` | +| `properties` | \{ `doc_ids`: \{ `isRequired`: ``true`` = true; `type`: ``"DocIds"`` = "DocIds" } ; `finish_reason`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } ; `id`: \{ `description`: ``"A unique identifier for the chat completion."`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } ; `response`: \{ `contains`: \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `usage`: \{ `isRequired`: ``true`` = true; `type`: ``"CompletionUsage"`` = "CompletionUsage" } } | +| `properties.doc_ids` | \{ `isRequired`: ``true`` = true; `type`: ``"DocIds"`` = "DocIds" } | +| `properties.doc_ids.isRequired` | ``true`` | +| `properties.doc_ids.type` | ``"DocIds"`` | +| `properties.finish_reason` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.finish_reason.isRequired` | ``true`` | +| `properties.finish_reason.type` | ``"Enum"`` | +| `properties.id` | \{ `description`: ``"A unique identifier for the chat completion."`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"A unique identifier for the chat completion."`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | +| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.jobs.contains.format` | ``"uuid"`` | +| `properties.jobs.contains.type` | ``"string"`` | +| `properties.jobs.type` | ``"array"`` | +| `properties.response` | \{ `contains`: \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.response.contains` | \{ `contains`: \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } ; `type`: ``"array"`` = "array" } | +| `properties.response.contains.contains` | \{ `type`: ``"ChatMLMessage"`` = "ChatMLMessage" } | +| `properties.response.contains.contains.type` | ``"ChatMLMessage"`` | +| `properties.response.contains.type` | ``"array"`` | +| `properties.response.isRequired` | ``true`` | +| `properties.response.type` | ``"array"`` | +| `properties.usage` | \{ `isRequired`: ``true`` = true; `type`: ``"CompletionUsage"`` = "CompletionUsage" } | +| `properties.usage.isRequired` | ``true`` | +| `properties.usage.type` | ``"CompletionUsage"`` | + +#### Defined in + +[src/api/schemas/$ChatResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ChatResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ChatSettings.md b/docs/js-sdk-docs/modules/api_schemas__ChatSettings.md new file mode 100644 index 000000000..2271c5761 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ChatSettings.md @@ -0,0 +1,101 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ChatSettings + +# Module: api/schemas/$ChatSettings + +## Table of contents + +### Variables + +- [$ChatSettings](api_schemas__ChatSettings.md#$chatsettings) + +## Variables + +### $ChatSettings + +• `Const` **$ChatSettings**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `frequency_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `length_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `logit_bias`: \{ `contains`: \{ `type`: ``"number"`` = "number" } ; `isNullable`: ``true`` = true; `type`: ``"dictionary"`` = "dictionary" } ; `max_tokens`: \{ `description`: ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``16384`` = 16384; `minimum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `min_p`: \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } ; `presence_penalty`: \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `preset`: \{ `type`: ``"Enum"`` = "Enum" } ; `repetition_penalty`: \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `response_format`: \{ `description`: ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` ; `properties`: \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } } ; `seed`: \{ `description`: ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``9999`` = 9999; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `stop`: \{ `contains`: readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` ; `type`: ``"one-of"`` = "one-of" } ; `stream`: \{ `description`: ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` ; `isNullable`: ``true`` = true; `type`: ``"boolean"`` = "boolean" } ; `temperature`: \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } ; `top_p`: \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `exclusiveMinimum`: ``true`` = true; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } } | +| `properties.frequency_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | +| `properties.frequency_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.frequency_penalty.isNullable` | ``true`` | +| `properties.frequency_penalty.maximum` | ``1`` | +| `properties.frequency_penalty.minimum` | ``-1`` | +| `properties.frequency_penalty.type` | ``"number"`` | +| `properties.length_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | +| `properties.length_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "`` | +| `properties.length_penalty.isNullable` | ``true`` | +| `properties.length_penalty.maximum` | ``2`` | +| `properties.length_penalty.type` | ``"number"`` | +| `properties.logit_bias` | \{ `contains`: \{ `type`: ``"number"`` = "number" } ; `isNullable`: ``true`` = true; `type`: ``"dictionary"`` = "dictionary" } | +| `properties.logit_bias.contains` | \{ `type`: ``"number"`` = "number" } | +| `properties.logit_bias.contains.type` | ``"number"`` | +| `properties.logit_bias.isNullable` | ``true`` | +| `properties.logit_bias.type` | ``"dictionary"`` | +| `properties.max_tokens` | \{ `description`: ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``16384`` = 16384; `minimum`: ``1`` = 1; `type`: ``"number"`` = "number" } | +| `properties.max_tokens.description` | ``"The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "`` | +| `properties.max_tokens.isNullable` | ``true`` | +| `properties.max_tokens.maximum` | ``16384`` | +| `properties.max_tokens.minimum` | ``1`` | +| `properties.max_tokens.type` | ``"number"`` | +| `properties.min_p` | \{ `description`: ``"Minimum probability compared to leading token to be considered"`` ; `exclusiveMaximum`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | +| `properties.min_p.description` | ``"Minimum probability compared to leading token to be considered"`` | +| `properties.min_p.exclusiveMaximum` | ``true`` | +| `properties.min_p.maximum` | ``1`` | +| `properties.min_p.type` | ``"number"`` | +| `properties.presence_penalty` | \{ `description`: ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | +| `properties.presence_penalty.description` | ``"(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.presence_penalty.isNullable` | ``true`` | +| `properties.presence_penalty.maximum` | ``1`` | +| `properties.presence_penalty.minimum` | ``-1`` | +| `properties.presence_penalty.type` | ``"number"`` | +| `properties.preset` | \{ `type`: ``"Enum"`` = "Enum" } | +| `properties.preset.type` | ``"Enum"`` | +| `properties.repetition_penalty` | \{ `description`: ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | +| `properties.repetition_penalty.description` | ``"(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."`` | +| `properties.repetition_penalty.isNullable` | ``true`` | +| `properties.repetition_penalty.maximum` | ``2`` | +| `properties.repetition_penalty.type` | ``"number"`` | +| `properties.response_format` | \{ `description`: ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` ; `properties`: \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } } | +| `properties.response_format.description` | ``"An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "`` | +| `properties.response_format.properties` | \{ `pattern`: \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } ; `schema`: \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } ; `type`: \{ `type`: ``"Enum"`` = "Enum" } } | +| `properties.response_format.properties.pattern` | \{ `description`: ``"Regular expression pattern to use if `type` is `\"regex\"`"`` ; `type`: ``"string"`` = "string" } | +| `properties.response_format.properties.pattern.description` | ``"Regular expression pattern to use if `type` is `\"regex\"`"`` | +| `properties.response_format.properties.pattern.type` | ``"string"`` | +| `properties.response_format.properties.schema` | \{ `description`: ``"JSON Schema to use if `type` is `\"json_object\"`"`` ; `properties`: {} = \{} } | +| `properties.response_format.properties.schema.description` | ``"JSON Schema to use if `type` is `\"json_object\"`"`` | +| `properties.response_format.properties.schema.properties` | {} | +| `properties.response_format.properties.type` | \{ `type`: ``"Enum"`` = "Enum" } | +| `properties.response_format.properties.type.type` | ``"Enum"`` | +| `properties.seed` | \{ `description`: ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` ; `isNullable`: ``true`` = true; `maximum`: ``9999`` = 9999; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | +| `properties.seed.description` | ``"This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "`` | +| `properties.seed.isNullable` | ``true`` | +| `properties.seed.maximum` | ``9999`` | +| `properties.seed.minimum` | ``-1`` | +| `properties.seed.type` | ``"number"`` | +| `properties.stop` | \{ `contains`: readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` ; `type`: ``"one-of"`` = "one-of" } | +| `properties.stop.contains` | readonly [\{ `isNullable`: ``true`` = true; `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | +| `properties.stop.description` | ``"Up to 4 sequences where the API will stop generating further tokens.\n "`` | +| `properties.stop.type` | ``"one-of"`` | +| `properties.stream` | \{ `description`: ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` ; `isNullable`: ``true`` = true; `type`: ``"boolean"`` = "boolean" } | +| `properties.stream.description` | ``"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "`` | +| `properties.stream.isNullable` | ``true`` | +| `properties.stream.type` | ``"boolean"`` | +| `properties.temperature` | \{ `description`: ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` ; `isNullable`: ``true`` = true; `maximum`: ``2`` = 2; `type`: ``"number"`` = "number" } | +| `properties.temperature.description` | ``"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."`` | +| `properties.temperature.isNullable` | ``true`` | +| `properties.temperature.maximum` | ``2`` | +| `properties.temperature.type` | ``"number"`` | +| `properties.top_p` | \{ `description`: ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` ; `exclusiveMinimum`: ``true`` = true; `isNullable`: ``true`` = true; `maximum`: ``1`` = 1; `type`: ``"number"`` = "number" } | +| `properties.top_p.description` | ``"Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."`` | +| `properties.top_p.exclusiveMinimum` | ``true`` | +| `properties.top_p.isNullable` | ``true`` | +| `properties.top_p.maximum` | ``1`` | +| `properties.top_p.type` | ``"number"`` | + +#### Defined in + +[src/api/schemas/$ChatSettings.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ChatSettings.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CompletionUsage.md b/docs/js-sdk-docs/modules/api_schemas__CompletionUsage.md new file mode 100644 index 000000000..85f9f26e6 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CompletionUsage.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CompletionUsage + +# Module: api/schemas/$CompletionUsage + +## Table of contents + +### Variables + +- [$CompletionUsage](api_schemas__CompletionUsage.md#$completionusage) + +## Variables + +### $CompletionUsage + +• `Const` **$CompletionUsage**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"Usage statistics for the completion request."`` | +| `properties` | \{ `completion_tokens`: \{ `description`: ``"Number of tokens in the generated completion."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } ; `prompt_tokens`: \{ `description`: ``"Number of tokens in the prompt."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } ; `total_tokens`: \{ `description`: ``"Total number of tokens used in the request (prompt + completion)."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } } | +| `properties.completion_tokens` | \{ `description`: ``"Number of tokens in the generated completion."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | +| `properties.completion_tokens.description` | ``"Number of tokens in the generated completion."`` | +| `properties.completion_tokens.isRequired` | ``true`` | +| `properties.completion_tokens.type` | ``"number"`` | +| `properties.prompt_tokens` | \{ `description`: ``"Number of tokens in the prompt."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | +| `properties.prompt_tokens.description` | ``"Number of tokens in the prompt."`` | +| `properties.prompt_tokens.isRequired` | ``true`` | +| `properties.prompt_tokens.type` | ``"number"`` | +| `properties.total_tokens` | \{ `description`: ``"Total number of tokens used in the request (prompt + completion)."`` ; `isRequired`: ``true`` = true; `type`: ``"number"`` = "number" } | +| `properties.total_tokens.description` | ``"Total number of tokens used in the request (prompt + completion)."`` | +| `properties.total_tokens.isRequired` | ``true`` | +| `properties.total_tokens.type` | ``"number"`` | + +#### Defined in + +[src/api/schemas/$CompletionUsage.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CompletionUsage.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CreateAgentRequest.md b/docs/js-sdk-docs/modules/api_schemas__CreateAgentRequest.md new file mode 100644 index 000000000..a400fc828 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CreateAgentRequest.md @@ -0,0 +1,54 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CreateAgentRequest + +# Module: api/schemas/$CreateAgentRequest + +## Table of contents + +### Variables + +- [$CreateAgentRequest](api_schemas__CreateAgentRequest.md#$createagentrequest) + +## Variables + +### $CreateAgentRequest + +• `Const` **$CreateAgentRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for creating an agent"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `docs`: \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `tools`: \{ `contains`: \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } ; `type`: ``"array"`` = "array" } } | +| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the agent"`` | +| `properties.about.type` | ``"string"`` | +| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | +| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | +| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | +| `properties.docs` | \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } | +| `properties.docs.contains` | \{ `type`: ``"CreateDoc"`` = "CreateDoc" } | +| `properties.docs.contains.type` | ``"CreateDoc"`` | +| `properties.docs.type` | ``"array"`` | +| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | +| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | +| `properties.instructions.description` | ``"Instructions for the agent"`` | +| `properties.instructions.type` | ``"one-of"`` | +| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"(Optional) metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | +| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | +| `properties.model.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the agent"`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | +| `properties.tools` | \{ `contains`: \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } ; `type`: ``"array"`` = "array" } | +| `properties.tools.contains` | \{ `type`: ``"CreateToolRequest"`` = "CreateToolRequest" } | +| `properties.tools.contains.type` | ``"CreateToolRequest"`` | +| `properties.tools.type` | ``"array"`` | + +#### Defined in + +[src/api/schemas/$CreateAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CreateAgentRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CreateDoc.md b/docs/js-sdk-docs/modules/api_schemas__CreateDoc.md new file mode 100644 index 000000000..e12180205 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CreateDoc.md @@ -0,0 +1,37 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CreateDoc + +# Module: api/schemas/$CreateDoc + +## Table of contents + +### Variables + +- [$CreateDoc](api_schemas__CreateDoc.md#$createdoc) + +## Variables + +### $CreateDoc + +• `Const` **$CreateDoc**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `content`: \{ `contains`: readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] ; `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `title`: \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.content` | \{ `contains`: readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] ; `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | +| `properties.content.contains` | readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] | +| `properties.content.description` | ``"Information content"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"one-of"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.title` | \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.title.description` | ``"Title describing what this bit of information contains"`` | +| `properties.title.isRequired` | ``true`` | +| `properties.title.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$CreateDoc.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CreateDoc.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CreateSessionRequest.md b/docs/js-sdk-docs/modules/api_schemas__CreateSessionRequest.md new file mode 100644 index 000000000..bf21e2d72 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CreateSessionRequest.md @@ -0,0 +1,44 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CreateSessionRequest + +# Module: api/schemas/$CreateSessionRequest + +## Table of contents + +### Variables + +- [$CreateSessionRequest](api_schemas__CreateSessionRequest.md#$createsessionrequest) + +## Variables + +### $CreateSessionRequest + +• `Const` **$CreateSessionRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for creating a session"`` | +| `properties` | \{ `agent_id`: \{ `description`: ``"Agent ID of agent to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `render_templates`: \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } ; `situation`: \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"(Optional) User ID of user to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } } | +| `properties.agent_id` | \{ `description`: ``"Agent ID of agent to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.agent_id.description` | ``"Agent ID of agent to associate with this session"`` | +| `properties.agent_id.format` | ``"uuid"`` | +| `properties.agent_id.isRequired` | ``true`` | +| `properties.agent_id.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.render_templates` | \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.render_templates.description` | ``"Render system and assistant message content as jinja templates"`` | +| `properties.render_templates.type` | ``"boolean"`` | +| `properties.situation` | \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } | +| `properties.situation.description` | ``"A specific situation that sets the background for this session"`` | +| `properties.situation.type` | ``"string"`` | +| `properties.user_id` | \{ `description`: ``"(Optional) User ID of user to associate with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.user_id.description` | ``"(Optional) User ID of user to associate with this session"`` | +| `properties.user_id.format` | ``"uuid"`` | +| `properties.user_id.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$CreateSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CreateSessionRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CreateToolRequest.md b/docs/js-sdk-docs/modules/api_schemas__CreateToolRequest.md new file mode 100644 index 000000000..e14b90a10 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CreateToolRequest.md @@ -0,0 +1,33 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CreateToolRequest + +# Module: api/schemas/$CreateToolRequest + +## Table of contents + +### Variables + +- [$CreateToolRequest](api_schemas__CreateToolRequest.md#$createtoolrequest) + +## Variables + +### $CreateToolRequest + +• `Const` **$CreateToolRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `function`: \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.function` | \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | +| `properties.function.contains` | readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] | +| `properties.function.description` | ``"Function definition and parameters"`` | +| `properties.function.isRequired` | ``true`` | +| `properties.function.type` | ``"one-of"`` | +| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.type.isRequired` | ``true`` | +| `properties.type.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$CreateToolRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CreateToolRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__CreateUserRequest.md b/docs/js-sdk-docs/modules/api_schemas__CreateUserRequest.md new file mode 100644 index 000000000..0a7268bc1 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__CreateUserRequest.md @@ -0,0 +1,39 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$CreateUserRequest + +# Module: api/schemas/$CreateUserRequest + +## Table of contents + +### Variables + +- [$CreateUserRequest](api_schemas__CreateUserRequest.md#$createuserrequest) + +## Variables + +### $CreateUserRequest + +• `Const` **$CreateUserRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for creating a user"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `docs`: \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the user"`` | +| `properties.about.type` | ``"string"`` | +| `properties.docs` | \{ `contains`: \{ `type`: ``"CreateDoc"`` = "CreateDoc" } ; `type`: ``"array"`` = "array" } | +| `properties.docs.contains` | \{ `type`: ``"CreateDoc"`` = "CreateDoc" } | +| `properties.docs.contains.type` | ``"CreateDoc"`` | +| `properties.docs.type` | ``"array"`` | +| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"(Optional) metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the user"`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$CreateUserRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$CreateUserRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Doc.md b/docs/js-sdk-docs/modules/api_schemas__Doc.md new file mode 100644 index 000000000..c27abc5ca --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Doc.md @@ -0,0 +1,47 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Doc + +# Module: api/schemas/$Doc + +## Table of contents + +### Variables + +- [$Doc](api_schemas__Doc.md#$doc) + +## Variables + +### $Doc + +• `Const` **$Doc**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `content`: \{ `contains`: readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] ; `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `created_at`: \{ `description`: ``"Doc created at"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"ID of doc"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"optional metadata"`` ; `properties`: {} = \{} } ; `title`: \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.content` | \{ `contains`: readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] ; `description`: ``"Information content"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | +| `properties.content.contains` | readonly [\{ `contains`: \{ `minItems`: ``1`` = 1; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }, \{ `description`: ``"A single document chunk"`` ; `type`: ``"string"`` = "string" }] | +| `properties.content.description` | ``"Information content"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"one-of"`` | +| `properties.created_at` | \{ `description`: ``"Doc created at"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Doc created at"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.isRequired` | ``true`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.id` | \{ `description`: ``"ID of doc"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"ID of doc"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.title` | \{ `description`: ``"Title describing what this bit of information contains"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.title.description` | ``"Title describing what this bit of information contains"`` | +| `properties.title.isRequired` | ``true`` | +| `properties.title.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$Doc.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Doc.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__DocIds.md b/docs/js-sdk-docs/modules/api_schemas__DocIds.md new file mode 100644 index 000000000..fb2544485 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__DocIds.md @@ -0,0 +1,35 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$DocIds + +# Module: api/schemas/$DocIds + +## Table of contents + +### Variables + +- [$DocIds](api_schemas__DocIds.md#$docids) + +## Variables + +### $DocIds + +• `Const` **$DocIds**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `agent_doc_ids`: \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `user_doc_ids`: \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } } | +| `properties.agent_doc_ids` | \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.agent_doc_ids.contains` | \{ `type`: ``"string"`` = "string" } | +| `properties.agent_doc_ids.contains.type` | ``"string"`` | +| `properties.agent_doc_ids.isRequired` | ``true`` | +| `properties.agent_doc_ids.type` | ``"array"`` | +| `properties.user_doc_ids` | \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.user_doc_ids.contains` | \{ `type`: ``"string"`` = "string" } | +| `properties.user_doc_ids.contains.type` | ``"string"`` | +| `properties.user_doc_ids.isRequired` | ``true`` | +| `properties.user_doc_ids.type` | ``"array"`` | + +#### Defined in + +[src/api/schemas/$DocIds.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$DocIds.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__FunctionCallOption.md b/docs/js-sdk-docs/modules/api_schemas__FunctionCallOption.md new file mode 100644 index 000000000..1e4c1608a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__FunctionCallOption.md @@ -0,0 +1,30 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$FunctionCallOption + +# Module: api/schemas/$FunctionCallOption + +## Table of contents + +### Variables + +- [$FunctionCallOption](api_schemas__FunctionCallOption.md#$functioncalloption) + +## Variables + +### $FunctionCallOption + +• `Const` **$FunctionCallOption**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n "`` | +| `properties` | \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.name` | \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"The name of the function to call."`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$FunctionCallOption.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$FunctionCallOption.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__FunctionDef.md b/docs/js-sdk-docs/modules/api_schemas__FunctionDef.md new file mode 100644 index 000000000..690cc6bf7 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__FunctionDef.md @@ -0,0 +1,36 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$FunctionDef + +# Module: api/schemas/$FunctionDef + +## Table of contents + +### Variables + +- [$FunctionDef](api_schemas__FunctionDef.md#$functiondef) + +## Variables + +### $FunctionDef + +• `Const` **$FunctionDef**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `description`: \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `parameters`: \{ `description`: ``"Parameters accepeted by this function"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionParameters"`` = "FunctionParameters" } } | +| `properties.description` | \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } | +| `properties.description.description` | ``"A description of what the function does, used by the model to choose when and how to call the function."`` | +| `properties.description.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | +| `properties.parameters` | \{ `description`: ``"Parameters accepeted by this function"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionParameters"`` = "FunctionParameters" } | +| `properties.parameters.description` | ``"Parameters accepeted by this function"`` | +| `properties.parameters.isRequired` | ``true`` | +| `properties.parameters.type` | ``"FunctionParameters"`` | + +#### Defined in + +[src/api/schemas/$FunctionDef.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$FunctionDef.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__FunctionParameters.md b/docs/js-sdk-docs/modules/api_schemas__FunctionParameters.md new file mode 100644 index 000000000..8dc50b139 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__FunctionParameters.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$FunctionParameters + +# Module: api/schemas/$FunctionParameters + +## Table of contents + +### Variables + +- [$FunctionParameters](api_schemas__FunctionParameters.md#$functionparameters) + +## Variables + +### $FunctionParameters + +• `Const` **$FunctionParameters**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `contains` | \{ `properties`: {} = \{} } | +| `contains.properties` | {} | +| `type` | ``"dictionary"`` | + +#### Defined in + +[src/api/schemas/$FunctionParameters.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$FunctionParameters.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__InputChatMLMessage.md b/docs/js-sdk-docs/modules/api_schemas__InputChatMLMessage.md new file mode 100644 index 000000000..66e30644a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__InputChatMLMessage.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$InputChatMLMessage + +# Module: api/schemas/$InputChatMLMessage + +## Table of contents + +### Variables + +- [$InputChatMLMessage](api_schemas__InputChatMLMessage.md#$inputchatmlmessage) + +## Variables + +### $InputChatMLMessage + +• `Const` **$InputChatMLMessage**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `content`: \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `continue`: \{ `description`: ``"Whether to continue this message or return a new one"`` ; `type`: ``"boolean"`` = "boolean" } ; `name`: \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } ; `role`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.content` | \{ `description`: ``"ChatML content"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.content.description` | ``"ChatML content"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"string"`` | +| `properties.continue` | \{ `description`: ``"Whether to continue this message or return a new one"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.continue.description` | ``"Whether to continue this message or return a new one"`` | +| `properties.continue.type` | ``"boolean"`` | +| `properties.name` | \{ `description`: ``"ChatML name"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"ChatML name"`` | +| `properties.name.type` | ``"string"`` | +| `properties.role` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.role.isRequired` | ``true`` | +| `properties.role.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$InputChatMLMessage.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$InputChatMLMessage.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__JobStatus.md b/docs/js-sdk-docs/modules/api_schemas__JobStatus.md new file mode 100644 index 000000000..7cbc51755 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__JobStatus.md @@ -0,0 +1,56 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$JobStatus + +# Module: api/schemas/$JobStatus + +## Table of contents + +### Variables + +- [$JobStatus](api_schemas__JobStatus.md#$jobstatus) + +## Variables + +### $JobStatus + +• `Const` **$JobStatus**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `created_at`: \{ `description`: ``"Job created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `has_progress`: \{ `description`: ``"Whether this Job supports progress updates"`` ; `type`: ``"boolean"`` = "boolean" } ; `id`: \{ `description`: ``"Job id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the job"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `progress`: \{ `description`: ``"Progress percentage"`` ; `maximum`: ``100`` = 100; `type`: ``"number"`` = "number" } ; `reason`: \{ `description`: ``"Reason for current state"`` ; `type`: ``"string"`` = "string" } ; `state`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } ; `updated_at`: \{ `description`: ``"Job updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | +| `properties.created_at` | \{ `description`: ``"Job created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Job created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.isRequired` | ``true`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.has_progress` | \{ `description`: ``"Whether this Job supports progress updates"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.has_progress.description` | ``"Whether this Job supports progress updates"`` | +| `properties.has_progress.type` | ``"boolean"`` | +| `properties.id` | \{ `description`: ``"Job id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Job id (UUID)"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"Name of the job"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the job"`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | +| `properties.progress` | \{ `description`: ``"Progress percentage"`` ; `maximum`: ``100`` = 100; `type`: ``"number"`` = "number" } | +| `properties.progress.description` | ``"Progress percentage"`` | +| `properties.progress.maximum` | ``100`` | +| `properties.progress.type` | ``"number"`` | +| `properties.reason` | \{ `description`: ``"Reason for current state"`` ; `type`: ``"string"`` = "string" } | +| `properties.reason.description` | ``"Reason for current state"`` | +| `properties.reason.type` | ``"string"`` | +| `properties.state` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.state.isRequired` | ``true`` | +| `properties.state.type` | ``"Enum"`` | +| `properties.updated_at` | \{ `description`: ``"Job updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.updated_at.description` | ``"Job updated at (RFC-3339 format)"`` | +| `properties.updated_at.format` | ``"date-time"`` | +| `properties.updated_at.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$JobStatus.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$JobStatus.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Memory.md b/docs/js-sdk-docs/modules/api_schemas__Memory.md new file mode 100644 index 000000000..eff2b983d --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Memory.md @@ -0,0 +1,67 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Memory + +# Module: api/schemas/$Memory + +## Table of contents + +### Variables + +- [$Memory](api_schemas__Memory.md#$memory) + +## Variables + +### $Memory + +• `Const` **$Memory**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `agent_id`: \{ `description`: ``"ID of the agent"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `content`: \{ `description`: ``"Content of the memory"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Memory created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `entities`: \{ `contains`: \{ `properties`: {} = \{} } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } ; `id`: \{ `description`: ``"Memory id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `last_accessed_at`: \{ `description`: ``"Memory last accessed at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `sentiment`: \{ `description`: ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` ; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } ; `timestamp`: \{ `description`: ``"Memory happened at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"ID of the user"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.agent_id` | \{ `description`: ``"ID of the agent"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.agent_id.description` | ``"ID of the agent"`` | +| `properties.agent_id.format` | ``"uuid"`` | +| `properties.agent_id.isRequired` | ``true`` | +| `properties.agent_id.type` | ``"string"`` | +| `properties.content` | \{ `description`: ``"Content of the memory"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.content.description` | ``"Content of the memory"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"Memory created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Memory created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.isRequired` | ``true`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.entities` | \{ `contains`: \{ `properties`: {} = \{} } ; `isRequired`: ``true`` = true; `type`: ``"array"`` = "array" } | +| `properties.entities.contains` | \{ `properties`: {} = \{} } | +| `properties.entities.contains.properties` | {} | +| `properties.entities.isRequired` | ``true`` | +| `properties.entities.type` | ``"array"`` | +| `properties.id` | \{ `description`: ``"Memory id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Memory id (UUID)"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.last_accessed_at` | \{ `description`: ``"Memory last accessed at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.last_accessed_at.description` | ``"Memory last accessed at (RFC-3339 format)"`` | +| `properties.last_accessed_at.format` | ``"date-time"`` | +| `properties.last_accessed_at.type` | ``"string"`` | +| `properties.sentiment` | \{ `description`: ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` ; `maximum`: ``1`` = 1; `minimum`: ``-1`` = -1; `type`: ``"number"`` = "number" } | +| `properties.sentiment.description` | ``"Sentiment (valence) of the memory on a scale of -1 to 1"`` | +| `properties.sentiment.maximum` | ``1`` | +| `properties.sentiment.minimum` | ``-1`` | +| `properties.sentiment.type` | ``"number"`` | +| `properties.timestamp` | \{ `description`: ``"Memory happened at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.timestamp.description` | ``"Memory happened at (RFC-3339 format)"`` | +| `properties.timestamp.format` | ``"date-time"`` | +| `properties.timestamp.type` | ``"string"`` | +| `properties.user_id` | \{ `description`: ``"ID of the user"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.user_id.description` | ``"ID of the user"`` | +| `properties.user_id.format` | ``"uuid"`` | +| `properties.user_id.isRequired` | ``true`` | +| `properties.user_id.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$Memory.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Memory.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__MemoryAccessOptions.md b/docs/js-sdk-docs/modules/api_schemas__MemoryAccessOptions.md new file mode 100644 index 000000000..e134f4b56 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__MemoryAccessOptions.md @@ -0,0 +1,34 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$MemoryAccessOptions + +# Module: api/schemas/$MemoryAccessOptions + +## Table of contents + +### Variables + +- [$MemoryAccessOptions](api_schemas__MemoryAccessOptions.md#$memoryaccessoptions) + +## Variables + +### $MemoryAccessOptions + +• `Const` **$MemoryAccessOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `recall`: \{ `description`: ``"Whether previous memories should be recalled or not"`` ; `type`: ``"boolean"`` = "boolean" } ; `record`: \{ `description`: ``"Whether this interaction should be recorded in history or not"`` ; `type`: ``"boolean"`` = "boolean" } ; `remember`: \{ `description`: ``"Whether this interaction should form memories or not"`` ; `type`: ``"boolean"`` = "boolean" } } | +| `properties.recall` | \{ `description`: ``"Whether previous memories should be recalled or not"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.recall.description` | ``"Whether previous memories should be recalled or not"`` | +| `properties.recall.type` | ``"boolean"`` | +| `properties.record` | \{ `description`: ``"Whether this interaction should be recorded in history or not"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.record.description` | ``"Whether this interaction should be recorded in history or not"`` | +| `properties.record.type` | ``"boolean"`` | +| `properties.remember` | \{ `description`: ``"Whether this interaction should form memories or not"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.remember.description` | ``"Whether this interaction should form memories or not"`` | +| `properties.remember.type` | ``"boolean"`` | + +#### Defined in + +[src/api/schemas/$MemoryAccessOptions.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$MemoryAccessOptions.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__NamedToolChoice.md b/docs/js-sdk-docs/modules/api_schemas__NamedToolChoice.md new file mode 100644 index 000000000..178041658 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__NamedToolChoice.md @@ -0,0 +1,36 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$NamedToolChoice + +# Module: api/schemas/$NamedToolChoice + +## Table of contents + +### Variables + +- [$NamedToolChoice](api_schemas__NamedToolChoice.md#$namedtoolchoice) + +## Variables + +### $NamedToolChoice + +• `Const` **$NamedToolChoice**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"Specifies a tool the model should use. Use to force the model to call a specific function."`` | +| `properties` | \{ `function`: \{ `isRequired`: ``true`` = true; `properties`: \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.function` | \{ `isRequired`: ``true`` = true; `properties`: \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } } | +| `properties.function.isRequired` | ``true`` | +| `properties.function.properties` | \{ `name`: \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.function.properties.name` | \{ `description`: ``"The name of the function to call."`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.function.properties.name.description` | ``"The name of the function to call."`` | +| `properties.function.properties.name.isRequired` | ``true`` | +| `properties.function.properties.name.type` | ``"string"`` | +| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.type.isRequired` | ``true`` | +| `properties.type.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$NamedToolChoice.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$NamedToolChoice.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__PartialFunctionDef.md b/docs/js-sdk-docs/modules/api_schemas__PartialFunctionDef.md new file mode 100644 index 000000000..f87e26402 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__PartialFunctionDef.md @@ -0,0 +1,34 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$PartialFunctionDef + +# Module: api/schemas/$PartialFunctionDef + +## Table of contents + +### Variables + +- [$PartialFunctionDef](api_schemas__PartialFunctionDef.md#$partialfunctiondef) + +## Variables + +### $PartialFunctionDef + +• `Const` **$PartialFunctionDef**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `description`: \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `type`: ``"string"`` = "string" } ; `parameters`: \{ `description`: ``"Parameters accepeted by this function"`` ; `type`: ``"FunctionParameters"`` = "FunctionParameters" } } | +| `properties.description` | \{ `description`: ``"A description of what the function does, used by the model to choose when and how to call the function."`` ; `type`: ``"string"`` = "string" } | +| `properties.description.description` | ``"A description of what the function does, used by the model to choose when and how to call the function."`` | +| `properties.description.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."`` | +| `properties.name.type` | ``"string"`` | +| `properties.parameters` | \{ `description`: ``"Parameters accepeted by this function"`` ; `type`: ``"FunctionParameters"`` = "FunctionParameters" } | +| `properties.parameters.description` | ``"Parameters accepeted by this function"`` | +| `properties.parameters.type` | ``"FunctionParameters"`` | + +#### Defined in + +[src/api/schemas/$PartialFunctionDef.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$PartialFunctionDef.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__PatchAgentRequest.md b/docs/js-sdk-docs/modules/api_schemas__PatchAgentRequest.md new file mode 100644 index 000000000..a755d5d0c --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__PatchAgentRequest.md @@ -0,0 +1,45 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$PatchAgentRequest + +# Module: api/schemas/$PatchAgentRequest + +## Table of contents + +### Variables + +- [$PatchAgentRequest](api_schemas__PatchAgentRequest.md#$patchagentrequest) + +## Variables + +### $PatchAgentRequest + +• `Const` **$PatchAgentRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A request for patching an agent"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the agent"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the agent"`` | +| `properties.about.type` | ``"string"`` | +| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | +| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | +| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | +| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | +| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | +| `properties.instructions.description` | ``"Instructions for the agent"`` | +| `properties.instructions.type` | ``"one-of"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | +| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | +| `properties.model.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the agent"`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$PatchAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$PatchAgentRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__PatchSessionRequest.md b/docs/js-sdk-docs/modules/api_schemas__PatchSessionRequest.md new file mode 100644 index 000000000..20fceabb4 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__PatchSessionRequest.md @@ -0,0 +1,32 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$PatchSessionRequest + +# Module: api/schemas/$PatchSessionRequest + +## Table of contents + +### Variables + +- [$PatchSessionRequest](api_schemas__PatchSessionRequest.md#$patchsessionrequest) + +## Variables + +### $PatchSessionRequest + +• `Const` **$PatchSessionRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A request for patching a session"`` | +| `properties` | \{ `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `situation`: \{ `description`: ``"Updated situation for this session"`` ; `type`: ``"string"`` = "string" } } | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.situation` | \{ `description`: ``"Updated situation for this session"`` ; `type`: ``"string"`` = "string" } | +| `properties.situation.description` | ``"Updated situation for this session"`` | +| `properties.situation.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$PatchSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$PatchSessionRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__PatchToolRequest.md b/docs/js-sdk-docs/modules/api_schemas__PatchToolRequest.md new file mode 100644 index 000000000..731137646 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__PatchToolRequest.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$PatchToolRequest + +# Module: api/schemas/$PatchToolRequest + +## Table of contents + +### Variables + +- [$PatchToolRequest](api_schemas__PatchToolRequest.md#$patchtoolrequest) + +## Variables + +### $PatchToolRequest + +• `Const` **$PatchToolRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `function`: \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"PartialFunctionDef"`` = "PartialFunctionDef" } } | +| `properties.function` | \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"PartialFunctionDef"`` = "PartialFunctionDef" } | +| `properties.function.description` | ``"Function definition and parameters"`` | +| `properties.function.isRequired` | ``true`` | +| `properties.function.type` | ``"PartialFunctionDef"`` | + +#### Defined in + +[src/api/schemas/$PatchToolRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$PatchToolRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__PatchUserRequest.md b/docs/js-sdk-docs/modules/api_schemas__PatchUserRequest.md new file mode 100644 index 000000000..f69f137b6 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__PatchUserRequest.md @@ -0,0 +1,35 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$PatchUserRequest + +# Module: api/schemas/$PatchUserRequest + +## Table of contents + +### Variables + +- [$PatchUserRequest](api_schemas__PatchUserRequest.md#$patchuserrequest) + +## Variables + +### $PatchUserRequest + +• `Const` **$PatchUserRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A request for patching a user"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the user"`` | +| `properties.about.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the user"`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$PatchUserRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$PatchUserRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ResourceCreatedResponse.md b/docs/js-sdk-docs/modules/api_schemas__ResourceCreatedResponse.md new file mode 100644 index 000000000..67701ede6 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ResourceCreatedResponse.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ResourceCreatedResponse + +# Module: api/schemas/$ResourceCreatedResponse + +## Table of contents + +### Variables + +- [$ResourceCreatedResponse](api_schemas__ResourceCreatedResponse.md#$resourcecreatedresponse) + +## Variables + +### $ResourceCreatedResponse + +• `Const` **$ResourceCreatedResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `created_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } } | +| `properties.created_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.isRequired` | ``true`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | +| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.jobs.contains.format` | ``"uuid"`` | +| `properties.jobs.contains.type` | ``"string"`` | +| `properties.jobs.type` | ``"array"`` | + +#### Defined in + +[src/api/schemas/$ResourceCreatedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ResourceCreatedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ResourceDeletedResponse.md b/docs/js-sdk-docs/modules/api_schemas__ResourceDeletedResponse.md new file mode 100644 index 000000000..54fd7d5b3 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ResourceDeletedResponse.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ResourceDeletedResponse + +# Module: api/schemas/$ResourceDeletedResponse + +## Table of contents + +### Variables + +- [$ResourceDeletedResponse](api_schemas__ResourceDeletedResponse.md#$resourcedeletedresponse) + +## Variables + +### $ResourceDeletedResponse + +• `Const` **$ResourceDeletedResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `deleted_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } } | +| `properties.deleted_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.deleted_at.format` | ``"date-time"`` | +| `properties.deleted_at.isRequired` | ``true`` | +| `properties.deleted_at.type` | ``"string"`` | +| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | +| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.jobs.contains.format` | ``"uuid"`` | +| `properties.jobs.contains.type` | ``"string"`` | +| `properties.jobs.type` | ``"array"`` | + +#### Defined in + +[src/api/schemas/$ResourceDeletedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ResourceDeletedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ResourceUpdatedResponse.md b/docs/js-sdk-docs/modules/api_schemas__ResourceUpdatedResponse.md new file mode 100644 index 000000000..dfa860b85 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ResourceUpdatedResponse.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ResourceUpdatedResponse + +# Module: api/schemas/$ResourceUpdatedResponse + +## Table of contents + +### Variables + +- [$ResourceUpdatedResponse](api_schemas__ResourceUpdatedResponse.md#$resourceupdatedresponse) + +## Variables + +### $ResourceUpdatedResponse + +• `Const` **$ResourceUpdatedResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `id`: \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `jobs`: \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } ; `updated_at`: \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.id` | \{ `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.jobs` | \{ `contains`: \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" } | +| `properties.jobs.contains` | \{ `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.jobs.contains.format` | ``"uuid"`` | +| `properties.jobs.contains.type` | ``"string"`` | +| `properties.jobs.type` | ``"array"`` | +| `properties.updated_at` | \{ `format`: ``"date-time"`` = "date-time"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.updated_at.format` | ``"date-time"`` | +| `properties.updated_at.isRequired` | ``true`` | +| `properties.updated_at.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$ResourceUpdatedResponse.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ResourceUpdatedResponse.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Session.md b/docs/js-sdk-docs/modules/api_schemas__Session.md new file mode 100644 index 000000000..f43260a31 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Session.md @@ -0,0 +1,59 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Session + +# Module: api/schemas/$Session + +## Table of contents + +### Variables + +- [$Session](api_schemas__Session.md#$session) + +## Variables + +### $Session + +• `Const` **$Session**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `agent_id`: \{ `description`: ``"Agent ID of agent associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Session created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"Session id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `render_templates`: \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } ; `situation`: \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } ; `summary`: \{ `description`: ``"(null at the beginning) - generated automatically after every interaction"`` ; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"Session updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `user_id`: \{ `description`: ``"User ID of user associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } } | +| `properties.agent_id` | \{ `description`: ``"Agent ID of agent associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.agent_id.description` | ``"Agent ID of agent associated with this session"`` | +| `properties.agent_id.format` | ``"uuid"`` | +| `properties.agent_id.isRequired` | ``true`` | +| `properties.agent_id.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"Session created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Session created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.id` | \{ `description`: ``"Session id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Session id (UUID)"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.render_templates` | \{ `description`: ``"Render system and assistant message content as jinja templates"`` ; `type`: ``"boolean"`` = "boolean" } | +| `properties.render_templates.description` | ``"Render system and assistant message content as jinja templates"`` | +| `properties.render_templates.type` | ``"boolean"`` | +| `properties.situation` | \{ `description`: ``"A specific situation that sets the background for this session"`` ; `type`: ``"string"`` = "string" } | +| `properties.situation.description` | ``"A specific situation that sets the background for this session"`` | +| `properties.situation.type` | ``"string"`` | +| `properties.summary` | \{ `description`: ``"(null at the beginning) - generated automatically after every interaction"`` ; `type`: ``"string"`` = "string" } | +| `properties.summary.description` | ``"(null at the beginning) - generated automatically after every interaction"`` | +| `properties.summary.type` | ``"string"`` | +| `properties.updated_at` | \{ `description`: ``"Session updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.updated_at.description` | ``"Session updated at (RFC-3339 format)"`` | +| `properties.updated_at.format` | ``"date-time"`` | +| `properties.updated_at.type` | ``"string"`` | +| `properties.user_id` | \{ `description`: ``"User ID of user associated with this session"`` ; `format`: ``"uuid"`` = "uuid"; `type`: ``"string"`` = "string" } | +| `properties.user_id.description` | ``"User ID of user associated with this session"`` | +| `properties.user_id.format` | ``"uuid"`` | +| `properties.user_id.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$Session.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Session.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Suggestion.md b/docs/js-sdk-docs/modules/api_schemas__Suggestion.md new file mode 100644 index 000000000..df306f68c --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Suggestion.md @@ -0,0 +1,46 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Suggestion + +# Module: api/schemas/$Suggestion + +## Table of contents + +### Variables + +- [$Suggestion](api_schemas__Suggestion.md#$suggestion) + +## Variables + +### $Suggestion + +• `Const` **$Suggestion**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `content`: \{ `description`: ``"The content of the suggestion"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"Suggestion created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `message_id`: \{ `description`: ``"The message that produced it"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `session_id`: \{ `description`: ``"Session this suggestion belongs to"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `target`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.content` | \{ `description`: ``"The content of the suggestion"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.content.description` | ``"The content of the suggestion"`` | +| `properties.content.isRequired` | ``true`` | +| `properties.content.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"Suggestion created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"Suggestion created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.message_id` | \{ `description`: ``"The message that produced it"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.message_id.description` | ``"The message that produced it"`` | +| `properties.message_id.format` | ``"uuid"`` | +| `properties.message_id.isRequired` | ``true`` | +| `properties.message_id.type` | ``"string"`` | +| `properties.session_id` | \{ `description`: ``"Session this suggestion belongs to"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.session_id.description` | ``"Session this suggestion belongs to"`` | +| `properties.session_id.format` | ``"uuid"`` | +| `properties.session_id.isRequired` | ``true`` | +| `properties.session_id.type` | ``"string"`` | +| `properties.target` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.target.isRequired` | ``true`` | +| `properties.target.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$Suggestion.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Suggestion.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__Tool.md b/docs/js-sdk-docs/modules/api_schemas__Tool.md new file mode 100644 index 000000000..f461676a8 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__Tool.md @@ -0,0 +1,38 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$Tool + +# Module: api/schemas/$Tool + +## Table of contents + +### Variables + +- [$Tool](api_schemas__Tool.md#$tool) + +## Variables + +### $Tool + +• `Const` **$Tool**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `function`: \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } ; `id`: \{ `description`: ``"Tool ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `type`: \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } } | +| `properties.function` | \{ `contains`: readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] ; `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"one-of"`` = "one-of" } | +| `properties.function.contains` | readonly [\{ `type`: ``"FunctionDef"`` = "FunctionDef" }] | +| `properties.function.description` | ``"Function definition and parameters"`` | +| `properties.function.isRequired` | ``true`` | +| `properties.function.type` | ``"one-of"`` | +| `properties.id` | \{ `description`: ``"Tool ID"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"Tool ID"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.type` | \{ `isRequired`: ``true`` = true; `type`: ``"Enum"`` = "Enum" } | +| `properties.type.isRequired` | ``true`` | +| `properties.type.type` | ``"Enum"`` | + +#### Defined in + +[src/api/schemas/$Tool.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$Tool.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__ToolChoiceOption.md b/docs/js-sdk-docs/modules/api_schemas__ToolChoiceOption.md new file mode 100644 index 000000000..004b25aef --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__ToolChoiceOption.md @@ -0,0 +1,27 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$ToolChoiceOption + +# Module: api/schemas/$ToolChoiceOption + +## Table of contents + +### Variables + +- [$ToolChoiceOption](api_schemas__ToolChoiceOption.md#$toolchoiceoption) + +## Variables + +### $ToolChoiceOption + +• `Const` **$ToolChoiceOption**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `contains` | readonly [\{ `type`: ``"Enum"`` = "Enum" }, \{ `type`: ``"NamedToolChoice"`` = "NamedToolChoice" }] | +| `description` | ``"Controls which (if any) function is called by the model.\n `none` means the model will not call a function and instead generates a message.\n `auto` means the model can pick between generating a message or calling a function.\n Specifying a particular function via `{\"type: \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.\n `none` is the default when no functions are present. `auto` is the default if functions are present.\n "`` | +| `type` | ``"one-of"`` | + +#### Defined in + +[src/api/schemas/$ToolChoiceOption.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$ToolChoiceOption.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__UpdateAgentRequest.md b/docs/js-sdk-docs/modules/api_schemas__UpdateAgentRequest.md new file mode 100644 index 000000000..f2136738a --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__UpdateAgentRequest.md @@ -0,0 +1,47 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$UpdateAgentRequest + +# Module: api/schemas/$UpdateAgentRequest + +## Table of contents + +### Variables + +- [$UpdateAgentRequest](api_schemas__UpdateAgentRequest.md#$updateagentrequest) + +## Variables + +### $UpdateAgentRequest + +• `Const` **$UpdateAgentRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for updating an agent"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `default_settings`: \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } ; `instructions`: \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `model`: \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } ; `name`: \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the agent"`` | +| `properties.about.isRequired` | ``true`` | +| `properties.about.type` | ``"string"`` | +| `properties.default_settings` | \{ `description`: ``"Default model settings to start every session with"`` ; `type`: ``"AgentDefaultSettings"`` = "AgentDefaultSettings" } | +| `properties.default_settings.description` | ``"Default model settings to start every session with"`` | +| `properties.default_settings.type` | ``"AgentDefaultSettings"`` | +| `properties.instructions` | \{ `contains`: readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] ; `description`: ``"Instructions for the agent"`` ; `type`: ``"one-of"`` = "one-of" } | +| `properties.instructions.contains` | readonly [\{ `type`: ``"string"`` = "string" }, \{ `contains`: \{ `type`: ``"string"`` = "string" } ; `type`: ``"array"`` = "array" }] | +| `properties.instructions.description` | ``"Instructions for the agent"`` | +| `properties.instructions.type` | ``"one-of"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.model` | \{ `description`: ``"Name of the model that the agent is supposed to use"`` ; `type`: ``"string"`` = "string" } | +| `properties.model.description` | ``"Name of the model that the agent is supposed to use"`` | +| `properties.model.type` | ``"string"`` | +| `properties.name` | \{ `description`: ``"Name of the agent"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the agent"`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$UpdateAgentRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$UpdateAgentRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__UpdateSessionRequest.md b/docs/js-sdk-docs/modules/api_schemas__UpdateSessionRequest.md new file mode 100644 index 000000000..e7372bcf2 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__UpdateSessionRequest.md @@ -0,0 +1,33 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$UpdateSessionRequest + +# Module: api/schemas/$UpdateSessionRequest + +## Table of contents + +### Variables + +- [$UpdateSessionRequest](api_schemas__UpdateSessionRequest.md#$updatesessionrequest) + +## Variables + +### $UpdateSessionRequest + +• `Const` **$UpdateSessionRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for updating a session"`` | +| `properties` | \{ `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `situation`: \{ `description`: ``"Updated situation for this session"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.situation` | \{ `description`: ``"Updated situation for this session"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.situation.description` | ``"Updated situation for this session"`` | +| `properties.situation.isRequired` | ``true`` | +| `properties.situation.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$UpdateSessionRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$UpdateSessionRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__UpdateToolRequest.md b/docs/js-sdk-docs/modules/api_schemas__UpdateToolRequest.md new file mode 100644 index 000000000..7ae682328 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__UpdateToolRequest.md @@ -0,0 +1,29 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$UpdateToolRequest + +# Module: api/schemas/$UpdateToolRequest + +## Table of contents + +### Variables + +- [$UpdateToolRequest](api_schemas__UpdateToolRequest.md#$updatetoolrequest) + +## Variables + +### $UpdateToolRequest + +• `Const` **$UpdateToolRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `function`: \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionDef"`` = "FunctionDef" } } | +| `properties.function` | \{ `description`: ``"Function definition and parameters"`` ; `isRequired`: ``true`` = true; `type`: ``"FunctionDef"`` = "FunctionDef" } | +| `properties.function.description` | ``"Function definition and parameters"`` | +| `properties.function.isRequired` | ``true`` | +| `properties.function.type` | ``"FunctionDef"`` | + +#### Defined in + +[src/api/schemas/$UpdateToolRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$UpdateToolRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__UpdateUserRequest.md b/docs/js-sdk-docs/modules/api_schemas__UpdateUserRequest.md new file mode 100644 index 000000000..556f6c80b --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__UpdateUserRequest.md @@ -0,0 +1,37 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$UpdateUserRequest + +# Module: api/schemas/$UpdateUserRequest + +## Table of contents + +### Variables + +- [$UpdateUserRequest](api_schemas__UpdateUserRequest.md#$updateuserrequest) + +## Variables + +### $UpdateUserRequest + +• `Const` **$UpdateUserRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description` | ``"A valid request payload for updating a user"`` | +| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the user"`` | +| `properties.about.isRequired` | ``true`` | +| `properties.about.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"Optional metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"Optional metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.name` | \{ `description`: ``"Name of the user"`` ; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the user"`` | +| `properties.name.isRequired` | ``true`` | +| `properties.name.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$UpdateUserRequest.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$UpdateUserRequest.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__User.md b/docs/js-sdk-docs/modules/api_schemas__User.md new file mode 100644 index 000000000..d13c768a7 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__User.md @@ -0,0 +1,47 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$User + +# Module: api/schemas/$User + +## Table of contents + +### Variables + +- [$User](api_schemas__User.md#$user) + +## Variables + +### $User + +• `Const` **$User**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | \{ `about`: \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } ; `created_at`: \{ `description`: ``"User created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } ; `id`: \{ `description`: ``"User id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } ; `metadata`: \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } ; `name`: \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } ; `updated_at`: \{ `description`: ``"User updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } } | +| `properties.about` | \{ `description`: ``"About the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.about.description` | ``"About the user"`` | +| `properties.about.type` | ``"string"`` | +| `properties.created_at` | \{ `description`: ``"User created at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.created_at.description` | ``"User created at (RFC-3339 format)"`` | +| `properties.created_at.format` | ``"date-time"`` | +| `properties.created_at.type` | ``"string"`` | +| `properties.id` | \{ `description`: ``"User id (UUID)"`` ; `format`: ``"uuid"`` = "uuid"; `isRequired`: ``true`` = true; `type`: ``"string"`` = "string" } | +| `properties.id.description` | ``"User id (UUID)"`` | +| `properties.id.format` | ``"uuid"`` | +| `properties.id.isRequired` | ``true`` | +| `properties.id.type` | ``"string"`` | +| `properties.metadata` | \{ `description`: ``"(Optional) metadata"`` ; `properties`: {} = \{} } | +| `properties.metadata.description` | ``"(Optional) metadata"`` | +| `properties.metadata.properties` | {} | +| `properties.name` | \{ `description`: ``"Name of the user"`` ; `type`: ``"string"`` = "string" } | +| `properties.name.description` | ``"Name of the user"`` | +| `properties.name.type` | ``"string"`` | +| `properties.updated_at` | \{ `description`: ``"User updated at (RFC-3339 format)"`` ; `format`: ``"date-time"`` = "date-time"; `type`: ``"string"`` = "string" } | +| `properties.updated_at.description` | ``"User updated at (RFC-3339 format)"`` | +| `properties.updated_at.format` | ``"date-time"`` | +| `properties.updated_at.type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$User.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$User.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__agent_id.md b/docs/js-sdk-docs/modules/api_schemas__agent_id.md new file mode 100644 index 000000000..f9862b770 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__agent_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$agent\_id + +# Module: api/schemas/$agent\_id + +## Table of contents + +### Variables + +- [$agent\_id](api_schemas__agent_id.md#$agent_id) + +## Variables + +### $agent\_id + +• `Const` **$agent\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$agent_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$agent_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__doc_id.md b/docs/js-sdk-docs/modules/api_schemas__doc_id.md new file mode 100644 index 000000000..7b409032f --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__doc_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$doc\_id + +# Module: api/schemas/$doc\_id + +## Table of contents + +### Variables + +- [$doc\_id](api_schemas__doc_id.md#$doc_id) + +## Variables + +### $doc\_id + +• `Const` **$doc\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$doc_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$doc_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__job_id.md b/docs/js-sdk-docs/modules/api_schemas__job_id.md new file mode 100644 index 000000000..168e5efea --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__job_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$job\_id + +# Module: api/schemas/$job\_id + +## Table of contents + +### Variables + +- [$job\_id](api_schemas__job_id.md#$job_id) + +## Variables + +### $job\_id + +• `Const` **$job\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$job_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$job_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__memory_id.md b/docs/js-sdk-docs/modules/api_schemas__memory_id.md new file mode 100644 index 000000000..596372423 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__memory_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$memory\_id + +# Module: api/schemas/$memory\_id + +## Table of contents + +### Variables + +- [$memory\_id](api_schemas__memory_id.md#$memory_id) + +## Variables + +### $memory\_id + +• `Const` **$memory\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$memory_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$memory_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__message_id.md b/docs/js-sdk-docs/modules/api_schemas__message_id.md new file mode 100644 index 000000000..63f4b075f --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__message_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$message\_id + +# Module: api/schemas/$message\_id + +## Table of contents + +### Variables + +- [$message\_id](api_schemas__message_id.md#$message_id) + +## Variables + +### $message\_id + +• `Const` **$message\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$message_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$message_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__session_id.md b/docs/js-sdk-docs/modules/api_schemas__session_id.md new file mode 100644 index 000000000..793e48498 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__session_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$session\_id + +# Module: api/schemas/$session\_id + +## Table of contents + +### Variables + +- [$session\_id](api_schemas__session_id.md#$session_id) + +## Variables + +### $session\_id + +• `Const` **$session\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$session_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$session_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__tool_id.md b/docs/js-sdk-docs/modules/api_schemas__tool_id.md new file mode 100644 index 000000000..5d92f530f --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__tool_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$tool\_id + +# Module: api/schemas/$tool\_id + +## Table of contents + +### Variables + +- [$tool\_id](api_schemas__tool_id.md#$tool_id) + +## Variables + +### $tool\_id + +• `Const` **$tool\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$tool_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$tool_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_schemas__user_id.md b/docs/js-sdk-docs/modules/api_schemas__user_id.md new file mode 100644 index 000000000..e6c13f934 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_schemas__user_id.md @@ -0,0 +1,26 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/schemas/$user\_id + +# Module: api/schemas/$user\_id + +## Table of contents + +### Variables + +- [$user\_id](api_schemas__user_id.md#$user_id) + +## Variables + +### $user\_id + +• `Const` **$user\_id**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `format` | ``"uuid"`` | +| `type` | ``"string"`` | + +#### Defined in + +[src/api/schemas/$user_id.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/api/schemas/$user_id.ts#L5) diff --git a/docs/js-sdk-docs/modules/api_services_DefaultService.md b/docs/js-sdk-docs/modules/api_services_DefaultService.md new file mode 100644 index 000000000..b3b309632 --- /dev/null +++ b/docs/js-sdk-docs/modules/api_services_DefaultService.md @@ -0,0 +1,9 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / api/services/DefaultService + +# Module: api/services/DefaultService + +## Table of contents + +### Classes + +- [DefaultService](../classes/api_services_DefaultService.DefaultService.md) diff --git a/docs/js-sdk-docs/modules/client.md b/docs/js-sdk-docs/modules/client.md new file mode 100644 index 000000000..7c865f4a6 --- /dev/null +++ b/docs/js-sdk-docs/modules/client.md @@ -0,0 +1,9 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / client + +# Module: client + +## Table of contents + +### Classes + +- [Client](../classes/client.Client.md) diff --git a/docs/js-sdk-docs/modules/env.md b/docs/js-sdk-docs/modules/env.md new file mode 100644 index 000000000..e1d2912ef --- /dev/null +++ b/docs/js-sdk-docs/modules/env.md @@ -0,0 +1,30 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / env + +# Module: env + +## Table of contents + +### Variables + +- [JULEP\_API\_KEY](env.md#julep_api_key) +- [JULEP\_API\_URL](env.md#julep_api_url) + +## Variables + +### JULEP\_API\_KEY + +• **JULEP\_API\_KEY**: `string` = `""` + +#### Defined in + +[src/env.ts:4](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/env.ts#L4) + +___ + +### JULEP\_API\_URL + +• **JULEP\_API\_URL**: `string` = `""` + +#### Defined in + +[src/env.ts:5](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/env.ts#L5) diff --git a/docs/js-sdk-docs/modules/index.md b/docs/js-sdk-docs/modules/index.md new file mode 100644 index 000000000..73e693130 --- /dev/null +++ b/docs/js-sdk-docs/modules/index.md @@ -0,0 +1,15 @@ +[@julep/sdk](../README.md) / [Exports](../modules.md) / index + +# Module: index + +## Table of contents + +### References + +- [Client](index.md#client) + +## References + +### Client + +Re-exports [Client](../classes/client.Client.md) diff --git a/docs/js-sdk-docs/modules/managers_agent.md b/docs/js-sdk-docs/modules/managers_agent.md index 6f5ea9677..2bc665ac6 100644 --- a/docs/js-sdk-docs/modules/managers_agent.md +++ b/docs/js-sdk-docs/modules/managers_agent.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/agent +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/agent # Module: managers/agent diff --git a/docs/js-sdk-docs/modules/managers_base.md b/docs/js-sdk-docs/modules/managers_base.md index fd0e930a7..8e280aa41 100644 --- a/docs/js-sdk-docs/modules/managers_base.md +++ b/docs/js-sdk-docs/modules/managers_base.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/base +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/base # Module: managers/base diff --git a/docs/js-sdk-docs/modules/managers_doc.md b/docs/js-sdk-docs/modules/managers_doc.md index b7a31fa3a..184b8fa90 100644 --- a/docs/js-sdk-docs/modules/managers_doc.md +++ b/docs/js-sdk-docs/modules/managers_doc.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/doc +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/doc # Module: managers/doc diff --git a/docs/js-sdk-docs/modules/managers_memory.md b/docs/js-sdk-docs/modules/managers_memory.md index 720bd4e70..fa57b3f94 100644 --- a/docs/js-sdk-docs/modules/managers_memory.md +++ b/docs/js-sdk-docs/modules/managers_memory.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/memory +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/memory # Module: managers/memory diff --git a/docs/js-sdk-docs/modules/managers_session.md b/docs/js-sdk-docs/modules/managers_session.md index 38c9d75ef..b2b0680a1 100644 --- a/docs/js-sdk-docs/modules/managers_session.md +++ b/docs/js-sdk-docs/modules/managers_session.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/session +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/session # Module: managers/session diff --git a/docs/js-sdk-docs/modules/managers_tool.md b/docs/js-sdk-docs/modules/managers_tool.md index 1c425999c..482af8f0b 100644 --- a/docs/js-sdk-docs/modules/managers_tool.md +++ b/docs/js-sdk-docs/modules/managers_tool.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/tool +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/tool # Module: managers/tool diff --git a/docs/js-sdk-docs/modules/managers_user.md b/docs/js-sdk-docs/modules/managers_user.md index d0d6bffbf..dd7c96c68 100644 --- a/docs/js-sdk-docs/modules/managers_user.md +++ b/docs/js-sdk-docs/modules/managers_user.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / managers/user +[@julep/sdk](../README.md) / [Exports](../modules.md) / managers/user # Module: managers/user diff --git a/docs/js-sdk-docs/modules/utils_invariant.md b/docs/js-sdk-docs/modules/utils_invariant.md index 0d4fa1560..e2e49873f 100644 --- a/docs/js-sdk-docs/modules/utils_invariant.md +++ b/docs/js-sdk-docs/modules/utils_invariant.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / utils/invariant +[@julep/sdk](../README.md) / [Exports](../modules.md) / utils/invariant # Module: utils/invariant @@ -29,4 +29,4 @@ Ensures that a condition is met, throwing a custom error message if not. #### Defined in -[src/utils/invariant.ts:6](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/invariant.ts#L6) +[src/utils/invariant.ts:6](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/invariant.ts#L6) diff --git a/docs/js-sdk-docs/modules/utils_isValidUuid4.md b/docs/js-sdk-docs/modules/utils_isValidUuid4.md index f94dd6dc8..9736306c7 100644 --- a/docs/js-sdk-docs/modules/utils_isValidUuid4.md +++ b/docs/js-sdk-docs/modules/utils_isValidUuid4.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / utils/isValidUuid4 +[@julep/sdk](../README.md) / [Exports](../modules.md) / utils/isValidUuid4 # Module: utils/isValidUuid4 @@ -33,4 +33,4 @@ True if the input is a valid UUID v4, otherwise false. #### Defined in -[src/utils/isValidUuid4.ts:11](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/isValidUuid4.ts#L11) +[src/utils/isValidUuid4.ts:11](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/isValidUuid4.ts#L11) diff --git a/docs/js-sdk-docs/modules/utils_openaiPatch.md b/docs/js-sdk-docs/modules/utils_openaiPatch.md index b5d8e1c5d..316886bac 100644 --- a/docs/js-sdk-docs/modules/utils_openaiPatch.md +++ b/docs/js-sdk-docs/modules/utils_openaiPatch.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / utils/openaiPatch +[@julep/sdk](../README.md) / [Exports](../modules.md) / utils/openaiPatch # Module: utils/openaiPatch @@ -30,4 +30,4 @@ This is useful for enforcing a consistent model usage across different parts of #### Defined in -[src/utils/openaiPatch.ts:8](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/openaiPatch.ts#L8) +[src/utils/openaiPatch.ts:8](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/openaiPatch.ts#L8) diff --git a/docs/js-sdk-docs/modules/utils_requestConstructor.md b/docs/js-sdk-docs/modules/utils_requestConstructor.md index a18bf52fe..d24300b17 100644 --- a/docs/js-sdk-docs/modules/utils_requestConstructor.md +++ b/docs/js-sdk-docs/modules/utils_requestConstructor.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / utils/requestConstructor +[@julep/sdk](../README.md) / [Exports](../modules.md) / utils/requestConstructor # Module: utils/requestConstructor diff --git a/docs/js-sdk-docs/modules/utils_xor.md b/docs/js-sdk-docs/modules/utils_xor.md index 4646ba9f4..c5d7b9cee 100644 --- a/docs/js-sdk-docs/modules/utils_xor.md +++ b/docs/js-sdk-docs/modules/utils_xor.md @@ -1,4 +1,4 @@ -[@julep/sdk](../README.md) / [Modules](../modules.md) / utils/xor +[@julep/sdk](../README.md) / [Exports](../modules.md) / utils/xor # Module: utils/xor @@ -27,4 +27,4 @@ #### Defined in -[src/utils/xor.ts:1](https://github.com/julep-ai/julep/blob/5fd292d2b36b7388e396daec0948fa7ee9ff5bcd/sdks/ts/src/utils/xor.ts#L1) +[src/utils/xor.ts:1](https://github.com/julep-ai/julep/blob/035e7f91b35da5c19151875490e535b6923a07fe/sdks/ts/src/utils/xor.ts#L1) diff --git a/docs/python-sdk-docs/README.md b/docs/python-sdk-docs/README.md index d9a5345a7..1923b2880 100644 --- a/docs/python-sdk-docs/README.md +++ b/docs/python-sdk-docs/README.md @@ -18,6 +18,7 @@ A full list of `Julep Python SDK` project modules. - [Agent](julep/api/types/agent.md#agent) - [AgentDefaultSettings](julep/api/types/agent_default_settings.md#agentdefaultsettings) - [AgentDefaultSettingsPreset](julep/api/types/agent_default_settings_preset.md#agentdefaultsettingspreset) + - [Agent Instructions](julep/api/types/agent_instructions.md#agent-instructions) - [AgentMetadata](julep/api/types/agent_metadata.md#agentmetadata) - [ChatInputData](julep/api/types/chat_input_data.md#chatinputdata) - [Chat Input Data Tool Choice](julep/api/types/chat_input_data_tool_choice.md#chat-input-data-tool-choice) @@ -32,14 +33,18 @@ A full list of `Julep Python SDK` project modules. - [ChatSettingsResponseFormatType](julep/api/types/chat_settings_response_format_type.md#chatsettingsresponseformattype) - [Chat Settings Stop](julep/api/types/chat_settings_stop.md#chat-settings-stop) - [CompletionUsage](julep/api/types/completion_usage.md#completionusage) + - [Create Agent Request Instructions](julep/api/types/create_agent_request_instructions.md#create-agent-request-instructions) - [CreateAgentRequestMetadata](julep/api/types/create_agent_request_metadata.md#createagentrequestmetadata) - [CreateDoc](julep/api/types/create_doc.md#createdoc) + - [Create Doc Content](julep/api/types/create_doc_content.md#create-doc-content) - [CreateDocMetadata](julep/api/types/create_doc_metadata.md#createdocmetadata) - [CreateSessionRequestMetadata](julep/api/types/create_session_request_metadata.md#createsessionrequestmetadata) - [CreateToolRequest](julep/api/types/create_tool_request.md#createtoolrequest) - [CreateToolRequestType](julep/api/types/create_tool_request_type.md#createtoolrequesttype) - [CreateUserRequestMetadata](julep/api/types/create_user_request_metadata.md#createuserrequestmetadata) - [Doc](julep/api/types/doc.md#doc) + - [Doc Content](julep/api/types/doc_content.md#doc-content) + - [DocIds](julep/api/types/doc_ids.md#docids) - [DocMetadata](julep/api/types/doc_metadata.md#docmetadata) - [FunctionCallOption](julep/api/types/function_call_option.md#functioncalloption) - [FunctionDef](julep/api/types/function_def.md#functiondef) @@ -73,6 +78,7 @@ A full list of `Julep Python SDK` project modules. - [NamedToolChoice](julep/api/types/named_tool_choice.md#namedtoolchoice) - [NamedToolChoiceFunction](julep/api/types/named_tool_choice_function.md#namedtoolchoicefunction) - [PartialFunctionDef](julep/api/types/partial_function_def.md#partialfunctiondef) + - [Patch Agent Request Instructions](julep/api/types/patch_agent_request_instructions.md#patch-agent-request-instructions) - [PatchAgentRequestMetadata](julep/api/types/patch_agent_request_metadata.md#patchagentrequestmetadata) - [PatchSessionRequestMetadata](julep/api/types/patch_session_request_metadata.md#patchsessionrequestmetadata) - [PatchUserRequestMetadata](julep/api/types/patch_user_request_metadata.md#patchuserrequestmetadata) @@ -86,6 +92,7 @@ A full list of `Julep Python SDK` project modules. - [Tool](julep/api/types/tool.md#tool) - [Tool Choice Option](julep/api/types/tool_choice_option.md#tool-choice-option) - [ToolType](julep/api/types/tool_type.md#tooltype) + - [Update Agent Request Instructions](julep/api/types/update_agent_request_instructions.md#update-agent-request-instructions) - [UpdateAgentRequestMetadata](julep/api/types/update_agent_request_metadata.md#updateagentrequestmetadata) - [UpdateSessionRequestMetadata](julep/api/types/update_session_request_metadata.md#updatesessionrequestmetadata) - [UpdateUserRequestMetadata](julep/api/types/update_user_request_metadata.md#updateuserrequestmetadata) diff --git a/docs/python-sdk-docs/julep/api/client.md b/docs/python-sdk-docs/julep/api/client.md index bfa9453a4..c1ab52b53 100644 --- a/docs/python-sdk-docs/julep/api/client.md +++ b/docs/python-sdk-docs/julep/api/client.md @@ -15,7 +15,7 @@ ## AsyncJulepApi -[Show source in client.py:1833](../../../../../../julep/api/client.py#L1833) +[Show source in client.py:1834](../../../../../../julep/api/client.py#L1834) #### Signature @@ -33,7 +33,7 @@ class AsyncJulepApi: ### AsyncJulepApi().chat -[Show source in client.py:2470](../../../../../../julep/api/client.py#L2470) +[Show source in client.py:2471](../../../../../../julep/api/client.py#L2471) #### Arguments @@ -137,7 +137,7 @@ async def chat( ### AsyncJulepApi().create_agent -[Show source in client.py:2119](../../../../../../julep/api/client.py#L2119) +[Show source in client.py:2120](../../../../../../julep/api/client.py#L2120) Create a new agent @@ -147,8 +147,6 @@ Create a new agent - `-` *about* - typing.Optional[str]. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *tools* - typing.Optional[typing.List[CreateToolRequest]]. A list of tools the model may call. Currently, only `function`s are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with @@ -157,7 +155,9 @@ Create a new agent - `-` *docs* - typing.Optional[typing.List[CreateDoc]]. List of docs about agent - - `-` *metadata* - typing.Optional[CreateAgentRequestMetadata]. (Optional) metadata +- `-` *metadata* - typing.Optional[CreateAgentRequestMetadata]. (Optional) metadata + + - `-` *instructions* - typing.Optional[CreateAgentRequestInstructions]. Instructions for the agent --- from julep.client import AsyncJulepApi @@ -175,12 +175,12 @@ async def create_agent( self, name: str, about: typing.Optional[str] = OMIT, - instructions: typing.Optional[typing.List[str]] = OMIT, tools: typing.Optional[typing.List[CreateToolRequest]] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, model: typing.Optional[str] = OMIT, docs: typing.Optional[typing.List[CreateDoc]] = OMIT, metadata: typing.Optional[CreateAgentRequestMetadata] = OMIT, + instructions: typing.Optional[CreateAgentRequestInstructions] = OMIT, ) -> ResourceCreatedResponse: ... ``` @@ -190,7 +190,7 @@ async def create_agent( ### AsyncJulepApi().create_agent_doc -[Show source in client.py:3100](../../../../../../julep/api/client.py#L3100) +[Show source in client.py:3101](../../../../../../julep/api/client.py#L3101) #### Arguments @@ -208,7 +208,6 @@ await client.create_agent_doc( agent_id="agent_id", request=CreateDoc( title="title", - content="content", ), ) @@ -222,7 +221,7 @@ async def create_agent_doc( ### AsyncJulepApi().create_agent_tool -[Show source in client.py:3395](../../../../../../julep/api/client.py#L3395) +[Show source in client.py:3394](../../../../../../julep/api/client.py#L3394) #### Arguments @@ -257,7 +256,7 @@ async def create_agent_tool( ### AsyncJulepApi().create_session -[Show source in client.py:1906](../../../../../../julep/api/client.py#L1906) +[Show source in client.py:1907](../../../../../../julep/api/client.py#L1907) Create a session between an agent and a user @@ -301,7 +300,7 @@ async def create_session( ### AsyncJulepApi().create_user -[Show source in client.py:2015](../../../../../../julep/api/client.py#L2015) +[Show source in client.py:2016](../../../../../../julep/api/client.py#L2016) Create a new user @@ -358,7 +357,6 @@ await client.create_user_doc( user_id="user_id", request=CreateDoc( title="title", - content="content", ), ) @@ -372,7 +370,7 @@ async def create_user_doc( ### AsyncJulepApi().delete_agent -[Show source in client.py:2940](../../../../../../julep/api/client.py#L2940) +[Show source in client.py:2941](../../../../../../julep/api/client.py#L2941) #### Arguments @@ -395,7 +393,7 @@ async def delete_agent(self, agent_id: str) -> None: ... ### AsyncJulepApi().delete_agent_doc -[Show source in client.py:3280](../../../../../../julep/api/client.py#L3280) +[Show source in client.py:3279](../../../../../../julep/api/client.py#L3279) #### Arguments @@ -421,7 +419,7 @@ async def delete_agent_doc(self, agent_id: str, doc_id: str) -> None: ... ### AsyncJulepApi().delete_agent_memory -[Show source in client.py:3316](../../../../../../julep/api/client.py#L3316) +[Show source in client.py:3315](../../../../../../julep/api/client.py#L3315) #### Arguments @@ -447,7 +445,7 @@ async def delete_agent_memory(self, agent_id: str, memory_id: str) -> None: ... ### AsyncJulepApi().delete_agent_tool -[Show source in client.py:3486](../../../../../../julep/api/client.py#L3486) +[Show source in client.py:3485](../../../../../../julep/api/client.py#L3485) #### Arguments @@ -473,7 +471,7 @@ async def delete_agent_tool(self, agent_id: str, tool_id: str) -> None: ... ### AsyncJulepApi().delete_session -[Show source in client.py:2269](../../../../../../julep/api/client.py#L2269) +[Show source in client.py:2270](../../../../../../julep/api/client.py#L2270) #### Arguments @@ -496,7 +494,7 @@ async def delete_session(self, session_id: str) -> None: ... ### AsyncJulepApi().delete_session_history -[Show source in client.py:2437](../../../../../../julep/api/client.py#L2437) +[Show source in client.py:2438](../../../../../../julep/api/client.py#L2438) #### Arguments @@ -519,7 +517,7 @@ async def delete_session_history(self, session_id: str) -> None: ... ### AsyncJulepApi().delete_user -[Show source in client.py:2757](../../../../../../julep/api/client.py#L2757) +[Show source in client.py:2758](../../../../../../julep/api/client.py#L2758) #### Arguments @@ -542,7 +540,7 @@ async def delete_user(self, user_id: str) -> None: ... ### AsyncJulepApi().delete_user_doc -[Show source in client.py:3244](../../../../../../julep/api/client.py#L3244) +[Show source in client.py:3243](../../../../../../julep/api/client.py#L3243) #### Arguments @@ -568,7 +566,7 @@ async def delete_user_doc(self, user_id: str, doc_id: str) -> None: ... ### AsyncJulepApi().get_agent -[Show source in client.py:2842](../../../../../../julep/api/client.py#L2842) +[Show source in client.py:2843](../../../../../../julep/api/client.py#L2843) #### Arguments @@ -591,7 +589,7 @@ async def get_agent(self, agent_id: str) -> Agent: ... ### AsyncJulepApi().get_agent_docs -[Show source in client.py:3040](../../../../../../julep/api/client.py#L3040) +[Show source in client.py:3041](../../../../../../julep/api/client.py#L3041) Sorted (created_at descending) @@ -634,7 +632,7 @@ async def get_agent_docs( ### AsyncJulepApi().get_agent_memories -[Show source in client.py:2622](../../../../../../julep/api/client.py#L2622) +[Show source in client.py:2623](../../../../../../julep/api/client.py#L2623) Sorted (created_at descending) @@ -675,7 +673,7 @@ async def get_agent_memories( ### AsyncJulepApi().get_agent_tools -[Show source in client.py:3352](../../../../../../julep/api/client.py#L3352) +[Show source in client.py:3351](../../../../../../julep/api/client.py#L3351) Sorted (created_at descending) @@ -709,7 +707,7 @@ async def get_agent_tools( ### AsyncJulepApi().get_history -[Show source in client.py:2393](../../../../../../julep/api/client.py#L2393) +[Show source in client.py:2394](../../../../../../julep/api/client.py#L2394) Sorted (created_at ascending) @@ -743,7 +741,7 @@ async def get_history( ### AsyncJulepApi().get_job_status -[Show source in client.py:3565](../../../../../../julep/api/client.py#L3565) +[Show source in client.py:3564](../../../../../../julep/api/client.py#L3564) #### Arguments @@ -766,7 +764,7 @@ async def get_job_status(self, job_id: str) -> JobStatus: ... ### AsyncJulepApi().get_session -[Show source in client.py:2190](../../../../../../julep/api/client.py#L2190) +[Show source in client.py:2191](../../../../../../julep/api/client.py#L2191) #### Arguments @@ -789,7 +787,7 @@ async def get_session(self, session_id: str) -> Session: ... ### AsyncJulepApi().get_suggestions -[Show source in client.py:2349](../../../../../../julep/api/client.py#L2349) +[Show source in client.py:2350](../../../../../../julep/api/client.py#L2350) Sorted (created_at descending) @@ -823,7 +821,7 @@ async def get_suggestions( ### AsyncJulepApi().get_user -[Show source in client.py:2674](../../../../../../julep/api/client.py#L2674) +[Show source in client.py:2675](../../../../../../julep/api/client.py#L2675) #### Arguments @@ -889,7 +887,7 @@ async def get_user_docs( ### AsyncJulepApi().list_agents -[Show source in client.py:2066](../../../../../../julep/api/client.py#L2066) +[Show source in client.py:2067](../../../../../../julep/api/client.py#L2067) List agents created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -927,7 +925,7 @@ async def list_agents( ### AsyncJulepApi().list_sessions -[Show source in client.py:1853](../../../../../../julep/api/client.py#L1853) +[Show source in client.py:1854](../../../../../../julep/api/client.py#L1854) List sessions created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -965,7 +963,7 @@ async def list_sessions( ### AsyncJulepApi().list_users -[Show source in client.py:1962](../../../../../../julep/api/client.py#L1962) +[Show source in client.py:1963](../../../../../../julep/api/client.py#L1963) List users created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -1003,7 +1001,7 @@ async def list_users( ### AsyncJulepApi().patch_agent -[Show source in client.py:2972](../../../../../../julep/api/client.py#L2972) +[Show source in client.py:2973](../../../../../../julep/api/client.py#L2973) #### Arguments @@ -1011,15 +1009,15 @@ async def list_users( - `-` *about* - typing.Optional[str]. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *name* - typing.Optional[str]. Name of the agent - `-` *model* - typing.Optional[str]. Name of the model that the agent is supposed to use - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with - - `-` *metadata* - typing.Optional[PatchAgentRequestMetadata]. Optional metadata +- `-` *metadata* - typing.Optional[PatchAgentRequestMetadata]. Optional metadata + + - `-` *instructions* - typing.Optional[PatchAgentRequestInstructions]. Instructions for the agent --- from julep.client import AsyncJulepApi @@ -1037,11 +1035,11 @@ async def patch_agent( self, agent_id: str, about: typing.Optional[str] = OMIT, - instructions: typing.Optional[typing.List[str]] = OMIT, name: typing.Optional[str] = OMIT, model: typing.Optional[str] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, metadata: typing.Optional[PatchAgentRequestMetadata] = OMIT, + instructions: typing.Optional[PatchAgentRequestInstructions] = OMIT, ) -> ResourceUpdatedResponse: ... ``` @@ -1051,7 +1049,7 @@ async def patch_agent( ### AsyncJulepApi().patch_agent_tool -[Show source in client.py:3522](../../../../../../julep/api/client.py#L3522) +[Show source in client.py:3521](../../../../../../julep/api/client.py#L3521) #### Arguments @@ -1083,7 +1081,7 @@ async def patch_agent_tool( ### AsyncJulepApi().patch_session -[Show source in client.py:2301](../../../../../../julep/api/client.py#L2301) +[Show source in client.py:2302](../../../../../../julep/api/client.py#L2302) #### Arguments @@ -1119,7 +1117,7 @@ async def patch_session( ### AsyncJulepApi().patch_user -[Show source in client.py:2789](../../../../../../julep/api/client.py#L2789) +[Show source in client.py:2790](../../../../../../julep/api/client.py#L2790) #### Arguments @@ -1158,7 +1156,7 @@ async def patch_user( ### AsyncJulepApi().update_agent -[Show source in client.py:2874](../../../../../../julep/api/client.py#L2874) +[Show source in client.py:2875](../../../../../../julep/api/client.py#L2875) #### Arguments @@ -1166,15 +1164,15 @@ async def patch_user( - `-` *about* - str. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *name* - str. Name of the agent - `-` *model* - typing.Optional[str]. Name of the model that the agent is supposed to use - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with - - `-` *metadata* - typing.Optional[UpdateAgentRequestMetadata]. Optional metadata +- `-` *metadata* - typing.Optional[UpdateAgentRequestMetadata]. Optional metadata + + - `-` *instructions* - typing.Optional[UpdateAgentRequestInstructions]. Instructions for the agent --- from julep.client import AsyncJulepApi @@ -1194,11 +1192,11 @@ async def update_agent( self, agent_id: str, about: str, - instructions: typing.Optional[typing.List[str]] = OMIT, name: str, model: typing.Optional[str] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, metadata: typing.Optional[UpdateAgentRequestMetadata] = OMIT, + instructions: typing.Optional[UpdateAgentRequestInstructions] = OMIT, ) -> ResourceUpdatedResponse: ... ``` @@ -1208,7 +1206,7 @@ async def update_agent( ### AsyncJulepApi().update_agent_tool -[Show source in client.py:3440](../../../../../../julep/api/client.py#L3440) +[Show source in client.py:3439](../../../../../../julep/api/client.py#L3439) #### Arguments @@ -1243,7 +1241,7 @@ async def update_agent_tool( ### AsyncJulepApi().update_session -[Show source in client.py:2222](../../../../../../julep/api/client.py#L2222) +[Show source in client.py:2223](../../../../../../julep/api/client.py#L2223) #### Arguments @@ -1280,7 +1278,7 @@ async def update_session( ### AsyncJulepApi().update_user -[Show source in client.py:2706](../../../../../../julep/api/client.py#L2706) +[Show source in client.py:2707](../../../../../../julep/api/client.py#L2707) #### Arguments @@ -1323,7 +1321,7 @@ async def update_user( ## JulepApi -[Show source in client.py:70](../../../../../../julep/api/client.py#L70) +[Show source in client.py:73](../../../../../../julep/api/client.py#L73) #### Signature @@ -1341,7 +1339,7 @@ class JulepApi: ### JulepApi().chat -[Show source in client.py:705](../../../../../../julep/api/client.py#L705) +[Show source in client.py:708](../../../../../../julep/api/client.py#L708) #### Arguments @@ -1445,7 +1443,7 @@ def chat( ### JulepApi().create_agent -[Show source in client.py:354](../../../../../../julep/api/client.py#L354) +[Show source in client.py:357](../../../../../../julep/api/client.py#L357) Create a new agent @@ -1455,8 +1453,6 @@ Create a new agent - `-` *about* - typing.Optional[str]. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *tools* - typing.Optional[typing.List[CreateToolRequest]]. A list of tools the model may call. Currently, only `function`s are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with @@ -1465,7 +1461,9 @@ Create a new agent - `-` *docs* - typing.Optional[typing.List[CreateDoc]]. List of docs about agent - - `-` *metadata* - typing.Optional[CreateAgentRequestMetadata]. (Optional) metadata +- `-` *metadata* - typing.Optional[CreateAgentRequestMetadata]. (Optional) metadata + + - `-` *instructions* - typing.Optional[CreateAgentRequestInstructions]. Instructions for the agent --- from julep.client import JulepApi @@ -1483,12 +1481,12 @@ def create_agent( self, name: str, about: typing.Optional[str] = OMIT, - instructions: typing.Optional[typing.List[str]] = OMIT, tools: typing.Optional[typing.List[CreateToolRequest]] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, model: typing.Optional[str] = OMIT, docs: typing.Optional[typing.List[CreateDoc]] = OMIT, metadata: typing.Optional[CreateAgentRequestMetadata] = OMIT, + instructions: typing.Optional[CreateAgentRequestInstructions] = OMIT, ) -> ResourceCreatedResponse: ... ``` @@ -1498,7 +1496,7 @@ def create_agent( ### JulepApi().create_agent_doc -[Show source in client.py:1335](../../../../../../julep/api/client.py#L1335) +[Show source in client.py:1338](../../../../../../julep/api/client.py#L1338) #### Arguments @@ -1516,7 +1514,6 @@ client.create_agent_doc( agent_id="agent_id", request=CreateDoc( title="title", - content="content", ), ) @@ -1530,7 +1527,7 @@ def create_agent_doc( ### JulepApi().create_agent_tool -[Show source in client.py:1630](../../../../../../julep/api/client.py#L1630) +[Show source in client.py:1631](../../../../../../julep/api/client.py#L1631) #### Arguments @@ -1565,7 +1562,7 @@ def create_agent_tool( ### JulepApi().create_session -[Show source in client.py:141](../../../../../../julep/api/client.py#L141) +[Show source in client.py:144](../../../../../../julep/api/client.py#L144) Create a session between an agent and a user @@ -1609,7 +1606,7 @@ def create_session( ### JulepApi().create_user -[Show source in client.py:250](../../../../../../julep/api/client.py#L250) +[Show source in client.py:253](../../../../../../julep/api/client.py#L253) Create a new user @@ -1648,7 +1645,7 @@ def create_user( ### JulepApi().create_user_doc -[Show source in client.py:1437](../../../../../../julep/api/client.py#L1437) +[Show source in client.py:1439](../../../../../../julep/api/client.py#L1439) #### Arguments @@ -1666,7 +1663,6 @@ client.create_user_doc( user_id="user_id", request=CreateDoc( title="title", - content="content", ), ) @@ -1680,7 +1676,7 @@ def create_user_doc( ### JulepApi().delete_agent -[Show source in client.py:1175](../../../../../../julep/api/client.py#L1175) +[Show source in client.py:1178](../../../../../../julep/api/client.py#L1178) #### Arguments @@ -1703,7 +1699,7 @@ def delete_agent(self, agent_id: str) -> None: ... ### JulepApi().delete_agent_doc -[Show source in client.py:1515](../../../../../../julep/api/client.py#L1515) +[Show source in client.py:1516](../../../../../../julep/api/client.py#L1516) #### Arguments @@ -1729,7 +1725,7 @@ def delete_agent_doc(self, agent_id: str, doc_id: str) -> None: ... ### JulepApi().delete_agent_memory -[Show source in client.py:1551](../../../../../../julep/api/client.py#L1551) +[Show source in client.py:1552](../../../../../../julep/api/client.py#L1552) #### Arguments @@ -1755,7 +1751,7 @@ def delete_agent_memory(self, agent_id: str, memory_id: str) -> None: ... ### JulepApi().delete_agent_tool -[Show source in client.py:1721](../../../../../../julep/api/client.py#L1721) +[Show source in client.py:1722](../../../../../../julep/api/client.py#L1722) #### Arguments @@ -1781,7 +1777,7 @@ def delete_agent_tool(self, agent_id: str, tool_id: str) -> None: ... ### JulepApi().delete_session -[Show source in client.py:504](../../../../../../julep/api/client.py#L504) +[Show source in client.py:507](../../../../../../julep/api/client.py#L507) #### Arguments @@ -1804,7 +1800,7 @@ def delete_session(self, session_id: str) -> None: ... ### JulepApi().delete_session_history -[Show source in client.py:672](../../../../../../julep/api/client.py#L672) +[Show source in client.py:675](../../../../../../julep/api/client.py#L675) #### Arguments @@ -1827,7 +1823,7 @@ def delete_session_history(self, session_id: str) -> None: ... ### JulepApi().delete_user -[Show source in client.py:992](../../../../../../julep/api/client.py#L992) +[Show source in client.py:995](../../../../../../julep/api/client.py#L995) #### Arguments @@ -1850,7 +1846,7 @@ def delete_user(self, user_id: str) -> None: ... ### JulepApi().delete_user_doc -[Show source in client.py:1479](../../../../../../julep/api/client.py#L1479) +[Show source in client.py:1480](../../../../../../julep/api/client.py#L1480) #### Arguments @@ -1876,7 +1872,7 @@ def delete_user_doc(self, user_id: str, doc_id: str) -> None: ... ### JulepApi().get_agent -[Show source in client.py:1077](../../../../../../julep/api/client.py#L1077) +[Show source in client.py:1080](../../../../../../julep/api/client.py#L1080) #### Arguments @@ -1899,7 +1895,7 @@ def get_agent(self, agent_id: str) -> Agent: ... ### JulepApi().get_agent_docs -[Show source in client.py:1275](../../../../../../julep/api/client.py#L1275) +[Show source in client.py:1278](../../../../../../julep/api/client.py#L1278) Sorted (created_at descending) @@ -1942,7 +1938,7 @@ def get_agent_docs( ### JulepApi().get_agent_memories -[Show source in client.py:857](../../../../../../julep/api/client.py#L857) +[Show source in client.py:860](../../../../../../julep/api/client.py#L860) Sorted (created_at descending) @@ -1983,7 +1979,7 @@ def get_agent_memories( ### JulepApi().get_agent_tools -[Show source in client.py:1587](../../../../../../julep/api/client.py#L1587) +[Show source in client.py:1588](../../../../../../julep/api/client.py#L1588) Sorted (created_at descending) @@ -2017,7 +2013,7 @@ def get_agent_tools( ### JulepApi().get_history -[Show source in client.py:628](../../../../../../julep/api/client.py#L628) +[Show source in client.py:631](../../../../../../julep/api/client.py#L631) Sorted (created_at ascending) @@ -2051,7 +2047,7 @@ def get_history( ### JulepApi().get_job_status -[Show source in client.py:1800](../../../../../../julep/api/client.py#L1800) +[Show source in client.py:1801](../../../../../../julep/api/client.py#L1801) #### Arguments @@ -2074,7 +2070,7 @@ def get_job_status(self, job_id: str) -> JobStatus: ... ### JulepApi().get_session -[Show source in client.py:425](../../../../../../julep/api/client.py#L425) +[Show source in client.py:428](../../../../../../julep/api/client.py#L428) #### Arguments @@ -2097,7 +2093,7 @@ def get_session(self, session_id: str) -> Session: ... ### JulepApi().get_suggestions -[Show source in client.py:584](../../../../../../julep/api/client.py#L584) +[Show source in client.py:587](../../../../../../julep/api/client.py#L587) Sorted (created_at descending) @@ -2131,7 +2127,7 @@ def get_suggestions( ### JulepApi().get_user -[Show source in client.py:909](../../../../../../julep/api/client.py#L909) +[Show source in client.py:912](../../../../../../julep/api/client.py#L912) #### Arguments @@ -2154,7 +2150,7 @@ def get_user(self, user_id: str) -> User: ... ### JulepApi().get_user_docs -[Show source in client.py:1377](../../../../../../julep/api/client.py#L1377) +[Show source in client.py:1379](../../../../../../julep/api/client.py#L1379) Sorted (created_at descending) @@ -2197,7 +2193,7 @@ def get_user_docs( ### JulepApi().list_agents -[Show source in client.py:301](../../../../../../julep/api/client.py#L301) +[Show source in client.py:304](../../../../../../julep/api/client.py#L304) List agents created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -2235,7 +2231,7 @@ def list_agents( ### JulepApi().list_sessions -[Show source in client.py:88](../../../../../../julep/api/client.py#L88) +[Show source in client.py:91](../../../../../../julep/api/client.py#L91) List sessions created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -2273,7 +2269,7 @@ def list_sessions( ### JulepApi().list_users -[Show source in client.py:197](../../../../../../julep/api/client.py#L197) +[Show source in client.py:200](../../../../../../julep/api/client.py#L200) List users created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) @@ -2311,7 +2307,7 @@ def list_users( ### JulepApi().patch_agent -[Show source in client.py:1207](../../../../../../julep/api/client.py#L1207) +[Show source in client.py:1210](../../../../../../julep/api/client.py#L1210) #### Arguments @@ -2319,15 +2315,15 @@ def list_users( - `-` *about* - typing.Optional[str]. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *name* - typing.Optional[str]. Name of the agent - `-` *model* - typing.Optional[str]. Name of the model that the agent is supposed to use - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with - - `-` *metadata* - typing.Optional[PatchAgentRequestMetadata]. Optional metadata +- `-` *metadata* - typing.Optional[PatchAgentRequestMetadata]. Optional metadata + + - `-` *instructions* - typing.Optional[PatchAgentRequestInstructions]. Instructions for the agent --- from julep.client import JulepApi @@ -2345,11 +2341,11 @@ def patch_agent( self, agent_id: str, about: typing.Optional[str] = OMIT, - instructions: typing.Optional[typing.List[str]] = OMIT, name: typing.Optional[str] = OMIT, model: typing.Optional[str] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, metadata: typing.Optional[PatchAgentRequestMetadata] = OMIT, + instructions: typing.Optional[PatchAgentRequestInstructions] = OMIT, ) -> ResourceUpdatedResponse: ... ``` @@ -2359,7 +2355,7 @@ def patch_agent( ### JulepApi().patch_agent_tool -[Show source in client.py:1757](../../../../../../julep/api/client.py#L1757) +[Show source in client.py:1758](../../../../../../julep/api/client.py#L1758) #### Arguments @@ -2391,7 +2387,7 @@ def patch_agent_tool( ### JulepApi().patch_session -[Show source in client.py:536](../../../../../../julep/api/client.py#L536) +[Show source in client.py:539](../../../../../../julep/api/client.py#L539) #### Arguments @@ -2427,7 +2423,7 @@ def patch_session( ### JulepApi().patch_user -[Show source in client.py:1024](../../../../../../julep/api/client.py#L1024) +[Show source in client.py:1027](../../../../../../julep/api/client.py#L1027) #### Arguments @@ -2466,7 +2462,7 @@ def patch_user( ### JulepApi().update_agent -[Show source in client.py:1109](../../../../../../julep/api/client.py#L1109) +[Show source in client.py:1112](../../../../../../julep/api/client.py#L1112) #### Arguments @@ -2474,15 +2470,15 @@ def patch_user( - `-` *about* - str. About the agent -- `-` *instructions* - typing.Optional[typing.List[str]]. List of instructions for the agent - - `-` *name* - str. Name of the agent - `-` *model* - typing.Optional[str]. Name of the model that the agent is supposed to use - `-` *default_settings* - typing.Optional[AgentDefaultSettings]. Default model settings to start every session with - - `-` *metadata* - typing.Optional[UpdateAgentRequestMetadata]. Optional metadata +- `-` *metadata* - typing.Optional[UpdateAgentRequestMetadata]. Optional metadata + + - `-` *instructions* - typing.Optional[UpdateAgentRequestInstructions]. Instructions for the agent --- from julep.client import JulepApi @@ -2502,11 +2498,11 @@ def update_agent( self, agent_id: str, about: str, - instructions: typing.Optional[typing.List[str]] = OMIT, name: str, model: typing.Optional[str] = OMIT, default_settings: typing.Optional[AgentDefaultSettings] = OMIT, metadata: typing.Optional[UpdateAgentRequestMetadata] = OMIT, + instructions: typing.Optional[UpdateAgentRequestInstructions] = OMIT, ) -> ResourceUpdatedResponse: ... ``` @@ -2516,7 +2512,7 @@ def update_agent( ### JulepApi().update_agent_tool -[Show source in client.py:1675](../../../../../../julep/api/client.py#L1675) +[Show source in client.py:1676](../../../../../../julep/api/client.py#L1676) #### Arguments @@ -2551,7 +2547,7 @@ def update_agent_tool( ### JulepApi().update_session -[Show source in client.py:457](../../../../../../julep/api/client.py#L457) +[Show source in client.py:460](../../../../../../julep/api/client.py#L460) #### Arguments @@ -2588,7 +2584,7 @@ def update_session( ### JulepApi().update_user -[Show source in client.py:941](../../../../../../julep/api/client.py#L941) +[Show source in client.py:944](../../../../../../julep/api/client.py#L944) #### Arguments diff --git a/docs/python-sdk-docs/julep/api/types/agent.md b/docs/python-sdk-docs/julep/api/types/agent.md index 1c27ecb5c..810fb3ccf 100644 --- a/docs/python-sdk-docs/julep/api/types/agent.md +++ b/docs/python-sdk-docs/julep/api/types/agent.md @@ -9,7 +9,7 @@ ## Agent -[Show source in agent.py:16](../../../../../../../julep/api/types/agent.py#L16) +[Show source in agent.py:17](../../../../../../../julep/api/types/agent.py#L17) #### Signature @@ -19,7 +19,7 @@ class Agent(pydantic.BaseModel): ... ### Agent().dict -[Show source in agent.py:45](../../../../../../../julep/api/types/agent.py#L45) +[Show source in agent.py:46](../../../../../../../julep/api/types/agent.py#L46) #### Signature @@ -29,7 +29,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### Agent().json -[Show source in agent.py:37](../../../../../../../julep/api/types/agent.py#L37) +[Show source in agent.py:38](../../../../../../../julep/api/types/agent.py#L38) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/agent_instructions.md b/docs/python-sdk-docs/julep/api/types/agent_instructions.md new file mode 100644 index 000000000..2fcdd8f44 --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/agent_instructions.md @@ -0,0 +1,6 @@ +# Agent Instructions + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Agent Instructions + +> Auto-generated documentation for [julep.api.types.agent_instructions](../../../../../../../julep/api/types/agent_instructions.py) module. +- [Agent Instructions](#agent-instructions) diff --git a/docs/python-sdk-docs/julep/api/types/chat_ml_message.md b/docs/python-sdk-docs/julep/api/types/chat_ml_message.md index 3d65beeca..bb735a4b8 100644 --- a/docs/python-sdk-docs/julep/api/types/chat_ml_message.md +++ b/docs/python-sdk-docs/julep/api/types/chat_ml_message.md @@ -19,7 +19,7 @@ class ChatMlMessage(pydantic.BaseModel): ... ### ChatMlMessage().dict -[Show source in chat_ml_message.py:34](../../../../../../../julep/api/types/chat_ml_message.py#L34) +[Show source in chat_ml_message.py:40](../../../../../../../julep/api/types/chat_ml_message.py#L40) #### Signature @@ -29,7 +29,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### ChatMlMessage().json -[Show source in chat_ml_message.py:26](../../../../../../../julep/api/types/chat_ml_message.py#L26) +[Show source in chat_ml_message.py:32](../../../../../../../julep/api/types/chat_ml_message.py#L32) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/chat_ml_message_role.md b/docs/python-sdk-docs/julep/api/types/chat_ml_message_role.md index 4819b76a1..a86971ccf 100644 --- a/docs/python-sdk-docs/julep/api/types/chat_ml_message_role.md +++ b/docs/python-sdk-docs/julep/api/types/chat_ml_message_role.md @@ -11,7 +11,7 @@ [Show source in chat_ml_message_role.py:9](../../../../../../../julep/api/types/chat_ml_message_role.py#L9) -ChatML role (system|assistant|user|function_call) +ChatML role (system|assistant|user|function_call|function) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/chat_response.md b/docs/python-sdk-docs/julep/api/types/chat_response.md index fa595315a..7b7119ab8 100644 --- a/docs/python-sdk-docs/julep/api/types/chat_response.md +++ b/docs/python-sdk-docs/julep/api/types/chat_response.md @@ -9,7 +9,7 @@ ## ChatResponse -[Show source in chat_response.py:17](../../../../../../../julep/api/types/chat_response.py#L17) +[Show source in chat_response.py:18](../../../../../../../julep/api/types/chat_response.py#L18) Represents a chat completion response returned by model, based on the provided input. @@ -21,7 +21,7 @@ class ChatResponse(pydantic.BaseModel): ... ### ChatResponse().dict -[Show source in chat_response.py:42](../../../../../../../julep/api/types/chat_response.py#L42) +[Show source in chat_response.py:44](../../../../../../../julep/api/types/chat_response.py#L44) #### Signature @@ -31,7 +31,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### ChatResponse().json -[Show source in chat_response.py:34](../../../../../../../julep/api/types/chat_response.py#L34) +[Show source in chat_response.py:36](../../../../../../../julep/api/types/chat_response.py#L36) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/create_agent_request_instructions.md b/docs/python-sdk-docs/julep/api/types/create_agent_request_instructions.md new file mode 100644 index 000000000..a969de1ff --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/create_agent_request_instructions.md @@ -0,0 +1,6 @@ +# Create Agent Request Instructions + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Create Agent Request Instructions + +> Auto-generated documentation for [julep.api.types.create_agent_request_instructions](../../../../../../../julep/api/types/create_agent_request_instructions.py) module. +- [Create Agent Request Instructions](#create-agent-request-instructions) diff --git a/docs/python-sdk-docs/julep/api/types/create_doc.md b/docs/python-sdk-docs/julep/api/types/create_doc.md index 151a6b0bb..85c9d4e52 100644 --- a/docs/python-sdk-docs/julep/api/types/create_doc.md +++ b/docs/python-sdk-docs/julep/api/types/create_doc.md @@ -9,7 +9,7 @@ ## CreateDoc -[Show source in create_doc.py:15](../../../../../../../julep/api/types/create_doc.py#L15) +[Show source in create_doc.py:16](../../../../../../../julep/api/types/create_doc.py#L16) #### Signature @@ -19,7 +19,7 @@ class CreateDoc(pydantic.BaseModel): ... ### CreateDoc().dict -[Show source in create_doc.py:32](../../../../../../../julep/api/types/create_doc.py#L32) +[Show source in create_doc.py:33](../../../../../../../julep/api/types/create_doc.py#L33) #### Signature @@ -29,7 +29,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### CreateDoc().json -[Show source in create_doc.py:24](../../../../../../../julep/api/types/create_doc.py#L24) +[Show source in create_doc.py:25](../../../../../../../julep/api/types/create_doc.py#L25) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/create_doc_content.md b/docs/python-sdk-docs/julep/api/types/create_doc_content.md new file mode 100644 index 000000000..da3594cc7 --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/create_doc_content.md @@ -0,0 +1,6 @@ +# Create Doc Content + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Create Doc Content + +> Auto-generated documentation for [julep.api.types.create_doc_content](../../../../../../../julep/api/types/create_doc_content.py) module. +- [Create Doc Content](#create-doc-content) diff --git a/docs/python-sdk-docs/julep/api/types/doc.md b/docs/python-sdk-docs/julep/api/types/doc.md index e22a672f6..c7217cc81 100644 --- a/docs/python-sdk-docs/julep/api/types/doc.md +++ b/docs/python-sdk-docs/julep/api/types/doc.md @@ -9,7 +9,7 @@ ## Doc -[Show source in doc.py:15](../../../../../../../julep/api/types/doc.py#L15) +[Show source in doc.py:16](../../../../../../../julep/api/types/doc.py#L16) #### Signature @@ -19,7 +19,7 @@ class Doc(pydantic.BaseModel): ... ### Doc().dict -[Show source in doc.py:34](../../../../../../../julep/api/types/doc.py#L34) +[Show source in doc.py:35](../../../../../../../julep/api/types/doc.py#L35) #### Signature @@ -29,7 +29,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### Doc().json -[Show source in doc.py:26](../../../../../../../julep/api/types/doc.py#L26) +[Show source in doc.py:27](../../../../../../../julep/api/types/doc.py#L27) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/doc_content.md b/docs/python-sdk-docs/julep/api/types/doc_content.md new file mode 100644 index 000000000..d94af58c9 --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/doc_content.md @@ -0,0 +1,6 @@ +# Doc Content + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Doc Content + +> Auto-generated documentation for [julep.api.types.doc_content](../../../../../../../julep/api/types/doc_content.py) module. +- [Doc Content](#doc-content) diff --git a/docs/python-sdk-docs/julep/api/types/doc_ids.md b/docs/python-sdk-docs/julep/api/types/doc_ids.md new file mode 100644 index 000000000..87348c73b --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/doc_ids.md @@ -0,0 +1,38 @@ +# DocIds + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / DocIds + +> Auto-generated documentation for [julep.api.types.doc_ids](../../../../../../../julep/api/types/doc_ids.py) module. + +- [DocIds](#docids) + - [DocIds](#docids-1) + +## DocIds + +[Show source in doc_ids.py:14](../../../../../../../julep/api/types/doc_ids.py#L14) + +#### Signature + +```python +class DocIds(pydantic.BaseModel): ... +``` + +### DocIds().dict + +[Show source in doc_ids.py:26](../../../../../../../julep/api/types/doc_ids.py#L26) + +#### Signature + +```python +def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... +``` + +### DocIds().json + +[Show source in doc_ids.py:18](../../../../../../../julep/api/types/doc_ids.py#L18) + +#### Signature + +```python +def json(self, **kwargs: typing.Any) -> str: ... +``` \ No newline at end of file diff --git a/docs/python-sdk-docs/julep/api/types/index.md b/docs/python-sdk-docs/julep/api/types/index.md index ec990539f..c7da97ff4 100644 --- a/docs/python-sdk-docs/julep/api/types/index.md +++ b/docs/python-sdk-docs/julep/api/types/index.md @@ -12,6 +12,7 @@ - [Agent](./agent.md) - [AgentDefaultSettings](./agent_default_settings.md) - [AgentDefaultSettingsPreset](./agent_default_settings_preset.md) +- [Agent Instructions](./agent_instructions.md) - [AgentMetadata](./agent_metadata.md) - [ChatInputData](./chat_input_data.md) - [Chat Input Data Tool Choice](./chat_input_data_tool_choice.md) @@ -26,14 +27,18 @@ - [ChatSettingsResponseFormatType](./chat_settings_response_format_type.md) - [Chat Settings Stop](./chat_settings_stop.md) - [CompletionUsage](./completion_usage.md) +- [Create Agent Request Instructions](./create_agent_request_instructions.md) - [CreateAgentRequestMetadata](./create_agent_request_metadata.md) - [CreateDoc](./create_doc.md) +- [Create Doc Content](./create_doc_content.md) - [CreateDocMetadata](./create_doc_metadata.md) - [CreateSessionRequestMetadata](./create_session_request_metadata.md) - [CreateToolRequest](./create_tool_request.md) - [CreateToolRequestType](./create_tool_request_type.md) - [CreateUserRequestMetadata](./create_user_request_metadata.md) - [Doc](./doc.md) +- [Doc Content](./doc_content.md) +- [DocIds](./doc_ids.md) - [DocMetadata](./doc_metadata.md) - [FunctionCallOption](./function_call_option.md) - [FunctionDef](./function_def.md) @@ -67,6 +72,7 @@ - [NamedToolChoice](./named_tool_choice.md) - [NamedToolChoiceFunction](./named_tool_choice_function.md) - [PartialFunctionDef](./partial_function_def.md) +- [Patch Agent Request Instructions](./patch_agent_request_instructions.md) - [PatchAgentRequestMetadata](./patch_agent_request_metadata.md) - [PatchSessionRequestMetadata](./patch_session_request_metadata.md) - [PatchUserRequestMetadata](./patch_user_request_metadata.md) @@ -80,6 +86,7 @@ - [Tool](./tool.md) - [Tool Choice Option](./tool_choice_option.md) - [ToolType](./tool_type.md) +- [Update Agent Request Instructions](./update_agent_request_instructions.md) - [UpdateAgentRequestMetadata](./update_agent_request_metadata.md) - [UpdateSessionRequestMetadata](./update_session_request_metadata.md) - [UpdateUserRequestMetadata](./update_user_request_metadata.md) diff --git a/docs/python-sdk-docs/julep/api/types/input_chat_ml_message.md b/docs/python-sdk-docs/julep/api/types/input_chat_ml_message.md index b9378ad8d..bbf8fc54d 100644 --- a/docs/python-sdk-docs/julep/api/types/input_chat_ml_message.md +++ b/docs/python-sdk-docs/julep/api/types/input_chat_ml_message.md @@ -19,7 +19,7 @@ class InputChatMlMessage(pydantic.BaseModel): ... ### InputChatMlMessage().dict -[Show source in input_chat_ml_message.py:34](../../../../../../../julep/api/types/input_chat_ml_message.py#L34) +[Show source in input_chat_ml_message.py:41](../../../../../../../julep/api/types/input_chat_ml_message.py#L41) #### Signature @@ -29,7 +29,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: ... ### InputChatMlMessage().json -[Show source in input_chat_ml_message.py:26](../../../../../../../julep/api/types/input_chat_ml_message.py#L26) +[Show source in input_chat_ml_message.py:33](../../../../../../../julep/api/types/input_chat_ml_message.py#L33) #### Signature diff --git a/docs/python-sdk-docs/julep/api/types/input_chat_ml_message_role.md b/docs/python-sdk-docs/julep/api/types/input_chat_ml_message_role.md index 38357c3a8..3a32633ab 100644 --- a/docs/python-sdk-docs/julep/api/types/input_chat_ml_message_role.md +++ b/docs/python-sdk-docs/julep/api/types/input_chat_ml_message_role.md @@ -11,7 +11,7 @@ [Show source in input_chat_ml_message_role.py:9](../../../../../../../julep/api/types/input_chat_ml_message_role.py#L9) -ChatML role (system|assistant|user|function_call) +ChatML role (system|assistant|user|function_call|function|auto) #### Signature @@ -21,7 +21,7 @@ class InputChatMlMessageRole(str, enum.Enum): ... ### InputChatMlMessageRole().visit -[Show source in input_chat_ml_message_role.py:20](../../../../../../../julep/api/types/input_chat_ml_message_role.py#L20) +[Show source in input_chat_ml_message_role.py:21](../../../../../../../julep/api/types/input_chat_ml_message_role.py#L21) #### Signature @@ -32,6 +32,7 @@ def visit( assistant: typing.Callable[[], T_Result], system: typing.Callable[[], T_Result], function_call: typing.Callable[[], T_Result], + function: typing.Callable[[], T_Result], auto: typing.Callable[[], T_Result], ) -> T_Result: ... ``` diff --git a/docs/python-sdk-docs/julep/api/types/patch_agent_request_instructions.md b/docs/python-sdk-docs/julep/api/types/patch_agent_request_instructions.md new file mode 100644 index 000000000..21d3fca36 --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/patch_agent_request_instructions.md @@ -0,0 +1,6 @@ +# Patch Agent Request Instructions + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Patch Agent Request Instructions + +> Auto-generated documentation for [julep.api.types.patch_agent_request_instructions](../../../../../../../julep/api/types/patch_agent_request_instructions.py) module. +- [Patch Agent Request Instructions](#patch-agent-request-instructions) diff --git a/docs/python-sdk-docs/julep/api/types/update_agent_request_instructions.md b/docs/python-sdk-docs/julep/api/types/update_agent_request_instructions.md new file mode 100644 index 000000000..405efe156 --- /dev/null +++ b/docs/python-sdk-docs/julep/api/types/update_agent_request_instructions.md @@ -0,0 +1,6 @@ +# Update Agent Request Instructions + +[Julep Python SDK Index](../../../README.md#julep-python-sdk-index) / [Julep](../../index.md#julep) / [Api](../index.md#api) / [Types](./index.md#types) / Update Agent Request Instructions + +> Auto-generated documentation for [julep.api.types.update_agent_request_instructions](../../../../../../../julep/api/types/update_agent_request_instructions.py) module. +- [Update Agent Request Instructions](#update-agent-request-instructions) diff --git a/docs/python-sdk-docs/julep/managers/doc.md b/docs/python-sdk-docs/julep/managers/doc.md index b18d376bc..d25537089 100644 --- a/docs/python-sdk-docs/julep/managers/doc.md +++ b/docs/python-sdk-docs/julep/managers/doc.md @@ -12,7 +12,7 @@ ## AsyncDocsManager -[Show source in doc.py:339](../../../../../../julep/managers/doc.py#L339) +[Show source in doc.py:342](../../../../../../julep/managers/doc.py#L342) A class for managing asynchronous operations on documents. @@ -67,7 +67,7 @@ class AsyncDocsManager(BaseDocsManager): ... ### AsyncDocsManager().create -[Show source in doc.py:420](../../../../../../julep/managers/doc.py#L420) +[Show source in doc.py:423](../../../../../../julep/managers/doc.py#L423) Create a new resource asynchronously. @@ -99,7 +99,7 @@ async def create(self, **kwargs: DocsCreateArgs) -> Doc: ... ### AsyncDocsManager().delete -[Show source in doc.py:440](../../../../../../julep/managers/doc.py#L440) +[Show source in doc.py:443](../../../../../../julep/managers/doc.py#L443) Asynchronously deletes a document by its ID. @@ -133,7 +133,7 @@ async def delete( ### AsyncDocsManager().list -[Show source in doc.py:379](../../../../../../julep/managers/doc.py#L379) +[Show source in doc.py:382](../../../../../../julep/managers/doc.py#L382) Asynchronously get a list of documents. @@ -177,7 +177,7 @@ async def list( ## BaseDocsManager -[Show source in doc.py:29](../../../../../../julep/managers/doc.py#L29) +[Show source in doc.py:30](../../../../../../julep/managers/doc.py#L30) Manages documents for agents or users by providing internal methods to list, create, and delete documents. @@ -219,7 +219,7 @@ class BaseDocsManager(BaseManager): ... ### BaseDocsManager()._create -[Show source in doc.py:114](../../../../../../julep/managers/doc.py#L114) +[Show source in doc.py:115](../../../../../../julep/managers/doc.py#L115) Create a new resource with docsrmation for either an agent or a user, but not both. @@ -256,7 +256,7 @@ def _create( ### BaseDocsManager()._delete -[Show source in doc.py:163](../../../../../../julep/managers/doc.py#L163) +[Show source in doc.py:164](../../../../../../julep/managers/doc.py#L164) Delete docs based on either an agent_id or a user_id. @@ -282,12 +282,12 @@ def _delete( agent_id: Optional[Union[str, UUID]], user_id: Optional[Union[str, UUID]], doc_id: Union[str, UUID], -): ... +) -> Union[ResourceDeletedResponse, Awaitable[ResourceDeletedResponse]]: ... ``` ### BaseDocsManager()._list -[Show source in doc.py:62](../../../../../../julep/managers/doc.py#L62) +[Show source in doc.py:63](../../../../../../julep/managers/doc.py#L63) Retrieve docsrmation for an agent or user based on their ID. @@ -328,7 +328,7 @@ def _list( ## DocsCreateArgs -[Show source in doc.py:22](../../../../../../julep/managers/doc.py#L22) +[Show source in doc.py:23](../../../../../../julep/managers/doc.py#L23) #### Signature @@ -340,7 +340,7 @@ class DocsCreateArgs(TypedDict): ... ## DocsManager -[Show source in doc.py:205](../../../../../../julep/managers/doc.py#L205) +[Show source in doc.py:208](../../../../../../julep/managers/doc.py#L208) A class responsible for managing documents. @@ -396,7 +396,7 @@ class DocsManager(BaseDocsManager): ... ### DocsManager().create -[Show source in doc.py:285](../../../../../../julep/managers/doc.py#L285) +[Show source in doc.py:288](../../../../../../julep/managers/doc.py#L288) Create a new resource with the specified document. @@ -431,7 +431,7 @@ def create(self, **kwargs: DocsCreateArgs) -> Doc: ... ### DocsManager().delete -[Show source in doc.py:308](../../../../../../julep/managers/doc.py#L308) +[Show source in doc.py:311](../../../../../../julep/managers/doc.py#L311) Deletes a document by its identifier. @@ -465,7 +465,7 @@ def delete( ### DocsManager().list -[Show source in doc.py:250](../../../../../../julep/managers/doc.py#L250) +[Show source in doc.py:253](../../../../../../julep/managers/doc.py#L253) Retrieve a list of documents based on specified criteria. diff --git a/docs/python-sdk-docs/julep/managers/session.md b/docs/python-sdk-docs/julep/managers/session.md index 7e321196a..2ed72dffe 100644 --- a/docs/python-sdk-docs/julep/managers/session.md +++ b/docs/python-sdk-docs/julep/managers/session.md @@ -13,7 +13,7 @@ ## AsyncSessionsManager -[Show source in session.py:777](../../../../../../julep/managers/session.py#L777) +[Show source in session.py:782](../../../../../../julep/managers/session.py#L782) A class for managing asynchronous sessions. @@ -71,7 +71,7 @@ class AsyncSessionsManager(BaseSessionsManager): ... ### AsyncSessionsManager().chat -[Show source in session.py:952](../../../../../../julep/managers/session.py#L952) +[Show source in session.py:957](../../../../../../julep/managers/session.py#L957) Sends a message in an asynchronous chat session and retrieves the response. @@ -144,7 +144,7 @@ async def chat( ### AsyncSessionsManager().create -[Show source in session.py:849](../../../../../../julep/managers/session.py#L849) +[Show source in session.py:854](../../../../../../julep/managers/session.py#L854) Asynchronously create a resource with the specified user and agent identifiers. @@ -179,7 +179,7 @@ async def create(self, **kwargs: SessionCreateArgs) -> Session: ... ### AsyncSessionsManager().delete -[Show source in session.py:902](../../../../../../julep/managers/session.py#L902) +[Show source in session.py:907](../../../../../../julep/managers/session.py#L907) Asynchronously delete a session given its ID. @@ -207,7 +207,7 @@ async def delete(self, session_id: Union[str, UUID]): ... ### AsyncSessionsManager().delete_history -[Show source in session.py:1097](../../../../../../julep/managers/session.py#L1097) +[Show source in session.py:1102](../../../../../../julep/managers/session.py#L1102) Delete the history of a session asynchronously. @@ -232,7 +232,7 @@ async def delete_history(self, session_id: Union[str, UUID]) -> None: ... ### AsyncSessionsManager().get -[Show source in session.py:821](../../../../../../julep/managers/session.py#L821) +[Show source in session.py:826](../../../../../../julep/managers/session.py#L826) Asynchronously get a Session object by its identifier. @@ -270,7 +270,7 @@ async def get(self, id: Union[UUID, str]) -> Session: ... ### AsyncSessionsManager().history -[Show source in session.py:1065](../../../../../../julep/managers/session.py#L1065) +[Show source in session.py:1070](../../../../../../julep/managers/session.py#L1070) Retrieve a history of chat messages based on the session ID, with optional limit and offset. @@ -304,7 +304,7 @@ async def history( ### AsyncSessionsManager().list -[Show source in session.py:872](../../../../../../julep/managers/session.py#L872) +[Show source in session.py:877](../../../../../../julep/managers/session.py#L877) Asynchronously retrieves a list of sessions with optional pagination. @@ -333,7 +333,7 @@ async def list( ### AsyncSessionsManager().suggestions -[Show source in session.py:1033](../../../../../../julep/managers/session.py#L1033) +[Show source in session.py:1038](../../../../../../julep/managers/session.py#L1038) Retrieve a list of suggestions asynchronously. @@ -367,7 +367,7 @@ async def suggestions( ### AsyncSessionsManager().update -[Show source in session.py:921](../../../../../../julep/managers/session.py#L921) +[Show source in session.py:926](../../../../../../julep/managers/session.py#L926) Asynchronously update a resource with the given situation. @@ -410,7 +410,7 @@ async def update(self, **kwargs: SessionUpdateArgs) -> Session: ... ## BaseSessionsManager -[Show source in session.py:51](../../../../../../julep/managers/session.py#L51) +[Show source in session.py:53](../../../../../../julep/managers/session.py#L53) A class to manage sessions using base API client methods. @@ -515,7 +515,7 @@ class BaseSessionsManager(BaseManager): ... ### BaseSessionsManager()._chat -[Show source in session.py:293](../../../../../../julep/managers/session.py#L293) +[Show source in session.py:298](../../../../../../julep/managers/session.py#L298) Conducts a chat conversation with an AI model using specific parameters. @@ -582,7 +582,7 @@ def _chat( ### BaseSessionsManager()._create -[Show source in session.py:176](../../../../../../julep/managers/session.py#L176) +[Show source in session.py:178](../../../../../../julep/managers/session.py#L178) Creates a session for a specified user and agent. @@ -594,6 +594,7 @@ agent_id (Union[str, UUID]): The agent's identifier which could be a string or a user_id (Optional[Union[str, UUID]]): The user's identifier which could be a string or a UUID object. - `situation` *Optional[str], optional* - An optional description of the situation. metadata (Dict[str, Any]) +- `render_templates` *bool, optional* - Whether to render templates in the metadata. Defaults to False. #### Returns @@ -612,12 +613,13 @@ def _create( user_id: Optional[Union[str, UUID]] = None, situation: Optional[str] = None, metadata: Dict[str, Any] = {}, + render_templates: bool = False, ) -> Union[ResourceCreatedResponse, Awaitable[ResourceCreatedResponse]]: ... ``` ### BaseSessionsManager()._delete -[Show source in session.py:238](../../../../../../julep/managers/session.py#L238) +[Show source in session.py:243](../../../../../../julep/managers/session.py#L243) Delete a session given its session ID. @@ -643,7 +645,7 @@ def _delete(self, session_id: Union[str, UUID]) -> Union[None, Awaitable[None]]: ### BaseSessionsManager()._delete_history -[Show source in session.py:421](../../../../../../julep/managers/session.py#L421) +[Show source in session.py:426](../../../../../../julep/managers/session.py#L426) Delete the history of a session. @@ -671,7 +673,7 @@ def _delete_history( ### BaseSessionsManager()._get -[Show source in session.py:160](../../../../../../julep/managers/session.py#L160) +[Show source in session.py:162](../../../../../../julep/managers/session.py#L162) Get a session by its ID. @@ -695,7 +697,7 @@ def _get(self, id: Union[str, UUID]) -> Union[Session, Awaitable[Session]]: ... ### BaseSessionsManager()._history -[Show source in session.py:393](../../../../../../julep/managers/session.py#L393) +[Show source in session.py:398](../../../../../../julep/managers/session.py#L398) Retrieve a session's history with optional pagination controls. @@ -725,7 +727,7 @@ def _history( ### BaseSessionsManager()._list_items -[Show source in session.py:213](../../../../../../julep/managers/session.py#L213) +[Show source in session.py:218](../../../../../../julep/managers/session.py#L218) List items with optional pagination. @@ -755,7 +757,7 @@ def _list_items( ### BaseSessionsManager()._suggestions -[Show source in session.py:370](../../../../../../julep/managers/session.py#L370) +[Show source in session.py:375](../../../../../../julep/managers/session.py#L375) Retrieve a list of suggestions for a given session. @@ -780,7 +782,7 @@ def _suggestions( ### BaseSessionsManager()._update -[Show source in session.py:259](../../../../../../julep/managers/session.py#L259) +[Show source in session.py:264](../../../../../../julep/managers/session.py#L264) Update a session with a given situation. @@ -826,7 +828,7 @@ class SessionCreateArgs(TypedDict): ... ## SessionUpdateArgs -[Show source in session.py:44](../../../../../../julep/managers/session.py#L44) +[Show source in session.py:45](../../../../../../julep/managers/session.py#L45) #### Signature @@ -838,7 +840,7 @@ class SessionUpdateArgs(TypedDict): ... ## SessionsManager -[Show source in session.py:443](../../../../../../julep/managers/session.py#L443) +[Show source in session.py:448](../../../../../../julep/managers/session.py#L448) A class responsible for managing session interactions. @@ -918,7 +920,7 @@ class SessionsManager(BaseSessionsManager): ... ### SessionsManager().chat -[Show source in session.py:624](../../../../../../julep/managers/session.py#L624) +[Show source in session.py:629](../../../../../../julep/managers/session.py#L629) Initiate a chat session with the provided inputs and configurations. @@ -982,7 +984,7 @@ def chat( ### SessionsManager().create -[Show source in session.py:528](../../../../../../julep/managers/session.py#L528) +[Show source in session.py:533](../../../../../../julep/managers/session.py#L533) Create a new resource with a user ID and an agent ID, optionally including a situation description. @@ -1015,7 +1017,7 @@ def create(self, **kwargs: SessionCreateArgs) -> Session: ... ### SessionsManager().delete -[Show source in session.py:580](../../../../../../julep/managers/session.py#L580) +[Show source in session.py:585](../../../../../../julep/managers/session.py#L585) Deletes a session based on its session ID. @@ -1040,7 +1042,7 @@ def delete(self, session_id: Union[str, UUID]): ... ### SessionsManager().delete_history -[Show source in session.py:760](../../../../../../julep/managers/session.py#L760) +[Show source in session.py:765](../../../../../../julep/managers/session.py#L765) Delete the history of a session. @@ -1065,7 +1067,7 @@ def delete_history(self, session_id: Union[str, UUID]) -> None: ... ### SessionsManager().get -[Show source in session.py:511](../../../../../../julep/managers/session.py#L511) +[Show source in session.py:516](../../../../../../julep/managers/session.py#L516) Retrieve a Session object based on a given identifier. @@ -1088,7 +1090,7 @@ def get(self, id: Union[str, UUID]) -> Session: ... ### SessionsManager().history -[Show source in session.py:733](../../../../../../julep/managers/session.py#L733) +[Show source in session.py:738](../../../../../../julep/managers/session.py#L738) Retrieve a history of ChatMl messages for a given session. @@ -1116,7 +1118,7 @@ def history( ### SessionsManager().list -[Show source in session.py:549](../../../../../../julep/managers/session.py#L549) +[Show source in session.py:554](../../../../../../julep/managers/session.py#L554) Retrieve a list of Session objects with optional pagination. @@ -1146,7 +1148,7 @@ def list( ### SessionsManager().suggestions -[Show source in session.py:699](../../../../../../julep/managers/session.py#L699) +[Show source in session.py:704](../../../../../../julep/managers/session.py#L704) Provides a list of suggestion objects based on the given session ID. @@ -1184,7 +1186,7 @@ def suggestions( ### SessionsManager().update -[Show source in session.py:596](../../../../../../julep/managers/session.py#L596) +[Show source in session.py:601](../../../../../../julep/managers/session.py#L601) Updates the state of a resource based on a given situation. diff --git a/docs/python-sdk-docs/julep/managers/tool.md b/docs/python-sdk-docs/julep/managers/tool.md index 97c0d0573..73889b87a 100644 --- a/docs/python-sdk-docs/julep/managers/tool.md +++ b/docs/python-sdk-docs/julep/managers/tool.md @@ -11,7 +11,7 @@ ## AsyncToolsManager -[Show source in tool.py:351](../../../../../../julep/managers/tool.py#L351) +[Show source in tool.py:352](../../../../../../julep/managers/tool.py#L352) A manager for asynchronous tools handling. @@ -38,7 +38,7 @@ class AsyncToolsManager(BaseToolsManager): ... ### AsyncToolsManager().create -[Show source in tool.py:402](../../../../../../julep/managers/tool.py#L402) +[Show source in tool.py:403](../../../../../../julep/managers/tool.py#L403) Create a new resource asynchronously. @@ -68,7 +68,7 @@ async def create( ### AsyncToolsManager().delete -[Show source in tool.py:429](../../../../../../julep/managers/tool.py#L429) +[Show source in tool.py:430](../../../../../../julep/managers/tool.py#L430) Asynchronously delete a specified agent-tool association. @@ -97,12 +97,14 @@ Raises: ```python @beartype -async def delete(self, agent_id: Union[str, UUID], tool_id: Union[str, UUID]): ... +async def delete( + self, agent_id: Union[str, UUID], tool_id: Union[str, UUID] +) -> Awaitable[ResourceDeletedResponse]: ... ``` ### AsyncToolsManager().get -[Show source in tool.py:367](../../../../../../julep/managers/tool.py#L367) +[Show source in tool.py:368](../../../../../../julep/managers/tool.py#L368) Asynchronously get a list of Tool objects based on provided filters. @@ -139,7 +141,7 @@ async def get( ### AsyncToolsManager().update -[Show source in tool.py:465](../../../../../../julep/managers/tool.py#L465) +[Show source in tool.py:466](../../../../../../julep/managers/tool.py#L466) Asynchronously updates a resource identified by the agent_id and tool_id with a new definition. @@ -175,7 +177,7 @@ async def update( ## BaseToolsManager -[Show source in tool.py:21](../../../../../../julep/managers/tool.py#L21) +[Show source in tool.py:22](../../../../../../julep/managers/tool.py#L22) A class to manage tools by interacting with an API client. @@ -207,7 +209,7 @@ class BaseToolsManager(BaseManager): ... ### BaseToolsManager()._create -[Show source in tool.py:76](../../../../../../julep/managers/tool.py#L76) +[Show source in tool.py:77](../../../../../../julep/managers/tool.py#L77) Create a new tool associated with a given agent. @@ -229,7 +231,7 @@ def _create( ### BaseToolsManager()._delete -[Show source in tool.py:141](../../../../../../julep/managers/tool.py#L141) +[Show source in tool.py:142](../../../../../../julep/managers/tool.py#L142) Delete a tool associated with an agent. @@ -246,12 +248,14 @@ Raises: #### Signature ```python -def _delete(self, agent_id: Union[str, UUID], tool_id: Union[str, UUID]): ... +def _delete( + self, agent_id: Union[str, UUID], tool_id: Union[str, UUID] +) -> Union[ResourceDeletedResponse, Awaitable[ResourceDeletedResponse]]: ... ``` ### BaseToolsManager()._get -[Show source in tool.py:44](../../../../../../julep/managers/tool.py#L44) +[Show source in tool.py:45](../../../../../../julep/managers/tool.py#L45) Retrieve tools associated with the given agent. @@ -288,7 +292,7 @@ def _get( ### BaseToolsManager()._update -[Show source in tool.py:101](../../../../../../julep/managers/tool.py#L101) +[Show source in tool.py:102](../../../../../../julep/managers/tool.py#L102) Update the tool definition for a given agent. @@ -320,7 +324,7 @@ def _update( ## ToolsManager -[Show source in tool.py:169](../../../../../../julep/managers/tool.py#L169) +[Show source in tool.py:170](../../../../../../julep/managers/tool.py#L170) A manager class for handling tools related to agents. @@ -380,7 +384,7 @@ class ToolsManager(BaseToolsManager): ... ### ToolsManager().create -[Show source in tool.py:251](../../../../../../julep/managers/tool.py#L251) +[Show source in tool.py:252](../../../../../../julep/managers/tool.py#L252) Create a new resource with the provided agent identifier and tool information. @@ -420,7 +424,7 @@ def create( ### ToolsManager().delete -[Show source in tool.py:289](../../../../../../julep/managers/tool.py#L289) +[Show source in tool.py:290](../../../../../../julep/managers/tool.py#L290) Deletes an agent's access to a specific tool. @@ -446,7 +450,7 @@ def delete(self, agent_id: Union[str, UUID], tool_id: Union[str, UUID]): ... ### ToolsManager().get -[Show source in tool.py:220](../../../../../../julep/managers/tool.py#L220) +[Show source in tool.py:221](../../../../../../julep/managers/tool.py#L221) Retrieve a list of Tool objects for the specified agent. @@ -478,7 +482,7 @@ def get( ### ToolsManager().update -[Show source in tool.py:314](../../../../../../julep/managers/tool.py#L314) +[Show source in tool.py:315](../../../../../../julep/managers/tool.py#L315) Update a specific tool definition for an agent. diff --git a/mock_openapi.yaml b/mock_openapi.yaml index c30365969..008f2b129 100644 --- a/mock_openapi.yaml +++ b/mock_openapi.yaml @@ -51,7 +51,8 @@ paths: get: summary: List sessions description: >- - List sessions created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) + List sessions created (use limit/offset pagination to get large number + of sessions; sorted by descending order of `created_at` by default) operationId: ListSessions tags: [] parameters: @@ -89,7 +90,8 @@ paths: - in: query name: order description: >- - Which order should the sort be: `asc` (ascending) or `desc` (descending) + Which order should the sort be: `asc` (ascending) or `desc` + (descending) schema: type: string enum: @@ -111,7 +113,8 @@ paths: required: - items description: >- - List of sessions (sorted created_at descending order) with limit+offset pagination + List of sessions (sorted created_at descending order) with + limit+offset pagination security: - api-key: [] /api/users: @@ -139,7 +142,8 @@ paths: get: summary: List users description: >- - List users created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) + List users created (use limit/offset pagination to get large number of + sessions; sorted by descending order of `created_at` by default) operationId: ListUsers tags: [] parameters: @@ -175,7 +179,8 @@ paths: - in: query name: order description: >- - Which order should the sort be: `asc` (ascending) or `desc` (descending) + Which order should the sort be: `asc` (ascending) or `desc` + (descending) schema: type: string enum: @@ -197,7 +202,8 @@ paths: required: - items description: >- - List of users (sorted created_at descending order) with limit+offset pagination + List of users (sorted created_at descending order) with limit+offset + pagination security: - api-key: [] /api/agents: @@ -225,7 +231,8 @@ paths: get: summary: List agents description: >- - List agents created (use limit/offset pagination to get large number of sessions; sorted by descending order of `created_at` by default) + List agents created (use limit/offset pagination to get large number of + sessions; sorted by descending order of `created_at` by default) operationId: ListAgents tags: [] parameters: @@ -263,7 +270,8 @@ paths: - in: query name: order description: >- - Which order should the sort be: `asc` (ascending) or `desc` (descending) + Which order should the sort be: `asc` (ascending) or `desc` + (descending) schema: type: string enum: @@ -273,7 +281,8 @@ paths: responses: '200': description: >- - List of agents (sorted created_at descending order) with limit+offset pagination + List of agents (sorted created_at descending order) with + limit+offset pagination content: application/json: schema: @@ -744,7 +753,8 @@ paths: - in: query name: order description: >- - Which order should the sort be: `asc` (ascending) or `desc` (descending) + Which order should the sort be: `asc` (ascending) or `desc` + (descending) schema: type: string enum: @@ -830,7 +840,8 @@ paths: - in: query name: order description: >- - Which order should the sort be: `asc` (ascending) or `desc` (descending) + Which order should the sort be: `asc` (ascending) or `desc` + (descending) schema: type: string enum: @@ -1211,11 +1222,13 @@ components: description: type: string description: >- - A description of what the function does, used by the model to choose when and how to call the function. + A description of what the function does, used by the model to choose + when and how to call the function. name: type: string description: >- - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + The name of the function to be called. Must be a-z, A-Z, 0-9, or + contain underscores and dashes, with a maximum length of 64. parameters: $ref: '#/components/schemas/FunctionParameters' description: Parameters accepeted by this function @@ -1231,7 +1244,8 @@ components: - function - webhook description: >- - Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) + Whether this tool is a `function` or a `webhook` (Only `function` + tool supported right now) function: oneOf: - $ref: '#/components/schemas/FunctionDef' @@ -1266,7 +1280,8 @@ components: summary: type: string description: >- - (null at the beginning) - generated automatically after every interaction + (null at the beginning) - generated automatically after every + interaction created_at: type: string format: date-time @@ -1350,7 +1365,9 @@ components: items: $ref: '#/components/schemas/CreateToolRequest' description: >- - A list of tools the model may call. Currently, only `function`s are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. + A list of tools the model may call. Currently, only `function`s are + supported as a tool. Use this to provide a list of functions the + model may generate JSON inputs for. default_settings: $ref: '#/components/schemas/AgentDefaultSettings' description: Default model settings to start every session with @@ -1546,7 +1563,9 @@ components: type: array nullable: true description: >- - (Advanced) List of tools that are provided in addition to agent's default set of tools. Functions of same name in agent set are overriden + (Advanced) List of tools that are provided in addition to agent's + default set of tools. Functions of same name in agent set are + overriden items: $ref: '#/components/schemas/Tool' tool_choice: @@ -1555,13 +1574,15 @@ components: - $ref: '#/components/schemas/ToolChoiceOption' - $ref: '#/components/schemas/NamedToolChoice' description: >- - Can be one of existing tools given to the agent earlier or the ones included in the request + Can be one of existing tools given to the agent earlier or the ones + included in the request required: - messages NamedToolChoice: type: object description: >- - Specifies a tool the model should use. Use to force the model to call a specific function. + Specifies a tool the model should use. Use to force the model to call a + specific function. properties: type: type: string @@ -1583,20 +1604,24 @@ components: description: > Controls which (if any) function is called by the model. - `none` means the model will not call a function and instead generates a message. + `none` means the model will not call a function and instead generates a + message. - `auto` means the model can pick between generating a message or calling a function. + `auto` means the model can pick between generating a message or calling + a function. - Specifying a particular function via `{"type: "function", "function": {"name": "my_function"}}` forces the model to call that function. + Specifying a particular function via `{"type: "function", "function": + {"name": "my_function"}}` forces the model to call that function. - `none` is the default when no functions are present. `auto` is the default if functions are present. - + `none` is the default when no functions are present. `auto` is the + default if functions are present. oneOf: - type: string description: > - `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. - + `none` means the model will not call a function and instead + generates a message. `auto` means the model can pick between + generating a message or calling a function. enum: - none - auto @@ -1605,8 +1630,8 @@ components: FunctionCallOption: type: object description: > - Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. - + Specifying a particular function via `{"name": "my_function"}` forces + the model to call that function. properties: name: type: string @@ -1633,7 +1658,8 @@ components: ChatResponse: type: object description: >- - Represents a chat completion response returned by model, based on the provided input. + Represents a chat completion response returned by model, based on the + provided input. properties: id: type: string @@ -1642,7 +1668,12 @@ components: finish_reason: type: string description: >- - The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. + The reason the model stopped generating tokens. This will be `stop` + if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request + was reached, `content_filter` if content was omitted due to a flag + from our content filters, `tool_calls` if the model called a tool, + or `function_call` (deprecated) if the model called a function. enum: - stop - length @@ -1668,11 +1699,14 @@ components: format: uuid uniqueItems: true description: IDs (if any) of jobs created as part of this request + doc_ids: + $ref: '#/components/schemas/DocIds' required: - usage - response - finish_reason - id + - doc_ids Memory: $schema: http://json-schema.org/draft-04/schema# type: object @@ -1734,14 +1768,18 @@ components: maximum: 1 nullable: true description: >- - (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize + new tokens based on their existing frequency in the text so far, + decreasing the model's likelihood to repeat the same line verbatim. length_penalty: type: number default: 1 minimum: 0 maximum: 2 nullable: true - description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " + description: >- + (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and + values larger than that penalize number of tokens generated. logit_bias: type: object default: null @@ -1749,19 +1787,25 @@ components: additionalProperties: type: integer description: > - Modify the likelihood of specified tokens appearing in the completion. + Modify the likelihood of specified tokens appearing in the + completion. - Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. - + Accepts a JSON object that maps tokens (specified by their token ID + in the tokenizer) to an associated bias value from -100 to 100. + Mathematically, the bias is added to the logits generated by the + model prior to sampling. The exact effect will vary per model, but + values between -1 and 1 should decrease or increase likelihood of + selection; values like -100 or 100 should result in a ban or + exclusive selection of the relevant token. properties: {} max_tokens: description: > The maximum number of tokens to generate in the chat completion. - The total length of input tokens and generated tokens is limited by the model's context length. - + The total length of input tokens and generated tokens is limited by + the model's context length. type: integer nullable: true default: 200 @@ -1774,7 +1818,9 @@ components: maximum: 1 nullable: true description: >- - (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize + new tokens based on their existing frequency in the text so far, + decreasing the model's likelihood to repeat the same line verbatim. repetition_penalty: type: number default: 1 @@ -1782,18 +1828,28 @@ components: maximum: 2 nullable: true description: >- - (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and + values larger than that penalize new tokens based on their existing + frequency in the text so far, decreasing the model's likelihood to + repeat the same line verbatim. response_format: type: object description: > An object specifying the format that the model must output. - Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + Setting to `{ "type": "json_object" }` enables JSON mode, which + guarantees the message the model generates is valid JSON. - **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. - + **Important:** when using JSON mode, you **must** also instruct the + model to produce JSON yourself via a system or user message. Without + this, the model may generate an unending stream of whitespace until + the generation reaches the token limit, resulting in a long-running + and seemingly "stuck" request. Also note that the message content + may be partially cut off if `finish_reason="length"`, which + indicates the generation exceeded `max_tokens` or the conversation + exceeded the max context length. properties: type: type: string @@ -1820,10 +1876,13 @@ components: description: > This feature is in Beta. - If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. - - Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + If specified, our system will make a best effort to sample + deterministically, such that repeated requests with the same `seed` + and parameters should return the same result. + Determinism is not guaranteed, and you should refer to the + `system_fingerprint` response parameter to monitor changes in the + backend. stop: description: | Up to 4 sequences where the API will stop generating further tokens. @@ -1838,8 +1897,12 @@ components: type: string stream: description: > - If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). - + If set, partial message deltas will be sent, like in ChatGPT. Tokens + will be sent as data-only [server-sent + events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: + [DONE]` message. [Example Python + code](https://cookbook.openai.com/examples/how_to_stream_completions). type: boolean nullable: true default: false @@ -1851,7 +1914,9 @@ components: example: 0.75 nullable: true description: >- - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + What sampling temperature to use, between 0 and 2. Higher values + like 0.8 will make the output more random, while lower values like + 0.2 will make it more focused and deterministic. top_p: type: number minimum: 0 @@ -1860,7 +1925,11 @@ components: example: 1 nullable: true description: >- - Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. + Defaults to 1 An alternative to sampling with temperature, called + nucleus sampling, where the model considers the results of the + tokens with top_p probability mass. So 0.1 means only the tokens + comprising the top 10% probability mass are considered. We + generally recommend altering this or temperature but not both. exclusiveMinimum: true min_p: type: number @@ -1874,7 +1943,8 @@ components: preset: type: string description: >- - Generation preset name (problem_solving|conversational|fun|prose|creative|business|deterministic|code|multilingual) + Generation preset name + (problem_solving|conversational|fun|prose|creative|business|deterministic|code|multilingual) enum: - problem_solving - conversational @@ -1895,14 +1965,18 @@ components: maximum: 2 nullable: true description: >- - (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize + new tokens based on their existing frequency in the text so far, + decreasing the model's likelihood to repeat the same line verbatim. length_penalty: type: number default: 1 minimum: 0 maximum: 2 nullable: true - description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " + description: >- + (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and + values larger than that penalize number of tokens generated. presence_penalty: type: number default: 0 @@ -1910,7 +1984,9 @@ components: maximum: 1 nullable: true description: >- - (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize + new tokens based on their existing frequency in the text so far, + decreasing the model's likelihood to repeat the same line verbatim. repetition_penalty: type: number default: 1 @@ -1918,7 +1994,10 @@ components: maximum: 2 nullable: true description: >- - (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and + values larger than that penalize new tokens based on their existing + frequency in the text so far, decreasing the model's likelihood to + repeat the same line verbatim. temperature: type: number minimum: 0 @@ -1927,7 +2006,9 @@ components: example: 0.75 nullable: true description: >- - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + What sampling temperature to use, between 0 and 2. Higher values + like 0.8 will make the output more random, while lower values like + 0.2 will make it more focused and deterministic. top_p: type: number minimum: 0 @@ -1936,7 +2017,11 @@ components: example: 1 nullable: true description: >- - Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. + Defaults to 1 An alternative to sampling with temperature, called + nucleus sampling, where the model considers the results of the + tokens with top_p probability mass. So 0.1 means only the tokens + comprising the top 10% probability mass are considered. We + generally recommend altering this or temperature but not both. min_p: type: number description: Minimum probability compared to leading token to be considered @@ -1949,7 +2034,8 @@ components: preset: type: string description: >- - Generation preset name (one of: problem_solving, conversational, fun, prose, creative, business, deterministic, code, multilingual) + Generation preset name (one of: problem_solving, conversational, + fun, prose, creative, business, deterministic, code, multilingual) enum: - problem_solving - conversational @@ -1972,7 +2058,14 @@ components: type: string description: Title describing what this bit of information contains content: - type: string + oneOf: + - type: array + description: List of document chunks + items: + type: string + minItems: 1 + - type: string + description: A single document chunk description: Information content id: type: string @@ -1998,7 +2091,14 @@ components: type: string description: Title describing what this bit of information contains content: - type: string + oneOf: + - type: array + description: List of document chunks + items: + type: string + minItems: 1 + - type: string + description: A single document chunk description: Information content metadata: type: object @@ -2007,6 +2107,7 @@ components: required: - title - content + - field_0 MemoryAccessOptions: type: object properties: @@ -2031,7 +2132,8 @@ components: - function - webhook description: >- - Whether this tool is a `function` or a `webhook` (Only `function` tool supported right now) + Whether this tool is a `function` or a `webhook` (Only `function` + tool supported right now) function: oneOf: - $ref: '#/components/schemas/FunctionDef' @@ -2139,7 +2241,8 @@ components: state: type: string description: >- - Current state (one of: pending, in_progress, retrying, succeeded, aborted, failed) + Current state (one of: pending, in_progress, retrying, succeeded, + aborted, failed) enum: - pending - in_progress @@ -2223,14 +2326,30 @@ components: description: type: string description: >- - A description of what the function does, used by the model to choose when and how to call the function. + A description of what the function does, used by the model to choose + when and how to call the function. name: type: string description: >- - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + The name of the function to be called. Must be a-z, A-Z, 0-9, or + contain underscores and dashes, with a maximum length of 64. parameters: $ref: '#/components/schemas/FunctionParameters' description: Parameters accepeted by this function + DocIds: + type: object + properties: + agent_doc_ids: + type: array + items: + type: string + user_doc_ids: + type: array + items: + type: string + required: + - agent_doc_ids + - user_doc_ids securitySchemes: api-key: type: apiKey diff --git a/openapi.yaml b/openapi.yaml index 358ed03fa..ece3a9da5 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2058,7 +2058,14 @@ components: type: string description: Title describing what this bit of information contains content: - type: string + oneOf: + - type: array + description: List of document chunks + items: + type: string + minItems: 1 + - type: string + description: A single document chunk description: Information content id: type: string diff --git a/sdks/postman/collection.json b/sdks/postman/collection.json index 5df99c162..027187a32 100644 --- a/sdks/postman/collection.json +++ b/sdks/postman/collection.json @@ -1296,7 +1296,7 @@ } }, "description": null, - "body": "{\n \"id\": \"id\",\n \"finish_reason\": \"stop\",\n \"response\": [\n [\n {\n \"role\": \"user\",\n \"content\": \"content\",\n \"created_at\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\"\n }\n ]\n ],\n \"usage\": {\n \"completion_tokens\": 1,\n \"prompt_tokens\": 1,\n \"total_tokens\": 1\n },\n \"jobs\": [\n \"jobs\"\n ]\n}", + "body": "{\n \"id\": \"id\",\n \"finish_reason\": \"stop\",\n \"response\": [\n [\n {\n \"role\": \"user\",\n \"content\": \"content\",\n \"created_at\": \"2024-01-15T09:30:00Z\",\n \"id\": \"id\"\n }\n ]\n ],\n \"usage\": {\n \"completion_tokens\": 1,\n \"prompt_tokens\": 1,\n \"total_tokens\": 1\n },\n \"jobs\": [\n \"jobs\"\n ],\n \"doc_ids\": {\n \"agent_doc_ids\": [\n \"agent_doc_ids\"\n ],\n \"user_doc_ids\": [\n \"user_doc_ids\"\n ]\n }\n}", "_postman_previewlanguage": "json" } ] @@ -2256,7 +2256,7 @@ "body": null }, "description": null, - "body": "{\n \"items\": [\n {\n \"title\": \"title\",\n \"content\": \"content\",\n \"id\": \"id\",\n \"created_at\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ],\n \"id\": \"id\",\n \"created_at\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}", "_postman_previewlanguage": "json" } ] @@ -2302,7 +2302,7 @@ "auth": null, "body": { "mode": "raw", - "raw": "{\n \"title\": \"title\",\n \"content\": \"content\"\n}", + "raw": "{\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ]\n}", "options": { "raw": { "language": "json" @@ -2353,7 +2353,7 @@ "auth": null, "body": { "mode": "raw", - "raw": "{\n \"title\": \"title\",\n \"content\": \"content\"\n}", + "raw": "{\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ]\n}", "options": { "raw": { "language": "json" @@ -2452,7 +2452,7 @@ "body": null }, "description": null, - "body": "{\n \"items\": [\n {\n \"title\": \"title\",\n \"content\": \"content\",\n \"id\": \"id\",\n \"created_at\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}", + "body": "{\n \"items\": [\n {\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ],\n \"id\": \"id\",\n \"created_at\": \"2024-01-15T09:30:00Z\"\n }\n ]\n}", "_postman_previewlanguage": "json" } ] @@ -2498,7 +2498,7 @@ "auth": null, "body": { "mode": "raw", - "raw": "{\n \"title\": \"title\",\n \"content\": \"content\"\n}", + "raw": "{\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ]\n}", "options": { "raw": { "language": "json" @@ -2549,7 +2549,7 @@ "auth": null, "body": { "mode": "raw", - "raw": "{\n \"title\": \"title\",\n \"content\": \"content\"\n}", + "raw": "{\n \"title\": \"title\",\n \"content\": [\n \"content\"\n ]\n}", "options": { "raw": { "language": "json" diff --git a/sdks/python/julep/api/__init__.py b/sdks/python/julep/api/__init__.py index 68d35f5dc..11415eb1a 100644 --- a/sdks/python/julep/api/__init__.py +++ b/sdks/python/julep/api/__init__.py @@ -22,12 +22,15 @@ CreateAgentRequestInstructions, CreateAgentRequestMetadata, CreateDoc, + CreateDocContent, CreateDocMetadata, CreateSessionRequestMetadata, CreateToolRequest, CreateToolRequestType, CreateUserRequestMetadata, Doc, + DocContent, + DocIds, DocMetadata, FunctionCallOption, FunctionDef, @@ -106,12 +109,15 @@ "CreateAgentRequestInstructions", "CreateAgentRequestMetadata", "CreateDoc", + "CreateDocContent", "CreateDocMetadata", "CreateSessionRequestMetadata", "CreateToolRequest", "CreateToolRequestType", "CreateUserRequestMetadata", "Doc", + "DocContent", + "DocIds", "DocMetadata", "FunctionCallOption", "FunctionDef", diff --git a/sdks/python/julep/api/client.py b/sdks/python/julep/api/client.py index 29cc09f07..ad49a9b04 100644 --- a/sdks/python/julep/api/client.py +++ b/sdks/python/julep/api/client.py @@ -1356,7 +1356,6 @@ def create_agent_doc( agent_id="agent_id", request=CreateDoc( title="title", - content="content", ), ) """ @@ -1458,7 +1457,6 @@ def create_user_doc( user_id="user_id", request=CreateDoc( title="title", - content="content", ), ) """ @@ -3121,7 +3119,6 @@ async def create_agent_doc( agent_id="agent_id", request=CreateDoc( title="title", - content="content", ), ) """ @@ -3223,7 +3220,6 @@ async def create_user_doc( user_id="user_id", request=CreateDoc( title="title", - content="content", ), ) """ diff --git a/sdks/python/julep/api/types/__init__.py b/sdks/python/julep/api/types/__init__.py index 5ebde51d9..11fa4d201 100644 --- a/sdks/python/julep/api/types/__init__.py +++ b/sdks/python/julep/api/types/__init__.py @@ -21,12 +21,15 @@ from .create_agent_request_instructions import CreateAgentRequestInstructions from .create_agent_request_metadata import CreateAgentRequestMetadata from .create_doc import CreateDoc +from .create_doc_content import CreateDocContent from .create_doc_metadata import CreateDocMetadata from .create_session_request_metadata import CreateSessionRequestMetadata from .create_tool_request import CreateToolRequest from .create_tool_request_type import CreateToolRequestType from .create_user_request_metadata import CreateUserRequestMetadata from .doc import Doc +from .doc_content import DocContent +from .doc_ids import DocIds from .doc_metadata import DocMetadata from .function_call_option import FunctionCallOption from .function_def import FunctionDef @@ -103,12 +106,15 @@ "CreateAgentRequestInstructions", "CreateAgentRequestMetadata", "CreateDoc", + "CreateDocContent", "CreateDocMetadata", "CreateSessionRequestMetadata", "CreateToolRequest", "CreateToolRequestType", "CreateUserRequestMetadata", "Doc", + "DocContent", + "DocIds", "DocMetadata", "FunctionCallOption", "FunctionDef", diff --git a/sdks/python/julep/api/types/chat_response.py b/sdks/python/julep/api/types/chat_response.py index 17e44c33a..c24284f61 100644 --- a/sdks/python/julep/api/types/chat_response.py +++ b/sdks/python/julep/api/types/chat_response.py @@ -7,6 +7,7 @@ from .chat_ml_message import ChatMlMessage from .chat_response_finish_reason import ChatResponseFinishReason from .completion_usage import CompletionUsage +from .doc_ids import DocIds try: import pydantic.v1 as pydantic # type: ignore @@ -30,6 +31,7 @@ class ChatResponse(pydantic.BaseModel): jobs: typing.Optional[typing.List[str]] = pydantic.Field( description="IDs (if any) of jobs created as part of this request" ) + doc_ids: DocIds def json(self, **kwargs: typing.Any) -> str: kwargs_with_defaults: typing.Any = { diff --git a/sdks/python/julep/api/types/create_doc.py b/sdks/python/julep/api/types/create_doc.py index 76a713dab..3c7d2b602 100644 --- a/sdks/python/julep/api/types/create_doc.py +++ b/sdks/python/julep/api/types/create_doc.py @@ -4,6 +4,7 @@ import typing from ..core.datetime_utils import serialize_datetime +from .create_doc_content import CreateDocContent from .create_doc_metadata import CreateDocMetadata try: @@ -16,7 +17,7 @@ class CreateDoc(pydantic.BaseModel): title: str = pydantic.Field( description="Title describing what this bit of information contains" ) - content: str = pydantic.Field(description="Information content") + content: CreateDocContent = pydantic.Field(description="Information content") metadata: typing.Optional[CreateDocMetadata] = pydantic.Field( description="Optional metadata" ) diff --git a/sdks/python/julep/api/types/create_doc_content.py b/sdks/python/julep/api/types/create_doc_content.py new file mode 100644 index 000000000..e186d7fa0 --- /dev/null +++ b/sdks/python/julep/api/types/create_doc_content.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CreateDocContent = typing.Union[typing.List[str], str] diff --git a/sdks/python/julep/api/types/doc.py b/sdks/python/julep/api/types/doc.py index 112e9ddbd..6239d4090 100644 --- a/sdks/python/julep/api/types/doc.py +++ b/sdks/python/julep/api/types/doc.py @@ -4,6 +4,7 @@ import typing from ..core.datetime_utils import serialize_datetime +from .doc_content import DocContent from .doc_metadata import DocMetadata try: @@ -16,7 +17,7 @@ class Doc(pydantic.BaseModel): title: str = pydantic.Field( description="Title describing what this bit of information contains" ) - content: str = pydantic.Field(description="Information content") + content: DocContent = pydantic.Field(description="Information content") id: str = pydantic.Field(description="ID of doc") created_at: dt.datetime = pydantic.Field(description="Doc created at") metadata: typing.Optional[DocMetadata] = pydantic.Field( diff --git a/sdks/python/julep/api/types/doc_content.py b/sdks/python/julep/api/types/doc_content.py new file mode 100644 index 000000000..8b27a9501 --- /dev/null +++ b/sdks/python/julep/api/types/doc_content.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +DocContent = typing.Union[typing.List[str], str] diff --git a/sdks/python/julep/api/types/doc_ids.py b/sdks/python/julep/api/types/doc_ids.py new file mode 100644 index 000000000..19eea5473 --- /dev/null +++ b/sdks/python/julep/api/types/doc_ids.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +from ..core.datetime_utils import serialize_datetime + +try: + import pydantic.v1 as pydantic # type: ignore +except ImportError: + import pydantic # type: ignore + + +class DocIds(pydantic.BaseModel): + agent_doc_ids: typing.List[str] + user_doc_ids: typing.List[str] + + def json(self, **kwargs: typing.Any) -> str: + kwargs_with_defaults: typing.Any = { + "by_alias": True, + "exclude_unset": True, + **kwargs, + } + return super().json(**kwargs_with_defaults) + + def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: + kwargs_with_defaults: typing.Any = { + "by_alias": True, + "exclude_unset": True, + **kwargs, + } + return super().dict(**kwargs_with_defaults) + + class Config: + frozen = True + smart_union = True + json_encoders = {dt.datetime: serialize_datetime} diff --git a/sdks/python/poetry.lock b/sdks/python/poetry.lock index 07a9f3e5d..bc5cf6912 100644 --- a/sdks/python/poetry.lock +++ b/sdks/python/poetry.lock @@ -176,13 +176,13 @@ tests-no-zope = ["attrs[tests-mypy]", "cloudpickle", "hypothesis", "pympler", "p [[package]] name = "babel" -version = "2.14.0" +version = "2.15.0" description = "Internationalization utilities" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"}, - {file = "Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363"}, + {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"}, + {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"}, ] [package.dependencies] @@ -948,13 +948,13 @@ testing = ["Django", "attrs", "colorama", "docopt", "pytest (<7.0.0)"] [[package]] name = "jinja2" -version = "3.1.3" +version = "3.1.4" description = "A very fast and expressive template engine." optional = false python-versions = ">=3.7" files = [ - {file = "Jinja2-3.1.3-py3-none-any.whl", hash = "sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa"}, - {file = "Jinja2-3.1.3.tar.gz", hash = "sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90"}, + {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"}, + {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"}, ] [package.dependencies] @@ -987,13 +987,13 @@ files = [ [[package]] name = "jsonschema" -version = "4.21.1" +version = "4.22.0" description = "An implementation of JSON Schema validation for Python" optional = false python-versions = ">=3.8" files = [ - {file = "jsonschema-4.21.1-py3-none-any.whl", hash = "sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f"}, - {file = "jsonschema-4.21.1.tar.gz", hash = "sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5"}, + {file = "jsonschema-4.22.0-py3-none-any.whl", hash = "sha256:ff4cfd6b1367a40e7bc6411caec72effadd3db0bbe5017de188f2d6108335802"}, + {file = "jsonschema-4.22.0.tar.gz", hash = "sha256:5b22d434a45935119af990552c862e5d6d564e8f6601206b305a61fdf661a2b7"}, ] [package.dependencies] @@ -1171,13 +1171,13 @@ test = ["jupyter-server (>=2.0.0)", "pytest (>=7.0)", "pytest-jupyter[server] (> [[package]] name = "jupyterlab" -version = "4.1.6" +version = "4.2.0" description = "JupyterLab computational environment" optional = false python-versions = ">=3.8" files = [ - {file = "jupyterlab-4.1.6-py3-none-any.whl", hash = "sha256:cf3e862bc10dbf4331e4eb37438634f813c238cfc62c71c640b3b3b2caa089a8"}, - {file = "jupyterlab-4.1.6.tar.gz", hash = "sha256:7935f36ba26eb615183a4f5c2bbca5791b5108ce2a00b5505f8cfd100d53648e"}, + {file = "jupyterlab-4.2.0-py3-none-any.whl", hash = "sha256:0dfe9278e25a145362289c555d9beb505697d269c10e99909766af7c440ad3cc"}, + {file = "jupyterlab-4.2.0.tar.gz", hash = "sha256:356e9205a6a2ab689c47c8fe4919dba6c076e376d03f26baadc05748c2435dd5"}, ] [package.dependencies] @@ -1190,7 +1190,7 @@ jinja2 = ">=3.0.3" jupyter-core = "*" jupyter-lsp = ">=2.0.0" jupyter-server = ">=2.4.0,<3" -jupyterlab-server = ">=2.19.0,<3" +jupyterlab-server = ">=2.27.1,<3" notebook-shim = ">=0.2" packaging = "*" tomli = {version = ">=1.2.2", markers = "python_version < \"3.11\""} @@ -1198,11 +1198,11 @@ tornado = ">=6.2.0" traitlets = "*" [package.extras] -dev = ["build", "bump2version", "coverage", "hatch", "pre-commit", "pytest-cov", "ruff (==0.2.0)"] +dev = ["build", "bump2version", "coverage", "hatch", "pre-commit", "pytest-cov", "ruff (==0.3.5)"] docs = ["jsx-lexer", "myst-parser", "pydata-sphinx-theme (>=0.13.0)", "pytest", "pytest-check-links", "pytest-jupyter", "sphinx (>=1.8,<7.3.0)", "sphinx-copybutton"] -docs-screenshots = ["altair (==5.2.0)", "ipython (==8.16.1)", "ipywidgets (==8.1.1)", "jupyterlab-geojson (==3.4.0)", "jupyterlab-language-pack-zh-cn (==4.0.post6)", "matplotlib (==3.8.2)", "nbconvert (>=7.0.0)", "pandas (==2.2.0)", "scipy (==1.12.0)", "vega-datasets (==0.9.0)"] +docs-screenshots = ["altair (==5.3.0)", "ipython (==8.16.1)", "ipywidgets (==8.1.2)", "jupyterlab-geojson (==3.4.0)", "jupyterlab-language-pack-zh-cn (==4.1.post2)", "matplotlib (==3.8.3)", "nbconvert (>=7.0.0)", "pandas (==2.2.1)", "scipy (==1.12.0)", "vega-datasets (==0.9.0)"] test = ["coverage", "pytest (>=7.0)", "pytest-check-links (>=0.7)", "pytest-console-scripts", "pytest-cov", "pytest-jupyter (>=0.5.3)", "pytest-timeout", "pytest-tornasync", "requests", "requests-cache", "virtualenv"] -upgrade-extension = ["copier (>=8.0,<9.0)", "jinja2-time (<0.3)", "pydantic (<2.0)", "pyyaml-include (<2.0)", "tomli-w (<2.0)"] +upgrade-extension = ["copier (>=8,<10)", "jinja2-time (<0.3)", "pydantic (<2.0)", "pyyaml-include (<2.0)", "tomli-w (<2.0)"] [[package]] name = "jupyterlab-pygments" @@ -1384,13 +1384,13 @@ files = [ [[package]] name = "marshmallow" -version = "3.21.1" +version = "3.21.2" description = "A lightweight library for converting complex datatypes to and from native Python datatypes." optional = false python-versions = ">=3.8" files = [ - {file = "marshmallow-3.21.1-py3-none-any.whl", hash = "sha256:f085493f79efb0644f270a9bf2892843142d80d7174bbbd2f3713f2a589dc633"}, - {file = "marshmallow-3.21.1.tar.gz", hash = "sha256:4e65e9e0d80fc9e609574b9983cf32579f305c718afb30d7233ab818571768c3"}, + {file = "marshmallow-3.21.2-py3-none-any.whl", hash = "sha256:70b54a6282f4704d12c0a41599682c5c5450e843b9ec406308653b47c59648a1"}, + {file = "marshmallow-3.21.2.tar.gz", hash = "sha256:82408deadd8b33d56338d2182d455db632c6313aa2af61916672146bb32edc56"}, ] [package.dependencies] @@ -1398,7 +1398,7 @@ packaging = ">=17.0" [package.extras] dev = ["marshmallow[tests]", "pre-commit (>=3.5,<4.0)", "tox"] -docs = ["alabaster (==0.7.16)", "autodocsumm (==0.2.12)", "sphinx (==7.2.6)", "sphinx-issues (==4.0.0)", "sphinx-version-warning (==1.1.2)"] +docs = ["alabaster (==0.7.16)", "autodocsumm (==0.2.12)", "sphinx (==7.3.7)", "sphinx-issues (==4.1.0)", "sphinx-version-warning (==1.1.2)"] tests = ["pytest", "pytz", "simplejson"] [[package]] @@ -1472,13 +1472,13 @@ test = ["flaky", "ipykernel (>=6.19.3)", "ipython", "ipywidgets", "nbconvert (>= [[package]] name = "nbconvert" -version = "7.16.3" +version = "7.16.4" description = "Converting Jupyter Notebooks (.ipynb files) to other formats. Output formats include asciidoc, html, latex, markdown, pdf, py, rst, script. nbconvert can be used both as a Python library (`import nbconvert`) or as a command line tool (invoked as `jupyter nbconvert ...`)." optional = false python-versions = ">=3.8" files = [ - {file = "nbconvert-7.16.3-py3-none-any.whl", hash = "sha256:ddeff14beeeedf3dd0bc506623e41e4507e551736de59df69a91f86700292b3b"}, - {file = "nbconvert-7.16.3.tar.gz", hash = "sha256:a6733b78ce3d47c3f85e504998495b07e6ea9cf9bf6ec1c98dda63ec6ad19142"}, + {file = "nbconvert-7.16.4-py3-none-any.whl", hash = "sha256:05873c620fe520b6322bf8a5ad562692343fe3452abda5765c7a34b7d1aa3eb3"}, + {file = "nbconvert-7.16.4.tar.gz", hash = "sha256:86ca91ba266b0a448dc96fa6c5b9d98affabde2867b363258703536807f9f7f4"}, ] [package.dependencies] @@ -1500,9 +1500,9 @@ tinycss2 = "*" traitlets = ">=5.1" [package.extras] -all = ["nbconvert[docs,qtpdf,serve,test,webpdf]"] +all = ["flaky", "ipykernel", "ipython", "ipywidgets (>=7.5)", "myst-parser", "nbsphinx (>=0.2.12)", "playwright", "pydata-sphinx-theme", "pyqtwebengine (>=5.15)", "pytest (>=7)", "sphinx (==5.0.2)", "sphinxcontrib-spelling", "tornado (>=6.1)"] docs = ["ipykernel", "ipython", "myst-parser", "nbsphinx (>=0.2.12)", "pydata-sphinx-theme", "sphinx (==5.0.2)", "sphinxcontrib-spelling"] -qtpdf = ["nbconvert[qtpng]"] +qtpdf = ["pyqtwebengine (>=5.15)"] qtpng = ["pyqtwebengine (>=5.15)"] serve = ["tornado (>=6.1)"] test = ["flaky", "ipykernel", "ipywidgets (>=7.5)", "pytest (>=7)"] @@ -1618,13 +1618,13 @@ test = ["pytest", "pytest-console-scripts", "pytest-jupyter", "pytest-tornasync" [[package]] name = "openai" -version = "1.23.6" +version = "1.30.1" description = "The official Python library for the openai API" optional = false python-versions = ">=3.7.1" files = [ - {file = "openai-1.23.6-py3-none-any.whl", hash = "sha256:f406c76ba279d16b9aca5a89cee0d968488e39f671f4dc6f0d690ac3c6f6fca1"}, - {file = "openai-1.23.6.tar.gz", hash = "sha256:612de2d54cf580920a1156273f84aada6b3dca26d048f62eb5364a4314d7f449"}, + {file = "openai-1.30.1-py3-none-any.whl", hash = "sha256:c9fb3c3545c118bbce8deb824397b9433a66d0d0ede6a96f7009c95b76de4a46"}, + {file = "openai-1.30.1.tar.gz", hash = "sha256:4f85190e577cba0b066e1950b8eb9b11d25bc7ebcc43a86b326ce1bfa564ec74"}, ] [package.dependencies] @@ -1758,13 +1758,13 @@ files = [ [[package]] name = "platformdirs" -version = "4.2.1" +version = "4.2.2" description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`." optional = false python-versions = ">=3.8" files = [ - {file = "platformdirs-4.2.1-py3-none-any.whl", hash = "sha256:17d5a1161b3fd67b390023cb2d3b026bbd40abde6fdb052dfbd3a29c3ba22ee1"}, - {file = "platformdirs-4.2.1.tar.gz", hash = "sha256:031cd18d4ec63ec53e82dceaac0417d218a6863f7745dfcc9efe7793b7039bdf"}, + {file = "platformdirs-4.2.2-py3-none-any.whl", hash = "sha256:2d7a1657e36a80ea911db832a8a6ece5ee53d8de21edd5cc5879af6530b1bfee"}, + {file = "platformdirs-4.2.2.tar.gz", hash = "sha256:38b7b51f512eed9e84a22788b4bce1de17c0adb134d6becb09836e37d8654cd3"}, ] [package.extras] @@ -2050,17 +2050,16 @@ tests = ["black", "chardet", "tox"] [[package]] name = "pygments" -version = "2.17.2" +version = "2.18.0" description = "Pygments is a syntax highlighting package written in Python." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"}, - {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"}, + {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"}, + {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"}, ] [package.extras] -plugins = ["importlib-metadata"] windows-terminal = ["colorama (>=0.4.6)"] [[package]] @@ -2079,13 +2078,13 @@ diagrams = ["jinja2", "railroad-diagrams"] [[package]] name = "pyright" -version = "1.1.360" +version = "1.1.363" description = "Command line wrapper for pyright" optional = false python-versions = ">=3.7" files = [ - {file = "pyright-1.1.360-py3-none-any.whl", hash = "sha256:7637f75451ac968b7cf1f8c51cfefb6d60ac7d086eb845364bc8ac03a026efd7"}, - {file = "pyright-1.1.360.tar.gz", hash = "sha256:784ddcda9745e9f5610483d7b963e9aa8d4f50d7755a9dffb28ccbeb27adce32"}, + {file = "pyright-1.1.363-py3-none-any.whl", hash = "sha256:d3b8d73c8d230e26cc3523862f3398032a0c39a00d7bb69dc0f595f8e888fd01"}, + {file = "pyright-1.1.363.tar.gz", hash = "sha256:00a8f0ae0e339473bb0488f8a2a2dcdf574e94a16cd7b4390d49d144714d8db2"}, ] [package.dependencies] @@ -2242,6 +2241,7 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -2278,99 +2278,99 @@ files = [ [[package]] name = "pyzmq" -version = "26.0.2" +version = "26.0.3" description = "Python bindings for 0MQ" optional = false python-versions = ">=3.7" files = [ - {file = "pyzmq-26.0.2-cp310-cp310-macosx_10_15_universal2.whl", hash = "sha256:1a60a03b01e8c9c58932ec0cca15b1712d911c2800eb82d4281bc1ae5b6dad50"}, - {file = "pyzmq-26.0.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:949067079e14ea1973bd740255e0840118c163d4bce8837f539d749f145cf5c3"}, - {file = "pyzmq-26.0.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:37e7edfa6cf96d036a403775c96afa25058d1bb940a79786a9a2fc94a783abe3"}, - {file = "pyzmq-26.0.2-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:903cc7a84a7d4326b43755c368780800e035aa3d711deae84a533fdffa8755b0"}, - {file = "pyzmq-26.0.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6cb2e41af165e5f327d06fbdd79a42a4e930267fade4e9f92d17f3ccce03f3a7"}, - {file = "pyzmq-26.0.2-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:55353b8189adcfc4c125fc4ce59d477744118e9c0ec379dd0999c5fa120ac4f5"}, - {file = "pyzmq-26.0.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:f961423ff6236a752ced80057a20e623044df95924ed1009f844cde8b3a595f9"}, - {file = "pyzmq-26.0.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:ba77fe84fe4f5f3dc0ef681a6d366685c8ffe1c8439c1d7530997b05ac06a04b"}, - {file = "pyzmq-26.0.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:52589f0a745ef61b9c75c872cf91f8c1f7c0668eb3dd99d7abd639d8c0fb9ca7"}, - {file = "pyzmq-26.0.2-cp310-cp310-win32.whl", hash = "sha256:b7b6d2a46c7afe2ad03ec8faf9967090c8ceae85c4d8934d17d7cae6f9062b64"}, - {file = "pyzmq-26.0.2-cp310-cp310-win_amd64.whl", hash = "sha256:86531e20de249d9204cc6d8b13d5a30537748c78820215161d8a3b9ea58ca111"}, - {file = "pyzmq-26.0.2-cp310-cp310-win_arm64.whl", hash = "sha256:f26a05029ecd2bd306b941ff8cb80f7620b7901421052bc429d238305b1cbf2f"}, - {file = "pyzmq-26.0.2-cp311-cp311-macosx_10_15_universal2.whl", hash = "sha256:70770e296a9cb03d955540c99360aab861cbb3cba29516abbd106a15dbd91268"}, - {file = "pyzmq-26.0.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2740fd7161b39e178554ebf21aa5667a1c9ef0cd2cb74298fd4ef017dae7aec4"}, - {file = "pyzmq-26.0.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f5e3706c32dea077faa42b1c92d825b7f86c866f72532d342e0be5e64d14d858"}, - {file = "pyzmq-26.0.2-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0fa1416876194927f7723d6b7171b95e1115602967fc6bfccbc0d2d51d8ebae1"}, - {file = "pyzmq-26.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4ef9a79a48794099c57dc2df00340b5d47c5caa1792f9ddb8c7a26b1280bd575"}, - {file = "pyzmq-26.0.2-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:1c60fcdfa3229aeee4291c5d60faed3a813b18bdadb86299c4bf49e8e51e8605"}, - {file = "pyzmq-26.0.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e943c39c206b04df2eb5d71305761d7c3ca75fd49452115ea92db1b5b98dbdef"}, - {file = "pyzmq-26.0.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:8da0ed8a598693731c76659880a668f4748b59158f26ed283a93f7f04d47447e"}, - {file = "pyzmq-26.0.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:7bf51970b11d67096bede97cdbad0f4333f7664f4708b9b2acb352bf4faa3140"}, - {file = "pyzmq-26.0.2-cp311-cp311-win32.whl", hash = "sha256:6f8e6bd5d066be605faa9fe5ec10aa1a46ad9f18fc8646f2b9aaefc8fb575742"}, - {file = "pyzmq-26.0.2-cp311-cp311-win_amd64.whl", hash = "sha256:6d03da3a0ae691b361edcb39530075461202f699ce05adbb15055a0e1c9bcaa4"}, - {file = "pyzmq-26.0.2-cp311-cp311-win_arm64.whl", hash = "sha256:f84e33321b68ff00b60e9dbd1a483e31ab6022c577c8de525b8e771bd274ce68"}, - {file = "pyzmq-26.0.2-cp312-cp312-macosx_10_15_universal2.whl", hash = "sha256:44c33ebd1c62a01db7fbc24e18bdda569d6639217d13d5929e986a2b0f69070d"}, - {file = "pyzmq-26.0.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ac04f904b4fce4afea9cdccbb78e24d468cb610a839d5a698853e14e2a3f9ecf"}, - {file = "pyzmq-26.0.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f2133de5ba9adc5f481884ccb699eac9ce789708292945c05746880f95b241c0"}, - {file = "pyzmq-26.0.2-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7753c67c570d7fc80c2dc59b90ca1196f1224e0e2e29a548980c95fe0fe27fc1"}, - {file = "pyzmq-26.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8d4e51632e6b12e65e8d9d7612446ecda2eda637a868afa7bce16270194650dd"}, - {file = "pyzmq-26.0.2-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:d6c38806f6ecd0acf3104b8d7e76a206bcf56dadd6ce03720d2fa9d9157d5718"}, - {file = "pyzmq-26.0.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:48f496bbe14686b51cec15406323ae6942851e14022efd7fc0e2ecd092c5982c"}, - {file = "pyzmq-26.0.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:e84a3161149c75bb7a7dc8646384186c34033e286a67fec1ad1bdedea165e7f4"}, - {file = "pyzmq-26.0.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:dabf796c67aa9f5a4fcc956d47f0d48b5c1ed288d628cf53aa1cf08e88654343"}, - {file = "pyzmq-26.0.2-cp312-cp312-win32.whl", hash = "sha256:3eee4c676af1b109f708d80ef0cf57ecb8aaa5900d1edaf90406aea7e0e20e37"}, - {file = "pyzmq-26.0.2-cp312-cp312-win_amd64.whl", hash = "sha256:26721fec65846b3e4450dad050d67d31b017f97e67f7e0647b5f98aa47f828cf"}, - {file = "pyzmq-26.0.2-cp312-cp312-win_arm64.whl", hash = "sha256:653955c6c233e90de128a1b8e882abc7216f41f44218056bd519969c8c413a15"}, - {file = "pyzmq-26.0.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:becd8d8fb068fbb5a52096efd83a2d8e54354383f691781f53a4c26aee944542"}, - {file = "pyzmq-26.0.2-cp37-cp37m-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:7a15e5465e7083c12517209c9dd24722b25e9b63c49a563922922fc03554eb35"}, - {file = "pyzmq-26.0.2-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:e8158ac8616941f874841f9fa0f6d2f1466178c2ff91ea08353fdc19de0d40c2"}, - {file = "pyzmq-26.0.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ea2c6a53e28c7066ea7db86fcc0b71d78d01b818bb11d4a4341ec35059885295"}, - {file = "pyzmq-26.0.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:bdbc7dab0b0e9c62c97b732899c4242e3282ba803bad668e03650b59b165466e"}, - {file = "pyzmq-26.0.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:e74b6d5ef57bb65bf1b4a37453d8d86d88550dde3fb0f23b1f1a24e60c70af5b"}, - {file = "pyzmq-26.0.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ed4c6ee624ecbc77b18aeeb07bf0700d26571ab95b8f723f0d02e056b5bce438"}, - {file = "pyzmq-26.0.2-cp37-cp37m-win32.whl", hash = "sha256:8a98b3cb0484b83c19d8fb5524c8a469cd9f10e743f5904ac285d92678ee761f"}, - {file = "pyzmq-26.0.2-cp37-cp37m-win_amd64.whl", hash = "sha256:aa5f95d71b6eca9cec28aa0a2f8310ea53dea313b63db74932879ff860c1fb8d"}, - {file = "pyzmq-26.0.2-cp38-cp38-macosx_10_15_universal2.whl", hash = "sha256:5ff56c76ce77b9805378a7a73032c17cbdb1a5b84faa1df03c5d3e306e5616df"}, - {file = "pyzmq-26.0.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:bab697fc1574fee4b81da955678708567c43c813c84c91074e452bda5346c921"}, - {file = "pyzmq-26.0.2-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:0c0fed8aa9ba0488ee1cbdaa304deea92d52fab43d373297002cfcc69c0a20c5"}, - {file = "pyzmq-26.0.2-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:606b922699fcec472ed814dda4dc3ff7c748254e0b26762a0ba21a726eb1c107"}, - {file = "pyzmq-26.0.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:45f0fd82bad4d199fa993fbf0ac586a7ac5879addbe436a35a389df7e0eb4c91"}, - {file = "pyzmq-26.0.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:166c5e41045939a52c01e6f374e493d9a6a45dfe677360d3e7026e38c42e8906"}, - {file = "pyzmq-26.0.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d566e859e8b8d5bca08467c093061774924b3d78a5ba290e82735b2569edc84b"}, - {file = "pyzmq-26.0.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:264ee0e72b72ca59279dc320deab5ae0fac0d97881aed1875ce4bde2e56ffde0"}, - {file = "pyzmq-26.0.2-cp38-cp38-win32.whl", hash = "sha256:3152bbd3a4744cbdd83dfb210ed701838b8b0c9065cef14671d6d91df12197d0"}, - {file = "pyzmq-26.0.2-cp38-cp38-win_amd64.whl", hash = "sha256:bf77601d75ca692c179154b7e5943c286a4aaffec02c491afe05e60493ce95f2"}, - {file = "pyzmq-26.0.2-cp39-cp39-macosx_10_15_universal2.whl", hash = "sha256:c770a7545b3deca2db185b59175e710a820dd4ed43619f4c02e90b0e227c6252"}, - {file = "pyzmq-26.0.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:d47175f0a380bfd051726bc5c0054036ae4a5d8caf922c62c8a172ccd95c1a2a"}, - {file = "pyzmq-26.0.2-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:9bce298c1ce077837e110367c321285dc4246b531cde1abfc27e4a5bbe2bed4d"}, - {file = "pyzmq-26.0.2-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:c40b09b7e184d6e3e1be1c8af2cc320c0f9f610d8a5df3dd866e6e6e4e32b235"}, - {file = "pyzmq-26.0.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d420d856bf728713874cefb911398efe69e1577835851dd297a308a78c14c249"}, - {file = "pyzmq-26.0.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d792d3cab987058451e55c70c5926e93e2ceb68ca5a2334863bb903eb860c9cb"}, - {file = "pyzmq-26.0.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:83ec17729cf6d3464dab98a11e98294fcd50e6b17eaabd3d841515c23f6dbd3a"}, - {file = "pyzmq-26.0.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:47c17d5ebfa88ae90f08960c97b49917098665b8cd8be31f2c24e177bcf37a0f"}, - {file = "pyzmq-26.0.2-cp39-cp39-win32.whl", hash = "sha256:d509685d1cd1d018705a811c5f9d5bc237790936ead6d06f6558b77e16cc7235"}, - {file = "pyzmq-26.0.2-cp39-cp39-win_amd64.whl", hash = "sha256:c7cc8cc009e8f6989a6d86c96f87dae5f5fb07d6c96916cdc7719d546152c7db"}, - {file = "pyzmq-26.0.2-cp39-cp39-win_arm64.whl", hash = "sha256:3ada31cb879cd7532f4a85b501f4255c747d4813ab76b35c49ed510ce4865b45"}, - {file = "pyzmq-26.0.2-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:0a6ceaddc830dd3ca86cb8451cf373d1f05215368e11834538c2902ed5205139"}, - {file = "pyzmq-26.0.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6a967681463aa7a99eb9a62bb18229b653b45c10ff0947b31cc0837a83dfb86f"}, - {file = "pyzmq-26.0.2-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6472a73bc115bc40a2076609a90894775abe6faf19a78375675a2f889a613071"}, - {file = "pyzmq-26.0.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5d6aea92bcccfe5e5524d3c70a6f16ffdae548390ddad26f4207d55c55a40593"}, - {file = "pyzmq-26.0.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:e025f6351e49d48a5aa2f5a09293aa769b0ee7369c25bed551647234b7fa0c75"}, - {file = "pyzmq-26.0.2-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:40bd7ebe4dbb37d27f0c56e2a844f360239343a99be422085e13e97da13f73f9"}, - {file = "pyzmq-26.0.2-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:1dd40d586ad6f53764104df6e01810fe1b4e88fd353774629a5e6fe253813f79"}, - {file = "pyzmq-26.0.2-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f2aca15e9ad8c8657b5b3d7ae3d1724dc8c1c1059c06b4b674c3aa36305f4930"}, - {file = "pyzmq-26.0.2-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:450ec234736732eb0ebeffdb95a352450d4592f12c3e087e2a9183386d22c8bf"}, - {file = "pyzmq-26.0.2-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:f43be2bebbd09360a2f23af83b243dc25ffe7b583ea8c722e6df03e03a55f02f"}, - {file = "pyzmq-26.0.2-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:867f55e54aff254940bcec5eec068e7c0ac1e6bf360ab91479394a8bf356b0e6"}, - {file = "pyzmq-26.0.2-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:b4dbc033c5ad46f8c429bf238c25a889b8c1d86bfe23a74e1031a991cb3f0000"}, - {file = "pyzmq-26.0.2-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6e8dd2961462e337e21092ec2da0c69d814dcb1b6e892955a37444a425e9cfb8"}, - {file = "pyzmq-26.0.2-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:35391e72df6c14a09b697c7b94384947c1dd326aca883ff98ff137acdf586c33"}, - {file = "pyzmq-26.0.2-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:1c3d3c92fa54eda94ab369ca5b8d35059987c326ba5e55326eb068862f64b1fc"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e7aa61a9cc4f0523373e31fc9255bf4567185a099f85ca3598e64de484da3ab2"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ee53a8191271f144cc20b12c19daa9f1546adc84a2f33839e3338039b55c373c"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ac60a980f07fa988983f7bfe6404ef3f1e4303f5288a01713bc1266df6d18783"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:88896b1b4817d7b2fe1ec7205c4bbe07bf5d92fb249bf2d226ddea8761996068"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:18dfffe23751edee917764ffa133d5d3fef28dfd1cf3adebef8c90bc854c74c4"}, - {file = "pyzmq-26.0.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:6926dd14cfe6967d3322640b6d5c3c3039db71716a5e43cca6e3b474e73e0b36"}, - {file = "pyzmq-26.0.2.tar.gz", hash = "sha256:f0f9bb370449158359bb72a3e12c658327670c0ffe6fbcd1af083152b64f9df0"}, + {file = "pyzmq-26.0.3-cp310-cp310-macosx_10_15_universal2.whl", hash = "sha256:44dd6fc3034f1eaa72ece33588867df9e006a7303725a12d64c3dff92330f625"}, + {file = "pyzmq-26.0.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:acb704195a71ac5ea5ecf2811c9ee19ecdc62b91878528302dd0be1b9451cc90"}, + {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5dbb9c997932473a27afa93954bb77a9f9b786b4ccf718d903f35da3232317de"}, + {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6bcb34f869d431799c3ee7d516554797f7760cb2198ecaa89c3f176f72d062be"}, + {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:38ece17ec5f20d7d9b442e5174ae9f020365d01ba7c112205a4d59cf19dc38ee"}, + {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:ba6e5e6588e49139a0979d03a7deb9c734bde647b9a8808f26acf9c547cab1bf"}, + {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:3bf8b000a4e2967e6dfdd8656cd0757d18c7e5ce3d16339e550bd462f4857e59"}, + {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:2136f64fbb86451dbbf70223635a468272dd20075f988a102bf8a3f194a411dc"}, + {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:e8918973fbd34e7814f59143c5f600ecd38b8038161239fd1a3d33d5817a38b8"}, + {file = "pyzmq-26.0.3-cp310-cp310-win32.whl", hash = "sha256:0aaf982e68a7ac284377d051c742610220fd06d330dcd4c4dbb4cdd77c22a537"}, + {file = "pyzmq-26.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:f1a9b7d00fdf60b4039f4455afd031fe85ee8305b019334b72dcf73c567edc47"}, + {file = "pyzmq-26.0.3-cp310-cp310-win_arm64.whl", hash = "sha256:80b12f25d805a919d53efc0a5ad7c0c0326f13b4eae981a5d7b7cc343318ebb7"}, + {file = "pyzmq-26.0.3-cp311-cp311-macosx_10_15_universal2.whl", hash = "sha256:a72a84570f84c374b4c287183debc776dc319d3e8ce6b6a0041ce2e400de3f32"}, + {file = "pyzmq-26.0.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7ca684ee649b55fd8f378127ac8462fb6c85f251c2fb027eb3c887e8ee347bcd"}, + {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e222562dc0f38571c8b1ffdae9d7adb866363134299264a1958d077800b193b7"}, + {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f17cde1db0754c35a91ac00b22b25c11da6eec5746431d6e5092f0cd31a3fea9"}, + {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4b7c0c0b3244bb2275abe255d4a30c050d541c6cb18b870975553f1fb6f37527"}, + {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:ac97a21de3712afe6a6c071abfad40a6224fd14fa6ff0ff8d0c6e6cd4e2f807a"}, + {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:88b88282e55fa39dd556d7fc04160bcf39dea015f78e0cecec8ff4f06c1fc2b5"}, + {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:72b67f966b57dbd18dcc7efbc1c7fc9f5f983e572db1877081f075004614fcdd"}, + {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f4b6cecbbf3b7380f3b61de3a7b93cb721125dc125c854c14ddc91225ba52f83"}, + {file = "pyzmq-26.0.3-cp311-cp311-win32.whl", hash = "sha256:eed56b6a39216d31ff8cd2f1d048b5bf1700e4b32a01b14379c3b6dde9ce3aa3"}, + {file = "pyzmq-26.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:3191d312c73e3cfd0f0afdf51df8405aafeb0bad71e7ed8f68b24b63c4f36500"}, + {file = "pyzmq-26.0.3-cp311-cp311-win_arm64.whl", hash = "sha256:b6907da3017ef55139cf0e417c5123a84c7332520e73a6902ff1f79046cd3b94"}, + {file = "pyzmq-26.0.3-cp312-cp312-macosx_10_15_universal2.whl", hash = "sha256:068ca17214038ae986d68f4a7021f97e187ed278ab6dccb79f837d765a54d753"}, + {file = "pyzmq-26.0.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:7821d44fe07335bea256b9f1f41474a642ca55fa671dfd9f00af8d68a920c2d4"}, + {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eeb438a26d87c123bb318e5f2b3d86a36060b01f22fbdffd8cf247d52f7c9a2b"}, + {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:69ea9d6d9baa25a4dc9cef5e2b77b8537827b122214f210dd925132e34ae9b12"}, + {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7daa3e1369355766dea11f1d8ef829905c3b9da886ea3152788dc25ee6079e02"}, + {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:6ca7a9a06b52d0e38ccf6bca1aeff7be178917893f3883f37b75589d42c4ac20"}, + {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1b7d0e124948daa4d9686d421ef5087c0516bc6179fdcf8828b8444f8e461a77"}, + {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:e746524418b70f38550f2190eeee834db8850088c834d4c8406fbb9bc1ae10b2"}, + {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:6b3146f9ae6af82c47a5282ac8803523d381b3b21caeae0327ed2f7ecb718798"}, + {file = "pyzmq-26.0.3-cp312-cp312-win32.whl", hash = "sha256:2b291d1230845871c00c8462c50565a9cd6026fe1228e77ca934470bb7d70ea0"}, + {file = "pyzmq-26.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:926838a535c2c1ea21c903f909a9a54e675c2126728c21381a94ddf37c3cbddf"}, + {file = "pyzmq-26.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:5bf6c237f8c681dfb91b17f8435b2735951f0d1fad10cc5dfd96db110243370b"}, + {file = "pyzmq-26.0.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0c0991f5a96a8e620f7691e61178cd8f457b49e17b7d9cfa2067e2a0a89fc1d5"}, + {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:dbf012d8fcb9f2cf0643b65df3b355fdd74fc0035d70bb5c845e9e30a3a4654b"}, + {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:01fbfbeb8249a68d257f601deb50c70c929dc2dfe683b754659569e502fbd3aa"}, + {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1c8eb19abe87029c18f226d42b8a2c9efdd139d08f8bf6e085dd9075446db450"}, + {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:5344b896e79800af86ad643408ca9aa303a017f6ebff8cee5a3163c1e9aec987"}, + {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:204e0f176fd1d067671157d049466869b3ae1fc51e354708b0dc41cf94e23a3a"}, + {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:a42db008d58530efa3b881eeee4991146de0b790e095f7ae43ba5cc612decbc5"}, + {file = "pyzmq-26.0.3-cp37-cp37m-win32.whl", hash = "sha256:8d7a498671ca87e32b54cb47c82a92b40130a26c5197d392720a1bce1b3c77cf"}, + {file = "pyzmq-26.0.3-cp37-cp37m-win_amd64.whl", hash = "sha256:3b4032a96410bdc760061b14ed6a33613ffb7f702181ba999df5d16fb96ba16a"}, + {file = "pyzmq-26.0.3-cp38-cp38-macosx_10_15_universal2.whl", hash = "sha256:2cc4e280098c1b192c42a849de8de2c8e0f3a84086a76ec5b07bfee29bda7d18"}, + {file = "pyzmq-26.0.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5bde86a2ed3ce587fa2b207424ce15b9a83a9fa14422dcc1c5356a13aed3df9d"}, + {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:34106f68e20e6ff253c9f596ea50397dbd8699828d55e8fa18bd4323d8d966e6"}, + {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ebbbd0e728af5db9b04e56389e2299a57ea8b9dd15c9759153ee2455b32be6ad"}, + {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f6b1d1c631e5940cac5a0b22c5379c86e8df6a4ec277c7a856b714021ab6cfad"}, + {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:e891ce81edd463b3b4c3b885c5603c00141151dd9c6936d98a680c8c72fe5c67"}, + {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:9b273ecfbc590a1b98f014ae41e5cf723932f3b53ba9367cfb676f838038b32c"}, + {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b32bff85fb02a75ea0b68f21e2412255b5731f3f389ed9aecc13a6752f58ac97"}, + {file = "pyzmq-26.0.3-cp38-cp38-win32.whl", hash = "sha256:f6c21c00478a7bea93caaaef9e7629145d4153b15a8653e8bb4609d4bc70dbfc"}, + {file = "pyzmq-26.0.3-cp38-cp38-win_amd64.whl", hash = "sha256:3401613148d93ef0fd9aabdbddb212de3db7a4475367f49f590c837355343972"}, + {file = "pyzmq-26.0.3-cp39-cp39-macosx_10_15_universal2.whl", hash = "sha256:2ed8357f4c6e0daa4f3baf31832df8a33334e0fe5b020a61bc8b345a3db7a606"}, + {file = "pyzmq-26.0.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c1c8f2a2ca45292084c75bb6d3a25545cff0ed931ed228d3a1810ae3758f975f"}, + {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:b63731993cdddcc8e087c64e9cf003f909262b359110070183d7f3025d1c56b5"}, + {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:b3cd31f859b662ac5d7f4226ec7d8bd60384fa037fc02aee6ff0b53ba29a3ba8"}, + {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:115f8359402fa527cf47708d6f8a0f8234f0e9ca0cab7c18c9c189c194dbf620"}, + {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:715bdf952b9533ba13dfcf1f431a8f49e63cecc31d91d007bc1deb914f47d0e4"}, + {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:e1258c639e00bf5e8a522fec6c3eaa3e30cf1c23a2f21a586be7e04d50c9acab"}, + {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:15c59e780be8f30a60816a9adab900c12a58d79c1ac742b4a8df044ab2a6d920"}, + {file = "pyzmq-26.0.3-cp39-cp39-win32.whl", hash = "sha256:d0cdde3c78d8ab5b46595054e5def32a755fc028685add5ddc7403e9f6de9879"}, + {file = "pyzmq-26.0.3-cp39-cp39-win_amd64.whl", hash = "sha256:ce828058d482ef860746bf532822842e0ff484e27f540ef5c813d516dd8896d2"}, + {file = "pyzmq-26.0.3-cp39-cp39-win_arm64.whl", hash = "sha256:788f15721c64109cf720791714dc14afd0f449d63f3a5487724f024345067381"}, + {file = "pyzmq-26.0.3-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:2c18645ef6294d99b256806e34653e86236eb266278c8ec8112622b61db255de"}, + {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7e6bc96ebe49604df3ec2c6389cc3876cabe475e6bfc84ced1bf4e630662cb35"}, + {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:971e8990c5cc4ddcff26e149398fc7b0f6a042306e82500f5e8db3b10ce69f84"}, + {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d8416c23161abd94cc7da80c734ad7c9f5dbebdadfdaa77dad78244457448223"}, + {file = "pyzmq-26.0.3-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:082a2988364b60bb5de809373098361cf1dbb239623e39e46cb18bc035ed9c0c"}, + {file = "pyzmq-26.0.3-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d57dfbf9737763b3a60d26e6800e02e04284926329aee8fb01049635e957fe81"}, + {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:77a85dca4c2430ac04dc2a2185c2deb3858a34fe7f403d0a946fa56970cf60a1"}, + {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:4c82a6d952a1d555bf4be42b6532927d2a5686dd3c3e280e5f63225ab47ac1f5"}, + {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4496b1282c70c442809fc1b151977c3d967bfb33e4e17cedbf226d97de18f709"}, + {file = "pyzmq-26.0.3-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:e4946d6bdb7ba972dfda282f9127e5756d4f299028b1566d1245fa0d438847e6"}, + {file = "pyzmq-26.0.3-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:03c0ae165e700364b266876d712acb1ac02693acd920afa67da2ebb91a0b3c09"}, + {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:3e3070e680f79887d60feeda051a58d0ac36622e1759f305a41059eff62c6da7"}, + {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6ca08b840fe95d1c2bd9ab92dac5685f949fc6f9ae820ec16193e5ddf603c3b2"}, + {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e76654e9dbfb835b3518f9938e565c7806976c07b37c33526b574cc1a1050480"}, + {file = "pyzmq-26.0.3-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:871587bdadd1075b112e697173e946a07d722459d20716ceb3d1bd6c64bd08ce"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d0a2d1bd63a4ad79483049b26514e70fa618ce6115220da9efdff63688808b17"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0270b49b6847f0d106d64b5086e9ad5dc8a902413b5dbbb15d12b60f9c1747a4"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:703c60b9910488d3d0954ca585c34f541e506a091a41930e663a098d3b794c67"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:74423631b6be371edfbf7eabb02ab995c2563fee60a80a30829176842e71722a"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:4adfbb5451196842a88fda3612e2c0414134874bffb1c2ce83ab4242ec9e027d"}, + {file = "pyzmq-26.0.3-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:3516119f4f9b8671083a70b6afaa0a070f5683e431ab3dc26e9215620d7ca1ad"}, + {file = "pyzmq-26.0.3.tar.gz", hash = "sha256:dba7d9f2e047dfa2bca3b01f4f84aa5246725203d6284e3790f2ca15fba6b40a"}, ] [package.dependencies] @@ -2378,13 +2378,13 @@ cffi = {version = "*", markers = "implementation_name == \"pypy\""} [[package]] name = "referencing" -version = "0.35.0" +version = "0.35.1" description = "JSON Referencing + Python" optional = false python-versions = ">=3.8" files = [ - {file = "referencing-0.35.0-py3-none-any.whl", hash = "sha256:8080727b30e364e5783152903672df9b6b091c926a146a759080b62ca3126cd6"}, - {file = "referencing-0.35.0.tar.gz", hash = "sha256:191e936b0c696d0af17ad7430a3dc68e88bc11be6514f4757dc890f04ab05889"}, + {file = "referencing-0.35.1-py3-none-any.whl", hash = "sha256:eda6d3234d62814d1c64e305c1331c9a3a6132da475ab6382eaa997b21ee75de"}, + {file = "referencing-0.35.1.tar.gz", hash = "sha256:25b42124a6c8b632a425174f24087783efb348a6f1e0008e63cd4466fedf703c"}, ] [package.dependencies] @@ -2458,110 +2458,110 @@ jupyter = ["ipywidgets (>=7.5.1,<9)"] [[package]] name = "rpds-py" -version = "0.18.0" +version = "0.18.1" description = "Python bindings to Rust's persistent data structures (rpds)" optional = false python-versions = ">=3.8" files = [ - {file = "rpds_py-0.18.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:5b4e7d8d6c9b2e8ee2d55c90b59c707ca59bc30058269b3db7b1f8df5763557e"}, - {file = "rpds_py-0.18.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c463ed05f9dfb9baebef68048aed8dcdc94411e4bf3d33a39ba97e271624f8f7"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:01e36a39af54a30f28b73096dd39b6802eddd04c90dbe161c1b8dbe22353189f"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d62dec4976954a23d7f91f2f4530852b0c7608116c257833922a896101336c51"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dd18772815d5f008fa03d2b9a681ae38d5ae9f0e599f7dda233c439fcaa00d40"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:923d39efa3cfb7279a0327e337a7958bff00cc447fd07a25cddb0a1cc9a6d2da"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:39514da80f971362f9267c600b6d459bfbbc549cffc2cef8e47474fddc9b45b1"}, - {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a34d557a42aa28bd5c48a023c570219ba2593bcbbb8dc1b98d8cf5d529ab1434"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:93df1de2f7f7239dc9cc5a4a12408ee1598725036bd2dedadc14d94525192fc3"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:34b18ba135c687f4dac449aa5157d36e2cbb7c03cbea4ddbd88604e076aa836e"}, - {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:c0b5dcf9193625afd8ecc92312d6ed78781c46ecbf39af9ad4681fc9f464af88"}, - {file = "rpds_py-0.18.0-cp310-none-win32.whl", hash = "sha256:c4325ff0442a12113a6379af66978c3fe562f846763287ef66bdc1d57925d337"}, - {file = "rpds_py-0.18.0-cp310-none-win_amd64.whl", hash = "sha256:7223a2a5fe0d217e60a60cdae28d6949140dde9c3bcc714063c5b463065e3d66"}, - {file = "rpds_py-0.18.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:3a96e0c6a41dcdba3a0a581bbf6c44bb863f27c541547fb4b9711fd8cf0ffad4"}, - {file = "rpds_py-0.18.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:30f43887bbae0d49113cbaab729a112251a940e9b274536613097ab8b4899cf6"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fcb25daa9219b4cf3a0ab24b0eb9a5cc8949ed4dc72acb8fa16b7e1681aa3c58"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d68c93e381010662ab873fea609bf6c0f428b6d0bb00f2c6939782e0818d37bf"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b34b7aa8b261c1dbf7720b5d6f01f38243e9b9daf7e6b8bc1fd4657000062f2c"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e6d75ab12b0bbab7215e5d40f1e5b738aa539598db27ef83b2ec46747df90e1"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b8612cd233543a3781bc659c731b9d607de65890085098986dfd573fc2befe5"}, - {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aec493917dd45e3c69d00a8874e7cbed844efd935595ef78a0f25f14312e33c6"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:661d25cbffaf8cc42e971dd570d87cb29a665f49f4abe1f9e76be9a5182c4688"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:1df3659d26f539ac74fb3b0c481cdf9d725386e3552c6fa2974f4d33d78e544b"}, - {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a1ce3ba137ed54f83e56fb983a5859a27d43a40188ba798993812fed73c70836"}, - {file = "rpds_py-0.18.0-cp311-none-win32.whl", hash = "sha256:69e64831e22a6b377772e7fb337533c365085b31619005802a79242fee620bc1"}, - {file = "rpds_py-0.18.0-cp311-none-win_amd64.whl", hash = "sha256:998e33ad22dc7ec7e030b3df701c43630b5bc0d8fbc2267653577e3fec279afa"}, - {file = "rpds_py-0.18.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:7f2facbd386dd60cbbf1a794181e6aa0bd429bd78bfdf775436020172e2a23f0"}, - {file = "rpds_py-0.18.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1d9a5be316c15ffb2b3c405c4ff14448c36b4435be062a7f578ccd8b01f0c4d8"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cd5bf1af8efe569654bbef5a3e0a56eca45f87cfcffab31dd8dde70da5982475"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5417558f6887e9b6b65b4527232553c139b57ec42c64570569b155262ac0754f"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:56a737287efecafc16f6d067c2ea0117abadcd078d58721f967952db329a3e5c"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8f03bccbd8586e9dd37219bce4d4e0d3ab492e6b3b533e973fa08a112cb2ffc9"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4457a94da0d5c53dc4b3e4de1158bdab077db23c53232f37a3cb7afdb053a4e3"}, - {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0ab39c1ba9023914297dd88ec3b3b3c3f33671baeb6acf82ad7ce883f6e8e157"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9d54553c1136b50fd12cc17e5b11ad07374c316df307e4cfd6441bea5fb68496"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0af039631b6de0397ab2ba16eaf2872e9f8fca391b44d3d8cac317860a700a3f"}, - {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:84ffab12db93b5f6bad84c712c92060a2d321b35c3c9960b43d08d0f639d60d7"}, - {file = "rpds_py-0.18.0-cp312-none-win32.whl", hash = "sha256:685537e07897f173abcf67258bee3c05c374fa6fff89d4c7e42fb391b0605e98"}, - {file = "rpds_py-0.18.0-cp312-none-win_amd64.whl", hash = "sha256:e003b002ec72c8d5a3e3da2989c7d6065b47d9eaa70cd8808b5384fbb970f4ec"}, - {file = "rpds_py-0.18.0-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:08f9ad53c3f31dfb4baa00da22f1e862900f45908383c062c27628754af2e88e"}, - {file = "rpds_py-0.18.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:c0013fe6b46aa496a6749c77e00a3eb07952832ad6166bd481c74bda0dcb6d58"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e32a92116d4f2a80b629778280103d2a510a5b3f6314ceccd6e38006b5e92dcb"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e541ec6f2ec456934fd279a3120f856cd0aedd209fc3852eca563f81738f6861"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bed88b9a458e354014d662d47e7a5baafd7ff81c780fd91584a10d6ec842cb73"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2644e47de560eb7bd55c20fc59f6daa04682655c58d08185a9b95c1970fa1e07"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8e8916ae4c720529e18afa0b879473049e95949bf97042e938530e072fde061d"}, - {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:465a3eb5659338cf2a9243e50ad9b2296fa15061736d6e26240e713522b6235c"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:ea7d4a99f3b38c37eac212dbd6ec42b7a5ec51e2c74b5d3223e43c811609e65f"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:67071a6171e92b6da534b8ae326505f7c18022c6f19072a81dcf40db2638767c"}, - {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:41ef53e7c58aa4ef281da975f62c258950f54b76ec8e45941e93a3d1d8580594"}, - {file = "rpds_py-0.18.0-cp38-none-win32.whl", hash = "sha256:fdea4952db2793c4ad0bdccd27c1d8fdd1423a92f04598bc39425bcc2b8ee46e"}, - {file = "rpds_py-0.18.0-cp38-none-win_amd64.whl", hash = "sha256:7cd863afe7336c62ec78d7d1349a2f34c007a3cc6c2369d667c65aeec412a5b1"}, - {file = "rpds_py-0.18.0-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:5307def11a35f5ae4581a0b658b0af8178c65c530e94893345bebf41cc139d33"}, - {file = "rpds_py-0.18.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:77f195baa60a54ef9d2de16fbbfd3ff8b04edc0c0140a761b56c267ac11aa467"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39f5441553f1c2aed4de4377178ad8ff8f9d733723d6c66d983d75341de265ab"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:9a00312dea9310d4cb7dbd7787e722d2e86a95c2db92fbd7d0155f97127bcb40"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8f2fc11e8fe034ee3c34d316d0ad8808f45bc3b9ce5857ff29d513f3ff2923a1"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:586f8204935b9ec884500498ccc91aa869fc652c40c093bd9e1471fbcc25c022"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ddc2f4dfd396c7bfa18e6ce371cba60e4cf9d2e5cdb71376aa2da264605b60b9"}, - {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5ddcba87675b6d509139d1b521e0c8250e967e63b5909a7e8f8944d0f90ff36f"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:7bd339195d84439cbe5771546fe8a4e8a7a045417d8f9de9a368c434e42a721e"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:d7c36232a90d4755b720fbd76739d8891732b18cf240a9c645d75f00639a9024"}, - {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:6b0817e34942b2ca527b0e9298373e7cc75f429e8da2055607f4931fded23e20"}, - {file = "rpds_py-0.18.0-cp39-none-win32.whl", hash = "sha256:99f70b740dc04d09e6b2699b675874367885217a2e9f782bdf5395632ac663b7"}, - {file = "rpds_py-0.18.0-cp39-none-win_amd64.whl", hash = "sha256:6ef687afab047554a2d366e112dd187b62d261d49eb79b77e386f94644363294"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:ad36cfb355e24f1bd37cac88c112cd7730873f20fb0bdaf8ba59eedf8216079f"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:36b3ee798c58ace201289024b52788161e1ea133e4ac93fba7d49da5fec0ef9e"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8a2f084546cc59ea99fda8e070be2fd140c3092dc11524a71aa8f0f3d5a55ca"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e4461d0f003a0aa9be2bdd1b798a041f177189c1a0f7619fe8c95ad08d9a45d7"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8db715ebe3bb7d86d77ac1826f7d67ec11a70dbd2376b7cc214199360517b641"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:793968759cd0d96cac1e367afd70c235867831983f876a53389ad869b043c948"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:66e6a3af5a75363d2c9a48b07cb27c4ea542938b1a2e93b15a503cdfa8490795"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6ef0befbb5d79cf32d0266f5cff01545602344eda89480e1dd88aca964260b18"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d4acf42190d449d5e89654d5c1ed3a4f17925eec71f05e2a41414689cda02d1"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:a5f446dd5055667aabaee78487f2b5ab72e244f9bc0b2ffebfeec79051679984"}, - {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:9dbbeb27f4e70bfd9eec1be5477517365afe05a9b2c441a0b21929ee61048124"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:22806714311a69fd0af9b35b7be97c18a0fc2826e6827dbb3a8c94eac6cf7eeb"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:b34ae4636dfc4e76a438ab826a0d1eed2589ca7d9a1b2d5bb546978ac6485461"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c8370641f1a7f0e0669ddccca22f1da893cef7628396431eb445d46d893e5cd"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c8362467a0fdeccd47935f22c256bec5e6abe543bf0d66e3d3d57a8fb5731863"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:11a8c85ef4a07a7638180bf04fe189d12757c696eb41f310d2426895356dcf05"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b316144e85316da2723f9d8dc75bada12fa58489a527091fa1d5a612643d1a0e"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cf1ea2e34868f6fbf070e1af291c8180480310173de0b0c43fc38a02929fc0e3"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:e546e768d08ad55b20b11dbb78a745151acbd938f8f00d0cfbabe8b0199b9880"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:4901165d170a5fde6f589acb90a6b33629ad1ec976d4529e769c6f3d885e3e80"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:618a3d6cae6ef8ec88bb76dd80b83cfe415ad4f1d942ca2a903bf6b6ff97a2da"}, - {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:ed4eb745efbff0a8e9587d22a84be94a5eb7d2d99c02dacf7bd0911713ed14dd"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c81e5f372cd0dc5dc4809553d34f832f60a46034a5f187756d9b90586c2c307"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:43fbac5f22e25bee1d482c97474f930a353542855f05c1161fd804c9dc74a09d"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6d7faa6f14017c0b1e69f5e2c357b998731ea75a442ab3841c0dbbbfe902d2c4"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:08231ac30a842bd04daabc4d71fddd7e6d26189406d5a69535638e4dcb88fe76"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:044a3e61a7c2dafacae99d1e722cc2d4c05280790ec5a05031b3876809d89a5c"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3f26b5bd1079acdb0c7a5645e350fe54d16b17bfc5e71f371c449383d3342e17"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:482103aed1dfe2f3b71a58eff35ba105289b8d862551ea576bd15479aba01f66"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1374f4129f9bcca53a1bba0bb86bf78325a0374577cf7e9e4cd046b1e6f20e24"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:635dc434ff724b178cb192c70016cc0ad25a275228f749ee0daf0eddbc8183b1"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:bc362ee4e314870a70f4ae88772d72d877246537d9f8cb8f7eacf10884862432"}, - {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:4832d7d380477521a8c1644bbab6588dfedea5e30a7d967b5fb75977c45fd77f"}, - {file = "rpds_py-0.18.0.tar.gz", hash = "sha256:42821446ee7a76f5d9f71f9e33a4fb2ffd724bb3e7f93386150b61a43115788d"}, + {file = "rpds_py-0.18.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:d31dea506d718693b6b2cffc0648a8929bdc51c70a311b2770f09611caa10d53"}, + {file = "rpds_py-0.18.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:732672fbc449bab754e0b15356c077cc31566df874964d4801ab14f71951ea80"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a98a1f0552b5f227a3d6422dbd61bc6f30db170939bd87ed14f3c339aa6c7c9"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7f1944ce16401aad1e3f7d312247b3d5de7981f634dc9dfe90da72b87d37887d"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:38e14fb4e370885c4ecd734f093a2225ee52dc384b86fa55fe3f74638b2cfb09"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:08d74b184f9ab6289b87b19fe6a6d1a97fbfea84b8a3e745e87a5de3029bf944"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d70129cef4a8d979caa37e7fe957202e7eee8ea02c5e16455bc9808a59c6b2f0"}, + {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ce0bb20e3a11bd04461324a6a798af34d503f8d6f1aa3d2aa8901ceaf039176d"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:81c5196a790032e0fc2464c0b4ab95f8610f96f1f2fa3d4deacce6a79852da60"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:f3027be483868c99b4985fda802a57a67fdf30c5d9a50338d9db646d590198da"}, + {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d44607f98caa2961bab4fa3c4309724b185b464cdc3ba6f3d7340bac3ec97cc1"}, + {file = "rpds_py-0.18.1-cp310-none-win32.whl", hash = "sha256:c273e795e7a0f1fddd46e1e3cb8be15634c29ae8ff31c196debb620e1edb9333"}, + {file = "rpds_py-0.18.1-cp310-none-win_amd64.whl", hash = "sha256:8352f48d511de5f973e4f2f9412736d7dea76c69faa6d36bcf885b50c758ab9a"}, + {file = "rpds_py-0.18.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:6b5ff7e1d63a8281654b5e2896d7f08799378e594f09cf3674e832ecaf396ce8"}, + {file = "rpds_py-0.18.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8927638a4d4137a289e41d0fd631551e89fa346d6dbcfc31ad627557d03ceb6d"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:154bf5c93d79558b44e5b50cc354aa0459e518e83677791e6adb0b039b7aa6a7"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:07f2139741e5deb2c5154a7b9629bc5aa48c766b643c1a6750d16f865a82c5fc"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8c7672e9fba7425f79019db9945b16e308ed8bc89348c23d955c8c0540da0a07"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:489bdfe1abd0406eba6b3bb4fdc87c7fa40f1031de073d0cfb744634cc8fa261"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3c20f05e8e3d4fc76875fc9cb8cf24b90a63f5a1b4c5b9273f0e8225e169b100"}, + {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:967342e045564cef76dfcf1edb700b1e20838d83b1aa02ab313e6a497cf923b8"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:2cc7c1a47f3a63282ab0f422d90ddac4aa3034e39fc66a559ab93041e6505da7"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:f7afbfee1157e0f9376c00bb232e80a60e59ed716e3211a80cb8506550671e6e"}, + {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:9e6934d70dc50f9f8ea47081ceafdec09245fd9f6032669c3b45705dea096b88"}, + {file = "rpds_py-0.18.1-cp311-none-win32.whl", hash = "sha256:c69882964516dc143083d3795cb508e806b09fc3800fd0d4cddc1df6c36e76bb"}, + {file = "rpds_py-0.18.1-cp311-none-win_amd64.whl", hash = "sha256:70a838f7754483bcdc830444952fd89645569e7452e3226de4a613a4c1793fb2"}, + {file = "rpds_py-0.18.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3dd3cd86e1db5aadd334e011eba4e29d37a104b403e8ca24dcd6703c68ca55b3"}, + {file = "rpds_py-0.18.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:05f3d615099bd9b13ecf2fc9cf2d839ad3f20239c678f461c753e93755d629ee"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:35b2b771b13eee8729a5049c976197ff58a27a3829c018a04341bcf1ae409b2b"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ee17cd26b97d537af8f33635ef38be873073d516fd425e80559f4585a7b90c43"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b646bf655b135ccf4522ed43d6902af37d3f5dbcf0da66c769a2b3938b9d8184"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19ba472b9606c36716062c023afa2484d1e4220548751bda14f725a7de17b4f6"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e30ac5e329098903262dc5bdd7e2086e0256aa762cc8b744f9e7bf2a427d3f8"}, + {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d58ad6317d188c43750cb76e9deacf6051d0f884d87dc6518e0280438648a9ac"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e1735502458621921cee039c47318cb90b51d532c2766593be6207eec53e5c4c"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:f5bab211605d91db0e2995a17b5c6ee5edec1270e46223e513eaa20da20076ac"}, + {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:2fc24a329a717f9e2448f8cd1f960f9dac4e45b6224d60734edeb67499bab03a"}, + {file = "rpds_py-0.18.1-cp312-none-win32.whl", hash = "sha256:1805d5901779662d599d0e2e4159d8a82c0b05faa86ef9222bf974572286b2b6"}, + {file = "rpds_py-0.18.1-cp312-none-win_amd64.whl", hash = "sha256:720edcb916df872d80f80a1cc5ea9058300b97721efda8651efcd938a9c70a72"}, + {file = "rpds_py-0.18.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:c827576e2fa017a081346dce87d532a5310241648eb3700af9a571a6e9fc7e74"}, + {file = "rpds_py-0.18.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:aa3679e751408d75a0b4d8d26d6647b6d9326f5e35c00a7ccd82b78ef64f65f8"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0abeee75434e2ee2d142d650d1e54ac1f8b01e6e6abdde8ffd6eeac6e9c38e20"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ed402d6153c5d519a0faf1bb69898e97fb31613b49da27a84a13935ea9164dfc"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:338dee44b0cef8b70fd2ef54b4e09bb1b97fc6c3a58fea5db6cc083fd9fc2724"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7750569d9526199c5b97e5a9f8d96a13300950d910cf04a861d96f4273d5b104"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:607345bd5912aacc0c5a63d45a1f73fef29e697884f7e861094e443187c02be5"}, + {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:207c82978115baa1fd8d706d720b4a4d2b0913df1c78c85ba73fe6c5804505f0"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:6d1e42d2735d437e7e80bab4d78eb2e459af48c0a46e686ea35f690b93db792d"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:5463c47c08630007dc0fe99fb480ea4f34a89712410592380425a9b4e1611d8e"}, + {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:06d218939e1bf2ca50e6b0ec700ffe755e5216a8230ab3e87c059ebb4ea06afc"}, + {file = "rpds_py-0.18.1-cp38-none-win32.whl", hash = "sha256:312fe69b4fe1ffbe76520a7676b1e5ac06ddf7826d764cc10265c3b53f96dbe9"}, + {file = "rpds_py-0.18.1-cp38-none-win_amd64.whl", hash = "sha256:9437ca26784120a279f3137ee080b0e717012c42921eb07861b412340f85bae2"}, + {file = "rpds_py-0.18.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:19e515b78c3fc1039dd7da0a33c28c3154458f947f4dc198d3c72db2b6b5dc93"}, + {file = "rpds_py-0.18.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a7b28c5b066bca9a4eb4e2f2663012debe680f097979d880657f00e1c30875a0"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:673fdbbf668dd958eff750e500495ef3f611e2ecc209464f661bc82e9838991e"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d960de62227635d2e61068f42a6cb6aae91a7fe00fca0e3aeed17667c8a34611"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:352a88dc7892f1da66b6027af06a2e7e5d53fe05924cc2cfc56495b586a10b72"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4e0ee01ad8260184db21468a6e1c37afa0529acc12c3a697ee498d3c2c4dcaf3"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4c39ad2f512b4041343ea3c7894339e4ca7839ac38ca83d68a832fc8b3748ab"}, + {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aaa71ee43a703c321906813bb252f69524f02aa05bf4eec85f0c41d5d62d0f4c"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:6cd8098517c64a85e790657e7b1e509b9fe07487fd358e19431cb120f7d96338"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:4adec039b8e2928983f885c53b7cc4cda8965b62b6596501a0308d2703f8af1b"}, + {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:32b7daaa3e9389db3695964ce8e566e3413b0c43e3394c05e4b243a4cd7bef26"}, + {file = "rpds_py-0.18.1-cp39-none-win32.whl", hash = "sha256:2625f03b105328729f9450c8badda34d5243231eef6535f80064d57035738360"}, + {file = "rpds_py-0.18.1-cp39-none-win_amd64.whl", hash = "sha256:bf18932d0003c8c4d51a39f244231986ab23ee057d235a12b2684ea26a353590"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:cbfbea39ba64f5e53ae2915de36f130588bba71245b418060ec3330ebf85678e"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:a3d456ff2a6a4d2adcdf3c1c960a36f4fd2fec6e3b4902a42a384d17cf4e7a65"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7700936ef9d006b7ef605dc53aa364da2de5a3aa65516a1f3ce73bf82ecfc7ae"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:51584acc5916212e1bf45edd17f3a6b05fe0cbb40482d25e619f824dccb679de"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:942695a206a58d2575033ff1e42b12b2aece98d6003c6bc739fbf33d1773b12f"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b906b5f58892813e5ba5c6056d6a5ad08f358ba49f046d910ad992196ea61397"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6f8e3fecca256fefc91bb6765a693d96692459d7d4c644660a9fff32e517843"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:7732770412bab81c5a9f6d20aeb60ae943a9b36dcd990d876a773526468e7163"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:bd1105b50ede37461c1d51b9698c4f4be6e13e69a908ab7751e3807985fc0346"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:618916f5535784960f3ecf8111581f4ad31d347c3de66d02e728de460a46303c"}, + {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:17c6d2155e2423f7e79e3bb18151c686d40db42d8645e7977442170c360194d4"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c4c4c3f878df21faf5fac86eda32671c27889e13570645a9eea0a1abdd50922"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:fab6ce90574645a0d6c58890e9bcaac8d94dff54fb51c69e5522a7358b80ab64"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:531796fb842b53f2695e94dc338929e9f9dbf473b64710c28af5a160b2a8927d"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:740884bc62a5e2bbb31e584f5d23b32320fd75d79f916f15a788d527a5e83644"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:998125738de0158f088aef3cb264a34251908dd2e5d9966774fdab7402edfab7"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e2be6e9dd4111d5b31ba3b74d17da54a8319d8168890fbaea4b9e5c3de630ae5"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d0cee71bc618cd93716f3c1bf56653740d2d13ddbd47673efa8bf41435a60daa"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2c3caec4ec5cd1d18e5dd6ae5194d24ed12785212a90b37f5f7f06b8bedd7139"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:27bba383e8c5231cd559affe169ca0b96ec78d39909ffd817f28b166d7ddd4d8"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:a888e8bdb45916234b99da2d859566f1e8a1d2275a801bb8e4a9644e3c7e7909"}, + {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:6031b25fb1b06327b43d841f33842b383beba399884f8228a6bb3df3088485ff"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:48c2faaa8adfacefcbfdb5f2e2e7bdad081e5ace8d182e5f4ade971f128e6bb3"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:d85164315bd68c0806768dc6bb0429c6f95c354f87485ee3593c4f6b14def2bd"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6afd80f6c79893cfc0574956f78a0add8c76e3696f2d6a15bca2c66c415cf2d4"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa242ac1ff583e4ec7771141606aafc92b361cd90a05c30d93e343a0c2d82a89"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d21be4770ff4e08698e1e8e0bce06edb6ea0626e7c8f560bc08222880aca6a6f"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5c45a639e93a0c5d4b788b2613bd637468edd62f8f95ebc6fcc303d58ab3f0a8"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:910e71711d1055b2768181efa0a17537b2622afeb0424116619817007f8a2b10"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b9bb1f182a97880f6078283b3505a707057c42bf55d8fca604f70dedfdc0772a"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d54f74f40b1f7aaa595a02ff42ef38ca654b1469bef7d52867da474243cc633"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:8d2e182c9ee01135e11e9676e9a62dfad791a7a467738f06726872374a83db49"}, + {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:636a15acc588f70fda1661234761f9ed9ad79ebed3f2125d44be0862708b666e"}, + {file = "rpds_py-0.18.1.tar.gz", hash = "sha256:dc48b479d540770c811fbd1eb9ba2bb66951863e448efec2e2c102625328e92f"}, ] [[package]] @@ -2782,13 +2782,13 @@ files = [ [[package]] name = "tqdm" -version = "4.66.2" +version = "4.66.4" description = "Fast, Extensible Progress Meter" optional = false python-versions = ">=3.7" files = [ - {file = "tqdm-4.66.2-py3-none-any.whl", hash = "sha256:1ee4f8a893eb9bef51c6e35730cebf234d5d0b6bd112b0271e10ed7c24a02bd9"}, - {file = "tqdm-4.66.2.tar.gz", hash = "sha256:6cd52cdf0fef0e0f543299cfc96fec90d7b8a7e88745f411ec33eb44d5ed3531"}, + {file = "tqdm-4.66.4-py3-none-any.whl", hash = "sha256:b75ca56b413b030bc3f00af51fd2c1a1a5eac6a0c1cca83cbb37a5c52abce644"}, + {file = "tqdm-4.66.4.tar.gz", hash = "sha256:e4d936c9de8727928f3be6079590e97d9abfe8d39a590be678eb5919ffc186bb"}, ] [package.dependencies] @@ -3009,18 +3009,18 @@ test = ["websockets"] [[package]] name = "zipp" -version = "3.18.1" +version = "3.18.2" description = "Backport of pathlib-compatible object wrapper for zip files" optional = false python-versions = ">=3.8" files = [ - {file = "zipp-3.18.1-py3-none-any.whl", hash = "sha256:206f5a15f2af3dbaee80769fb7dc6f249695e940acca08dfb2a4769fe61e538b"}, - {file = "zipp-3.18.1.tar.gz", hash = "sha256:2884ed22e7d8961de1c9a05142eb69a247f120291bc0206a00a7642f09b5b715"}, + {file = "zipp-3.18.2-py3-none-any.whl", hash = "sha256:dce197b859eb796242b0622af1b8beb0a722d52aa2f57133ead08edd5bf5374e"}, + {file = "zipp-3.18.2.tar.gz", hash = "sha256:6278d9ddbcfb1f1089a88fde84481528b07b0e10474e09dcfe53dad4069fa059"}, ] [package.extras] docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] +testing = ["big-O", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"] [metadata] lock-version = "2.0" diff --git a/sdks/python/pyproject.toml b/sdks/python/pyproject.toml index 8cdd58fbc..164640439 100644 --- a/sdks/python/pyproject.toml +++ b/sdks/python/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "julep" -version = "0.3.2" +version = "0.3.3" description = "Julep is a platform for creating agents with long-term memory" authors = ["Julep Developers "] license = "ISC" diff --git a/sdks/ts/package-lock.json b/sdks/ts/package-lock.json index 2cc1421f9..25daa1d2c 100644 --- a/sdks/ts/package-lock.json +++ b/sdks/ts/package-lock.json @@ -1,12 +1,12 @@ { "name": "@julep/sdk", - "version": "0.3.0", + "version": "0.3.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@julep/sdk", - "version": "0.3.0", + "version": "0.3.3", "license": "ISC", "dependencies": { "@rollup/plugin-typescript": "^11.1.6", diff --git a/sdks/ts/package.json b/sdks/ts/package.json index 153efac5a..8231cf2a0 100644 --- a/sdks/ts/package.json +++ b/sdks/ts/package.json @@ -1,6 +1,6 @@ { "name": "@julep/sdk", - "version": "0.3.2", + "version": "0.3.3", "description": "Julep is a platform for creating agents with long-term memory", "keywords": [ "julep-ai", @@ -75,7 +75,7 @@ "start_mock_api": "prism mock ./tests/mock_openapi.yaml -p 8080 -v fatal 1> /dev/null &", "kill_mock_api": "kill $(pgrep -f 'prism .*') || echo bye", "format": "prettier -w .", - "openapi-codegen": "openapi -c axios --name JulepApiClient --useOptions --indent 2 -i <(yq -o=json '.' ../../openapi.yaml) -o src/api --exportSchemas true --useUnionTypes true", + "openapi-codegen": "bash -c 'openapi -c axios --name JulepApiClient --useOptions --indent 2 -i <(yq \".\" ../../openapi.yaml) -o src/api --exportSchemas true --useUnionTypes true'", "codegen": "npm run openapi-codegen && npm run format", "generate-docs": "typedoc --plugin typedoc-plugin-markdown --out ../../docs/js-sdk-docs src/**/*.ts", "test-inspect": "node --inspect-brk node_modules/.bin/jest --runInBand", diff --git a/sdks/ts/src/api/index.ts b/sdks/ts/src/api/index.ts index 2393d9be3..3e0dc5da8 100644 --- a/sdks/ts/src/api/index.ts +++ b/sdks/ts/src/api/index.ts @@ -26,6 +26,7 @@ export type { CreateToolRequest } from "./models/CreateToolRequest"; export type { CreateUserRequest } from "./models/CreateUserRequest"; export type { Doc } from "./models/Doc"; export type { doc_id } from "./models/doc_id"; +export type { DocIds } from "./models/DocIds"; export type { FunctionCallOption } from "./models/FunctionCallOption"; export type { FunctionDef } from "./models/FunctionDef"; export type { FunctionParameters } from "./models/FunctionParameters"; @@ -74,6 +75,7 @@ export { $CreateToolRequest } from "./schemas/$CreateToolRequest"; export { $CreateUserRequest } from "./schemas/$CreateUserRequest"; export { $Doc } from "./schemas/$Doc"; export { $doc_id } from "./schemas/$doc_id"; +export { $DocIds } from "./schemas/$DocIds"; export { $FunctionCallOption } from "./schemas/$FunctionCallOption"; export { $FunctionDef } from "./schemas/$FunctionDef"; export { $FunctionParameters } from "./schemas/$FunctionParameters"; diff --git a/sdks/ts/src/api/models/ChatResponse.ts b/sdks/ts/src/api/models/ChatResponse.ts index e880bc927..6614069fe 100644 --- a/sdks/ts/src/api/models/ChatResponse.ts +++ b/sdks/ts/src/api/models/ChatResponse.ts @@ -4,6 +4,7 @@ /* eslint-disable */ import type { ChatMLMessage } from "./ChatMLMessage"; import type { CompletionUsage } from "./CompletionUsage"; +import type { DocIds } from "./DocIds"; /** * Represents a chat completion response returned by model, based on the provided input. */ @@ -30,4 +31,5 @@ export type ChatResponse = { * IDs (if any) of jobs created as part of this request */ jobs?: Array; + doc_ids: DocIds; }; diff --git a/sdks/ts/src/api/models/CreateDoc.ts b/sdks/ts/src/api/models/CreateDoc.ts index 437fa1535..ff4542a0c 100644 --- a/sdks/ts/src/api/models/CreateDoc.ts +++ b/sdks/ts/src/api/models/CreateDoc.ts @@ -10,7 +10,7 @@ export type CreateDoc = { /** * Information content */ - content: string; + content: Array | string; /** * Optional metadata */ diff --git a/sdks/ts/src/api/models/Doc.ts b/sdks/ts/src/api/models/Doc.ts index c19f2b84c..4e190d21f 100644 --- a/sdks/ts/src/api/models/Doc.ts +++ b/sdks/ts/src/api/models/Doc.ts @@ -10,7 +10,7 @@ export type Doc = { /** * Information content */ - content: string; + content: Array | string; /** * ID of doc */ diff --git a/sdks/ts/src/api/models/DocIds.ts b/sdks/ts/src/api/models/DocIds.ts new file mode 100644 index 000000000..c33bb4948 --- /dev/null +++ b/sdks/ts/src/api/models/DocIds.ts @@ -0,0 +1,8 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type DocIds = { + agent_doc_ids: Array; + user_doc_ids: Array; +}; diff --git a/sdks/ts/src/api/schemas/$ChatResponse.ts b/sdks/ts/src/api/schemas/$ChatResponse.ts index c30f28c57..3c19ea0fc 100644 --- a/sdks/ts/src/api/schemas/$ChatResponse.ts +++ b/sdks/ts/src/api/schemas/$ChatResponse.ts @@ -36,5 +36,9 @@ export const $ChatResponse = { format: "uuid", }, }, + doc_ids: { + type: "DocIds", + isRequired: true, + }, }, } as const; diff --git a/sdks/ts/src/api/schemas/$CreateDoc.ts b/sdks/ts/src/api/schemas/$CreateDoc.ts index 8e7e7b002..85d4bafa0 100644 --- a/sdks/ts/src/api/schemas/$CreateDoc.ts +++ b/sdks/ts/src/api/schemas/$CreateDoc.ts @@ -10,8 +10,21 @@ export const $CreateDoc = { isRequired: true, }, content: { - type: "string", + type: "one-of", description: `Information content`, + contains: [ + { + type: "array", + contains: { + type: "string", + minItems: 1, + }, + }, + { + type: "string", + description: `A single document chunk`, + }, + ], isRequired: true, }, metadata: { diff --git a/sdks/ts/src/api/schemas/$Doc.ts b/sdks/ts/src/api/schemas/$Doc.ts index 549052b3d..8f79f21f9 100644 --- a/sdks/ts/src/api/schemas/$Doc.ts +++ b/sdks/ts/src/api/schemas/$Doc.ts @@ -10,8 +10,21 @@ export const $Doc = { isRequired: true, }, content: { - type: "string", + type: "one-of", description: `Information content`, + contains: [ + { + type: "array", + contains: { + type: "string", + minItems: 1, + }, + }, + { + type: "string", + description: `A single document chunk`, + }, + ], isRequired: true, }, id: { diff --git a/sdks/ts/src/api/schemas/$DocIds.ts b/sdks/ts/src/api/schemas/$DocIds.ts new file mode 100644 index 000000000..594e9771a --- /dev/null +++ b/sdks/ts/src/api/schemas/$DocIds.ts @@ -0,0 +1,22 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export const $DocIds = { + properties: { + agent_doc_ids: { + type: "array", + contains: { + type: "string", + }, + isRequired: true, + }, + user_doc_ids: { + type: "array", + contains: { + type: "string", + }, + isRequired: true, + }, + }, +} as const;