UncountablePythonSDK 0.0.8__py3-none-any.whl → 0.0.92__py3-none-any.whl

type_spec/external/api/inputs/get_inputs_data.yaml

@@ -1,82 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/inputs/external_get_inputs_data
-    function: main.site.app.external.inputs.get_inputs_data.get_inputs_data
-    desc: "Gets the details for passed input ids"
-
-Arguments:
-    type: Object
-    properties:
-        input_ids:
-            type: List<ObjectId>
-            desc: "Ids of the inputs to retrieve"
-
-AttributeDetails:
-    type: Object
-    properties:
-        attribute_id:
-            type: ObjectId
-            desc: "A unique identifier for the attribute."
-        name:
-            type: String
-            desc: "The name of the attribute"
-        quantity_type:
-            type: String
-            desc: "The value type of the attribute"
-
-InputTag:
-    type: Object
-    properties:
-        tag_id:
-            type: ObjectId
-            desc: "A unique identifier for the tag."
-        tag_name:
-            type: String
-            desc: "A name for the tag"
-
-InputCategory:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "A unique identifier for the material family id where the category assignment is made."
-        category_id:
-            type: ObjectId
-            desc: "A unique identifer for the category"
-        category_name:
-            type: String
-            desc: "A name for the category"
-
-InputDetails:
-    type: Object
-    properties:
-        input_id:
-            type: ObjectId
-            desc: "A unique identifier for the input."
-        name:
-            type: String
-            desc: "The name of the input."
-        quantity_type:
-            type: String
-            desc: "The quantity type of the input.  Always numeric for standard inputs"
-        type:
-            type: String
-            desc: "The type of the input.  E.g. input, process parameter, equipment"
-        attributes:
-            type: List<input_attributes.InputAttributeValue>
-            desc: "The attributes of the input"
-        categories:
-            type: List<InputCategory>
-            desc: "The categories for the input for each material family"
-        tags:
-            type: List<InputTag>
-            desc: "The tags (subcategories) for the input"
-
-Data:
-    type: Object
-    properties:
-        input_details:
-            type: List<InputDetails>
-        input_attributes:
-            type: List<AttributeDetails>

type_spec/external/api/inputs/set_input_attribute_values.yaml

@@ -1,33 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/inputs/external_set_input_attribute_values
-    function: main.site.app.external.inputs.set_input_attribute_values.set_input_attribute_values
-    desc: "Sets attribute values for an input"
-
-Arguments:
-    type: Object
-    properties:
-        attribute_values:
-            type: List<InputAttributeValue>
-            desc: "The attributes of the input to set"
-
-InputAttributeValue:
-    type: Object
-    properties:
-        input_id:
-            type: ObjectId
-            desc: "A unique identifier for the input to set the attribute value on"
-        attribute_id:
-            type: ObjectId
-            desc: "A unique identifier for the attribute."
-        quantity_dec?:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json?:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
-Data:
-    type: response.Response
-    properties:

type_spec/external/api/outputs/get_output_data.yaml

@@ -1,92 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/outputs/external_get_output_data
-    function: main.site.app.external.outputs.get_output_data.get_output_data
-    desc: "Gets the attribute, categorization and other metadata associated with a set of outputs"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The material family ID to get the output values from."
-        output_ids?:
-            type: List<ObjectId>
-            desc: "The output IDs to get the data from. If this is not filled in, all outputs from a material family will be returned (in paginated form)."
-        offset?:
-            type: Integer
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID"
-        limit?:
-            type: Integer
-            desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
-
-OutputAttrVal:
-    type: Object
-    properties:
-        attribute_id:
-            type: ObjectId
-            desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
-SimpleOutputAttr:
-    type: Object
-    properties:
-        attribute_id:
-            type: ObjectId
-            desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the output attribute"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the output attribute, such as numeric, categorical or text"
-
-SimpleOutputGlobalCategory:
-    type: Object
-    properties:
-        category_id:
-            type: ObjectId
-            desc: "The unique integer ID for the global category. Used for joining and identification elsewhere."
-        name:
-            type: String
-            desc: "The name of the output global category"
-
-FullOutput:
-    type: Object
-    properties:
-        output_id:
-            type: ObjectId
-            desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the output"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the output, such as numeric, categorical, text, curve, or calculation"
-        attributes:
-            type: List<OutputAttrVal>
-            desc: "Attributes associated with an output, such as a test documentation"
-        global_category_id:
-            type: ObjectId
-            desc: "The global category ID associated with the output"
-        unit_id:
-            type: ObjectId
-            desc: "The unit for the output, which all data is stored in. This may be different than the users default displayed information for the output"
-
-Data:
-    type: Object
-    properties:
-        outputs:
-            type: List<FullOutput>
-        attrs:
-            type: List<SimpleOutputAttr>
-        global_categories:
-            type: List<SimpleOutputGlobalCategory>
-        units:
-            type: List<units.SimpleUnit>

