Management API Reference for embedding-store-content-retriever

Provided Capabilities (1)

Attributes (4)

• embedding-model - Embedding model used to compute embeddings.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Embedding model used to compute embeddings.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.ai.embedding.model", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• embedding-store - Store were the contents and embeddings are retrieved from.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Store were the contents and embeddings are retrieved from.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.ai.embedding.store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• max-results - The maximum number of contents to retrieve.

  Type	INT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of contents to retrieve.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• min-score - The minimum relevance score for the returned contents.Contents scoring below this score are excluded from the results.

  Type	DOUBLE
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "The minimum relevance score for the returned contents.Contents scoring below this score are excluded from the results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - This operation adds an embedding store content retriever.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  embedding-model	STRING	true	true		Embedding model used to compute embeddings.
  embedding-store	STRING	true	true		Store were the contents and embeddings are retrieved from.
  max-results	INT	false	true		The maximum number of contents to retrieve.
  min-score	DOUBLE	false	true		The minimum relevance score for the returned contents.Contents scoring below this score are excluded from the results.

  Raw DMR model

  { "operation-name" : "add", "description" : "This operation adds an embedding store content retriever.", "request-properties" : { "embedding-model" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Embedding model used to compute embeddings.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.ai.embedding.model", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "embedding-store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Store were the contents and embeddings are retrieved from.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.ai.embedding.store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "max-results" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of contents to retrieve.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "min-score" : { "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "The minimum relevance score for the returned contents.Contents scoring below this score are excluded from the results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - This operation removes an embedding store content retriever.

  Raw DMR model

  { "operation-name" : "remove", "description" : "This operation removes an embedding store content retriever.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.ai.embedding-store-content-retriever

          
  <feature spec="subsystem.ai.embedding-store-content-retriever">
    <param name="embedding-store-content-retriever" value="{resource name}"/>
    <param name="embedding-model" value="{value}"/>
    <param name="embedding-store" value="{value}"/>
    <param name="max-results" value="{value}"/>
    <param name="min-score" value="{value}"/>
  <feature/>
          
        

  📋