Index

_

__init__() (genai.ApiClient method) (genai.Client method) (genai.client.Client method) (genai.Credentials method) (genai.credentials.Credentials method) (genai.exceptions.ApiNetworkException method) (genai.exceptions.ApiResponseException method) (genai.extensions.huggingface.agent.IBMGenAIAgent method) (genai.extensions.huggingface.IBMGenAIAgent method) (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) (genai.extensions.localserver.local_api_server.ApiAuthMiddleware method) (genai.extensions.localserver.local_api_server.ApiErrorMiddleware method) (genai.extensions.localserver.local_api_server.LocalLLMServer method) (genai.extensions.localserver.LocalLLMServer method) (genai.request.request_service.RequestService method) (genai.text.chat.chat_generation_service.ChatService method) (genai.text.embedding.embedding_service.EmbeddingService method) (genai.text.generation.generation_service.GenerationService method) (genai.text.text_service.TextService method)

A

achat() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) acomplete() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) aembed_documents() (genai.extensions.langchain.LangChainEmbeddingsInterface method) aembed_query() (genai.extensions.langchain.LangChainEmbeddingsInterface method) api_client_config (genai.client.BaseConfig attribute) api_endpoint (genai.Credentials attribute) (genai.credentials.Credentials attribute) api_key (genai.Credentials attribute) (genai.credentials.Credentials attribute)

ApiAuthMiddleware (class in genai.extensions.localserver.local_api_server) ApiClient (class in genai) ApiErrorMiddleware (class in genai.extensions.localserver.local_api_server) ApiNetworkException ApiResponseException aretrieve() (genai.text.embedding.limit.limit_service.LimitService method) (genai.text.generation.limits.limit_service.LimitService method) astream_chat() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) astream_complete() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method)

B

BaseApiException

batch_size (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute)

C

cache (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) callback (genai.text.embedding.embedding_service.CreateExecutionOptions attribute) (genai.text.generation.generation_service.CreateExecutionOptions attribute) (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute) callback_manager (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) callbacks (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) chat() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) (genai.request.request_service.RequestService method) chat_delete() (genai.request.request_service.RequestService method) ChatService (class in genai.text.chat.chat_generation_service) (genai.text.text_service.BaseServices attribute) class_name() (genai.extensions.llama_index.IBMGenAILlamaIndex class method) (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding class method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex class method) Client (class in genai) (class in genai.client) client (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainEmbeddingsInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) compare() (genai.text.generation.generation_service.GenerationService method) complete() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) completion_to_prompt (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute)

concurrency_limit (genai.text.embedding.embedding_service.CreateExecutionOptions attribute) (genai.text.generation.generation_service.CreateExecutionOptions attribute) (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute) Config (genai.ApiClient attribute) (genai.Client attribute) (genai.client.Client attribute) (genai.text.embedding.embedding_service.EmbeddingService attribute) (genai.text.generation.generation_service.GenerationService attribute) (genai.text.moderation.moderation_service.ModerationService attribute) (genai.text.tokenization.tokenization_service.TokenizationService attribute) conversation_id (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) create() (genai.file.file_service.FileService method) (genai.prompt.prompt_service.PromptService method) (genai.text.chat.chat_generation_service.ChatService method) (genai.text.embedding.embedding_service.EmbeddingService method) (genai.text.generation.generation_service.GenerationService method) (genai.text.moderation.moderation_service.ModerationService method) (genai.text.tokenization.tokenization_service.TokenizationService method) (genai.tune.tune_service.TuneService method) (genai.user.user_service.UserService method) create_execution_options (genai.text.embedding.embedding_service.BaseConfig attribute) (genai.text.generation.generation_service.BaseConfig attribute) (genai.text.moderation.moderation_service.BaseConfig attribute) (genai.text.tokenization.tokenization_service.BaseConfig attribute) create_from_file() (genai.tune.tune_service.TuneService method) create_llm_output() (in module genai.extensions.langchain.utils) create_stream() (genai.text.chat.chat_generation_service.ChatService method) (genai.text.generation.generation_service.GenerationService method) CustomAIMessageChunk (class in genai.extensions.langchain.utils) CustomChatGenerationChunk (class in genai.extensions.langchain.utils) CustomGenerationChunk (class in genai.extensions.langchain.utils)

D

data (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) (genai.extensions.localserver.schema.TextGenerationCreateRequest attribute) delete() (genai.file.file_service.FileService method) (genai.prompt.prompt_service.PromptService method) (genai.request.request_service.RequestService method) (genai.tune.tune_service.TuneService method) (genai.user.user_service.UserService method)