type_spec/external/api/outputs/get_output_names.yaml

@@ -1,35 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/outputs/external_get_output_names
-    function: main.site.app.external.outputs.get_output_names.get_output_names
-    desc: "Gets the name of all outputs for a material family. An output represents a measurement value of any time (numeric, text, curve, etc). This includes calculations based off of other outputs, such as a calculated change over time"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The material family ID to get the output values from"
-        offset?:
-            type: Integer
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the output ID"
-        limit?:
-            type: Integer
-            desc: "The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000"
-
-OutputWithName:
-    type: Object
-    properties:
-        output_id:
-            type: ObjectId
-            desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the output"
-
-Data:
-    type: Object
-    properties:
-        outputs:
-            type: List<OutputWithName>

type_spec/external/api/outputs/resolve_output_conditions.yaml

@@ -1,50 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/outputs/external_resolve_output_conditions
-    function: main.site.app.external.outputs.resolve_output_conditions.resolve_output_conditions
-    desc: For the provided set of condition parameter id and values, returns the existing or newly created output condition id for that value and id pair.
-
-ConditionParameterValueRecord:
-    type: Object
-    properties:
-        condition_parameter_id:
-            type: ObjectId
-        value_numeric?:
-            type: Decimal
-            desc: The numeric value for the condition parameter. Should be none if condition parameter is not of type numeric
-        value_string?:
-            type: String
-            desc: The string value for the condition parameter if applicable for this condition parameter
-
-ConditionRequest:
-    type: Object
-    properties:
-        conditions:
-            type: List<ConditionParameterValueRecord>
-
-Arguments:
-    type: Object
-    properties:
-        requested_conditions:
-            type: List<ConditionRequest>
-
-ConditionResponse:
-    type: Object
-    properties:
-        conditions:
-            type: List<ConditionParameterValueRecord>
-        output_condition_id:
-            type: ObjectId
-            desc: The resolved output condition id for this condition parameter id and value pair
-
-Data:
-    type: Object
-    properties:
-        resolved_conditions:
-            type: List<ConditionResponse>
-            desc: Retains the same order as the request and includes the resolve output condition id for each condition request
-
-max_num_condition_requests:
-    type: Integer
-    value: 100

type_spec/external/api/project/get_projects.yaml

@@ -1,42 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/project/external_get_projects
-    function: main.site.app.external.project.get_projects.get_projects
-    desc: "Gets either all projects created in the platform, or the projects associated with a material family ID. Projects are where experiments are placed in Uncountable, similar to folders in a directory structure"
-Arguments:
-    type: Object
-    properties:
-        all_material_families:
-            type: Boolean
-            desc: "Whether to get projects from all material families. Material families are high level groupings of data, usually separated by functional area"
-        material_family_id:
-            type: Optional<ObjectId>
-            desc: "The specific material family ID to get projects from. Only fill this in if all_material_families is set to false"
-
-Project:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the project"
-        material_family_id:
-            type: ObjectId
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<ObjectId>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<ObjectId>
-            desc: "The phase id corresponding to a phase workflow"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<Project>
-        phases:
-            type: List<phases.Phase>

type_spec/external/api/project/get_projects_data.yaml

