GraphQL Schema Documentation

This document provides comprehensive documentation for the GraphQL schema defined in the schema.py file. The schema includes scalars, enumerations, input objects, output objects, interfaces, and queries.

Scalars and Enumerations

Scalars

• Boolean: Represents a boolean value.

• DateTime: Represents a date and time.

• Float: Represents a floating-point number.

• Int: Represents an integer.

• String: Represents a string.

• UUID: Represents a universally unique identifier (UUID).

• JSON: Represents a JSON data structure.

Enumerations

• DpsAggMethod: Represents aggregation methods with the following choices:
  • AVG: Average
  • COUNT: Count
  • CUSTOM: Custom
  • MAX: Maximum
  • MIN: Minimum
  • NONE: None
  • SUM: Sum

Input Objects

The schema does not define any input objects.

Output Objects and Interfaces

Interfaces

• LLMApiConfig: Common fields for API configurations.

  • id: A universally unique identifier.
  • api_type: The type of API.
  • model_type: The type of model.
  • model_name: The name of the model.
  • is_active: Indicates whether the API is active.

• MaxDomainObject: Common fields for domain objects.

  • type: The type of the domain object.
  • id: The identifier of the domain object.
  • name: The name of the domain object.
  • description: A description of the domain object.
  • output_label: The label for the domain object's output.
  • synonyms: Synonyms associated with the domain object.
  • output_label_plural: The plural label for the domain object's output.
  • hide_from_user: Indicates whether the domain object should be hidden from the user.

• MaxDomainAttribute: Common fields for domain attributes.

  • type: The type of the domain attribute.
  • id: The identifier of the domain attribute.
  • name: The name of the domain attribute.
  • description: A description of the domain attribute.
  • output_label: The label for the domain attribute's output.
  • synonyms: Synonyms associated with the domain attribute.
  • output_label_plural: The plural label for the domain attribute's output.
  • hide_from_user: Indicates whether the domain attribute should be hidden from the user.
  • display_format: The format for displaying the attribute.
  • headline_name: The name of the attribute for headlines.
  • is_favorite: Indicates whether the attribute is a favorite.
  • domain_entity: The domain entity to which the attribute belongs.

• MaxDimensionAttribute: Common fields for dimension attributes.

  • type: The type of the dimension attribute.
  • id: The identifier of the dimension attribute.
  • name: The name of the dimension attribute.
  • description: A description of the dimension attribute.
  • output_label: The label for the dimension attribute's output.
  • synonyms: Synonyms associated with the dimension attribute.
  • output_label_plural: The plural label for the dimension attribute's output.
  • hide_from_user: Indicates whether the dimension attribute should be hidden from the user.
  • display_format: The format for displaying the attribute.
  • headline_name: The name of the attribute for headlines.
  • is_favorite: Indicates whether the attribute is a favorite.
  • domain_entity: The domain entity to which the attribute belongs.
  • default_filter_value: The default filter value for the attribute.
  • is_required_in_query: Indicates whether the attribute is required in queries.

• MaxDomainEntity: Common fields for domain entities.

  • type: The type of the domain entity.
  • id: The identifier of the domain entity.
  • name: The name of the domain entity.
  • description: A description of the domain entity.
  • output_label: The label for the domain entity's output.
  • synonyms: Synonyms associated with the domain entity.
  • output_label_plural: The plural label for the domain entity's output.
  • hide_from_user: Indicates whether the domain entity should be hidden from the user.
  • db_table: The database table associated with the domain entity.
  • attributes: List of attributes belonging to the domain entity.

Output Objects

• CopilotSkillArtifact: Represents an artifact related to a Copilot skill.

  • copilot_skill_artifact_id: A universally unique identifier for the Copilot skill artifact.
  • copilot_id: The identifier of the Copilot.
  • copilot_skill_id: The identifier of the Copilot skill.
  • artifact_path: The path to the artifact.
  • artifact: The artifact data.
  • description: A description of the artifact.
  • created_user_id: The identifier of the user who created the artifact.
  • created_utc: The creation timestamp.
  • last_modified_user_id: The identifier of the user who last modified the artifact.
  • last_modified_utc: The timestamp of the last modification.
  • version: The version of the artifact.
  • is_active: Indicates whether the artifact is active.
  • is_deleted: Indicates whether the artifact is deleted.

