fastly 17.1.0 → 18.0.0

data/lib/fastly/api/ai_runtime_control_providers_api.rb

@@ -0,0 +1,195 @@
+=begin
+#Fastly API
+
+#Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
+
+The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
+
+=end
+
+require 'cgi'
+
+module Fastly
+  class AiRuntimeControlProvidersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Bedrock setup information
+    # Returns the AI Runtime Control IAM role Amazon Resource Name (ARN) and external ID to reference in your AWS account's IAM trust policy before creating an `aws-iam` [provider connection](https://www.fastly.com/documentation/reference/api/ai-runtime-control/provider-connections#arc-create-provider-connection) to Amazon Bedrock.  Requires AWS IAM authentication to be enabled on your account. If it isn't, this endpoint returns a 404 response. 
+    # @return [ArcBedrockSetupResponse]
+    def arc_get_bedrock_setup(opts = {})
+      data, _status_code, _headers = arc_get_bedrock_setup_with_http_info(opts)
+      data
+    end
+
+    # Get Bedrock setup information
+    # Returns the AI Runtime Control IAM role Amazon Resource Name (ARN) and external ID to reference in your AWS account's IAM trust policy before creating an `aws-iam` [provider connection](https://www.fastly.com/documentation/reference/api/ai-runtime-control/provider-connections#arc-create-provider-connection) to Amazon Bedrock.  Requires AWS IAM authentication to be enabled on your account. If it isn't, this endpoint returns a 404 response. 
+    # @return [Array<(ArcBedrockSetupResponse, Integer, Hash)>] ArcBedrockSetupResponse data, response status code and response headers
+    def arc_get_bedrock_setup_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlProvidersApi.arc_get_bedrock_setup ...'
+      end
+      # unbox the parameters from the hash
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/providers/bedrock/setup'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcBedrockSetupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlProvidersApi.arc_get_bedrock_setup",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlProvidersApi#arc_get_bedrock_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get models for a provider
+    # Returns the models available for a specific provider.
+    # @option opts [String] :provider_id The ID of the provider. (required)
+    # @return [ArcModelsResponse]
+    def arc_get_models_for_provider(opts = {})
+      data, _status_code, _headers = arc_get_models_for_provider_with_http_info(opts)
+      data
+    end
+
+    # Get models for a provider
+    # Returns the models available for a specific provider.
+    # @option opts [String] :provider_id The ID of the provider. (required)
+    # @return [Array<(ArcModelsResponse, Integer, Hash)>] ArcModelsResponse data, response status code and response headers
+    def arc_get_models_for_provider_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlProvidersApi.arc_get_models_for_provider ...'
+      end
+      # unbox the parameters from the hash
+      provider_id = opts[:'provider_id']
+      # verify the required parameter 'provider_id' is set
+      if @api_client.config.client_side_validation && provider_id.nil?
+        fail ArgumentError, "Missing the required parameter 'provider_id' when calling AiRuntimeControlProvidersApi.arc_get_models_for_provider"
+      end
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/providers/{provider_id}/models'.sub('{' + 'provider_id' + '}', CGI.escape(provider_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcModelsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlProvidersApi.arc_get_models_for_provider",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlProvidersApi#arc_get_models_for_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get supported providers
+    # Returns the AI providers supported by AI Runtime Control, with each provider's available models nested within.
+    # @return [ArcProvidersResponse]
+    def arc_get_supported_providers(opts = {})
+      data, _status_code, _headers = arc_get_supported_providers_with_http_info(opts)
+      data
+    end
+
+    # Get supported providers
+    # Returns the AI providers supported by AI Runtime Control, with each provider&#39;s available models nested within.
+    # @return [Array<(ArcProvidersResponse, Integer, Hash)>] ArcProvidersResponse data, response status code and response headers
+    def arc_get_supported_providers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlProvidersApi.arc_get_supported_providers ...'
+      end
+      # unbox the parameters from the hash
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/providers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcProvidersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlProvidersApi.arc_get_supported_providers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlProvidersApi#arc_get_supported_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/fastly/api/ai_runtime_control_sessions_api.rb