@@ -1,50 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/project/external_get_projects_data
-    function: main.site.app.external.project.get_projects_data.get_projects_data
-    desc: "Gets either all data associated with a set of projects created in the platform.  Because Uncountables recipe structure is complex, various data values are exploded out to increase efficiency in parsing, and this page is paginated to prevent too large of return values"
-Arguments:
-    type: Object
-    properties:
-        project_ids:
-            type: List<ObjectId>
-            desc: "The projects to get the data from"
-        offset?:
-            type: Optional<Integer>
-            desc: "Used for pagination. All pagination is done in order of Project ID"
-        limit?:
-            type: Optional<Integer>
-            desc: "The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100"
-
-ProjectDetailed:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the project"
-        material_family_id:
-            type: ObjectId
-            desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
-        project_owner_id:
-            type: Optional<ObjectId>
-            desc: "The projects owner, as a user ID within the platform"
-        phase_id:
-            type: Optional<ObjectId>
-            desc: "The phase id corresponding to a phase workflow"
-        values:
-            type: List<field_values.ArgumentValueId>
-            desc: "List of fields and values associated with the project"
-
-Data:
-    type: Object
-    properties:
-        projects:
-            type: List<ProjectDetailed>
-        phases:
-            type: List<phases.Phase>
-        fields:
-            type: List<fields.Field>

type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml

@@ -1,41 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipe_metadata/external_get_recipe_metadata_data
-    function: main.site.app.external.recipe_metadata.get_recipe_metadata_data.get_recipe_metadata_data
-    desc: "Gets the recipe metadata. Recipe metadata is data associated with experiments that is not an input, output or calculation, such as a sample ID."
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The material family ID to get the recipe metadata values from."
-        recipe_metadata_ids:
-            type: Optional<List<ObjectId>>
-            desc: "The recipe metadata IDs to get the data from. If this is not filled in, all metadata from a material family will be returned (in paginated form)."
-        offset?:
-            type: Optional<Integer>
-            desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID"
-        limit?:
-            type: Optional<Integer>
-            desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
-
-FullRecipeMetadataField:
-    type: Object
-    properties:
-        recipe_metadata_id:
-            type: ObjectId
-            desc: "The unique integer ID of the recipe metadata value. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe metadata"
-        quantity_type:
-            type: String
-            desc: "The quantity type of the recipe metadata, such as numeric, categorical or text"
-
-Data:
-    type: Object
-    properties:
-        recipe_metadata:
-            type: List<FullRecipeMetadataField>

type_spec/external/api/recipes/create_recipes.yaml

@@ -1,47 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: post
-    path: ${external}/recipes/external_create_recipes
-    function: main.site.app.external.recipes.create_recipes.create_recipes
-    desc: "Sets inputs values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system"
-
-CreateRecipeDefinition:
-    type: Object
-    properties:
-        name?:
-            type: String
-            desc: "The name for the recipe"
-        workflow_id:
-            type: ObjectId
-            desc: "The identifier of the workflow to create the recipe with"
-        workflow_variant_id?:
-            type: Optional<ObjectId>
-            desc: "The identifier of the workflow variant to create the recipe with"
-        recipe_metadata?:
-            type: List<recipe_metadata.MetadataValue>
-            desc: "Metadata values to populate the recipe with"
-
-Arguments:
-    type: Object
-    properties:
-        material_family_id:
-            type: ObjectId
-            desc: "The identifier of the material family to create the recipes in"
-        project_id?:
-            type: ObjectId
-            desc: "The identifier of the project to create the recipes in"
-        recipe_definitions:
-            type: List<CreateRecipeDefinition>
-
-CreateRecipeResult:
-    type: Object
-    properties:
-        recipe_id:
-            type: ObjectId
-            desc: The identifier for the created recipe
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<CreateRecipeResult>

type_spec/external/api/recipes/get_curve.yaml