• DomainObjectResponse: Response containing a domain object with the following fields:

  • success: Indicates the success of the response.
  • code: Response code (optional).
  • error: Error message (optional).
  • domain_object: The domain object data.

• ExecuteSqlQueryResponse: Response containing the result of an SQL query execution with the following fields:

  • success: Indicates the success of the query execution.
  • code: Query execution code (optional).
  • error: Query execution error message (optional).
  • data: The query result data.

• Mutation: Contains mutation fields.

• Query: Contains query fields.

• AzureOpenaiCompletionLLMApiConfig: Configuration for Azure OpenAI Completion API.

  • api_base_url: The base URL for the API.
  • api_version: The API version.
  • openai_model_name: The name of the OpenAI model.
  • max_tokens_content_generation: The maximum number of tokens for content generation.
  • temperature: The temperature setting for content generation.
  • top_p: The top-p setting for content generation.
  • presence_penalty: The presence penalty for content generation.
  • frequency_penalty: The frequency penalty for content generation.
  • stop_sequence: The stop sequence for content generation.

• AzureOpenaiEmbeddingLLMApiConfig: Configuration for Azure OpenAI Embedding API.

  • api_base_url: The base URL for the API.
  • api_version: The API version.

• MaxCalculatedMetric: Represents a calculated metric.

  • display_format: The format for displaying the metric.
  • rql: The RQL (Report Query Language) for the metric.
  • agg_method: The aggregation method for the metric.
  • is_positive_direction_up: Indicates whether a positive direction means an increase in the metric.
  • can_be_averaged: Indicates whether the metric can be averaged.
  • is_not_additive: Indicates whether the metric is not additive.
  • growth_output_format: The format for displaying growth metrics.
  • hide_percentage_change: Indicates whether the percentage change should be hidden.

• MaxDimensionEntity: Represents a dimension entity.

  • primary_attribute: The primary attribute associated with the dimension entity.
  • archetype: The archetype of the dimension entity.

• MaxFactEntity: Represents a fact entity.

• MaxMetricAttribute: Represents a metric attribute.

  • db_metric_column: The database column associated with the metric attribute.
  • agg_method: The aggregation method for the metric attribute.
  • is_row_level_filter: Indicates whether the metric attribute is a row-level filter.
  • is_positive_direction_up: Indicates whether a positive direction means an increase in the metric.
  • can_be_averaged: Indicates whether the metric attribute can be averaged.
  • is_not_additive: Indicates whether the metric attribute is not additive.
  • growth_output_format: The format for displaying growth metrics.
  • hide_percentage_change: Indicates whether the percentage change should be hidden.

• MaxNormalAttribute: Represents a normal attribute.

  • db_column: The database column associated with the normal attribute.
  • db_secondary_column: The secondary database column associated with the normal attribute.

• MaxPrimaryAttribute: Represents a primary attribute.

  • db_primary_key_columns: The primary key columns in the database.
  • db_secondary_column: The secondary database column associated with the primary attribute.

• MaxReferenceAttribute: Represents a reference attribute.

  • db_foreign_key_columns: The foreign key columns in the database.
  • referenced_dimension_entity_id: The identifier of the referenced dimension entity.

• OpenaiCompletionLLMApiConfig: Configuration for OpenAI Completion API.

  • organization: The organization associated with the API configuration.
  • max_tokens_content_generation: The maximum number of tokens for content generation.
  • temperature: The temperature setting for content generation.
  • top_p: The top-p setting for content generation.
  • presence_penalty: The presence penalty for content generation.
  • frequency_penalty: The frequency penalty for content generation.
  • stop_sequence: The stop sequence for content generation.

• OpenaiEmbeddingLLMApiConfig: Configuration for OpenAI Embedding API.

  • organization: The organization associated with the API configuration.

Unions

The schema does not define any unions.

Schema Entry Points

• Query: Entry point for querying data.
• Mutation: Entry point for mutating data.

The schema contains various scalar types, enumerations, input objects, output objects, and interfaces. These elements provide the necessary structure for creating and querying data within the GraphQL API.

For more detailed information on specific types and queries, please refer to the original schema.py file or consult the schema documentation provided by your GraphQL server.

Note: This documentation is a general overview and may need to be expanded or customized according to the specific usage and requirements of your GraphQL schema.