DeploymentService (genai.client.BaseServices attribute) dispatch() (genai.extensions.localserver.local_api_server.ApiAuthMiddleware method) (genai.extensions.localserver.local_api_server.ApiErrorMiddleware method) dump_optional_model() (in module genai.extensions.langchain.utils)

E

embed_batch_size (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding attribute) embed_documents() (genai.extensions.langchain.LangChainEmbeddingsInterface method) embed_query() (genai.extensions.langchain.LangChainEmbeddingsInterface method) EmbeddingService (class in genai.text.embedding.embedding_service) (genai.text.text_service.BaseServices attribute) error_count() (genai.exceptions.ValidationError method)

errors() (genai.exceptions.ValidationError method) execution_options (genai.extensions.langchain.LangChainEmbeddingsInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding attribute) ExperimentalService (genai.text.text_service.BaseServices attribute)

F

FeedbackService (genai.request.request_service.BaseServices attribute) file (genai.Client attribute) (genai.client.Client attribute) FileService (class in genai.file.file_service) (genai.client.BaseServices attribute) folder (genai.Client attribute) (genai.client.Client attribute)

FolderService (genai.client.BaseServices attribute) from_env() (genai.Credentials class method) (genai.credentials.Credentials class method) from_exception_data() (genai.exceptions.ValidationError static method) from_http_response() (genai.exceptions.ApiResponseException class method) from_langchain_template() (in module genai.extensions.langchain) (in module genai.extensions.langchain.template)

G

genai module genai.client module genai.credentials module genai.exceptions module genai.extensions module genai.extensions.huggingface module genai.extensions.huggingface.agent module genai.extensions.langchain module genai.extensions.langchain.chat_llm module genai.extensions.langchain.llm module genai.extensions.langchain.template module genai.extensions.langchain.utils module genai.extensions.llama_index module genai.extensions.llama_index.llm module genai.extensions.localserver module genai.extensions.localserver.local_api_server module genai.extensions.localserver.local_base_model module genai.extensions.localserver.schema module genai.file module genai.file.file_service module genai.model module genai.model.model_service module genai.prompt module genai.prompt.prompt_service module genai.request module genai.request.request_service module genai.text module genai.text.chat module genai.text.chat.chat_generation_service module

genai.text.embedding module genai.text.embedding.embedding_service module genai.text.embedding.limit module genai.text.embedding.limit.limit_service module genai.text.generation module genai.text.generation.generation_service module genai.text.generation.limits module genai.text.generation.limits.limit_service module genai.text.moderation module genai.text.moderation.moderation_service module genai.text.text_service module genai.text.tokenization module genai.text.tokenization.tokenization_service module genai.tune module genai.tune.tune_service module genai.user module genai.user.user_service module generate() (genai.extensions.localserver.local_base_model.LocalModel method) (genai.extensions.localserver.LocalModel method) generate_many() (genai.extensions.huggingface.agent.IBMGenAIAgent method) (genai.extensions.huggingface.IBMGenAIAgent method) generate_one() (genai.extensions.huggingface.agent.IBMGenAIAgent method) (genai.extensions.huggingface.IBMGenAIAgent method) GenerationService (class in genai.text.generation.generation_service) (genai.text.text_service.BaseServices attribute) get_async_http_client() (genai.ApiClient method) get_credentials() (genai.extensions.localserver.local_api_server.LocalLLMServer method) (genai.extensions.localserver.LocalLLMServer method) get_http_client() (genai.ApiClient method) get_num_tokens() (genai.extensions.langchain.chat_llm.LangChainChatInterface method) (genai.extensions.langchain.LangChainChatInterface method) (genai.extensions.langchain.LangChainInterface method) (genai.extensions.langchain.llm.LangChainInterface method) get_num_tokens_from_messages() (genai.extensions.langchain.chat_llm.LangChainChatInterface method) (genai.extensions.langchain.LangChainChatInterface method) (genai.extensions.langchain.LangChainInterface method) (genai.extensions.langchain.llm.LangChainInterface method) get_token_ids() (genai.extensions.langchain.chat_llm.LangChainChatInterface method) (genai.extensions.langchain.LangChainChatInterface method) (genai.extensions.langchain.LangChainInterface method) (genai.extensions.langchain.llm.LangChainInterface method)

H

handle_shutdown_event() (in module genai)

I

