vellum_ai 0.3.4

data/lib/vellum_ai/document_indexes/client.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/entity_status"
+require_relative "../types/environment_enum"
+require_relative "../types/document_index_read"
+require "async"
+
+module Vellum
+  class DocumentIndexesClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [DocumentIndexesClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Creates a new document index.
+    #
+    # @param label [String] A human-readable label for the document index
+    # @param name [String] A name that uniquely identifies this index within its workspace
+    # @param status [ENTITY_STATUS] The current status of the document index
+    #   * `ACTIVE` - Active
+    #   * `ARCHIVED` - Archived
+    # @param environment [ENVIRONMENT_ENUM] The environment this document index is used in
+    #   * `DEVELOPMENT` - Development
+    #   * `STAGING` - Staging
+    #   * `PRODUCTION` - Production
+    # @param indexing_config [Hash{String => String}] Configuration representing how documents should be indexed
+    # @param copy_documents_from_index_id [String] Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
+    # @param request_options [RequestOptions]
+    # @return [DocumentIndexRead]
+    def create(label:, name:, indexing_config:, status: nil, environment: nil, copy_documents_from_index_id: nil,
+               request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          label: label,
+          name: name,
+          status: status,
+          environment: environment,
+          indexing_config: indexing_config,
+          copy_documents_from_index_id: copy_documents_from_index_id
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+      end
+      DocumentIndexRead.from_json(json_object: response.body)
+    end
+
+    # Used to retrieve a Document Index given its ID or name.
+    #
+    # @param id [String] Either the Document Index's ID or its unique name
+    # @param request_options [RequestOptions]
+    # @return [DocumentIndexRead]
+    def retrieve(id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes/#{id}"
+      end
+      DocumentIndexRead.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncDocumentIndexesClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncDocumentIndexesClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Creates a new document index.
+    #
+    # @param label [String] A human-readable label for the document index
+    # @param name [String] A name that uniquely identifies this index within its workspace
+    # @param status [ENTITY_STATUS] The current status of the document index
+    #   * `ACTIVE` - Active
+    #   * `ARCHIVED` - Archived
+    # @param environment [ENVIRONMENT_ENUM] The environment this document index is used in
+    #   * `DEVELOPMENT` - Development
+    #   * `STAGING` - Staging
+    #   * `PRODUCTION` - Production
+    # @param indexing_config [Hash{String => String}] Configuration representing how documents should be indexed
+    # @param copy_documents_from_index_id [String] Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
+    # @param request_options [RequestOptions]
+    # @return [DocumentIndexRead]
+    def create(label:, name:, indexing_config:, status: nil, environment: nil, copy_documents_from_index_id: nil,
+               request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            label: label,
+            name: name,
+            status: status,
+            environment: environment,
+            indexing_config: indexing_config,
+            copy_documents_from_index_id: copy_documents_from_index_id
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+        end
+        DocumentIndexRead.from_json(json_object: response.body)
+      end
+    end
+
+    # Used to retrieve a Document Index given its ID or name.
+    #
+    # @param id [String] Either the Document Index's ID or its unique name
+    # @param request_options [RequestOptions]
+    # @return [DocumentIndexRead]
+    def retrieve(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes/#{id}"
+        end
+        DocumentIndexRead.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/documents/client.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/paginated_slim_document_list"
+require_relative "../types/document_status"
+require_relative "../types/document_read"
+require_relative "../types/upload_document_response"
+require_relative "../../core/file_utilities"
+require "async"
+
+module Vellum
+  class DocumentsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [DocumentsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Used to list documents. Optionally filter on supported fields.
+    #
+    # @param document_index_id [String] Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param request_options [RequestOptions]
+    # @return [PaginatedSlimDocumentList]
+    def list(document_index_id: nil, limit: nil, offset: nil, ordering: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "document_index_id": document_index_id,
+          "limit": limit,
+          "offset": offset,
+          "ordering": ordering
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/documents"
+      end
+      PaginatedSlimDocumentList.from_json(json_object: response.body)
+    end
+
+    # @param id [String] A UUID string identifying this document.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def destroy(id:, request_options: nil)
+      @request_client.conn.delete do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/documents/#{id}"
+      end
+    end
+
+    # Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+    #
+    # @param id [String] A UUID string identifying this document.
+    # @param label [String] A human-readable label for the document. Defaults to the originally uploaded file's file name.
+    # @param status [DOCUMENT_STATUS] The current status of the document
+    #   * `ACTIVE` - Active
+    # @param metadata [Hash{String => String}] A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    # @param request_options [RequestOptions]
+    # @return [DocumentRead]
+    def partial_update(id:, label: nil, status: nil, metadata: nil, request_options: nil)
+      response = @request_client.conn.patch do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          label: label,
+          status: status,
+          metadata: metadata
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/documents/#{id}"
+      end
+      DocumentRead.from_json(json_object: response.body)
+    end
+
+    # Upload a document to be indexed and used for search.
+    #
+    # **Note:** Uses a base url of `https://documents.vellum.ai`.
+    #
+    # This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
+    #
+    # - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
+    # - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+    # - `label: str` - A human-friendly name for this document. Typically the filename.
+    # - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+    # - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    #
+    # @param add_to_index_names [Array<String>] Optionally include the names of all indexes that you'd like this document to be included in
+    # @param external_id [String] Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+    # @param label [String] A human-friendly name for this document. Typically the filename.
+    # @param contents [String, IO]
+    # @param keywords [Array<String>] Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+    # @param metadata [String] A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    # @param request_options [RequestOptions]
+    # @return [UploadDocumentResponse]
+    def upload(label:, contents:, add_to_index_names: nil, external_id: nil, keywords: nil, metadata: nil,
+               request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          add_to_index_names: add_to_index_names,
+          external_id: external_id,
+          label: label,
+          contents: FileUtilities.as_faraday_multipart(file_like: contents),
+          keywords: keywords,
+          metadata: metadata
+        }.compact
+        req.url "#{@request_client.default_environment[:Documents]}/v1/upload-document"
+      end
+      UploadDocumentResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncDocumentsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncDocumentsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Used to list documents. Optionally filter on supported fields.
+    #
+    # @param document_index_id [String] Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param request_options [RequestOptions]
+    # @return [PaginatedSlimDocumentList]
+    def list(document_index_id: nil, limit: nil, offset: nil, ordering: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "document_index_id": document_index_id,
+            "limit": limit,
+            "offset": offset,
+            "ordering": ordering
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/documents"
+        end
+        PaginatedSlimDocumentList.from_json(json_object: response.body)
+      end
+    end
+
+    # @param id [String] A UUID string identifying this document.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def destroy(id:, request_options: nil)
+      Async do
+        @request_client.conn.delete do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/documents/#{id}"
+        end
+      end
+    end
+
+    # Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+    #
+    # @param id [String] A UUID string identifying this document.
+    # @param label [String] A human-readable label for the document. Defaults to the originally uploaded file's file name.
+    # @param status [DOCUMENT_STATUS] The current status of the document
+    #   * `ACTIVE` - Active
+    # @param metadata [Hash{String => String}] A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    # @param request_options [RequestOptions]
+    # @return [DocumentRead]
+    def partial_update(id:, label: nil, status: nil, metadata: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.patch do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            label: label,
+            status: status,
+            metadata: metadata
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/documents/#{id}"
+        end
+        DocumentRead.from_json(json_object: response.body)
+      end
+    end
+
+    # Upload a document to be indexed and used for search.
+    #
+    # **Note:** Uses a base url of `https://documents.vellum.ai`.
+    #
+    # This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
+    #
+    # - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
+    # - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+    # - `label: str` - A human-friendly name for this document. Typically the filename.
+    # - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+    # - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    #
+    # @param add_to_index_names [Array<String>] Optionally include the names of all indexes that you'd like this document to be included in
+    # @param external_id [String] Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+    # @param label [String] A human-friendly name for this document. Typically the filename.
+    # @param contents [String, IO]
+    # @param keywords [Array<String>] Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+    # @param metadata [String] A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+    # @param request_options [RequestOptions]
+    # @return [UploadDocumentResponse]
+    def upload(label:, contents:, add_to_index_names: nil, external_id: nil, keywords: nil, metadata: nil,
+               request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            add_to_index_names: add_to_index_names,
+            external_id: external_id,
+            label: label,
+            contents: FileUtilities.as_faraday_multipart(file_like: contents),
+            keywords: keywords,
+            metadata: metadata
+          }.compact
+          req.url "#{@request_client.default_environment[:Documents]}/v1/upload-document"
+        end
+        UploadDocumentResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/model_versions/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/model_version_read"
+require "async"
+
+module Vellum
+  class ModelVersionsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [ModelVersionsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Deprecated. Use the `deployments/provider-payload` endpoint to fetch information that we send to Model providers.
+    #
+    # @param id [String] A UUID string identifying this model version.
+    # @param request_options [RequestOptions]
+    # @return [ModelVersionRead]
+    def retrieve(id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/model-versions/#{id}"
+      end
+      ModelVersionRead.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncModelVersionsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncModelVersionsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Deprecated. Use the `deployments/provider-payload` endpoint to fetch information that we send to Model providers.
+    #
+    # @param id [String] A UUID string identifying this model version.
+    # @param request_options [RequestOptions]
+    # @return [ModelVersionRead]
+    def retrieve(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/model-versions/#{id}"
+        end
+        ModelVersionRead.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/registered_prompts/client.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/register_prompt_prompt_info_request"
+require_relative "../types/provider_enum"
+require_relative "../types/register_prompt_model_parameters_request"
+require_relative "../types/register_prompt_response"
+require "async"
+
+module Vellum
+  class RegisteredPromptsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [RegisteredPromptsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
+    # partners, not directly by Vellum users.
+    #
+    # Under the hood, this endpoint creates a new sandbox, a new model version, and a new deployment.
+    #
+    # @param label [String] A human-friendly label for corresponding entities created in Vellum.
+    # @param name [String] A uniquely-identifying name for corresponding entities created in Vellum.
+    # @param prompt [Hash] Information about how to execute the prompt template.Request of type RegisterPromptPromptInfoRequest, as a Hash
+    #   * :prompt_block_data (Hash)
+    #     * :version (Integer)
+    #     * :blocks (Array<PromptTemplateBlockRequest>)
+    #   * :input_variables (Array<RegisteredPromptInputVariableRequest>)
+    # @param provider [PROVIDER_ENUM] The initial LLM provider to use for this prompt
+    #   * `ANTHROPIC` - Anthropic
+    #   * `AWS_BEDROCK` - AWS Bedrock
+    #   * `AZURE_OPENAI` - Azure OpenAI
+    #   * `COHERE` - Cohere
+    #   * `GOOGLE` - Google
+    #   * `HOSTED` - Hosted
+    #   * `MOSAICML` - MosaicML
+    #   * `OPENAI` - OpenAI
+    #   * `FIREWORKS_AI` - Fireworks AI
+    #   * `HUGGINGFACE` - HuggingFace
+    #   * `MYSTIC` - Mystic
+    #   * `PYQ` - Pyq
+    #   * `REPLICATE` - Replicate
+    # @param model [String] The initial model to use for this prompt
+    # @param parameters [Hash] The initial model parameters to use for  this promptRequest of type RegisterPromptModelParametersRequest, as a Hash
+    #   * :temperature (Float)
+    #   * :max_tokens (Integer)
+    #   * :stop (Array<String>)
+    #   * :top_p (Float)
+    #   * :top_k (Integer)
+    #   * :frequency_penalty (Float)
+    #   * :presence_penalty (Float)
+    #   * :logit_bias (Hash{String => String})
+    #   * :custom_parameters (Hash{String => String})
+    # @param meta [Hash{String => String}] Optionally include additional metadata to store along with the prompt.
+    # @param request_options [RequestOptions]
+    # @return [RegisterPromptResponse]
+    def register_prompt(label:, name:, prompt:, model:, parameters:, provider: nil, meta: nil, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          label: label,
+          name: name,
+          prompt: prompt,
+          provider: provider,
+          model: model,
+          parameters: parameters,
+          meta: meta
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/registered-prompts/register"
+      end
+      RegisterPromptResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncRegisteredPromptsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncRegisteredPromptsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
+    # partners, not directly by Vellum users.
+    #
+    # Under the hood, this endpoint creates a new sandbox, a new model version, and a new deployment.
+    #
+    # @param label [String] A human-friendly label for corresponding entities created in Vellum.
+    # @param name [String] A uniquely-identifying name for corresponding entities created in Vellum.
+    # @param prompt [Hash] Information about how to execute the prompt template.Request of type RegisterPromptPromptInfoRequest, as a Hash
+    #   * :prompt_block_data (Hash)
+    #     * :version (Integer)
+    #     * :blocks (Array<PromptTemplateBlockRequest>)
+    #   * :input_variables (Array<RegisteredPromptInputVariableRequest>)
+    # @param provider [PROVIDER_ENUM] The initial LLM provider to use for this prompt
+    #   * `ANTHROPIC` - Anthropic
+    #   * `AWS_BEDROCK` - AWS Bedrock
+    #   * `AZURE_OPENAI` - Azure OpenAI
+    #   * `COHERE` - Cohere
+    #   * `GOOGLE` - Google
+    #   * `HOSTED` - Hosted
+    #   * `MOSAICML` - MosaicML
+    #   * `OPENAI` - OpenAI
+    #   * `FIREWORKS_AI` - Fireworks AI
+    #   * `HUGGINGFACE` - HuggingFace
+    #   * `MYSTIC` - Mystic
+    #   * `PYQ` - Pyq
+    #   * `REPLICATE` - Replicate
+    # @param model [String] The initial model to use for this prompt
+    # @param parameters [Hash] The initial model parameters to use for  this promptRequest of type RegisterPromptModelParametersRequest, as a Hash
+    #   * :temperature (Float)
+    #   * :max_tokens (Integer)
+    #   * :stop (Array<String>)
+    #   * :top_p (Float)
+    #   * :top_k (Integer)
+    #   * :frequency_penalty (Float)
+    #   * :presence_penalty (Float)
+    #   * :logit_bias (Hash{String => String})
+    #   * :custom_parameters (Hash{String => String})
+    # @param meta [Hash{String => String}] Optionally include additional metadata to store along with the prompt.
+    # @param request_options [RequestOptions]
+    # @return [RegisterPromptResponse]
+    def register_prompt(label:, name:, prompt:, model:, parameters:, provider: nil, meta: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            label: label,
+            name: name,
+            prompt: prompt,
+            provider: provider,
+            model: model,
+            parameters: parameters,
+            meta: meta
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/registered-prompts/register"
+        end
+        RegisterPromptResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end