Class: Aws::ElementalInference::Types::CreateFunctionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:request_expression, :response_expression, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the function. Maximum length: 1,024 characters.

Returns:

  • (String)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#event_bridge_delivery ⇒ String

Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental Inference sends a result only when the result is a JSON object with a top-level eventBridge field set to true. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event has resultOmitted set to true in place of the result.

Valid values:

  • ENABLED – Elemental Inference sends each marked result as an event.

  • DISABLED (default) – Elemental Inference doesn't send events.

For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level eventBridge field. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds.

Returns:

  • (String)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#name ⇒ String

A name for this function.

Returns:

  • (String)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#request_expression ⇒ String

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for. Maximum length: 5,120 characters.

When you save the function, Elemental Inference evaluates the expression against sample media and rejects it if the evaluation fails. For a Bedrock target, the result must be a JSON object; Elemental Inference doesn't check that the object is a valid request body for the model. The expression can reference at most one of media.transcript, media.contextual, and media.clip. For a passthrough target, it can't reference media.frames.

Returns:

  • (String)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#response_expression ⇒ String

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result. Maximum length: 5,120 characters.

When you save the function, Elemental Inference checks that the expression is valid JSONata. For a passthrough target, it also evaluates the request and response expressions together against sample media, and rejects them if they produce no value.

Returns:

  • (String)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags to associate with this function.

Returns:

  • (Hash<String,String>)


604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#target ⇒ Types::FunctionTarget

The destination for the request that the function builds.



604
605
606
607
608
609
610
611
612
613
614
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 604

class CreateFunctionRequest < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end