IBMGenAIAgent (class in genai.extensions.huggingface) (class in genai.extensions.huggingface.agent) IBMGenAILlamaIndex (class in genai.extensions.llama_index) (class in genai.extensions.llama_index.llm) IBMGenAILlamaIndexEmbedding (class in genai.extensions.llama_index)

input (genai.extensions.localserver.schema.TextGenerationCreateRequest attribute) (genai.extensions.localserver.schema.TextTokenizationCreateRequest attribute) is_lc_serializable() (genai.extensions.langchain.chat_llm.LangChainChatInterface class method) (genai.extensions.langchain.LangChainChatInterface class method) (genai.extensions.langchain.LangChainInterface class method) (genai.extensions.langchain.llm.LangChainInterface class method)

J

json() (genai.exceptions.ValidationError method)

L

LangChainChatInterface (class in genai.extensions.langchain) (class in genai.extensions.langchain.chat_llm) LangChainInterface (class in genai.extensions.langchain) (class in genai.extensions.langchain.llm) lc_secrets (genai.extensions.langchain.chat_llm.LangChainChatInterface property) (genai.extensions.langchain.LangChainChatInterface property) (genai.extensions.langchain.LangChainInterface property) (genai.extensions.langchain.llm.LangChainInterface property) LimitService (class in genai.text.embedding.limit.limit_service) (class in genai.text.generation.limits.limit_service) (genai.text.embedding.embedding_service.BaseServices attribute) (genai.text.generation.generation_service.BaseServices attribute) list() (genai.file.file_service.FileService method) (genai.model.model_service.ModelService method) (genai.prompt.prompt_service.PromptService method) (genai.request.request_service.RequestService method) (genai.tune.tune_service.TuneService method)

load_config() (in module genai.extensions.langchain.utils) load_from_file() (genai.extensions.langchain.chat_llm.LangChainChatInterface class method) (genai.extensions.langchain.LangChainChatInterface class method) (genai.extensions.langchain.LangChainInterface class method) (genai.extensions.langchain.llm.LangChainInterface class method) LocalLLMServer (class in genai.extensions.localserver) (class in genai.extensions.localserver.local_api_server) LocalModel (class in genai.extensions.localserver) (class in genai.extensions.localserver.local_base_model)

M

message (genai.exceptions.ApiNetworkException attribute) (genai.exceptions.BaseApiException attribute) messages_to_prompt (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) metadata (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex property) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex property) model (genai.Client attribute) (genai.client.Client attribute) model_id (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainEmbeddingsInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) (genai.extensions.localserver.local_base_model.LocalModel property) (genai.extensions.localserver.LocalModel property) (genai.extensions.localserver.schema.TextGenerationCreateRequest attribute) (genai.extensions.localserver.schema.TextTokenizationCreateRequest attribute) ModelService (class in genai.model.model_service) (genai.client.BaseServices attribute) moderations (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) (genai.extensions.localserver.schema.TextGenerationCreateRequest attribute) ModerationService (class in genai.text.moderation.moderation_service) (genai.text.text_service.BaseServices attribute) module genai genai.client genai.credentials genai.exceptions genai.extensions genai.extensions.huggingface genai.extensions.huggingface.agent genai.extensions.langchain genai.extensions.langchain.chat_llm genai.extensions.langchain.llm genai.extensions.langchain.template genai.extensions.langchain.utils genai.extensions.llama_index genai.extensions.llama_index.llm genai.extensions.localserver genai.extensions.localserver.local_api_server genai.extensions.localserver.local_base_model genai.extensions.localserver.schema genai.file genai.file.file_service genai.model genai.model.model_service genai.prompt genai.prompt.prompt_service genai.request genai.request.request_service genai.text genai.text.chat genai.text.chat.chat_generation_service genai.text.embedding genai.text.embedding.embedding_service genai.text.embedding.limit genai.text.embedding.limit.limit_service genai.text.generation genai.text.generation.generation_service genai.text.generation.limits genai.text.generation.limits.limit_service genai.text.moderation genai.text.moderation.moderation_service genai.text.text_service genai.text.tokenization genai.text.tokenization.tokenization_service genai.tune genai.tune.tune_service genai.user genai.user.user_service

O

ordered (genai.text.embedding.embedding_service.CreateExecutionOptions attribute) (genai.text.generation.generation_service.CreateExecutionOptions attribute) (genai.text.moderation.moderation_service.CreateExecutionOptions attribute) (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute)

output_parser (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute)

P

parameters (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainEmbeddingsInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.IBMGenAILlamaIndexEmbedding attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) (genai.extensions.localserver.schema.TextGenerationCreateRequest attribute) (genai.extensions.localserver.schema.TextTokenizationCreateRequest attribute) parent_id (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) prompt (genai.Client attribute) (genai.client.Client attribute)