@@ -1,18 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_curve
-    function: main.site.app.external.recipes.get_curve.get_curve
-    desc: "Returns an array of values for the specified curve id."
-Arguments:
-    type: Object
-    properties:
-        recipe_output_id:
-            type: ObjectId
-            desc: "The recipe output ID to fetch the curve for. This must be a curve recipe output. Recipe Outputs can be found from external_get_recipes_data"
-
-Data:
-    type: Object
-    properties:
-        curve:
-            type: curves.Curve

type_spec/external/api/recipes/get_recipe_calculations.yaml

@@ -1,39 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_calculations
-    function: main.site.app.external.recipes.get_recipe_calculations.get_recipe_calculations
-    desc: "Gets the calculations for the passed recipes"
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipes to retrieve calculations for"
-        calculation_ids?:
-            type: List<ObjectId>
-            desc: "Optionally a list of ids of calculations to retrieve"
-
-RecipeCalculation:
-    type: Object
-    properties:
-        recipe_id:
-            type: ObjectId
-            desc: "Identifier for the recipe"
-        calculation_id:
-            type: ObjectId
-            desc: "Identifier for the calculation"
-        quantity_dec?:
-            type: Decimal
-            desc: "The value for the calculation, if it is of numeric type"
-        quantity_json?:
-            type: JsonValue
-            desc: "The value for the calculation, if it is not of numeric type"
-
-Data:
-    type: Object
-    properties:
-        recipe_calculations:
-            type: List<RecipeCalculation>
-        calculations:
-            type: List<calculations.Calculation>

type_spec/external/api/recipes/get_recipe_links.yaml

@@ -1,26 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_links
-    function: main.site.app.external.recipes.get_recipe_links.get_recipe_links
-    desc: "Gets the links for the passed recipes"
-
-Arguments:
-    type: Object
-    properties:
-        recipe_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipes to retrieve links for"
-        depth:
-            type: Integer
-            desc: "How many layers deep to look for links"
-            default: 1
-        link_types:
-            type: Optional<List<recipe_links.RecipeLinkType>>
-            desc: "Optional filter to only desired link types"
-
-Data:
-    type: Object
-    properties:
-        recipe_links:
-            type: List<recipe_links.RecipeLink>

type_spec/external/api/recipes/get_recipe_names.yaml

@@ -1,29 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_names
-    function: main.site.app.external.recipes.get_recipe_names.get_recipe_names
-    desc: "Gets the name of all recipes (or experiments, used as synonyms by Uncountable) for a project. The call external_get_projects can be used to find projects"
-
-Arguments:
-    type: Object
-    properties:
-        project_id:
-            type: ObjectId
-            desc: "Required: The project ID to get the recipes/experiments from."
-
-SimpleRecipe:
-    type: Object
-    properties:
-        id:
-            type: ObjectId
-            desc: "The unique integer ID of the recipe/experiment. Used for joining and identification elsewhere"
-        name:
-            type: String
-            desc: "The name of the recipe"
-
-Data:
-    type: Object
-    properties:
-        recipes:
-            type: List<SimpleRecipe>

type_spec/external/api/recipes/get_recipe_output_metadata.yaml

@@ -1,36 +0,0 @@
-$endpoint:
-    is_sdk: true
-    method: get
-    path: ${external}/recipes/external_get_recipe_output_metadata
-    function: main.site.app.external.recipes.get_recipe_output_metadata.get_recipe_output_metadata
-    desc: "Gets the metadata values for the passed recipe outputs"
-Arguments:
-    type: Object
-    properties:
-        recipe_output_ids:
-            type: List<ObjectId>
-            desc: "Ids of the Recipe Outputs to retrieve metadata for"
-
-RecipeOutputMetadata:
-    type: Object
-    properties:
-        recipe_output_id:
-            type: ObjectId
-            desc: "Identifier for the recipe output"
-        recipe_output_metadata_field_id:
-            type: ObjectId
-            desc: "Identifier for the metadata field id"
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the metadata, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the metadata, if it is not of numeric type"
-
-Data:
-    type: Object
-    properties:
-        recipe_output_metadata:
-            type: List<RecipeOutputMetadata>
-        recipe_output_metadata_fields:
-            type: List<recipe_output_metadata.RecipeOutputMetadataField>