• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Model connectivity & developmentModelsAPI ReferencesAPI: Language model transform inputs

    Language model classes

    palantir_models provides a set of classes to be used in Python transforms.

    ClassDescription
    OpenAiGptChatLanguageModelInputA FoundryInputParam which binds to the OpenAiGptChatLanguageModel API from language model service. Use in a Python transforms decorator.
    GenericChatCompletionLanguageModelInputBinds a model to the generic chat completion API in a Python transform.
    GenericCompletionLanguageModelInputA FoundryInputParam which binds to the GenericCompletionLanguageModel API from language model service. Use in a Python transforms decorator.
    GenericEmbeddingModelInputA FoundryInputParam which exposes the GenericEmbeddingsModel API from language model service. Use in a Python transforms decorator.
    OpenAiGptChatLanguageModelProvides a client to an OpenAI chat completion model.
    GenericChatCompletionLanguageModelProvides a client for text conversations through the generic chat completion API.
    GenericCompletionLanguageModelProvides a client to execute any chat completion model available in AIP.
    GenericEmbeddingModelProvides a client to execute any embedding model available in AIP.

    OpenAiGptChatLanguageModelInput

    class palantir_models.transforms.OpenAiGptChatLanguageModelInput(rid)

    • rid
      • The resource identifier that identifies the language model.

    GenericChatCompletionLanguageModelInput

    class palantir_models.transforms.GenericChatCompletionLanguageModelInput(rid)

    • rid
      • The resource identifier of the language model, including a registered model RID where applicable.

    Supplies a GenericChatCompletionLanguageModel to the transform. See the generic chat completion example and request reference.

    GenericCompletionLanguageModelInput

    class palantir_models.transforms.GenericCompletionLanguageModelInput(rid)

    • rid
      • The resource identifier that identifies the language model.

    GenericEmbeddingModelInput

    class palantir_models.transforms.GenericEmbeddingModelInput(rid)

    • rid
      • The resource identifier that identifies the embedding model.

    OpenAiGptChatLanguageModel

    class palantir_models.models.OpenAiGptChatLanguageModel

    • create_chat_completion(completion_request)
      • Executes the provided chat completion request.
      • Parameters
        • completion_request: language_model_service_api.languagemodelservice_api_completion_v3.GptChatCompletionRequest
      • Return Type
        • language_model_service_api.languagemodelservice_api_completion_v3.GptChatCompletionResponse

    GenericChatCompletionLanguageModel

    class palantir_models.models.GenericChatCompletionLanguageModel

    • create_chat_completion(completion_request)
      • Executes the provided text chat completion request.
      • Parameters
        • completion_request: language_model_service_api.languagemodelservice_api_completion_v3.GenericChatCompletionRequest
      • Return Type
        • language_model_service_api.languagemodelservice_api_completion_v3.GenericChatCompletionResponse

    See the request fields, message structure, and response format.

    GenericCompletionLanguageModel

    class palantir_models.models.GenericCompletionLanguageModel

    • create_completion(completion_request)
      • Executes the provided completion request.
      • Parameters
        • completion_request: language_model_service_api.languagemodelservice_api_completion_v3.GenericCompletionRequest
      • Return Type
        • language_model_service_api.languagemodelservice_api_completion_v3.GenericCompletionResponse

    GenericEmbeddingModel

    class palantir_models.models.GenericEmbeddingModel

    • create_embeddings(embeddings_request)
      • Computes embeddings for all inputs provided in the embeddings_request
      • Parameters
        • embeddings_request: language_model_service_api.languagemodelservice_api_embeddings_v3.GenericEmbeddingsRequest
      • Return Type
        • language_model_service_api.languagemodelservice_api_embeddings_v3.GenericEmbeddingsResponse