prompt_id (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) (genai.extensions.localserver.schema.TextTokenizationCreateRequest attribute) prompt_template_id (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) PromptService (class in genai.prompt.prompt_service) (genai.client.BaseServices attribute) pydantic_program_mode (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute)

Q

query_wrapper_prompt (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute)

R

rate_limit_options (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute) read() (genai.file.file_service.FileService method) (genai.tune.tune_service.TuneService method) request (genai.Client attribute) (genai.client.Client attribute) RequestService (class in genai.request.request_service) (genai.client.BaseServices attribute) (genai.text.chat.chat_generation_service.BaseServices attribute) response (genai.exceptions.ApiResponseException attribute)

retrieve() (genai.file.file_service.FileService method) (genai.model.model_service.ModelService method) (genai.prompt.prompt_service.PromptService method) (genai.text.embedding.limit.limit_service.LimitService method) (genai.text.generation.limits.limit_service.LimitService method) (genai.tune.tune_service.TuneService method) (genai.user.user_service.UserService method) run_locally() (genai.extensions.localserver.local_api_server.LocalLLMServer method) (genai.extensions.localserver.LocalLLMServer method)

S

Services (genai.Client attribute) (genai.client.Client attribute) (genai.request.request_service.RequestService attribute) (genai.text.chat.chat_generation_service.ChatService attribute) (genai.text.embedding.embedding_service.EmbeddingService attribute) (genai.text.generation.generation_service.GenerationService attribute) (genai.text.text_service.TextService attribute) start_server() (genai.extensions.localserver.local_api_server.LocalLLMServer method) (genai.extensions.localserver.LocalLLMServer method) stop_server() (genai.extensions.localserver.local_api_server.LocalLLMServer method) (genai.extensions.localserver.LocalLLMServer method)

stream_chat() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) stream_complete() (genai.extensions.llama_index.IBMGenAILlamaIndex method) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex method) streaming (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) system_prompt (genai.Client attribute) (genai.client.Client attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) SystemPromptService (genai.client.BaseServices attribute)

T

tag (genai.Client attribute) (genai.client.Client attribute) tags (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute) TagService (genai.client.BaseServices attribute) task (genai.Client attribute) (genai.client.Client attribute) TaskService (genai.client.BaseServices attribute) text (genai.Client attribute) (genai.client.Client attribute) TextService (class in genai.text.text_service) (genai.client.BaseServices attribute) throw_on_error (genai.text.embedding.embedding_service.CreateExecutionOptions attribute) (genai.text.generation.generation_service.CreateExecutionOptions attribute) (genai.text.moderation.moderation_service.CreateExecutionOptions attribute) (genai.text.tokenization.tokenization_service.CreateExecutionOptions attribute) title (genai.exceptions.ValidationError attribute)

to_genai_message() (in module genai.extensions.llama_index.llm) to_genai_messages() (in module genai.extensions.llama_index.llm) to_langchain_template() (in module genai.extensions.langchain) (in module genai.extensions.langchain.template) TokenizationService (class in genai.text.tokenization.tokenization_service) (genai.text.text_service.BaseServices attribute) tokenize() (genai.extensions.localserver.local_base_model.LocalModel method) (genai.extensions.localserver.LocalModel method) trim_method (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute) tune (genai.Client attribute) (genai.client.Client attribute) TuneService (class in genai.tune.tune_service) (genai.client.BaseServices attribute) types() (genai.tune.tune_service.TuneService method)

U

update() (genai.file.file_service.FileService method) (genai.prompt.prompt_service.PromptService method) (genai.user.user_service.UserService method) update_token_usage() (in module genai.extensions.langchain.utils) update_token_usage_stream() (in module genai.extensions.langchain.utils) use_conversation_parameters (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.LangChainChatInterface attribute) (genai.extensions.llama_index.IBMGenAILlamaIndex attribute) (genai.extensions.llama_index.llm.IBMGenAILlamaIndex attribute)

user (genai.Client attribute) (genai.client.Client attribute) UserService (class in genai.user.user_service) (genai.client.BaseServices attribute)

V

validate_data_models() (genai.extensions.langchain.chat_llm.LangChainChatInterface class method) (genai.extensions.langchain.LangChainChatInterface class method)

ValidationError verbose (genai.extensions.langchain.chat_llm.LangChainChatInterface attribute) (genai.extensions.langchain.llm.LangChainInterface attribute)