RosIndex

This class is a base encapsulation around the ROS resource type ALIYUN::Bailian::Index.

Initializers

import ros_cdk_bailian
ros_cdk_bailian.RosIndex(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  structure_type: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  category_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  chunk_mode: typing.Union[str, IResolvable] = None,
  chunk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  connect_id: typing.Union[str, IResolvable] = None,
  database: typing.Union[str, IResolvable] = None,
  dense_similarity_top_k: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  document_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  embedding_model_name: typing.Union[str, IResolvable] = None,
  enable_headers: typing.Union[bool, IResolvable] = None,
  enable_rewrite: typing.Union[bool, IResolvable] = None,
  knowledge_scene: typing.Union[str, IResolvable] = None,
  knowledge_type: typing.Union[str, IResolvable] = None,
  meta_extract_columns: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MetaExtractColumnsProperty]]] = None,
  overlap_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  pipeline_commercial_cu: typing.Union[typing.Union[int, float], IResolvable] = None,
  pipeline_commercial_type: typing.Union[str, IResolvable] = None,
  pipeline_retrieve_rate_limit_strategy: typing.Union[str, IResolvable] = None,
  rerank_instruct: typing.Union[str, IResolvable] = None,
  rerank_min_score: typing.Union[typing.Union[int, float], IResolvable] = None,
  rerank_mode: typing.Union[str, IResolvable] = None,
  rerank_model_name: typing.Union[str, IResolvable] = None,
  separator: typing.Union[str, IResolvable] = None,
  sink_instance_id: typing.Union[str, IResolvable] = None,
  sink_region: typing.Union[str, IResolvable] = None,
  sink_type: typing.Union[str, IResolvable] = None,
  sparse_similarity_top_k: typing.Union[typing.Union[int, float], IResolvable] = None,
  table: typing.Union[str, IResolvable] = None,
  table_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool
)

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

id^Required

• Type: str

scoped id of the resource.

name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

source_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

structure_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

workspace_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

category_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

chunk_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

chunk_size^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

connect_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

database^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

dense_similarity_top_k^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

document_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

embedding_model_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_headers^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

enable_rewrite^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

knowledge_scene^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

knowledge_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

meta_extract_columns^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MetaExtractColumnsProperty]]]

overlap_size^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

pipeline_commercial_cu^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

pipeline_commercial_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

pipeline_retrieve_rate_limit_strategy^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_instruct^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_min_score^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

rerank_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_model_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

separator^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_instance_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_region^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sparse_similarity_top_k^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

table^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

table_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

enable_resource_property_constraint^Required

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

add_condition

def add_condition(
  con: RosCondition
) -> None

con^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

add_meta_data

def add_meta_data(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

value^Required

• Type: typing.Any

The value.

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policy^Optional

• Type: bool

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_desc

def fetch_desc() -> str

fetch_ros_dependency

def fetch_ros_dependency() -> typing.List[str]

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

Static Functions

is_construct

import ros_cdk_bailian
ros_cdk_bailian.RosIndex.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

is_ros_element

import ros_cdk_bailian
ros_cdk_bailian.RosIndex.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

is_ros_resource

import ros_cdk_bailian
ros_cdk_bailian.RosIndex.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

attr_id^Required

attr_id: IResolvable

• Type: ros_cdk_core.IResolvable

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

name^Required

name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

source_type^Required

source_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

structure_type^Required

structure_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

workspace_id^Required

workspace_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

category_ids^Optional

category_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

chunk_mode^Optional

chunk_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

chunk_size^Optional

chunk_size: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

connect_id^Optional

connect_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

database^Optional

database: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

dense_similarity_top_k^Optional

dense_similarity_top_k: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

description^Optional

description: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

document_ids^Optional

document_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

embedding_model_name^Optional

embedding_model_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_headers^Optional

enable_headers: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

enable_rewrite^Optional

enable_rewrite: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

knowledge_scene^Optional

knowledge_scene: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

knowledge_type^Optional

knowledge_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

meta_extract_columns^Optional

meta_extract_columns: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MetaExtractColumnsProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MetaExtractColumnsProperty]]]

overlap_size^Optional

overlap_size: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

pipeline_commercial_cu^Optional

pipeline_commercial_cu: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

pipeline_commercial_type^Optional

pipeline_commercial_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

pipeline_retrieve_rate_limit_strategy^Optional

pipeline_retrieve_rate_limit_strategy: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_instruct^Optional

rerank_instruct: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_min_score^Optional

rerank_min_score: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

rerank_mode^Optional

rerank_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rerank_model_name^Optional

rerank_model_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

separator^Optional

separator: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_instance_id^Optional

sink_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_region^Optional

sink_region: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sink_type^Optional

sink_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sparse_similarity_top_k^Optional

sparse_similarity_top_k: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

table^Optional

table: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

table_ids^Optional

table_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Constants

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.

Structs