Foundation Models¶
Warning
Warning! Supported only for IBM watsonx.ai for IBM Cloud and IBM watsonx.ai software with IBM Cloud Pak® for Data 5.0 and later.
Modules¶
- Embeddings
- Models
- Modules
- ModelInference
ModelInferenceModelInference.achat()ModelInference.achat_stream()ModelInference.aclose_persistent_connection()ModelInference.agenerate()ModelInference.agenerate_stream()ModelInference.chat()ModelInference.chat_stream()ModelInference.close_persistent_connection()ModelInference.generate()ModelInference.generate_text()ModelInference.generate_text_stream()ModelInference.get_details()ModelInference.get_identifying_params()ModelInference.set_api_client()ModelInference.to_langchain()ModelInference.tokenize()
- Enums
- TSModelInference
- AudioModelInference
- Model
ModelInferencefor Deployments
- ModelInference
- Modules
- Tuning
- Working with TuneExperiment and PromptTuner
- Working with TuneExperiment and FineTuner
- Working with TuneExperiment and ILabTuner (BETA)
- Tuned Model Inference
- Tune Experiment
- InstructLab Experiment (BETA)
- Prompt Template Manager
PromptTemplateManagerPromptTemplateManager.add_chat_items()PromptTemplateManager.delete_prompt()PromptTemplateManager.get_lock()PromptTemplateManager.list()PromptTemplateManager.load_prompt()PromptTemplateManager.lock()PromptTemplateManager.store_prompt()PromptTemplateManager.unlock()PromptTemplateManager.update_prompt()
PromptTemplateFreeformPromptTemplateDetachedPromptTemplateChatPrompt- Enums
- Extensions
- LangChain
- LlamaIndex
- RAG
- Chunkers
- Retrievers
- Vector Stores
- VectorStore
VectorStoreVectorStore.add_documents()VectorStore.add_documents_async()VectorStore.as_langchain_retriever()VectorStore.clear()VectorStore.count()VectorStore.delete()VectorStore.from_dict()VectorStore.get_client()VectorStore.search()VectorStore.set_embeddings()VectorStore.to_dict()VectorStore.window_search()
- MilvusVectorStore
- ElasticsearchVectorStore
- DB2VectorStore
- BaseVectorStore
- VectorStoreConnector
- VectorStoreDataSourceType
- LangChainVectorStoreAdapter
LangChainVectorStoreAdapterLangChainVectorStoreAdapter.add_documents()LangChainVectorStoreAdapter.add_documents_async()LangChainVectorStoreAdapter.as_langchain_retriever()LangChainVectorStoreAdapter.clear()LangChainVectorStoreAdapter.count()LangChainVectorStoreAdapter.delete()LangChainVectorStoreAdapter.get_client()LangChainVectorStoreAdapter.search()LangChainVectorStoreAdapter.window_search()
- VectorStore
- Helpers
FoundationModelsManagerFoundationModelsManager.get_model_specs()FoundationModelsManager.get_chat_model_specs()FoundationModelsManager.get_chat_function_calling_model_specs()FoundationModelsManager.get_audio_chat_model_specs()FoundationModelsManager.get_text_generation_model_specs()FoundationModelsManager.get_custom_model_specs()FoundationModelsManager.get_embeddings_model_specs()FoundationModelsManager.get_time_series_model_specs()FoundationModelsManager.get_rerank_model_specs()FoundationModelsManager.get_audio_transcriptions_model_specs()FoundationModelsManager.get_base_foundation_model_deployable_specs()FoundationModelsManager.get_model_specs_with_prompt_tuning_support()FoundationModelsManager.get_model_specs_with_fine_tuning_support()FoundationModelsManager.get_model_specs_with_lora_fine_tuning_support()FoundationModelsManager.get_model_lifecycle()
get_model_specs()get_model_lifecycle()get_model_specs_with_prompt_tuning_support()get_supported_tasks()
- Custom models
- Text Detection
- Text Extractions
- Parameter Scheme
- Chat Parameters
TextChatParametersTextChatParameters.chat_template_kwargsTextChatParameters.frequency_penaltyTextChatParameters.guided_choiceTextChatParameters.guided_grammarTextChatParameters.guided_jsonTextChatParameters.guided_regexTextChatParameters.include_reasoningTextChatParameters.logit_biasTextChatParameters.logprobsTextChatParameters.max_completion_tokensTextChatParameters.max_tokensTextChatParameters.nTextChatParameters.presence_penaltyTextChatParameters.reasoning_effortTextChatParameters.response_formatTextChatParameters.seedTextChatParameters.stopTextChatParameters.temperatureTextChatParameters.time_limitTextChatParameters.top_logprobsTextChatParameters.top_p
TextChatResponseFormatTextChatResponseFormatTypeTextChatResponseJsonSchema
- Generate Parameters
TextGenParametersTextGenParameters.decoding_methodTextGenParameters.include_stop_sequenceTextGenParameters.length_penaltyTextGenParameters.max_new_tokensTextGenParameters.min_new_tokensTextGenParameters.prompt_variablesTextGenParameters.random_seedTextGenParameters.repetition_penaltyTextGenParameters.return_optionsTextGenParameters.stop_sequencesTextGenParameters.temperatureTextGenParameters.time_limitTextGenParameters.top_kTextGenParameters.top_pTextGenParameters.truncate_input_tokens
ReturnOptionPropertiesTextGenLengthPenaltyTextGenDecodingMethod
- Rerank Parameters
- TSModelInference Parameters
TSForecastParametersTSForecastParameters.conditional_columnsTSForecastParameters.control_columnsTSForecastParameters.freqTSForecastParameters.id_columnsTSForecastParameters.observable_columnsTSForecastParameters.prediction_lengthTSForecastParameters.static_categorical_columnsTSForecastParameters.target_columnsTSForecastParameters.timestamp_column
- PeftParameters Parameters
- GuardianDetectors
- Chat Parameters
- Rerank
- Deploy on Demand
- Rate Limits
- Toolkit
- VectorIndexes