@@ -0,0 +1,112 @@
+=begin
+#Fastly API
+
+#Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
+
+The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
+
+=end
+
+require 'cgi'
+
+module Fastly
+  class AiRuntimeControlSessionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get session logs
+    # Returns session logs, including request and response data and metadata, for debugging and audit purposes.
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to `now`.
+    # @option opts [String] :cursor Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results, or the `prev_cursor` value to request the previous page. 
+    # @option opts [Integer] :limit Limit how many results are returned. (default to 100)
+    # @option opts [String] :sort Sort field. Prefix with `-` for descending order (e.g., `sort=-created_at`).  (default to 'created_at')
+    # @return [ArcSessionsResponse]
+    def arc_get_session_logs(opts = {})
+      data, _status_code, _headers = arc_get_session_logs_with_http_info(opts)
+      data
+    end
+
+    # Get session logs
+    # Returns session logs, including request and response data and metadata, for debugging and audit purposes.
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to `now`.
+    # @option opts [String] :cursor Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results, or the `prev_cursor` value to request the previous page. 
+    # @option opts [Integer] :limit Limit how many results are returned. (default to 100)
+    # @option opts [String] :sort Sort field. Prefix with `-` for descending order (e.g., `sort=-created_at`).  (default to 'created_at')
+    # @return [Array<(ArcSessionsResponse, Integer, Hash)>] ArcSessionsResponse data, response status code and response headers
+    def arc_get_session_logs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlSessionsApi.arc_get_session_logs ...'
+      end
+      # unbox the parameters from the hash
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AiRuntimeControlSessionsApi.arc_get_session_logs, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AiRuntimeControlSessionsApi.arc_get_session_logs, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["created_at", "-created_at"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/sessions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
+      query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcSessionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlSessionsApi.arc_get_session_logs",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlSessionsApi#arc_get_session_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/fastly/api/ai_runtime_control_usage_metrics_api.rb

@@ -0,0 +1,176 @@
+=begin
+#Fastly API
+
+#Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
+
+The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
+
+=end
+
+require 'cgi'
+
+module Fastly
+  class AiRuntimeControlUsageMetricsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Export usage metrics
+    # Returns usage metrics for AI Runtime Control requests. Accepts the same filter parameters as [get usage metrics](#arc-get-usage-metrics), except `sort` and `granularity`, which aren't supported here.  Set the `Accept` header to `text/csv` to receive a CSV file download instead of a JSON response. In the CSV output, the column named `time` corresponds to the `date` field in the JSON response. 
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to now.
+    # @return [ArcUsageMetricsResponse]
+    def arc_export_usage_metrics(opts = {})
+      data, _status_code, _headers = arc_export_usage_metrics_with_http_info(opts)
+      data
+    end
+
+    # Export usage metrics
+    # Returns usage metrics for AI Runtime Control requests. Accepts the same filter parameters as [get usage metrics](#arc-get-usage-metrics), except `sort` and `granularity`, which aren't supported here.  Set the `Accept` header to `text/csv` to receive a CSV file download instead of a JSON response. In the CSV output, the column named `time` corresponds to the `date` field in the JSON response. 
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to now.
+    # @return [Array<(ArcUsageMetricsResponse, Integer, Hash)>] ArcUsageMetricsResponse data, response status code and response headers
+    def arc_export_usage_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlUsageMetricsApi.arc_export_usage_metrics ...'
+      end
+      # unbox the parameters from the hash
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/usage-metrics/export'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
+      query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcUsageMetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlUsageMetricsApi.arc_export_usage_metrics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlUsageMetricsApi#arc_export_usage_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get usage metrics
+    # Returns usage metrics for AI Runtime Control requests, including request counts, session counts, input token counts, and output token counts.
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to now.
+    # @option opts [String] :granularity The time granularity to aggregate usage by. (default to 'daily')
+    # @option opts [String] :sort Sort field. Prefix with &#x60;-&#x60; for descending order (e.g., &#x60;sort&#x3D;-date&#x60;).  (default to 'date')
+    # @return [ArcUsageMetricsResponse]
+    def arc_get_usage_metrics(opts = {})
+      data, _status_code, _headers = arc_get_usage_metrics_with_http_info(opts)
+      data
+    end
+
+    # Get usage metrics
+    # Returns usage metrics for AI Runtime Control requests, including request counts, session counts, input token counts, and output token counts.
+    # @option opts [String] :key Filter results to a specific virtual key ID.
+    # @option opts [String] :provider Filter results by AI provider connection ID.
+    # @option opts [String] :model Filter results by AI model identifier.
+    # @option opts [Time] :from The start of the time range, in RFC 3339 format.
+    # @option opts [Time] :to The end of the time range, in RFC 3339 format. Defaults to now.
+    # @option opts [String] :granularity The time granularity to aggregate usage by. (default to 'daily')
+    # @option opts [String] :sort Sort field. Prefix with &#x60;-&#x60; for descending order (e.g., &#x60;sort&#x3D;-date&#x60;).  (default to 'date')
+    # @return [Array<(ArcUsageMetricsResponse, Integer, Hash)>] ArcUsageMetricsResponse data, response status code and response headers
+    def arc_get_usage_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AiRuntimeControlUsageMetricsApi.arc_get_usage_metrics ...'
+      end
+      # unbox the parameters from the hash
+      allowable_values = ["daily", "hourly"]
+      if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity'])
+        fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["date", "-date"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ai-runtime-control/v1/usage-metrics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
+      query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ArcUsageMetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"AiRuntimeControlUsageMetricsApi.arc_get_usage_metrics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AiRuntimeControlUsageMetricsApi#arc_get_usage_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end